1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
|
# -*- coding: utf-8 -*-
# Copyright 2008-2015 Canonical
# Copyright 2015-2016 Chicharreros (https://launchpad.net/~chicharreros)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# For further info, check http://launchpad.net/magicicada-server
"""Test Storage Server requests/responses."""
import collections
import logging
import os
import types
import time
import uuid
import weakref
import metrics
from django.utils.timezone import now
from mocker import expect, Mocker, MockerTestCase, ARGS, KWARGS, ANY
from twisted.python.failure import Failure
from twisted.python import log
from twisted.internet import defer, task, error as txerror
from twisted.trial.unittest import TestCase as TwistedTestCase
from ubuntuone.storageprotocol import protocol_pb2, request
from magicicada import settings
from magicicada.filesync import errors as dataerror
from magicicada.filesync.models import Share
from magicicada.server import errors
from magicicada.server.server import (
PREFERRED_CAP,
AccountResponse,
Action,
AuthenticateResponse,
BytesMessageProducer,
ChangePublicAccess,
CreateShare,
CreateUDF,
DeleteShare,
DeleteVolume,
FreeSpaceResponse,
GetContentResponse,
GetDeltaResponse,
ListShares,
ListPublicFiles,
ListVolumes,
LoopingPing,
MakeResponse,
MoveResponse,
PutContentResponse,
QuerySetCapsResponse,
RescanFromScratchResponse,
ShareAccepted,
SimpleRequestResponse,
StorageServer,
StorageServerFactory,
StorageServerRequestResponse,
Unlink,
cancel_filter,
logger,
)
from magicicada.server.testing import testcase
from magicicada.testing.testcase import BaseTestCase
try:
from versioninfo import version_info
except ImportError:
version_info = None
def noop(*args, **kwargs):
return
class FakeNode(object):
"""A fake node."""
id = 123
generation = 0
is_live = False
is_file = False
name = u"name"
parent_id = None
content_hash = None
crc32 = 12123
size = 45325
last_modified = 2334524
is_public = False
path = u"path"
volume_id = 'volumeid'
public_url = 'public_url'
class FakeUser(object):
"""A fake user."""
id = 42
username = 'username'
def get_root(self):
return (123, 456) # root_id, gen
def set_client_caps(self, caps):
return
class FakeProducer(object):
"""A fake producer."""
def dummy(*s):
return
resumeProducing = stopProducing = pauseProducing = startProducing = dummy
class FakedStats(object):
"""A faked statsmeter"""
def __init__(self):
self.informed = []
def hit(self, *args):
"""Inform stats."""
self.informed.append(args)
class FakedFactory(object):
"""A faked factory."""
auth_provider = None
def __init__(self):
self.stats = FakedStats()
self.metrics = metrics.get_meter('metrics')
self.user_metrics = metrics.get_meter('user_metrics')
self.sli_metrics = metrics.get_meter('sli_metrics')
self.servername = "fakeservername"
self.trace_users = []
class FakedPeer(object):
"""A faked peer."""
def __init__(self):
self.host = 'localhost'
self.port = 0
class FakedTransport(object):
"""A faked transport."""
def __init__(self):
self.registerProducer = noop
self.unregisterProducer = noop
self.loseConnection = noop
self.getPeer = lambda *_: FakedPeer()
class BaseStorageServerTestCase(BaseTestCase, TwistedTestCase):
"""Test the StorageServer class.
This is just a base class with a lot of functionality for other TestCases.
"""
maxDiff = None
session_id = '1234-567890'
@defer.inlineCallbacks
def setUp(self):
"""Init."""
yield super(BaseStorageServerTestCase, self).setUp()
self.last_msg = None
self.restore = {}
self.server = StorageServer(session_id=self.session_id)
self.patch(self.server, 'sendMessage',
lambda msg: setattr(self, 'last_msg', msg))
self.patch(self.server, 'factory', FakedFactory())
self.patch(self.server, 'transport', FakedTransport())
self.handler = self.add_memento_handler(logger, level=settings.TRACE)
@property
def shutdown(self):
"""Property to access self.server.shutting_down attribute."""
return self.server.shutting_down
@property
def msg(self):
"""A per-test message to raise exceptions."""
return 'Some message for a failure while executing %s.' % self
def assert_correct_comment(self, comment, msg):
"""Ckeck that error sent had `msg' as comment."""
self.assertTrue(comment is not None)
self.assertTrue(len(comment) > 0)
error_msg = 'msg ("%s") must be in comment field ("%s").'
self.assertTrue(unicode(msg) in comment, error_msg % (msg, comment))
def fail_please(self, failure):
"""Return a function that raises 'failure'."""
def inner(*args, **kwargs):
"""Do nothing but fail."""
raise failure
return inner
def just_return(self, result):
"""Return a function that returns 'result'."""
def inner(*args, **kwargs):
"""Do nothing but return a value."""
return result
return inner
def make_protocol_message(self, msg_type=None, msg_id=None):
message = protocol_pb2.Message()
if msg_type is not None:
message.type = getattr(protocol_pb2.Message, msg_type)
if msg_id is not None:
message.id = msg_id
return message
class StorageServerTestCase(BaseStorageServerTestCase):
"""Test the StorageServer class.
Here are the tests specific for the StorageServer class... other TestCase
classes should not inherit this.
"""
def test_log_error(self):
"""Test server._log_error."""
req = request.Request(protocol=None)
failure = Failure(Exception(self.msg))
self.server._log_error(failure, req.__class__)
self.handler.assert_error(req.__class__.__name__, str(failure))
def test_schedule_request(self):
"""Test schedule_request adds a logging errback to the request."""
self.patch(self.server, 'execute_next_request', lambda: None)
req = request.Request(protocol=self.server)
req.id = 42
self.server.requests[req.id] = req
self.server.schedule_request(request=req, callback=None)
# assert proper errback was chained
self.assertEqual(len(req.deferred.callbacks), 1)
self.assertEqual(req.deferred.callbacks[0][1][0],
self.server._log_error,
'errback must be correct')
self.assertEqual(req.deferred.callbacks[0][1][1],
(req.__class__,),
'errback parameter is correct')
# the logging callback actually works!
failure = Failure(Exception(self.msg))
req.error(failure)
self.handler.assert_error(str(failure), req.__class__.__name__)
def test_schedule_request_head(self):
"""Test schedule_request to the left of the deque."""
self.patch(self.server, 'execute_next_request', lambda: None)
req1 = request.Request(protocol=self.server)
req1.id = 42
self.server.requests[req1.id] = req1
self.server.schedule_request(req1, None)
req2 = request.Request(protocol=self.server)
req2.id = 43
self.server.requests[req2.id] = req2
self.server.schedule_request(req2, None, head=True)
# check that req2 is at the head of the deque
expected_deque = collections.deque([(req2, None), (req1, None)])
self.assertEqual(expected_deque, self.server.pending_requests)
self.assertEqual(req2.id, self.server.pending_requests.popleft()[0].id)
def test_handle_PROTOCOL_VERSION_when_version_too_low(self):
"""handle_PROTOCOL_VERSION when unsupported version."""
message = self.make_protocol_message(msg_type='PROTOCOL_VERSION')
message.protocol.version = self.server.VERSION_REQUIRED - 1
self.server.handle_PROTOCOL_VERSION(message)
self.assertTrue(self.shutdown)
self.assertTrue(self.last_msg is not None)
self.assertEqual(protocol_pb2.Message.ERROR, self.last_msg.type)
self.assertEqual(protocol_pb2.Error.UNSUPPORTED_VERSION,
self.last_msg.error.type)
self.assert_correct_comment(comment=self.last_msg.error.comment,
msg=message.protocol.version)
def test_handle_PROTOCOL_VERSION_when_version_too_high(self):
"""handle_PROTOCOL_VERSION when unsupported version."""
message = self.make_protocol_message(msg_type='PROTOCOL_VERSION')
message.protocol.version = self.server.PROTOCOL_VERSION + 1
self.server.handle_PROTOCOL_VERSION(message)
self.assertTrue(self.shutdown)
self.assertTrue(self.last_msg is not None)
self.assertEqual(protocol_pb2.Message.ERROR, self.last_msg.type)
self.assertEqual(protocol_pb2.Error.UNSUPPORTED_VERSION,
self.last_msg.error.type)
self.assert_correct_comment(comment=self.last_msg.error.comment,
msg=message.protocol.version)
def test_data_received(self):
"""Test error handling on server.dataReceived method."""
failure = Exception(self.msg)
self.patch(self.server, 'buildMessage', self.fail_please(failure))
self.server.dataReceived(data=None)
self.handler.assert_exception(failure)
def test_execute_next_request(self):
"""Test error handling for execute_next_request."""
failure = Exception(self.msg)
next_req = (request.Request(None), self.fail_please(failure))
self.server.pending_requests = collections.deque([next_req])
self.server.execute_next_request()
self.handler.assert_exception(failure, next_req[0].__class__.__name__)
def test_process_message_logs_on_error(self):
"""Test error handling for processMessage."""
failure = Exception(self.msg)
self.patch(request.RequestHandler, 'processMessage',
self.fail_please(failure))
self.server.processMessage(self.make_protocol_message())
self.handler.assert_exception(
failure, self.server.processMessage.__name__)
def test_protocol_ref_enabled(self):
"""Test that protocol weakref is disabled in tests."""
self.patch(settings.api_server, 'PROTOCOL_WEAKREF', True)
_server = StorageServer()
response = StorageServerRequestResponse(
protocol=_server, message=self.make_protocol_message())
self.assertEqual(_server, response._protocol_ref())
self.assertEqual(weakref.ref, type(response._protocol_ref))
def test_protocol_ref_disabled(self):
"""Test that protocol weakref is disabled in tests."""
self.patch(settings.api_server, 'PROTOCOL_WEAKREF', False)
_server = StorageServer()
response = StorageServerRequestResponse(
protocol=_server, message=self.make_protocol_message())
self.assertEqual(_server, response._protocol_ref)
def test_looping_ping_enabled(self):
"""Test that the server instantiates the looping ping."""
self.assertIsInstance(self.server.ping_loop, LoopingPing)
def test_looping_ping_interval(self):
"""Test the looping ping interval set from the server."""
self.assertEqual(self.server.ping_loop.interval, 120)
def test_looping_ping_timeout(self):
"""Test the looping ping timeout set from the server."""
self.assertEqual(self.server.ping_loop.timeout, 480)
def test_setuser_set_user(self):
"""Check the user is set."""
assert self.server.user is None
user = FakeUser()
self.server.set_user(user)
self.assertEqual(self.server.user, user)
def test_handle_PING(self):
"""Handle PING."""
# get the response
response = []
self.server.sendMessage = lambda r: response.append(r)
# build the msg
message = self.make_protocol_message('PING')
# try it
self.server.handle_PING(message)
# check response and logging
self.assertEqual(response[0].type, protocol_pb2.Message.PONG)
self.handler.assert_trace("ping pong")
class ActionTestCase(BaseStorageServerTestCase):
"""Test the Action class."""
@defer.inlineCallbacks
def setUp(self):
"""Init."""
yield super(ActionTestCase, self).setUp()
# create a request-response to use in the tests.
self.response = StorageServerRequestResponse(
protocol=self.server, message=self.make_protocol_message())
self.response.id = 42
self.response.protocol.requests[self.response.id] = self.response
self.callable_deferred = defer.Deferred()
self.action = Action(self.response, self._callable)
self.increments = []
self.decrements = []
self.patch(self.response.protocol.factory.metrics, 'increment',
self.increments.append)
self.patch(self.response.protocol.factory.metrics, 'decrement',
self.decrements.append)
def _callable(self):
"""Do nothing."""
return self.callable_deferred
def test_start(self):
"""Test the start method."""
self.action.start()
self.assertTrue(self.action.started)
self.assertEqual(["action_instances." + Action.__name__],
self.increments)
self.handler.assert_debug(
"Action being scheduled (%s)" % self._callable)
self.handler.assert_debug(
"Action being started, working on: %s" % self._callable)
def test_start_tail(self):
"""Test the start method, scheduled in the tail."""
# get the request lock
self.server.request_locked = self.response
action = Action(self.response, self._callable)
action.start()
self.action.start(False)
self.assertEqual(action, self.server.pending_requests.popleft()[0])
self.assertEqual(self.action,
self.server.pending_requests.popleft()[0])
def test_start_head(self):
"""Test the start method, scheduled in the head."""
# get the request lock
self.server.request_locked = self.response
self.action.start()
self.assertFalse(self.action.started)
action = Action(self.response, self._callable)
action.start()
self.action.start()
self.assertEqual(self.action,
self.server.pending_requests.popleft()[0])
self.assertEqual(action, self.server.pending_requests.popleft()[0])
def test_schedule_start(self):
"""Test the start method."""
self.server.request_locked = self.response
self.action.start()
self.assertEqual(["action_instances." + Action.__name__],
self.increments)
self.handler.assert_debug(
"Action being scheduled (%s)" % self._callable)
def test__start(self):
"""Test the _start method."""
def _callable():
"""Do nothing."""
self.callable_deferred.callback(None)
return self.callable_deferred
self.action._callable = _callable
self.action.start()
self.assertTrue(self.callable_deferred.called)
def test_cleanup(self):
"""Test the cleanup method."""
self.action.start()
self.callable_deferred.callback(None)
self.assertTrue(self.action.finished)
self.assertFalse(self.action.started)
self.assertEqual(["action_instances." + Action.__name__],
self.increments)
self.assertEqual(["action_instances." + Action.__name__],
self.decrements)
def test_done(self):
"""Test the done method."""
self.action.start()
self.callable_deferred.callback(None)
self.handler.assert_debug("Action done (%s)" % self._callable)
def test_done_fails(self):
"""Test that error is called if done fails."""
# patch base class done method, and make it fail.
exc = RuntimeError("fail!")
def bad_cleanup(_):
"""cleanup method that always fails."""
raise exc
self.patch(Action, 'cleanup', bad_cleanup)
# patch error method to know it was called
called = []
def error(_, e):
"""Collect the errors."""
called.append(e)
self.patch(Action, 'error', error)
self.action.start()
self.callable_deferred.callback(None)
self.handler.assert_debug("Action done (%s)" % self._callable)
# done was called, check if error too.
self.assertEqual(1, len(called))
self.assertEqual(exc, called[0].value)
def test_action_deferred_called(self):
"""Test the action.deferred callback chain."""
self.action.start()
result = object()
self.callable_deferred.callback(result)
self.assertTrue(self.action.deferred.called)
self.assertEqual(result, self.action.deferred.result)
def test_action_deferred_errback_called(self):
"""Test the action.deferred errback chain."""
self.action.start()
failure = Failure(RuntimeError("fail!"))
self.callable_deferred.errback(failure)
self.assertTrue(self.action.deferred.called)
def check(f):
"""Check the failure."""
self.assertEqual(failure, f)
self.action.deferred.addErrback(check)
class StorageServerRequestResponseTestCase(BaseStorageServerTestCase):
"""Test the StorageServerRequestResponse class."""
response_class = StorageServerRequestResponse
@defer.inlineCallbacks
def setUp(self):
"""Init."""
yield super(StorageServerRequestResponseTestCase, self).setUp()
self.errors = []
self.last_msg = None
def sendError(myself, msg, comment=None, free_space_info=None):
"""Fake sendError."""
self.errors.append((msg, comment, free_space_info))
self.patch(self.response_class, 'sendError', sendError)
self.patch(self.response_class, 'sendMessage',
lambda s, m: setattr(self, 'last_msg', m))
self.response = self.response_class(
protocol=self.server, message=self.make_protocol_message())
self.response.id = 42
self.response.protocol.requests[self.response.id] = self.response
factory = self.response.protocol.factory
self.increments = []
self.decrements = []
self.patch(factory.metrics, 'increment', self.increments.append)
self.patch(factory.metrics, 'decrement', self.decrements.append)
@property
def last_error(self):
"""Return the last error."""
return self.errors[-1] if self.errors else None
def assert_comment_present(self, msg):
"""Ckeck that error sent had `msg' as comment."""
self.assertTrue(self.last_error is not None)
self.assertEqual(3, len(self.last_error))
if self.last_error[2] is not None:
free_space_info = self.last_error[2]
self.assertEqual(dict, type(free_space_info))
comment = self.last_error[1]
self.assert_correct_comment(comment, msg)
def test_error_doesnt_fail(self):
"""Test response.error doesn't fail, always log."""
failure = Exception(self.msg)
self.patch(request.RequestResponse, 'error', self.fail_please(failure))
self.response.error(failure=failure)
self.handler.assert_error(str(failure), self.response.error.__name__)
def test_process_message_returns_result_when_started(self):
"""Test response.processMessage erturns the result."""
expected = object()
self.patch(self.response_class, '_processMessage',
self.just_return(expected))
# create a new response with the patched class
response = self.response_class(protocol=self.server,
message=self.make_protocol_message())
response.id = 43
response.protocol.requests[self.response.id] = self.response
# check
message = self.make_protocol_message()
response.started = True
actual = response.processMessage(message=message)
self.assertEqual(expected, actual,
'processMessage must return _processMessage result')
def test_protocol_gone_raise_error(self):
"""Test that ProtocolReferenceError is raised."""
# patch _protocol_ref to return None, and fake a gc'ed protocol.
self.response.use_protocol_weakref = True
self.response._protocol_ref = lambda: None
self.assertRaises(errors.ProtocolReferenceError,
self.response._get_protocol)
@defer.inlineCallbacks
def test_queue_action(self):
"""Test queue_action"""
result = object()
def to_do():
"""Just succeed."""
return defer.succeed(result)
r = yield self.response.queue_action(to_do)
self.assertEqual(result, r)
def test_request_logger_id_updated(self):
"""Test that StorageRequestLogger.request_id is updated."""
response = self.response_class(protocol=self.server,
message=self.make_protocol_message())
self.assertEqual(None, response.id)
self.assertEqual(None, response.log.request_id)
response.id = 42
self.assertEqual(42, response.id)
self.assertEqual(42, response.log.request_id)
def test_stop_if_started(self):
"""Cancel the request if already started."""
called = []
self.patch(self.response_class, 'cancel',
lambda _: called.append(True))
self.response.started = True
self.response.stop()
self.assertTrue(called)
def test_stop_if_not_started(self):
"""Log and cleanup the request if not started."""
called = []
self.patch(self.response_class, 'cleanup',
lambda _: called.append(True))
assert not self.response.started
self.response.stop()
self.assertTrue(called)
self.handler.assert_debug("Request being released before start")
class SSRequestResponseSpecificTestCase(StorageServerRequestResponseTestCase):
"""Test the StorageServerRequestResponse class, not all inherited ones."""
def test_done_user_activity_yes(self):
"""Report the request's user activity string."""
# put a user_activity in the class
self.response_class.user_activity = 'test-activity'
self.addCleanup(delattr, self.response_class, 'user_activity')
# set a user
self.response.protocol.user = FakeUser()
# record what is measured
informed = []
self.patch(self.response.protocol.factory.user_metrics, 'report',
lambda *a: informed.extend(a))
# execute and test
self.response.done()
self.assertEqual(informed, ['test-activity', '42'])
def test_done_user_activity_no_activity(self):
"""Don't report the request's user activity, as there is no string."""
# assure there's no activity
assert not hasattr(self.response_class, 'user_activity')
# record what is measured
informed = []
self.patch(self.response.protocol.factory.user_metrics, 'report',
lambda *a: informed.extend(a))
# execute and test
self.response.done()
self.assertEqual(informed, [])
def test_done_user_activity_no_user_name(self):
"""Report the request's user activity, but still no user."""
# put a user_activity in the class
self.response_class.user_activity = 'test-activity'
self.addCleanup(delattr, self.response_class, 'user_activity')
# assure there's no user
assert self.response.protocol.user is None
# record what is measured
informed = []
self.patch(self.response.protocol.factory.user_metrics, 'report',
lambda *a: informed.extend(a))
# execute and test
self.response.done()
self.assertEqual(informed, ['test-activity', ''])
def test_get_extension_valids(self):
"""Get a 2 chars extension."""
ext = self.response._get_extension("code.c")
self.assertEqual(ext, "c")
ext = self.response._get_extension("binary.db")
self.assertEqual(ext, "db")
ext = self.response._get_extension("image.png")
self.assertEqual(ext, "png")
ext = self.response._get_extension("image.jpeg")
self.assertEqual(ext, "jpeg")
def test_get_extension_toolong(self):
"""Get an extension from something that has too long similar one."""
ext = self.response._get_extension("document.personal")
self.assertEqual(ext, None)
def test_get_extension_path(self):
"""Get an extension from a big path."""
ext = self.response._get_extension("/foo/bar/etc/image.png")
self.assertEqual(ext, "png")
def test_get_extension_several_dots(self):
"""Get an extension from a path with several dots."""
ext = self.response._get_extension("/foo/bar.etc/image.stuff.png")
self.assertEqual(ext, "png")
def test_get_extension_small_name(self):
"""Get an extension from a small name."""
ext = self.response._get_extension("do")
self.assertEqual(ext, None)
def test_get_extension_nothing(self):
"""Get an extension not finding one."""
ext = self.response._get_extension("alltogetherjpg")
self.assertEqual(ext, None)
class SimpleRequestResponseTestCase(StorageServerRequestResponseTestCase):
"""Test the SimpleRequestResponse class."""
response_class = SimpleRequestResponse
def test_retry_limit_reached_sends_try_again(self):
"""When RetryLimitReached is raised TRY_AGAIN is sent."""
self.assertIn(dataerror.RetryLimitReached,
self.response.try_again_errors)
def test_tcp_timeout_sends_try_again(self):
"""When TCPTimedOutError is raised TRY_AGAIN is sent."""
self.assertIn(txerror.TCPTimedOutError,
self.response.try_again_errors)
def test_translation_does_not_exist(self):
"""DoesNotExist is properly translated."""
e = self.response.protocol_errors[dataerror.DoesNotExist]
self.assertEqual(protocol_pb2.Error.DOES_NOT_EXIST, e)
def test_send_protocol_error_handles_retry_limit_reached(self):
"""_send_protocol_error handles the RetryLimitReached."""
failure = Failure(dataerror.RetryLimitReached(self.msg))
self.response._send_protocol_error(failure=failure)
self.assertTrue(self.last_error is not None)
self.assertEqual(protocol_pb2.Error.TRY_AGAIN, self.last_error[0])
self.assertEqual(
"TryAgain (RetryLimitReached: %s)" % self.msg, self.last_error[1])
def test_tcp_timeout_handled_as_try_again(self):
"""_send_protocol_error handles TCPTimedOutError as TRY_AGAIN."""
failure = Failure(txerror.TCPTimedOutError())
self.response._send_protocol_error(failure=failure)
self.assertTrue(self.last_error is not None)
self.assertEqual(protocol_pb2.Error.TRY_AGAIN, self.last_error[0])
def test_send_protocol_error_handles_does_not_exist(self):
"""_send_protocol_error handles the DoesNotExist."""
failure = Failure(dataerror.DoesNotExist(self.msg))
self.response._send_protocol_error(failure=failure)
self.assertTrue(self.last_error is not None)
self.assertEqual(protocol_pb2.Error.DOES_NOT_EXIST, self.last_error[0])
self.assertEqual(self.msg, self.last_error[1])
def test_send_protocol_error_sends_comment(self):
"""_send_protocol_error sends the optional comment on errors."""
self.response.__class__.expected_errors = \
self.response.protocol_errors.keys()
for error in self.response.protocol_errors:
msg = 'Failing with %s' % error
if error == dataerror.QuotaExceeded:
failure = Failure(error(msg, uuid.uuid4(), 10))
else:
failure = Failure(error(msg))
self.response._send_protocol_error(failure=failure)
self.assert_comment_present(msg)
# any error not in protocol_errors
msg = u"ñoño message with non ascii chars"
failure = Failure(Exception(msg.encode('utf8')))
self.response._send_protocol_error(failure=failure)
self.assert_comment_present(msg)
def test_send_protocol_error_dont_shutdown(self):
"""_send_protocol_error don't shutdown the StorageServer instance."""
failure = Failure(ValueError(self.msg))
self.response._send_protocol_error(failure=failure)
self.assertTrue(self.last_error is not None)
self.assertEqual(protocol_pb2.Error.INTERNAL_ERROR, self.last_error[0])
self.assertEqual(self.msg, self.last_error[1])
self.assertFalse(self.shutdown)
def test_send_protocol_error_try_again_is_metered(self):
"""_send_protocol_error sends metrics on TryAgain errors."""
mocker = Mocker()
mock_metrics = mocker.mock(metrics.FileBasedMeter)
self.response.protocol.factory.metrics = mock_metrics
mock_metrics.meter("TRY_AGAIN.ValueError", 1)
with mocker:
failure = Failure(errors.TryAgain(ValueError(self.msg)))
self.response._send_protocol_error(failure=failure)
def test_send_protocol_error_converted_try_again_is_metered(self):
"""_send_protocol_error sends metrics on convertd TryAgain errors."""
mocker = Mocker()
mock_metrics = mocker.mock(metrics.FileBasedMeter)
self.response.protocol.factory.metrics = mock_metrics
error = self.response.try_again_errors[0]
mock_metrics.meter("TRY_AGAIN.%s" % error.__name__, 1)
with mocker:
failure = Failure(error(self.msg))
self.response._send_protocol_error(failure=failure)
def test_send_protocol_error_locked_user(self):
"""_send_protocol_error handles the LockedUserError"""
called = []
self.patch(self.response.protocol, 'shutdown',
lambda: called.append(1))
failure = Failure(dataerror.LockedUserError())
self.response._send_protocol_error(failure=failure)
self.assertEqual(self.last_error, None)
self.assertEqual(called, [1])
def fake_reactor_inspector(self, last_responsive_ts):
"""Instance that fakes the last_responsive_ts attribute."""
class FakeReactorInspector:
"""Just fakes the last_responsive_ts field."""
def __init__(self, last_responsive_ts):
"""Pass in the fake last_responsive_ts value."""
self.last_responsive_ts = last_responsive_ts
return FakeReactorInspector(last_responsive_ts)
def test_start_sends_comment_on_error(self):
"""_start sends the optional comment on errors."""
self.patch(self.response_class, 'authentication_required', True)
self.response.protocol.user = None
self.response._start()
self.assert_comment_present(self.response.auth_required_error)
def test_done_never_fails_if_inner_done_fails(self):
"""_start never fails even if done() fails."""
failure = Exception(self.msg)
self.patch(request.RequestResponse, 'done', self.fail_please(failure))
self.response.done()
self.assertTrue(
self.response.deferred.called, 'request.deferred was fired.')
self.handler.assert_exception(
failure, self.response.__class__.__name__)
def test_get_node_info(self):
"""Test the correct info generation."""
self.response = self.response_class(
protocol=self.server, message=self.make_protocol_message())
def test_log_working_on_nothing(self):
"""Log working on without specifications."""
message = self.make_protocol_message()
req = self.response_class(self.server, message)
req.start()
self.handler.assert_debug("Request being started")
def test_request_instances_metric(self):
"""request_instances.<request> is updated."""
message = self.make_protocol_message()
req = self.response_class(self.server, message)
req.start()
self.assertIn("request_instances." + self.response_class.__name__,
self.increments)
self.assertIn("request_instances." + self.response_class.__name__,
self.decrements)
def test_log_working_on_something(self):
"""Log working on something."""
message = self.make_protocol_message()
self.patch(self.response_class, '_get_node_info', lambda _: 'FOO')
req = self.response_class(self.server, message)
req.start()
self.handler.assert_debug("Request being started, working on: FOO")
def test_log_operation_data(self):
"""Log data operation."""
message = self.make_protocol_message()
req = self.response_class(self.server, message)
req.operation_data = "some=stuff bar=foo"
req.done()
self.handler.assert_info("Request done: some=stuff bar=foo")
def test_log_request_process(self):
"""Log correctly the life of a request."""
# setup the message
message = self.make_protocol_message(msg_id=42)
self.patch(self.response_class, '_process', lambda _: None)
req = self.response_class(self.server, message)
req.start()
# assert log order
msgs = [(r.levelname, r.msg) for r in self.handler.records
if r.levelno >= logging.DEBUG]
prefix = '%s localhost:0 - %s 42 - ' % (
self.session_id, self.response_class.__name__)
node = req._get_node_info()
if node is None:
working_on = ""
else:
working_on = ", working on: " + node
expected = [
('INFO', prefix + 'Request being scheduled'),
('DEBUG', prefix + "Request being started" + working_on),
('INFO', prefix + 'Request done'),
]
self.assertItemsEqual(msgs, expected)
@defer.inlineCallbacks
def test_internal_error(self):
"""Test for the internal_error method."""
failure = Failure(ValueError(self.msg))
self.response.internal_error(failure=failure)
try:
yield self.response.deferred
except ValueError:
pass
else:
self.fail('Should get a ValueError.')
self.assertTrue(self.response.finished)
self.assertTrue(self.shutdown)
def test_internal_error_after_shutdown(self):
"""Test for getting internal errors after shutdown."""
# shutdown the server, just like if another request
# failed with internal error
self.server.shutdown()
self.assertTrue(self.shutdown)
self.assertTrue(self.response.finished)
# now, make this one fail with internal error
called = []
self.patch(self.server, 'shutdown', lambda: called.append(1))
failure = Failure(ValueError(self.msg))
# the request is already finished
self.response.internal_error(failure=failure)
self.assertTrue(self.response.finished)
self.assertFalse(called)
def test_cancel_filter(self):
"""Test the cancel_filter decorator."""
self.response_class.fakefunction = cancel_filter(lambda *a: 'hi')
self.assertEqual(self.response.fakefunction(self.response), "hi")
self.response.cancelled = True
self.assertRaises(request.RequestCancelledError,
self.response.fakefunction, self.response)
def test_requests_leak(self):
"""Test that the server shutdown remove non-started requests."""
# remove the default request
del self.server.requests[42]
# set a fake user.
mocker = Mocker()
self.server.user = mocker.mock(count=False)
expect(self.server.user.username).result("username")
expect(self.server.user.id).result(1)
expect(self.server.user.reuse_content).result(noop)
expect(self.server.user.get_upload_job).result(
lambda *a, **k: defer.Deferred())
expect(self.server.user.get_node).result(
lambda *a, **k: defer.Deferred())
mocker.replay()
cleaned = []
orig_cleanup = self.response_class.cleanup
def fake_cleanup(response):
"""Clean up the request, but flag it here for the tests."""
cleaned.append(response.id)
orig_cleanup(response)
# patch the _start method to avoid real Response execution
start_deferred = defer.Deferred()
@defer.inlineCallbacks
def fake_start(r):
"""Fake start."""
yield start_deferred
# call done() only if it's not a PutContent response, as it handles
# its own termination in its own _cancel() method (that is called
# for the running instance at shutdown() time).
if not isinstance(r, PutContentResponse):
r.done()
self.patch(self.response_class, 'cleanup', fake_cleanup)
self.patch(self.response_class, '_start', fake_start)
for i in range(5):
response = self.response_class(
protocol=self.server, message=self.make_protocol_message())
response.source_message.id = i
response.start()
self.assertTrue(self.server.pending_requests)
# we should have 4 pending_requests
self.assertEqual(len(self.server.pending_requests), 4,
self.server.pending_requests)
# the first request should be executing
running_request = self.server.requests[0]
self.assertTrue(running_request.started)
# shutdown and check that pending_requests is clean
self.server.shutdown()
self.assertFalse(self.server.pending_requests,
self.server.pending_requests)
# trigger the executing request _process deferred, for
# it to finish, the requests should be clean now
start_deferred.callback(True)
self.assertFalse(self.server.requests, self.server.requests)
# verify that all the requests were properly cleaned
self.assertEqual(sorted(cleaned), range(5), cleaned)
def test_sli_informed_on_done_default(self):
"""The SLI is informed when all ok."""
mocker = Mocker()
mock_metrics = mocker.patch(self.response.protocol.factory.sli_metrics)
expect(mock_metrics.timing(self.response_class.__name__, ANY))
self.response.start_time = time.time()
with mocker:
self.response.done()
def test_sli_informed_on_done_some_value(self):
"""The SLI is informed when all ok."""
mocker = Mocker()
mock_metrics = mocker.patch(self.response.protocol.factory.sli_metrics)
op_length = 12345
expect(mock_metrics.timing(self.response_class.__name__, ANY))
self.response.start_time = time.time()
with mocker:
self.response.length = op_length
self.response.done()
def test_sli_informed_on_error(self):
"""The SLI is informed after a problem."""
mocker = Mocker()
mock_metrics = mocker.patch(self.response.protocol.factory.sli_metrics)
expect(mock_metrics.report('sli_error', self.response_class.__name__))
with mocker:
self.response.error(ValueError())
class ListSharesTestCase(SimpleRequestResponseTestCase):
"""Test the ListShares class."""
response_class = ListShares
@defer.inlineCallbacks
def test_process_set_length(self):
"""Set length attribute while processing."""
mocker = Mocker()
# fake share
share = dict(id=None, from_me=None, to_me=None, root_id=None,
name=u'name', shared_by_username=u'sby', accepted=False,
shared_to_username=u'sto', shared_by_visible_name=u'vby',
shared_to_visible_name=u'vto', access=Share.VIEW)
# fake user
user = mocker.mock()
shared_by = [share] * 3
shared_to = [share] * 2
expect(user.list_shares()
).result((shared_by, shared_to))
expect(user.get_volume_id(None)
).count(3).result(None)
expect(user.root_volume_id).count(3).result('')
self.response.protocol.user = user
with mocker:
yield self.response._process()
self.assertEqual(self.response.length, 5)
class ShareAcceptedTestCase(SimpleRequestResponseTestCase):
"""Test the ShareAccepted class."""
response_class = ShareAccepted
class CreateShareTestCase(SimpleRequestResponseTestCase):
"""Test the CreateShare class."""
response_class = CreateShare
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'create_share')
class DeleteShareTestCase(SimpleRequestResponseTestCase):
"""Test the DeleteShare class."""
response_class = DeleteShare
class CreateUDFTestCase(SimpleRequestResponseTestCase):
"""Test the CreateUDF class."""
response_class = CreateUDF
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'sync_activity')
class DeleteVolumeTestCase(SimpleRequestResponseTestCase):
"""Test the DeleteVolume class."""
response_class = DeleteVolume
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'sync_activity')
class ListVolumesTestCase(SimpleRequestResponseTestCase):
"""Test the ListVolumes class."""
response_class = ListVolumes
@defer.inlineCallbacks
def test_process_set_length(self):
"""Set length attribute while processing."""
mocker = Mocker()
# fake share
share = dict(id=None, root_id=None, name=u'name', path=u"somepath",
shared_by_username=u'sby', accepted=False,
shared_by_visible_name=u'vby', access=Share.VIEW,
generation=9, free_bytes=123)
# fake user
user = mocker.mock()
root = share
shares = [share] * 3
udfs = [share] * 2
expect(user.list_volumes()
).result((root, shares, udfs, 123))
self.response.protocol.user = user
with mocker:
yield self.response._process()
self.assertEqual(self.response.length, 6)
class ChangePublicAccessTestCase(SimpleRequestResponseTestCase):
"""Test the ChangePublicAccess class."""
response_class = ChangePublicAccess
class ListPublicFilesTestCase(SimpleRequestResponseTestCase):
"""Test the ListPublicFiles class."""
response_class = ListPublicFiles
@defer.inlineCallbacks
def test_process_set_values(self):
"""Set length attribute and operation data while processing."""
mocker = Mocker()
user = mocker.mock()
self.response.protocol.user = user
nodes = [FakeNode(), FakeNode()]
expect(user.list_public_files()).result(nodes)
with mocker:
yield self.response._process()
self.assertEqual(self.response.length, 2)
self.assertEqual(self.response.operation_data, "public_files=2")
class UnlinkTestCase(SimpleRequestResponseTestCase):
"""Test the Unlink class."""
response_class = Unlink
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'sync_activity')
class GetContentResponseTestCase(SimpleRequestResponseTestCase):
"""Test the GetContentResponse class."""
response_class = GetContentResponse
def test_download_last_good_state(self):
"""Test that last_good_state_ts gets updated properly."""
before = time.time()
time.sleep(.1)
self.response.start()
after = time.time()
self.assertTrue(before < self.response.last_good_state_ts <= after)
time.sleep(.1)
class FakeProducer:
"""Fake source of data to download."""
def __init__(self):
self.deferred = defer.Deferred()
self.consumer = None
def resumeProducing(self):
"""Do nothing."""
pauseProducing = stopProducing = resumeProducing
def startProducing(self, consumer):
"""Wait a little."""
time.sleep(.1)
consumer.write("abc")
fake_producer = FakeProducer()
self.response.send(fake_producer)
self.assertTrue(self.response.last_good_state_ts > after)
def test_start_sends_comment_on_error(self):
"""_start sends the optional comment on errors."""
self.response.protocol.user = None
self.response._start()
self.assert_comment_present(self.response.auth_required_error)
def test_on_request_cancelled_error_with_cancel_message(self):
"""_send_protocol_error sends CANCELLED when RequestCancelledError.
self.response.cancel_message is not None.
"""
self.response.cancel_message = self.make_protocol_message(msg_id=1)
assert not self.response.cancelled
failure = Failure(request.RequestCancelledError(self.msg))
self.response._send_protocol_error(failure=failure)
self.assertTrue(self.last_error is None)
self.assertTrue(self.last_msg is not None)
self.assertEqual(protocol_pb2.Message.CANCELLED, self.last_msg.type)
def test_on_request_cancelled_error_without_cancel_message(self):
"""_send_protocol_error logs warning.
self.response.cancel_message is None.
"""
self.response.cancel_message = None # no cancel_message
failure = Failure(request.RequestCancelledError(self.msg))
self.response._send_protocol_error(failure=failure)
self.assertTrue(self.last_error is None)
self.assertTrue(self.last_msg is None)
self.handler.assert_warning(str(failure), 'cancel_message is None')
def test__init__(self):
"""Test __init__."""
message = self.make_protocol_message()
response = GetContentResponse(self.server, message)
self.assertEqual(response.cancel_message, None)
self.assertEqual(response.message_producer, None)
self.assertEqual(response.transferred, 0)
def test_transferred_informed_on_done(self):
"""The transferred quantity is informed when all ok."""
mocker = Mocker()
mock_metrics = mocker.patch(self.response.protocol.factory.metrics)
expect(mock_metrics.gauge('GetContentResponse.transferred', 123))
with mocker:
self.response.transferred = 123
self.response.done()
def test_transferred_informed_on_error(self):
"""The transferred quantity is informed after a problem."""
mocker = Mocker()
mock_metrics = mocker.patch(self.response.protocol.factory.metrics)
expect(mock_metrics.gauge('GetContentResponse.transferred', 123))
with mocker:
self.response.transferred = 123
self.response.error(ValueError())
def test_sli_informed_on_done_default(self):
"""The SLI is NOT informed when all ok."""
self.patch(self.response.protocol.factory.sli_metrics,
'timing', lambda *a: self.fail("Must not be called"))
self.response.start_time = time.time()
self.response.done()
def test_sli_informed_on_done_some_value(self):
"""The SLI is informed when all ok."""
self.patch(self.response.protocol.factory.sli_metrics,
'timing', lambda *a: self.fail("Must not be called"))
self.response.start_time = time.time()
self.response.transferred = 12345
self.response.done()
def test_sli_informed_on_done_zero_value(self):
"""The SLI is informed when all ok."""
self.patch(self.response.protocol.factory.sli_metrics,
'timing', lambda *a: self.fail("Must not be called"))
self.response.start_time = time.time()
self.response.transferred = 0
self.response.done()
def test_sli_informed_on_init(self):
"""The SLI is informed after the operation init part."""
mocker = Mocker()
# fake producer
producer = mocker.mock()
# some node
node = mocker.mock()
expect(node.deflated_size).result(3)
expect(node.size).count(2).result(2)
expect(node.content_hash).count(2).result('hash')
expect(node.crc32).result(123)
expect(node.get_content(KWARGS)).result(defer.succeed(producer))
# the user
fake_user = mocker.mock()
expect(fake_user.get_node(None, '', '')).result(defer.succeed(node))
expect(fake_user.username).count(3).result('username')
self.patch(self.response.protocol, 'user', fake_user)
# the metric itself
mock_metrics = mocker.patch(self.response.protocol.factory.sli_metrics)
expect(mock_metrics.timing('GetContentResponseInit', ANY))
with mocker:
self.response._start()
class PutContentResponseTestCase(SimpleRequestResponseTestCase,
MockerTestCase):
"""Test the PutContentResponse class."""
# subclass PutContentResponse so we have a __dict__ and can patch it.
response_class = types.ClassType(PutContentResponse.__name__,
(PutContentResponse,), {})
class FakeUploadJob(object):
"""Fake an UploadJob."""
def __init__(self):
self.bytes = ''
self.inflated_size_hint = 1000
self.ops = defer.succeed(None)
self.deferred = defer.Deferred()
self.called = []
self.storage_key = "fake storagekey"
def stop(self):
"""Fake."""
def connect(self):
"""Flag the call."""
self.called.append('connect')
def cancel(self):
"""Flag the call."""
self.called.append('cancel')
def add_data(self, bytes):
"""Add data."""
self.bytes += bytes
def registerProducer(self, producer):
"""Register the producer."""
self.called.append('registerProducer')
def unregisterProducer(self):
"""Unregister the producer."""
self.called.append('unregisterProducer')
def add_operation(self, op, err):
self.ops.addCallback(op)
self.ops.addErrback(err)
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'sync_activity')
def test__init__(self):
"""Test __init__."""
message = self.make_protocol_message()
response = PutContentResponse(self.server, message)
self.assertEqual(response.cancel_message, None)
self.assertEqual(response.upload_job, None)
self.assertEqual(response.source_message, message)
self.assertEqual(response.protocol, self.server)
self.assertEqual(response.transferred, 0)
def test__get_node_info(self):
"""Test _get_node_info."""
message = self.make_protocol_message(msg_type='PUT_CONTENT')
message.put_content.node = 'abc'
response = PutContentResponse(self.server, message)
node_info = response._get_node_info()
self.assertEqual(node_info, "node: 'abc'")
def test_transferred_informed_on_done(self):
"""The transferred quantity is informed when all ok."""
mocker = Mocker()
mock_metrics = mocker.patch(self.response.protocol.factory.metrics)
expect(mock_metrics.gauge('PutContentResponse.transferred', 123))
with mocker:
self.response.transferred = 123
self.response.done()
def test_transferred_informed_on_error(self):
"""The transferred quantity is informed after a problem."""
mocker = Mocker()
mock_metrics = mocker.patch(self.response.protocol.factory.metrics)
expect(mock_metrics.gauge('PutContentResponse.transferred', 123))
with mocker:
self.response.transferred = 123
self.response.error(ValueError())
def test_sli_informed_on_done_default(self):
"""The SLI is informed when all ok."""
self.patch(self.response.protocol.factory.sli_metrics,
'timing', lambda *a: self.fail("Must not be called"))
self.response.start_time = time.time()
self.response.done()
def test_sli_informed_on_done_some_value(self):
"""The SLI is informed when all ok."""
self.patch(self.response.protocol.factory.sli_metrics,
'timing', lambda *a: self.fail("Must not be called"))
self.response.start_time = time.time()
self.response.transferred = 12345
self.response.done()
def test_sli_informed_on_done_zero_value(self):
"""The SLI is informed when all ok."""
self.patch(self.response.protocol.factory.sli_metrics,
'timing', lambda *a: self.fail("Must not be called"))
self.response.start_time = time.time()
self.response.transferred = 0
self.response.done()
@defer.inlineCallbacks
def test_sli_informed_on_init(self):
"""The SLI is informed after the operation init part."""
mocker = Mocker()
# fake uploadjob
uploadjob = mocker.mock()
expect(uploadjob.deferred).result(defer.Deferred())
expect(uploadjob.connect()).result(defer.succeed(None))
expect(uploadjob.stop()).result(defer.succeed(None))
self.patch(self.response, '_get_upload_job',
lambda: defer.succeed(uploadjob))
# the user
fake_user = mocker.mock()
expect(fake_user.username).count(5).result('username')
self.patch(self.response.protocol, 'user', fake_user)
# the metric itself
mock_metrics = mocker.patch(self.response.protocol.factory.sli_metrics)
expect(mock_metrics.timing('PutContentResponseInit', ANY))
with mocker:
yield self.response._start()
@defer.inlineCallbacks
def test_sli_informed_on_commit(self):
"""The SLI is informed after the operation commit part."""
mocker = Mocker()
self.response.state = PutContentResponse.states.commiting
self.patch(self.response, 'queue_action', lambda _: defer.succeed(0))
# the metric itself
mock_metrics = mocker.patch(self.response.protocol.factory.sli_metrics)
expect(mock_metrics.timing('PutContentResponseCommit', ANY))
with mocker:
yield self.response._commit_uploadjob('result')
def test_start_authentication_required(self):
"""Test that _start sends the optional comment on errors."""
assert self.response.protocol.user is None
response = self.mocker.patch(self.response)
expect(response._log_start())
expect(response.sendError(protocol_pb2.Error.AUTHENTICATION_REQUIRED,
comment=self.response.auth_required_error))
expect(response.done())
self.mocker.replay()
response._start()
self.assertEqual(response.state, PutContentResponse.states.done)
def test_start_upload_started_ok(self):
"""Test _start starts an upload."""
self.response.protocol.user = 'user'
response = self.mocker.patch(self.response)
expect(response._log_start())
expect(response._start_upload()).result(defer.Deferred())
self.mocker.replay()
response._start()
self.assertEqual(response.state, PutContentResponse.states.init)
def test_start_upload_started_error(self):
"""Test _start calls to generic error after a failing upload start."""
self.response.protocol.user = 'user'
response = self.mocker.patch(self.response)
expect(response._log_start())
failure = Failure(NameError('foo'))
expect(response._start_upload()).result(defer.fail(failure))
expect(response._generic_error(failure))
self.mocker.replay()
response._start()
def test_upload_last_good_state(self):
"""Test that last_good_state_ts gets updated as expected."""
upload_job = self.FakeUploadJob()
upload_job.offset = 0
upload_job.upload_id = str(uuid.uuid4())
user = self.mocker.mock()
self.response.protocol.user = user
transport = self.mocker.mock()
self.server.transport = transport
response = self.mocker.patch(self.response)
expect(response._log_start())
expect(response.upload_job).result(upload_job).count(1, None)
expect(transport.getPeer()).result(FakedPeer()).count(1, None)
expect(user.username).result('username').count(1, None)
expect(user.get_upload_job(ARGS, KWARGS)).result(upload_job)
expect(upload_job.registerProducer(transport))
self.mocker.replay()
before = time.time()
time.sleep(.1)
response.start()
after = time.time()
self.assertTrue(before < response.last_good_state_ts <= after)
time.sleep(.1)
bytes_msg = self.make_protocol_message('BYTES')
bytes_msg.bytes.bytes = "123"
response.processMessage(bytes_msg)
self.assertTrue(response.last_good_state_ts > after)
self.assertEqual("123", upload_job.bytes)
self.assertEqual(response.state, PutContentResponse.states.uploading)
def test__cancel_uploadjob_cancelled(self):
"""Test cancel cancelling the upload_job."""
self.response.state = PutContentResponse.states.canceling
self.response.cancel_message = self.make_protocol_message(msg_id=123)
mocker = Mocker()
upload_job = mocker.mock()
self.response.upload_job = upload_job
expect(upload_job.cancel())
with mocker:
self.response._cancel()
self.handler.assert_debug("Canceling the upload job")
def test__cancel_uploadjob_cancel_None(self):
"""Test cancel not having an upload_job."""
self.response.state = PutContentResponse.states.canceling
self.response.cancel_message = self.make_protocol_message(msg_id=123)
assert self.response.upload_job is None
self.response._cancel()
self.handler.assert_not_logged("Canceling the upload job")
def test__cancel_uploadjob_stopped(self):
"""Test cancel cancelling the upload_job."""
assert self.response.state != PutContentResponse.states.canceling
mocker = Mocker()
upload_job = mocker.mock()
self.response.upload_job = upload_job
expect(upload_job.stop())
with mocker:
self.response._cancel()
self.handler.assert_debug("Stoping the upload job after a cancel")
def test__cancel_uploadjob_stop_None(self):
"""Test cancel not having an upload_job."""
assert self.response.state != PutContentResponse.states.canceling
assert self.response.upload_job is None
self.response._cancel()
self.handler.assert_not_logged("Stoping the upload job after a cancel")
def test__cancel_answer_client_yes(self):
"""Test answer is sent to the client because canceling."""
self.response.state = PutContentResponse.states.canceling
# set up the original message
self.response.cancel_message = self.make_protocol_message(msg_id=123)
# be sure to close the request
called = []
self.response.done = lambda: called.append(True)
# call and check
self.response._cancel()
self.assertTrue(called)
self.assertEqual(self.response.state, PutContentResponse.states.done)
self.assertEqual(self.last_msg.type, protocol_pb2.Message.CANCELLED)
self.assertEqual(self.last_msg.id, 123)
def test__cancel_answer_client_no(self):
"""Test answer is not sent to the client if not canceling."""
assert self.response.state != PutContentResponse.states.canceling
# be sure to close the request
called = []
self.response.done = lambda: called.append(True)
# call and check
self.response._cancel()
self.assertTrue(called)
self.assertEqual(self.response.state, PutContentResponse.states.done)
def test__cancel_always_move_to_canceling(self):
"""Test that we always move to canceling state."""
assert self.response.state == PutContentResponse.states.init
mocker = Mocker()
upload_job = mocker.mock()
self.response.upload_job = upload_job
# be sure to close the request
called = []
self.response.done = lambda: called.append(True)
def save_state():
"""Save current state."""
called.append(self.response.state)
expect(upload_job.stop()).call(save_state).count(1)
# call and check
with mocker:
self.response._cancel()
self.handler.assert_debug("Request canceled (in INIT)")
self.assertEqual(len(called), 2)
self.assertEqual(called[0], PutContentResponse.states.canceling)
self.assertEqual(called[1], True)
self.assertEqual(self.response.state, PutContentResponse.states.done)
def test_genericerror_log_error(self):
"""Generic error logs when called with an error."""
assert self.response.state == PutContentResponse.states.init
self.response._generic_error(NameError('foo'))
self.handler.assert_warning("Error while in INIT", "NameError", "foo")
def test_genericerror_log_failure(self):
"""Generic error logs when called with a failure."""
assert self.response.state == PutContentResponse.states.init
self.response._generic_error(Failure(NameError('foo')))
self.handler.assert_warning("Error while in INIT", "NameError", "foo")
def test_genericerror_already_in_error(self):
"""Just log if already in error."""
self.response.state = PutContentResponse.states.error
called = []
self.response._send_protocol_error = called.append
self.response._generic_error(NameError('foo'))
self.assertFalse(called)
self.handler.assert_warning("Error while in ERROR", "NameError", "foo")
def test_genericerror_already_in_done(self):
"""Just log if already in done."""
self.response.state = PutContentResponse.states.done
called = []
self.response._send_protocol_error = called.append
self.response._generic_error(NameError('foo'))
self.assertFalse(called)
self.handler.assert_warning("Error while in DONE", "NameError", "foo")
def test_genericerror_no_uploadjob(self):
"""Don't stop the upload job if doesn't have one."""
assert self.response.upload_job is None
self.response._generic_error(NameError('foo'))
self.handler.assert_not_logged("Stoping the upload job after an error")
def test_genericerror_stop_uploadjob(self):
"""Stop the upload job if has one."""
mocker = Mocker()
upload_job = mocker.mock()
self.response.upload_job = upload_job
expect(upload_job.stop())
expect(upload_job.inflated_size_hint)
with mocker:
self.response._generic_error(NameError('foo'))
self.handler.assert_debug("Stoping the upload job after an error")
def test_try_again_handling(self):
"""Test how a TRY_AGAIN error is handled."""
# several patches
self.response.upload_job = self.FakeUploadJob()
size_hint = self.response.upload_job.inflated_size_hint
mocker = Mocker()
metrics = mocker.mock()
self.response.protocol.factory.metrics = metrics
# expect(metrics.gauge("upload_error.TRY_AGAIN.NameError", size_hint))
# call and test
with mocker:
self.response._log_exception(errors.TryAgain(NameError('foo')))
self.handler.assert_debug("TryAgain", "NameError", str(size_hint))
def test_genericerror_requestcancelled_canceling(self):
"""Test how a RequestCancelledError error is handled when canceling."""
self.response.state = PutContentResponse.states.canceling
called = []
self.response._send_protocol_error = called.append
self.response.done = called.append
self.response._generic_error(request.RequestCancelledError('message'))
self.assertFalse(called)
self.handler.assert_debug("Request cancelled: message")
def test_genericerror_requestcancelled_other(self):
"""Test how a RequestCancelledError error is handled in other state."""
assert self.response.state != PutContentResponse.states.canceling
self.response.upload_job = self.FakeUploadJob()
response = self.mocker.patch(self.response)
failure = Failure(request.RequestCancelledError("foo"))
# expect(response.protocol.factory.metrics.gauge(
# "upload_error.RequestCancelledError", 1000))
expect(response._send_protocol_error(failure))
expect(response.done())
self.mocker.replay()
response._generic_error(failure)
self.assertEqual(response.state, PutContentResponse.states.error)
self.handler.assert_debug("RequestCancelledError", str(1000))
def test_genericerror_other_errors_ok(self):
"""Generic error handling."""
self.response.upload_job = self.FakeUploadJob()
response = self.mocker.patch(self.response)
failure = Failure(NameError("foo"))
# expect(response.protocol.factory.metrics.gauge(
# "upload_error.NameError", 1000))
expect(response._send_protocol_error(failure))
expect(response.done())
self.mocker.replay()
response._generic_error(failure)
self.assertEqual(response.state, PutContentResponse.states.error)
self.handler.assert_debug("NameError", str(1000))
def test_genericerror_other_errors_problem_sendprotocolerror(self):
"""Handle problems in the _send_protocol_error() call."""
response = self.mocker.patch(self.response)
expect(response._send_protocol_error(ARGS)).throw(Exception("broken"))
internal = []
self.response.internal_error = internal.append
self.mocker.replay()
response._generic_error(ValueError('error'))
self.assertEqual(response.state, PutContentResponse.states.error)
error = internal[0].value
self.assertTrue(isinstance(error, Exception))
self.assertEqual(str(error), "broken")
def test_genericerror_other_errors_problem_done(self):
"""Handle problems in the done() call."""
response = self.mocker.patch(self.response)
expect(response._send_protocol_error(ARGS)).result(defer.succeed(True))
expect(response.done()).throw(Exception("broken"))
internal = []
self.response.internal_error = internal.append
self.mocker.replay()
response._generic_error(ValueError('error'))
self.assertEqual(response.state, PutContentResponse.states.error)
error = internal[0].value
self.assertTrue(isinstance(error, Exception))
self.assertEqual(str(error), "broken")
@defer.inlineCallbacks
def test__get_upload_job(self):
"""Test get_upload_job."""
share_id = uuid.uuid4()
upload_id = str(uuid.uuid4())
message = self.make_protocol_message(msg_type='PUT_CONTENT')
message.put_content.share = str(share_id)
message.put_content.node = 'abc'
message.put_content.previous_hash = 'p_hash'
message.put_content.hash = 'hash'
message.put_content.crc32 = 1
message.put_content.size = 2
message.put_content.deflated_size = 3
message.put_content.magic_hash = 'magic'
message.put_content.upload_id = upload_id
response = PutContentResponse(self.server, message)
response.protocol.working_caps = []
response.protocol.session_id = 'abc'
response.protocol.user = self.mocker.mock()
response.protocol.user.get_upload_job(
share_id, 'abc', 'p_hash', 'hash', 1, 2, 3,
session_id='abc', magic_hash='magic', upload_id=upload_id)
self.mocker.result('TheUploadJob')
self.mocker.replay()
uploadjob = yield response._get_upload_job()
self.assertEqual(uploadjob, 'TheUploadJob')
def test_processmessage_uploading_ok(self):
"""Process a message while uploading, all ok."""
self.response.state = PutContentResponse.states.uploading
response = self.mocker.patch(self.response)
# all message types
all_msgs = []
for mtype in "CANCEL_REQUEST EOF BYTES".split():
message = self.make_protocol_message(msg_type=mtype)
expect(response._process_while_uploading(message))
all_msgs.append(message)
self.mocker.replay()
for msg in all_msgs:
response._processMessage(msg)
def test_processmessage_uploading_error(self):
"""Process a message while uploading, explodes."""
self.response.state = PutContentResponse.states.uploading
response = self.mocker.patch(self.response)
message = self.make_protocol_message(msg_type='BYTES')
failure = Exception('foo')
expect(response._process_while_uploading(message)).throw(failure)
expect(response._generic_error(failure))
self.mocker.replay()
response._processMessage(message)
def test_processmessage_uploading_bad_message(self):
"""Process a bad message while uploading."""
self.response.state = PutContentResponse.states.uploading
message = self.make_protocol_message(msg_type='PUT_CONTENT')
self.response._processMessage(message)
self.handler.assert_error(
"unknown message", str(protocol_pb2.Message.PUT_CONTENT))
def test_processmessage_init_cancel_ok(self):
"""Process a cancel request while in init, all ok."""
self.response.state = PutContentResponse.states.init
message = self.make_protocol_message(msg_type='CANCEL_REQUEST')
response = self.mocker.patch(self.response)
expect(response.cancel())
self.mocker.replay()
response._processMessage(message)
self.assertEqual(response.state, PutContentResponse.states.canceling)
self.assertEqual(response.cancel_message, message)
def test_processmessage_init_cancel_error(self):
"""Process a cancel request while in init, explodes."""
self.response.state = PutContentResponse.states.init
message = self.make_protocol_message(msg_type='CANCEL_REQUEST')
response = self.mocker.patch(self.response)
failure = Exception('foo')
expect(response.cancel()).throw(failure)
expect(response._generic_error(failure))
self.mocker.replay()
response._processMessage(message)
def test_processmessage_init_not_cancel(self):
"""Process other requests while in init."""
self.response.state = PutContentResponse.states.init
cancel_called = []
self.response.cancel = lambda: cancel_called.append(True)
# all message types except cancel
all_msgs = []
for mtype in "EOF BYTES".split():
message = self.make_protocol_message(msg_type=mtype)
self.response._processMessage(message)
all_msgs.append(message.type)
for mtype in all_msgs:
self.handler.assert_warning(
"Received out-of-order", "INIT", str(mtype))
self.assertFalse(cancel_called)
def test_processmessage_error(self):
"""Process all requests while in error."""
self.response.state = PutContentResponse.states.error
# all message types
for mtype in "CANCEL_REQUEST EOF BYTES".split():
message = self.make_protocol_message(msg_type=mtype)
self.response._processMessage(message)
self.handler.assert_not_logged("Received out-of-order")
def test_processmessage_otherstates(self):
"""Process all requests while in other states."""
for state in "commiting canceling done".split():
for mtype in "CANCEL_REQUEST EOF BYTES".split():
self.response.state = getattr(PutContentResponse.states, state)
message = self.make_protocol_message(msg_type=mtype)
self.response._processMessage(message)
chk = "Received out-of-order", state.upper(), str(message.type)
self.handler.assert_warning(*chk)
def test_processwhileuploading_cancel(self):
"""Got a cancel request while uploading."""
self.response.state = PutContentResponse.states.uploading
message = self.make_protocol_message(msg_type='CANCEL_REQUEST')
cancel_called = []
self.response.cancel = lambda: cancel_called.append(True)
self.response._process_while_uploading(message)
self.assertEqual(self.response.cancel_message, message)
self.assertEqual(self.response.state,
PutContentResponse.states.canceling)
self.assertTrue(cancel_called)
def test_processwhileuploading_eof_ok(self):
"""Got an eof while uploading, all finished ok."""
self.response.state = PutContentResponse.states.uploading
message = self.make_protocol_message(msg_type='EOF')
self.response.upload_job = self.FakeUploadJob()
# check what is called
called = []
self.response._commit_uploadjob = lambda r: called.append(('commt', r))
self.response._generic_error = lambda _: called.append('error')
# call, it should change the state and set up the callbacks
self.response._process_while_uploading(message)
self.assertEqual(self.response.state,
PutContentResponse.states.commiting)
self.assertEqual(called, [('commt', None)])
def test_processwhileuploading_eof_error_commiting(self):
"""Got an eof while uploading, got an error while commiting."""
self.response.state = PutContentResponse.states.uploading
message = self.make_protocol_message(msg_type='EOF')
self.response.upload_job = self.FakeUploadJob()
# check what is called
called = []
failure = Failure(Exception())
self.response._commit_uploadjob = \
lambda r: called.append(('commit', r)) or failure
self.response._generic_error = lambda f: called.append(('error', f))
# call, it should change the state and set up the callbacks
self.response._process_while_uploading(message)
self.assertEqual(self.response.state,
PutContentResponse.states.commiting)
self.assertEqual(called, [('commit', None), ('error', failure)])
def test_processwhileuploading_bytes(self):
"""Got some bytes while uploading."""
self.response.state = PutContentResponse.states.uploading
message = self.make_protocol_message(msg_type='BYTES')
message.bytes.bytes = "foobar"
self.response.upload_job = self.FakeUploadJob()
prv_transferred = self.response.transferred
self.response._process_while_uploading(message)
self.assertEqual(self.response.transferred, prv_transferred + 6)
self.assertEqual(self.response.state,
PutContentResponse.states.uploading)
self.assertEqual(self.response.upload_job.bytes, "foobar")
def test_processwhileuploading_strange(self):
"""Got other message while uploading."""
self.response.state = PutContentResponse.states.uploading
message = self.make_protocol_message(msg_type='PUT_CONTENT')
self.response._process_while_uploading(message)
self.handler.assert_error(
"Received unknown message", str(message.type))
def test_commituploadjob_not_commiting(self):
"""Assure we're still commiting when we reach this."""
self.response.state = PutContentResponse.states.error
called = []
self.response.queue_action = lambda *a, **kw: called.append(True)
self.response._commit_uploadjob('result')
self.assertFalse(called)
def test_commituploadjob_all_ok(self):
"""Normal commiting behaviour."""
self.response.state = PutContentResponse.states.commiting
response = self.mocker.patch(self.response)
expect(response.queue_action(ARGS)).result(defer.succeed(35))
expect(response.done())
self.mocker.replay()
response._commit_uploadjob('result')
self.assertEqual(response.state, PutContentResponse.states.done)
self.assertEqual(self.last_msg.type, protocol_pb2.Message.OK)
self.assertEqual(self.last_msg.new_generation, 35)
def test_commituploadjob_ok_but_canceled_by_framework(self):
"""Commit started but was canceled while waiting for queued commit."""
self.response.state = PutContentResponse.states.commiting
response = self.mocker.patch(self.response)
node = FakeNode()
def state_changed_to_cancel(response):
"""Change state to cancel before proceeding."""
self.response.state = PutContentResponse.states.canceling
return defer.succeed(node)
expect(response.queue_action(ARGS)).call(state_changed_to_cancel)
# Don't expect done() or any response to client
expect(response.done()).count(0)
expect(response.sendMessage(ANY)).count(0)
self.mocker.replay()
response._commit_uploadjob('result')
self.assertEqual(response.state, PutContentResponse.states.canceling)
def test_commit_canceled_in_queued_job(self):
"""Commit called but canceled before queued job executes."""
self.response.upload_job = self.mocker.mock()
# Actual commit will not be called
expect(self.response.upload_job.commit(ANY)).count(0)
self.response.state = PutContentResponse.states.commiting
response = self.mocker.patch(self.response)
# Patched queue_action changes state then runs the function
def cancel_then_run_callback(f):
"""Change state to cancel, then call the function."""
self.response.state = PutContentResponse.states.canceling
f()
expect(response.queue_action(ARGS)).call(cancel_then_run_callback)
# Don't expect done() or any response to client
expect(response.done()).count(0)
expect(response.sendMessage(ANY)).count(0)
self.mocker.replay()
response._commit_uploadjob('result')
self.assertEqual(response.state, PutContentResponse.states.canceling)
def test_startupload_normal(self):
"""Normal behaviour for the start upload."""
self.response.state = PutContentResponse.states.init
response = self.mocker.patch(self.response)
upload_job = self.FakeUploadJob()
expect(response._get_upload_job()).result(upload_job)
expect(response.upload_job.deferred.addErrback(
self.response._generic_error))
expect(response.upload_job.connect()).result(defer.succeed(True))
expect(response.protocol.release(self.response))
expect(response._send_begin())
self.mocker.replay()
response._start_upload()
self.assertEqual(response.state, PutContentResponse.states.uploading)
def _test_startupload_canceling_while_getting_uploadjob(self, state):
"""State changes while waiting for the upload job."""
self.response.state = PutContentResponse.states.init
d = defer.Deferred()
self.response._get_upload_job = lambda: d
self.response._start_upload()
# before releasing the deferred, change the state
self.response.state = state
upload_job = self.FakeUploadJob()
d.callback(upload_job)
self.assertEqual(upload_job.called, ['cancel']) # not connect
self.handler.assert_debug(
"Manually canceling the upload job (in %s)" % state)
def test_startupload_done(self):
"""State changes to done while getting the upload job."""
state = PutContentResponse.states.done
self._test_startupload_canceling_while_getting_uploadjob(state)
def test_startupload_canceling(self):
"""State changes to canceling while getting the upload job."""
state = PutContentResponse.states.canceling
self._test_startupload_canceling_while_getting_uploadjob(state)
def test__send_begin(self):
"""Test sendbegin."""
self.response.upload_job = self.FakeUploadJob()
self.response.upload_job.offset = 10
self.response.upload_job.upload_id = 12
self.response._send_begin()
self.assertEqual(self.last_msg.type,
protocol_pb2.Message.BEGIN_CONTENT)
self.assertEqual(self.last_msg.begin_content.offset, 10)
self.assertEqual(self.last_msg.begin_content.upload_id, '12')
upload_type = self.response.upload_job.__class__.__name__
self.handler.assert_debug(
upload_type, "begin content", "from offset 10", "fake storagekey")
def test__send_begin_new_upload_id(self):
"""Test sendbegin when the upload_id received is invalid."""
self.response.upload_job = self.FakeUploadJob()
self.response.upload_job.offset = 0
self.response.upload_job.upload_id = 12
# the client sent an upload_id, but it's different from the one we got
# from content.py
self.response.source_message.put_content.upload_id = '11'
self.response._send_begin()
self.assertEqual(self.last_msg.type,
protocol_pb2.Message.BEGIN_CONTENT)
self.assertEqual(self.last_msg.begin_content.offset, 0)
self.assertEqual(self.last_msg.begin_content.upload_id, '12')
upload_type = self.response.upload_job.__class__.__name__
self.handler.assert_debug(
upload_type, "begin content", "from offset 0", "fake storagekey")
def test_putcontent_double_done(self):
"""Double call to self.done()."""
self.response.state = PutContentResponse.states.init
d = defer.Deferred()
self.response._get_upload_job = lambda: d
self.response._start_upload()
# before releasing the deferred, change the state
upload_job = self.FakeUploadJob()
upload_job.offset = 1
upload_job.upload_id = 1
d.callback(upload_job)
self.response.done()
called = []
self.response.error = called.append
self.response.done()
self.assertEqual(called, [])
msg = ("runWithWarningsSuppressed -> test_method_wrapper -> "
"test_putcontent_double_done: called done() finished=True")
self.handler.assert_warning(msg)
def test_putcontent_done_after_error(self):
"""Double call to self.done()."""
self.response.state = PutContentResponse.states.init
d = defer.Deferred()
self.response._get_upload_job = lambda: d
self.response._start_upload()
# before releasing the deferred, change the state
upload_job = self.FakeUploadJob()
upload_job.offset = 1
upload_job.upload_id = 1
d.callback(upload_job)
self.response.error(Failure(ValueError("foo")))
called = []
self.response.error = called.append
self.response.done()
self.assertEqual(called, [])
msg = ("runWithWarningsSuppressed -> test_method_wrapper -> "
"test_putcontent_done_after_error: called done() finished=True")
self.handler.assert_warning(msg)
class QuerySetCapsResponseTestCase(SimpleRequestResponseTestCase):
"""Test the QuerySetCapsResponse class."""
response_class = QuerySetCapsResponse
class MoveResponseTestCase(SimpleRequestResponseTestCase):
"""Test the MoveResponse class."""
response_class = MoveResponse
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'sync_activity')
class MakeResponseTestCase(SimpleRequestResponseTestCase):
"""Test the MakeResponse class."""
response_class = MakeResponse
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'sync_activity')
class FreeSpaceResponseTestCase(SimpleRequestResponseTestCase):
"""Test the FreeSpaceResponse class."""
response_class = FreeSpaceResponse
class AccountResponseTestCase(SimpleRequestResponseTestCase):
"""Test the AccountResponse class."""
response_class = AccountResponse
class AuthenticateResponseTestCase(SimpleRequestResponseTestCase):
"""Test the AuthenticateResponse class."""
response_class = AuthenticateResponse
def test_user_activity_indicator(self):
"""Check the user_activity value."""
self.assertEqual(self.response_class.user_activity, 'connected')
def test_set_user(self):
"""Check that the user is set after auth."""
user = FakeUser()
mocker = Mocker()
# set up a fake auth
auth_provider = mocker.mock()
expect(auth_provider.authenticate).result(lambda *a, **kw: user)
self.response.protocol.factory.auth_provider = auth_provider
called = []
self.response.protocol.set_user = lambda *a, **kw: called.append(a)
with mocker:
self.response._process()
self.assertEqual(called, [(user,)])
def _test_client_metadata(self, expected, expected_metrics):
"""Test client metadata handling in AuthenticateResponse."""
user = FakeUser()
mocker = Mocker()
# set up a fake auth
auth_provider = mocker.mock()
expect(auth_provider.authenticate).result(lambda *a, **kw: user)
self.response.protocol.factory.auth_provider = auth_provider
metrics_called = []
self.patch(self.response.protocol.factory.metrics, 'meter',
lambda *a: metrics_called.append(a))
with mocker:
self.response._process()
self.assertEqual(metrics_called, expected_metrics)
def test_client_metadata_valid(self):
"""Test client metadata handling in AuthenticateResponse."""
md = self.response.source_message.metadata.add()
md.key = "platform"
md.value = "linux"
md = self.response.source_message.metadata.add()
md.key = "version"
md.value = "42"
expected = [("client.platform.linux",), ("client.version.42",)]
expected_metrics = [
("client.platform.linux", 1),
("client.version.42", 1)
]
self._test_client_metadata(expected, expected_metrics)
def test_client_metadata_invalid_value(self):
"""Test client metadata handling in AuthenticateResponse."""
md = self.response.source_message.metadata.add()
md.key = "platform"
md.value = "Windows XP-SP3 6.1.2008"
md = self.response.source_message.metadata.add()
md.key = "version"
md.value = "1.42"
expected = [("client.platform.Windows_XP_SP3_6_1_2008",),
("client.version.1_42",)]
expected_metrics = [
("client.platform.Windows_XP_SP3_6_1_2008", 1),
("client.version.1_42", 1)
]
self._test_client_metadata(expected, expected_metrics)
class GetDeltaResponseTestCase(SimpleRequestResponseTestCase):
"""Test the GetDeltaResponse class."""
response_class = GetDeltaResponse
def test_cooperative_send_delta_info(self):
"""Test that send_delta_info isn't blocking."""
d = self.response.send_delta_info([], '')
self.assertTrue(isinstance(d, defer.Deferred))
# check if _send_delta_info returns a generator
gen = self.response._send_delta_info([], '')
self.assertTrue(hasattr(gen, 'next'))
# check if send_delta_info use the cooperator
called = []
real_cooperate = task.cooperate
def cooperate(iterator):
"""Intercept the call to task.cooperate."""
called.append(iterator)
return real_cooperate(iterator)
self.patch(task, 'cooperate', cooperate)
self.response.send_delta_info([], '')
self.assertEqual(len(called), 1)
self.assertTrue(hasattr(called[0], 'next'))
def test_reset_send_delta_info_counter(self):
"""Test that the count is reset on each iteration."""
self.patch(settings.api_server, 'MAX_DELTA_INFO', 5)
# create a few fake nodes
nodes = []
right_now = now()
for i in range(10):
node = FakeNode()
node.id = str(uuid.uuid4())
node.parent_id = str(uuid.uuid4())
node.generation = 100
node.name = u"node_%s" % i
node.is_live = True
node.is_file = True
node.is_public = True
node.content_hash = 'sha1:foo'
node.crc32 = 10
node.size = 1024
node.last_modified = int(time.mktime(right_now.timetuple()))
nodes.append(node)
gen = self.response._send_delta_info(nodes, 'share_id')
gen.next()
self.assertEqual(gen.gi_frame.f_locals['count'], 0)
@defer.inlineCallbacks
def test_process_set_length(self):
"""Set length attribute while processing."""
mocker = Mocker()
# fake message
message = mocker.mock()
expect(message.get_delta.share).count(2).result('')
expect(message.get_delta.from_generation).result(10)
self.response.source_message = message
# fake user
user = mocker.mock()
nodes = [FakeNode(), FakeNode()]
expect(user.get_delta(None, 10, KWARGS)).result((nodes, 12, 123))
self.response.protocol.user = user
with mocker:
yield self.response._process()
self.assertEqual(self.response.length, 2)
class RescanFromScratchResponseTestCase(SimpleRequestResponseTestCase):
"""Test the RescanFromScratchResponse class."""
# subclass so we have a __dict__ and can patch it.
response_class = types.ClassType(RescanFromScratchResponse.__name__,
(RescanFromScratchResponse,), {})
def test_cooperative_send_delta_info(self):
"""Test that send_delta_info isn't blocking."""
d = self.response.send_delta_info([], '')
self.assertTrue(isinstance(d, defer.Deferred))
# check if _send_delta_info returns a generator
gen = self.response._send_delta_info([], '')
self.assertTrue(hasattr(gen, 'next'))
# check if send_delta_info use the cooperator
called = []
real_cooperate = task.cooperate
def cooperate(iterator):
"""Intercept the call to task.cooperate."""
called.append(iterator)
return real_cooperate(iterator)
self.patch(task, 'cooperate', cooperate)
self.response.send_delta_info([], '')
self.assertEqual(len(called), 1)
self.assertTrue(hasattr(called[0], 'next'))
@defer.inlineCallbacks
def test_chunked_get_from_scratch(self):
"""Get the nodes list in chunks."""
self.patch(settings.api_server, 'GET_FROM_SCRATCH_LIMIT', 5)
# build fake nodes
nodes = []
right_now = now()
for i in range(20):
node = FakeNode()
node.id = str(uuid.uuid4())
node.parent_id = str(uuid.uuid4())
node.path = u"/"
node.generation = i
node.name = u"node_%s" % i
node.is_live = True
node.is_file = True
node.is_public = True
node.content_hash = 'sha1:foo'
node.crc32 = 10
node.size = 1024
node.last_modified = int(time.mktime(right_now.timetuple()))
nodes.append(node)
# set required caps
self.response.protocol.working_caps = PREFERRED_CAP
mocker = Mocker()
user = mocker.mock()
self.patch(self.response, "send_delta_info", lambda *a: None)
self.response.protocol.user = user
# expect 3 calls to get_from_scratch
expect(user.get_from_scratch(
None, limit=5)
).count(1).result((nodes[:10], 20, 100))
expect(user.get_from_scratch(
None, limit=5, max_generation=20,
start_from_path=("/", "node_9"))
).count(1).result((nodes[10:], 20, 100))
expect(user.get_from_scratch(
None, limit=5, max_generation=20,
start_from_path=("/", "node_19"))
).count(1).result(([], 20, 100))
mocker.replay()
yield self.response._process()
@defer.inlineCallbacks
def test_process_set_length(self):
"""Set length attribute while processing."""
mocker = Mocker()
# fake message
message = mocker.mock()
expect(message.get_delta.share).count(2).result('')
self.response.source_message = message
# fake user
user = mocker.mock()
nodes = [[FakeNode(), FakeNode()], []]
action = expect(user.get_from_scratch(None, KWARGS))
action.count(2).call(lambda *a, **k: (nodes.pop(0), 12, 123))
self.response.protocol.user = user
with mocker:
yield self.response._process()
self.assertEqual(self.response.length, 2)
class NodeInfoLogsTestCase(BaseStorageServerTestCase):
"""Check that operations return correct node info."""
def check(self, response, mes_type, klass=None, mes_name=None, **attrs):
"""Check that get_node_info returns correctly for the message."""
# build the message
message = self.make_protocol_message(msg_type=mes_type)
# optionally, has content!
if mes_name is not None:
inner = getattr(message, mes_name)
for name, value in attrs.iteritems():
setattr(inner, name, value)
# put it in the request, get node info, and check
if klass is None:
klass = StorageServerRequestResponse
req = klass(self.server, message)
req.source_message = message
self.assertEqual(req._get_node_info(), response)
def test_simple_ones(self):
"""Test all messages without node info."""
names = (
'PROTOCOL_VERSION', 'PING', 'AUTH_REQUEST', 'CREATE_UDF',
'CREATE_SHARE', 'QUERY_CAPS', 'SET_CAPS', 'FREE_SPACE_INQUIRY',
'ACCOUNT_INQUIRY', 'LIST_VOLUMES', 'LIST_SHARES',
)
for name in names:
self.check(None, name)
def test_with_nodes(self):
"""Test messages that have node info."""
data = [
('GET_CONTENT', GetContentResponse),
('PUT_CONTENT', PutContentResponse),
('UNLINK', Unlink),
('MOVE', MoveResponse),
]
for name, klass in data:
self.check("node: 'foo'", name, klass, name.lower(), node='foo')
def test_with_parent(self):
"""Test messages where the node is the parent."""
data = [
('MAKE_FILE', MakeResponse),
('MAKE_DIR', MakeResponse),
]
for name, klass in data:
self.check("parent: 'foo'", name, klass, 'make', parent_node='foo')
def test_with_shares(self):
"""Test messages that work on shares."""
data = [
('SHARE_ACCEPTED', ShareAccepted),
('DELETE_SHARE', DeleteShare),
]
for name, klass in data:
impl = os.environ.get('PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION')
if impl == 'cpp':
# the cpp implementation always return unicode.
self.check("share: u'foo'", name, klass,
name.lower(), share_id='foo')
else:
self.check("share: 'foo'", name, klass,
name.lower(), share_id='foo')
def test_with_volumes(self):
"""Test messages that work on volumes."""
self.check("volume: 'foo'", 'DELETE_VOLUME', DeleteVolume,
'delete_volume', volume='foo')
self.check("volume: 'foo'", 'GET_DELTA', GetDeltaResponse,
'get_delta', share='foo')
class TestLoopingPing(BaseStorageServerTestCase):
"""LoopingPing tests."""
@defer.inlineCallbacks
def setUp(self):
yield super(TestLoopingPing, self).setUp()
self.patch(self.server, 'ping', lambda: defer.succeed(None))
def test_idle_timeout_enabled(self):
"""Test that idle_timeout is enabled and works."""
self.server.ping_loop.idle_timeout = 0.1
self.server.ping_loop.pong_count = 2
self.server.ping_loop.schedule()
self.assertTrue(self.shutdown)
def test_idle_timeout_disabled(self):
"""Test that disbaled idle_timeout."""
self.server.ping_loop.idle_timeout = 0
self.server.ping_loop.schedule()
self.assertFalse(self.shutdown)
class StorageServerFactoryTestCase(BaseTestCase, TwistedTestCase):
"""Test the StorageServerFactory class."""
@defer.inlineCallbacks
def setUp(self):
"""Set up."""
yield super(StorageServerFactoryTestCase, self).setUp()
self.factory = StorageServerFactory()
self.handler = self.add_memento_handler(logger, level=logging.DEBUG)
def test_observer_added(self):
"""Test that the observer was added to Twisted logging."""
self.assertIn(self.factory._deferror_handler,
log.theLogPublisher.observers)
def test_noerror(self):
"""No error, no action."""
self.factory._deferror_handler(dict(isError=False, message=''))
self.handler.assert_not_logged("error")
def test_message(self):
"""Just a message."""
self.factory._deferror_handler(dict(isError=True, message="foobar"))
self.handler.assert_error("Unhandled error in deferred", "foobar")
def test_failure(self):
"""Received a full failure."""
f = Failure(ValueError('foobar'))
self.factory._deferror_handler(dict(isError=True,
failure=f, message=''))
self.handler.assert_error(
"Unhandled error in deferred", "ValueError", "foobar")
def test_trace_users(self):
"""Check trace users are correctly set."""
# set a specific config to test
self.patch(settings.api_server, 'TRACE_USERS', ['foo', 'bar', 'baz'])
factory = StorageServerFactory()
self.assertEqual(factory.trace_users, set(['foo', 'bar', 'baz']))
class BytesMessageProducerTestCase(BaseStorageServerTestCase):
"""Test the BytesMessageProducer class."""
@defer.inlineCallbacks
def setUp(self):
"""Set up."""
yield super(BytesMessageProducerTestCase, self).setUp()
req = GetContentResponse(protocol=self.server,
message=self.make_protocol_message())
self.patch(GetContentResponse, 'sendMessage', lambda *a: None)
self.producer = FakeProducer()
self.bmp = BytesMessageProducer(self.producer, req)
def test_resume_log(self):
"""Log when resumed."""
self.bmp.resumeProducing()
self.handler.assert_trace(
"BytesMessageProducer resumed", str(self.producer))
def test_stop_log(self):
"""Log when stopped."""
self.bmp.stopProducing()
self.handler.assert_trace(
"BytesMessageProducer stopped", str(self.producer))
def test_pause_log(self):
"""Log when paused."""
self.bmp.pauseProducing()
self.handler.assert_trace(
"BytesMessageProducer paused", str(self.producer))
def test_transferred_counting(self):
"""Keep count of transferred data."""
assert self.bmp.request.transferred == 0
self.bmp.write("foobar")
self.assertEqual(self.bmp.request.transferred, 6)
class TestMetricsSetup(testcase.TestWithDatabase):
"""Tests that metrics are setup from configs properly"""
def test_metrics_from_config(self):
"""Test that metrics names get set from the config properly"""
self.assertEqual("development.filesync.server.001.root",
metrics.get_meter("root")._namespace)
self.assertEqual("development.filesync.server.001.user",
metrics.get_meter("user")._namespace)
class VersionInfoTestCase(TwistedTestCase):
"""Test a the autogenerated version_info dict"""
def testInfo(self):
"""Validate the available data."""
self.assert_(version_info['revno'], "Revison Number")
self.assert_(version_info['branch_nick'], "Branch Nickname")
self.assert_(version_info['date'], "Date of last update")
self.assert_(version_info['build_date'], "Date of last Build")
self.assert_(version_info['revision_id'], "ID of revision")
if version_info is None:
testInfo.skip = 'No version info in this system, bzr probably missing.'
|