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
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
|
# Copyright (C) 2005-2011 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Testing framework extensions"""
# NOTE: Some classes in here use camelCaseNaming() rather than
# underscore_naming(). That's for consistency with unittest; it's not the
# general style of bzrlib. Please continue that consistency when adding e.g.
# new assertFoo() methods.
import atexit
import codecs
import copy
from cStringIO import StringIO
import difflib
import doctest
import errno
import itertools
import logging
import os
import platform
import pprint
import random
import re
import shlex
import stat
import subprocess
import sys
import tempfile
import threading
import time
import traceback
import unittest
import warnings
import testtools
# nb: check this before importing anything else from within it
_testtools_version = getattr(testtools, '__version__', ())
if _testtools_version < (0, 9, 5):
raise ImportError("need at least testtools 0.9.5: %s is %r"
% (testtools.__file__, _testtools_version))
from testtools import content
import bzrlib
from bzrlib import (
branchbuilder,
bzrdir,
chk_map,
commands as _mod_commands,
config,
debug,
errors,
hooks,
lock as _mod_lock,
lockdir,
memorytree,
osutils,
plugin as _mod_plugin,
pyutils,
ui,
urlutils,
registry,
symbol_versioning,
trace,
transport as _mod_transport,
workingtree,
)
try:
import bzrlib.lsprof
except ImportError:
# lsprof not available
pass
from bzrlib.smart import client, request
from bzrlib.transport import (
memory,
pathfilter,
)
from bzrlib.symbol_versioning import (
deprecated_function,
deprecated_in,
)
from bzrlib.tests import (
test_server,
TestUtil,
treeshape,
)
from bzrlib.ui import NullProgressView
from bzrlib.ui.text import TextUIFactory
# Mark this python module as being part of the implementation
# of unittest: this gives us better tracebacks where the last
# shown frame is the test code, not our assertXYZ.
__unittest = 1
default_transport = test_server.LocalURLServer
_unitialized_attr = object()
"""A sentinel needed to act as a default value in a method signature."""
# Subunit result codes, defined here to prevent a hard dependency on subunit.
SUBUNIT_SEEK_SET = 0
SUBUNIT_SEEK_CUR = 1
# These are intentionally brought into this namespace. That way plugins, etc
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
TestSuite = TestUtil.TestSuite
TestLoader = TestUtil.TestLoader
# Tests should run in a clean and clearly defined environment. The goal is to
# keep them isolated from the running environment as mush as possible. The test
# framework ensures the variables defined below are set (or deleted if the
# value is None) before a test is run and reset to their original value after
# the test is run. Generally if some code depends on an environment variable,
# the tests should start without this variable in the environment. There are a
# few exceptions but you shouldn't violate this rule lightly.
isolated_environ = {
'BZR_HOME': None,
'HOME': None,
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
# tests do check our impls match APPDATA
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
'VISUAL': None,
'EDITOR': None,
'BZR_EMAIL': None,
'BZREMAIL': None, # may still be present in the environment
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
'BZR_PROGRESS_BAR': None,
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
# as a base class instead of TestCaseInTempDir. Tests inheriting from
# TestCase should not use disk resources, BZR_LOG is one.
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
'BZR_PLUGIN_PATH': None,
'BZR_DISABLE_PLUGINS': None,
'BZR_PLUGINS_AT': None,
'BZR_CONCURRENCY': None,
# Make sure that any text ui tests are consistent regardless of
# the environment the test case is run in; you may want tests that
# test other combinations. 'dumb' is a reasonable guess for tests
# going to a pipe or a StringIO.
'TERM': 'dumb',
'LINES': '25',
'COLUMNS': '80',
'BZR_COLUMNS': '80',
# Disable SSH Agent
'SSH_AUTH_SOCK': None,
# Proxies
'http_proxy': None,
'HTTP_PROXY': None,
'https_proxy': None,
'HTTPS_PROXY': None,
'no_proxy': None,
'NO_PROXY': None,
'all_proxy': None,
'ALL_PROXY': None,
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
# least. If you do (care), please update this comment
# -- vila 20080401
'ftp_proxy': None,
'FTP_PROXY': None,
'BZR_REMOTE_PATH': None,
# Generally speaking, we don't want apport reporting on crashes in
# the test envirnoment unless we're specifically testing apport,
# so that it doesn't leak into the real system environment. We
# use an env var so it propagates to subprocesses.
'APPORT_DISABLE': '1',
}
def override_os_environ(test, env=None):
"""Modify os.environ keeping a copy.
:param test: A test instance
:param env: A dict containing variable definitions to be installed
"""
if env is None:
env = isolated_environ
test._original_os_environ = dict([(var, value)
for var, value in os.environ.iteritems()])
for var, value in env.iteritems():
osutils.set_or_unset_env(var, value)
if var not in test._original_os_environ:
# The var is new, add it with a value of None, so
# restore_os_environ will delete it
test._original_os_environ[var] = None
def restore_os_environ(test):
"""Restore os.environ to its original state.
:param test: A test instance previously passed to override_os_environ.
"""
for var, value in test._original_os_environ.iteritems():
# Restore the original value (or delete it if the value has been set to
# None in override_os_environ).
osutils.set_or_unset_env(var, value)
class ExtendedTestResult(testtools.TextTestResult):
"""Accepts, reports and accumulates the results of running tests.
Compared to the unittest version this class adds support for
profiling, benchmarking, stopping as soon as a test fails, and
skipping tests. There are further-specialized subclasses for
different types of display.
When a test finishes, in whatever way, it calls one of the addSuccess,
addFailure or addError classes. These in turn may redirect to a more
specific case for the special test results supported by our extended
tests.
Note that just one of these objects is fed the results from many tests.
"""
stop_early = False
def __init__(self, stream, descriptions, verbosity,
bench_history=None,
strict=False,
):
"""Construct new TestResult.
:param bench_history: Optionally, a writable file object to accumulate
benchmark results.
"""
testtools.TextTestResult.__init__(self, stream)
if bench_history is not None:
from bzrlib.version import _get_bzr_source_tree
src_tree = _get_bzr_source_tree()
if src_tree:
try:
revision_id = src_tree.get_parent_ids()[0]
except IndexError:
# XXX: if this is a brand new tree, do the same as if there
# is no branch.
revision_id = ''
else:
# XXX: If there's no branch, what should we do?
revision_id = ''
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
self._bench_history = bench_history
self.ui = ui.ui_factory
self.num_tests = 0
self.error_count = 0
self.failure_count = 0
self.known_failure_count = 0
self.skip_count = 0
self.not_applicable_count = 0
self.unsupported = {}
self.count = 0
self._overall_start_time = time.time()
self._strict = strict
self._first_thread_leaker_id = None
self._tests_leaking_threads_count = 0
self._traceback_from_test = None
def stopTestRun(self):
run = self.testsRun
actionTaken = "Ran"
stopTime = time.time()
timeTaken = stopTime - self.startTime
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
# the parent class method is similar have to duplicate
self._show_list('ERROR', self.errors)
self._show_list('FAIL', self.failures)
self.stream.write(self.sep2)
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
run, run != 1 and "s" or "", timeTaken))
if not self.wasSuccessful():
self.stream.write("FAILED (")
failed, errored = map(len, (self.failures, self.errors))
if failed:
self.stream.write("failures=%d" % failed)
if errored:
if failed: self.stream.write(", ")
self.stream.write("errors=%d" % errored)
if self.known_failure_count:
if failed or errored: self.stream.write(", ")
self.stream.write("known_failure_count=%d" %
self.known_failure_count)
self.stream.write(")\n")
else:
if self.known_failure_count:
self.stream.write("OK (known_failures=%d)\n" %
self.known_failure_count)
else:
self.stream.write("OK\n")
if self.skip_count > 0:
skipped = self.skip_count
self.stream.write('%d test%s skipped\n' %
(skipped, skipped != 1 and "s" or ""))
if self.unsupported:
for feature, count in sorted(self.unsupported.items()):
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
(feature, count))
if self._strict:
ok = self.wasStrictlySuccessful()
else:
ok = self.wasSuccessful()
if self._first_thread_leaker_id:
self.stream.write(
'%s is leaking threads among %d leaking tests.\n' % (
self._first_thread_leaker_id,
self._tests_leaking_threads_count))
# We don't report the main thread as an active one.
self.stream.write(
'%d non-main threads were left active in the end.\n'
% (len(self._active_threads) - 1))
def getDescription(self, test):
return test.id()
def _extractBenchmarkTime(self, testCase, details=None):
"""Add a benchmark time for the current test case."""
if details and 'benchtime' in details:
return float(''.join(details['benchtime'].iter_bytes()))
return getattr(testCase, "_benchtime", None)
def _elapsedTestTimeString(self):
"""Return a time string for the overall time the current test has taken."""
return self._formatTime(self._delta_to_float(
self._now() - self._start_datetime))
def _testTimeString(self, testCase):
benchmark_time = self._extractBenchmarkTime(testCase)
if benchmark_time is not None:
return self._formatTime(benchmark_time) + "*"
else:
return self._elapsedTestTimeString()
def _formatTime(self, seconds):
"""Format seconds as milliseconds with leading spaces."""
# some benchmarks can take thousands of seconds to run, so we need 8
# places
return "%8dms" % (1000 * seconds)
def _shortened_test_description(self, test):
what = test.id()
what = re.sub(r'^bzrlib\.tests\.', '', what)
return what
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
# multiple times in a row, because the handler is added for
# each test but the container list is shared between cases.
# See lp:498869 lp:625574 and lp:637725 for background.
def _record_traceback_from_test(self, exc_info):
"""Store the traceback from passed exc_info tuple till"""
self._traceback_from_test = exc_info[2]
def startTest(self, test):
super(ExtendedTestResult, self).startTest(test)
if self.count == 0:
self.startTests()
self.count += 1
self.report_test_start(test)
test.number = self.count
self._recordTestStartTime()
# Make testtools cases give us the real traceback on failure
addOnException = getattr(test, "addOnException", None)
if addOnException is not None:
addOnException(self._record_traceback_from_test)
# Only check for thread leaks on bzrlib derived test cases
if isinstance(test, TestCase):
test.addCleanup(self._check_leaked_threads, test)
def stopTest(self, test):
super(ExtendedTestResult, self).stopTest(test)
# Manually break cycles, means touching various private things but hey
getDetails = getattr(test, "getDetails", None)
if getDetails is not None:
getDetails().clear()
# Clear _type_equality_funcs to try to stop TestCase instances
# from wasting memory. 'clear' is not available in all Python
# versions (bug 809048)
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
if type_equality_funcs is not None:
tef_clear = getattr(type_equality_funcs, "clear", None)
if tef_clear is None:
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
if tef_instance_dict is not None:
tef_clear = tef_instance_dict.clear
if tef_clear is not None:
tef_clear()
self._traceback_from_test = None
def startTests(self):
self.report_tests_starting()
self._active_threads = threading.enumerate()
def _check_leaked_threads(self, test):
"""See if any threads have leaked since last call
A sample of live threads is stored in the _active_threads attribute,
when this method runs it compares the current live threads and any not
in the previous sample are treated as having leaked.
"""
now_active_threads = set(threading.enumerate())
threads_leaked = now_active_threads.difference(self._active_threads)
if threads_leaked:
self._report_thread_leak(test, threads_leaked, now_active_threads)
self._tests_leaking_threads_count += 1
if self._first_thread_leaker_id is None:
self._first_thread_leaker_id = test.id()
self._active_threads = now_active_threads
def _recordTestStartTime(self):
"""Record that a test has started."""
self._start_datetime = self._now()
def addError(self, test, err):
"""Tell result that test finished with an error.
Called from the TestCase run() method when the test
fails with an unexpected error.
"""
self._post_mortem(self._traceback_from_test)
super(ExtendedTestResult, self).addError(test, err)
self.error_count += 1
self.report_error(test, err)
if self.stop_early:
self.stop()
def addFailure(self, test, err):
"""Tell result that test failed.
Called from the TestCase run() method when the test
fails because e.g. an assert() method failed.
"""
self._post_mortem(self._traceback_from_test)
super(ExtendedTestResult, self).addFailure(test, err)
self.failure_count += 1
self.report_failure(test, err)
if self.stop_early:
self.stop()
def addSuccess(self, test, details=None):
"""Tell result that test completed successfully.
Called from the TestCase run()
"""
if self._bench_history is not None:
benchmark_time = self._extractBenchmarkTime(test, details)
if benchmark_time is not None:
self._bench_history.write("%s %s\n" % (
self._formatTime(benchmark_time),
test.id()))
self.report_success(test)
super(ExtendedTestResult, self).addSuccess(test)
test._log_contents = ''
def addExpectedFailure(self, test, err):
self.known_failure_count += 1
self.report_known_failure(test, err)
def addUnexpectedSuccess(self, test, details=None):
"""Tell result the test unexpectedly passed, counting as a failure
When the minimum version of testtools required becomes 0.9.8 this
can be updated to use the new handling there.
"""
super(ExtendedTestResult, self).addFailure(test, details=details)
self.failure_count += 1
self.report_unexpected_success(test,
"".join(details["reason"].iter_text()))
if self.stop_early:
self.stop()
def addNotSupported(self, test, feature):
"""The test will not be run because of a missing feature.
"""
# this can be called in two different ways: it may be that the
# test started running, and then raised (through requireFeature)
# UnavailableFeature. Alternatively this method can be called
# while probing for features before running the test code proper; in
# that case we will see startTest and stopTest, but the test will
# never actually run.
self.unsupported.setdefault(str(feature), 0)
self.unsupported[str(feature)] += 1
self.report_unsupported(test, feature)
def addSkip(self, test, reason):
"""A test has not run for 'reason'."""
self.skip_count += 1
self.report_skip(test, reason)
def addNotApplicable(self, test, reason):
self.not_applicable_count += 1
self.report_not_applicable(test, reason)
def _post_mortem(self, tb=None):
"""Start a PDB post mortem session."""
if os.environ.get('BZR_TEST_PDB', None):
import pdb
pdb.post_mortem(tb)
def progress(self, offset, whence):
"""The test is adjusting the count of tests to run."""
if whence == SUBUNIT_SEEK_SET:
self.num_tests = offset
elif whence == SUBUNIT_SEEK_CUR:
self.num_tests += offset
else:
raise errors.BzrError("Unknown whence %r" % whence)
def report_tests_starting(self):
"""Display information before the test run begins"""
if getattr(sys, 'frozen', None) is None:
bzr_path = osutils.realpath(sys.argv[0])
else:
bzr_path = sys.executable
self.stream.write(
'bzr selftest: %s\n' % (bzr_path,))
self.stream.write(
' %s\n' % (
bzrlib.__path__[0],))
self.stream.write(
' bzr-%s python-%s %s\n' % (
bzrlib.version_string,
bzrlib._format_version_tuple(sys.version_info),
platform.platform(aliased=1),
))
self.stream.write('\n')
def report_test_start(self, test):
"""Display information on the test just about to be run"""
def _report_thread_leak(self, test, leaked_threads, active_threads):
"""Display information on a test that leaked one or more threads"""
# GZ 2010-09-09: A leak summary reported separately from the general
# thread debugging would be nice. Tests under subunit
# need something not using stream, perhaps adding a
# testtools details object would be fitting.
if 'threads' in selftest_debug_flags:
self.stream.write('%s is leaking, active is now %d\n' %
(test.id(), len(active_threads)))
def startTestRun(self):
self.startTime = time.time()
def report_success(self, test):
pass
def wasStrictlySuccessful(self):
if self.unsupported or self.known_failure_count:
return False
return self.wasSuccessful()
class TextTestResult(ExtendedTestResult):
"""Displays progress and results of tests in text form"""
def __init__(self, stream, descriptions, verbosity,
bench_history=None,
pb=None,
strict=None,
):
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
bench_history, strict)
# We no longer pass them around, but just rely on the UIFactory stack
# for state
if pb is not None:
warnings.warn("Passing pb to TextTestResult is deprecated")
self.pb = self.ui.nested_progress_bar()
self.pb.show_pct = False
self.pb.show_spinner = False
self.pb.show_eta = False,
self.pb.show_count = False
self.pb.show_bar = False
self.pb.update_latency = 0
self.pb.show_transport_activity = False
def stopTestRun(self):
# called when the tests that are going to run have run
self.pb.clear()
self.pb.finished()
super(TextTestResult, self).stopTestRun()
def report_tests_starting(self):
super(TextTestResult, self).report_tests_starting()
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
def _progress_prefix_text(self):
# the longer this text, the less space we have to show the test
# name...
a = '[%d' % self.count # total that have been run
# tests skipped as known not to be relevant are not important enough
# to show here
## if self.skip_count:
## a += ', %d skip' % self.skip_count
## if self.known_failure_count:
## a += '+%dX' % self.known_failure_count
if self.num_tests:
a +='/%d' % self.num_tests
a += ' in '
runtime = time.time() - self._overall_start_time
if runtime >= 60:
a += '%dm%ds' % (runtime / 60, runtime % 60)
else:
a += '%ds' % runtime
total_fail_count = self.error_count + self.failure_count
if total_fail_count:
a += ', %d failed' % total_fail_count
# if self.unsupported:
# a += ', %d missing' % len(self.unsupported)
a += ']'
return a
def report_test_start(self, test):
self.pb.update(
self._progress_prefix_text()
+ ' '
+ self._shortened_test_description(test))
def _test_description(self, test):
return self._shortened_test_description(test)
def report_error(self, test, err):
self.stream.write('ERROR: %s\n %s\n' % (
self._test_description(test),
err[1],
))
def report_failure(self, test, err):
self.stream.write('FAIL: %s\n %s\n' % (
self._test_description(test),
err[1],
))
def report_known_failure(self, test, err):
pass
def report_unexpected_success(self, test, reason):
self.stream.write('FAIL: %s\n %s: %s\n' % (
self._test_description(test),
"Unexpected success. Should have failed",
reason,
))
def report_skip(self, test, reason):
pass
def report_not_applicable(self, test, reason):
pass
def report_unsupported(self, test, feature):
"""test cannot be run because feature is missing."""
class VerboseTestResult(ExtendedTestResult):
"""Produce long output, with one line per test run plus times"""
def _ellipsize_to_right(self, a_string, final_width):
"""Truncate and pad a string, keeping the right hand side"""
if len(a_string) > final_width:
result = '...' + a_string[3-final_width:]
else:
result = a_string
return result.ljust(final_width)
def report_tests_starting(self):
self.stream.write('running %d tests...\n' % self.num_tests)
super(VerboseTestResult, self).report_tests_starting()
def report_test_start(self, test):
name = self._shortened_test_description(test)
width = osutils.terminal_width()
if width is not None:
# width needs space for 6 char status, plus 1 for slash, plus an
# 11-char time string, plus a trailing blank
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
# space
self.stream.write(self._ellipsize_to_right(name, width-18))
else:
self.stream.write(name)
self.stream.flush()
def _error_summary(self, err):
indent = ' ' * 4
return '%s%s' % (indent, err[1])
def report_error(self, test, err):
self.stream.write('ERROR %s\n%s\n'
% (self._testTimeString(test),
self._error_summary(err)))
def report_failure(self, test, err):
self.stream.write(' FAIL %s\n%s\n'
% (self._testTimeString(test),
self._error_summary(err)))
def report_known_failure(self, test, err):
self.stream.write('XFAIL %s\n%s\n'
% (self._testTimeString(test),
self._error_summary(err)))
def report_unexpected_success(self, test, reason):
self.stream.write(' FAIL %s\n%s: %s\n'
% (self._testTimeString(test),
"Unexpected success. Should have failed",
reason))
def report_success(self, test):
self.stream.write(' OK %s\n' % self._testTimeString(test))
for bench_called, stats in getattr(test, '_benchcalls', []):
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
stats.pprint(file=self.stream)
# flush the stream so that we get smooth output. This verbose mode is
# used to show the output in PQM.
self.stream.flush()
def report_skip(self, test, reason):
self.stream.write(' SKIP %s\n%s\n'
% (self._testTimeString(test), reason))
def report_not_applicable(self, test, reason):
self.stream.write(' N/A %s\n %s\n'
% (self._testTimeString(test), reason))
def report_unsupported(self, test, feature):
"""test cannot be run because feature is missing."""
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
%(self._testTimeString(test), feature))
class TextTestRunner(object):
stop_on_failure = False
def __init__(self,
stream=sys.stderr,
descriptions=0,
verbosity=1,
bench_history=None,
strict=False,
result_decorators=None,
):
"""Create a TextTestRunner.
:param result_decorators: An optional list of decorators to apply
to the result object being used by the runner. Decorators are
applied left to right - the first element in the list is the
innermost decorator.
"""
# stream may know claim to know to write unicode strings, but in older
# pythons this goes sufficiently wrong that it is a bad idea. (
# specifically a built in file with encoding 'UTF-8' will still try
# to encode using ascii.
new_encoding = osutils.get_terminal_encoding()
codec = codecs.lookup(new_encoding)
if type(codec) is tuple:
# Python 2.4
encode = codec[0]
else:
encode = codec.encode
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
# so should swap to the plain codecs.StreamWriter
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
"backslashreplace")
stream.encoding = new_encoding
self.stream = stream
self.descriptions = descriptions
self.verbosity = verbosity
self._bench_history = bench_history
self._strict = strict
self._result_decorators = result_decorators or []
def run(self, test):
"Run the given test case or test suite."
if self.verbosity == 1:
result_class = TextTestResult
elif self.verbosity >= 2:
result_class = VerboseTestResult
original_result = result_class(self.stream,
self.descriptions,
self.verbosity,
bench_history=self._bench_history,
strict=self._strict,
)
# Signal to result objects that look at stop early policy to stop,
original_result.stop_early = self.stop_on_failure
result = original_result
for decorator in self._result_decorators:
result = decorator(result)
result.stop_early = self.stop_on_failure
result.startTestRun()
try:
test.run(result)
finally:
result.stopTestRun()
# higher level code uses our extended protocol to determine
# what exit code to give.
return original_result
def iter_suite_tests(suite):
"""Return all tests in a suite, recursing through nested suites"""
if isinstance(suite, unittest.TestCase):
yield suite
elif isinstance(suite, unittest.TestSuite):
for item in suite:
for r in iter_suite_tests(item):
yield r
else:
raise Exception('unknown type %r for object %r'
% (type(suite), suite))
TestSkipped = testtools.testcase.TestSkipped
class TestNotApplicable(TestSkipped):
"""A test is not applicable to the situation where it was run.
This is only normally raised by parameterized tests, if they find that
the instance they're constructed upon does not support one aspect
of its interface.
"""
# traceback._some_str fails to format exceptions that have the default
# __str__ which does an implicit ascii conversion. However, repr() on those
# objects works, for all that its not quite what the doctor may have ordered.
def _clever_some_str(value):
try:
return str(value)
except:
try:
return repr(value).replace('\\n', '\n')
except:
return '<unprintable %s object>' % type(value).__name__
traceback._some_str = _clever_some_str
# deprecated - use self.knownFailure(), or self.expectFailure.
KnownFailure = testtools.testcase._ExpectedFailure
class UnavailableFeature(Exception):
"""A feature required for this test was not available.
This can be considered a specialised form of SkippedTest.
The feature should be used to construct the exception.
"""
class StringIOWrapper(object):
"""A wrapper around cStringIO which just adds an encoding attribute.
Internally we can check sys.stdout to see what the output encoding
should be. However, cStringIO has no encoding attribute that we can
set. So we wrap it instead.
"""
encoding='ascii'
_cstring = None
def __init__(self, s=None):
if s is not None:
self.__dict__['_cstring'] = StringIO(s)
else:
self.__dict__['_cstring'] = StringIO()
def __getattr__(self, name, getattr=getattr):
return getattr(self.__dict__['_cstring'], name)
def __setattr__(self, name, val):
if name == 'encoding':
self.__dict__['encoding'] = val
else:
return setattr(self._cstring, name, val)
class TestUIFactory(TextUIFactory):
"""A UI Factory for testing.
Hide the progress bar but emit note()s.
Redirect stdin.
Allows get_password to be tested without real tty attached.
See also CannedInputUIFactory which lets you provide programmatic input in
a structured way.
"""
# TODO: Capture progress events at the model level and allow them to be
# observed by tests that care.
#
# XXX: Should probably unify more with CannedInputUIFactory or a
# particular configuration of TextUIFactory, or otherwise have a clearer
# idea of how they're supposed to be different.
# See https://bugs.launchpad.net/bzr/+bug/408213
def __init__(self, stdout=None, stderr=None, stdin=None):
if stdin is not None:
# We use a StringIOWrapper to be able to test various
# encodings, but the user is still responsible to
# encode the string and to set the encoding attribute
# of StringIOWrapper.
stdin = StringIOWrapper(stdin)
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
def get_non_echoed_password(self):
"""Get password from stdin without trying to handle the echo mode"""
password = self.stdin.readline()
if not password:
raise EOFError
if password[-1] == '\n':
password = password[:-1]
return password
def make_progress_view(self):
return NullProgressView()
def isolated_doctest_setUp(test):
override_os_environ(test)
def isolated_doctest_tearDown(test):
restore_os_environ(test)
def IsolatedDocTestSuite(*args, **kwargs):
"""Overrides doctest.DocTestSuite to handle isolation.
The method is really a factory and users are expected to use it as such.
"""
kwargs['setUp'] = isolated_doctest_setUp
kwargs['tearDown'] = isolated_doctest_tearDown
return doctest.DocTestSuite(*args, **kwargs)
class TestCase(testtools.TestCase):
"""Base class for bzr unit tests.
Tests that need access to disk resources should subclass
TestCaseInTempDir not TestCase.
Error and debug log messages are redirected from their usual
location into a temporary file, the contents of which can be
retrieved by _get_log(). We use a real OS file, not an in-memory object,
so that it can also capture file IO. When the test completes this file
is read into memory and removed from disk.
There are also convenience functions to invoke bzr's command-line
routine, and to build and check bzr trees.
In addition to the usual method of overriding tearDown(), this class also
allows subclasses to register cleanup functions via addCleanup, which are
run in order as the object is torn down. It's less likely this will be
accidentally overlooked.
"""
_log_file = None
# record lsprof data when performing benchmark calls.
_gather_lsprof_in_benchmarks = False
def __init__(self, methodName='testMethod'):
super(TestCase, self).__init__(methodName)
self._directory_isolation = True
self.exception_handlers.insert(0,
(UnavailableFeature, self._do_unsupported_or_skip))
self.exception_handlers.insert(0,
(TestNotApplicable, self._do_not_applicable))
def setUp(self):
super(TestCase, self).setUp()
for feature in getattr(self, '_test_needs_features', []):
self.requireFeature(feature)
self._cleanEnvironment()
self._silenceUI()
self._startLogFile()
self._benchcalls = []
self._benchtime = None
self._clear_hooks()
self._track_transports()
self._track_locks()
self._clear_debug_flags()
# Isolate global verbosity level, to make sure it's reproducible
# between tests. We should get rid of this altogether: bug 656694. --
# mbp 20101008
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
# Isolate config option expansion until its default value for bzrlib is
# settled on or a the FIXME associated with _get_expand_default_value
# is addressed -- vila 20110219
self.overrideAttr(config, '_expand_default_value', None)
self._log_files = set()
# Each key in the ``_counters`` dict holds a value for a different
# counter. When the test ends, addDetail() should be used to output the
# counter values. This happens in install_counter_hook().
self._counters = {}
if 'config_stats' in selftest_debug_flags:
self._install_config_stats_hooks()
def debug(self):
# debug a frame up.
import pdb
pdb.Pdb().set_trace(sys._getframe().f_back)
def discardDetail(self, name):
"""Extend the addDetail, getDetails api so we can remove a detail.
eg. bzr always adds the 'log' detail at startup, but we don't want to
include it for skipped, xfail, etc tests.
It is safe to call this for a detail that doesn't exist, in case this
gets called multiple times.
"""
# We cheat. details is stored in __details which means we shouldn't
# touch it. but getDetails() returns the dict directly, so we can
# mutate it.
details = self.getDetails()
if name in details:
del details[name]
def install_counter_hook(self, hooks, name, counter_name=None):
"""Install a counting hook.
Any hook can be counted as long as it doesn't need to return a value.
:param hooks: Where the hook should be installed.
:param name: The hook name that will be counted.
:param counter_name: The counter identifier in ``_counters``, defaults
to ``name``.
"""
_counters = self._counters # Avoid closing over self
if counter_name is None:
counter_name = name
if _counters.has_key(counter_name):
raise AssertionError('%s is already used as a counter name'
% (counter_name,))
_counters[counter_name] = 0
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
lambda: ['%d' % (_counters[counter_name],)]))
def increment_counter(*args, **kwargs):
_counters[counter_name] += 1
label = 'count %s calls' % (counter_name,)
hooks.install_named_hook(name, increment_counter, label)
self.addCleanup(hooks.uninstall_named_hook, name, label)
def _install_config_stats_hooks(self):
"""Install config hooks to count hook calls.
"""
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
self.install_counter_hook(config.ConfigHooks, hook_name,
'config.%s' % (hook_name,))
# The OldConfigHooks are private and need special handling to protect
# against recursive tests (tests that run other tests), so we just do
# manually what registering them into _builtin_known_hooks will provide
# us.
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
self.install_counter_hook(config.OldConfigHooks, hook_name,
'old_config.%s' % (hook_name,))
def _clear_debug_flags(self):
"""Prevent externally set debug flags affecting tests.
Tests that want to use debug flags can just set them in the
debug_flags set during setup/teardown.
"""
# Start with a copy of the current debug flags we can safely modify.
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
if 'allow_debug' not in selftest_debug_flags:
debug.debug_flags.clear()
if 'disable_lock_checks' not in selftest_debug_flags:
debug.debug_flags.add('strict_locks')
def _clear_hooks(self):
# prevent hooks affecting tests
known_hooks = hooks.known_hooks
self._preserved_hooks = {}
for key, (parent, name) in known_hooks.iter_parent_objects():
current_hooks = getattr(parent, name)
self._preserved_hooks[parent] = (name, current_hooks)
self._preserved_lazy_hooks = hooks._lazy_hooks
hooks._lazy_hooks = {}
self.addCleanup(self._restoreHooks)
for key, (parent, name) in known_hooks.iter_parent_objects():
factory = known_hooks.get(key)
setattr(parent, name, factory())
# this hook should always be installed
request._install_hook()
def disable_directory_isolation(self):
"""Turn off directory isolation checks."""
self._directory_isolation = False
def enable_directory_isolation(self):
"""Enable directory isolation checks."""
self._directory_isolation = True
def _silenceUI(self):
"""Turn off UI for duration of test"""
# by default the UI is off; tests can turn it on if they want it.
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
def _check_locks(self):
"""Check that all lock take/release actions have been paired."""
# We always check for mismatched locks. If a mismatch is found, we
# fail unless -Edisable_lock_checks is supplied to selftest, in which
# case we just print a warning.
# unhook:
acquired_locks = [lock for action, lock in self._lock_actions
if action == 'acquired']
released_locks = [lock for action, lock in self._lock_actions
if action == 'released']
broken_locks = [lock for action, lock in self._lock_actions
if action == 'broken']
# trivially, given the tests for lock acquistion and release, if we
# have as many in each list, it should be ok. Some lock tests also
# break some locks on purpose and should be taken into account by
# considering that breaking a lock is just a dirty way of releasing it.
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
message = (
'Different number of acquired and '
'released or broken locks.\n'
'acquired=%s\n'
'released=%s\n'
'broken=%s\n' %
(acquired_locks, released_locks, broken_locks))
if not self._lock_check_thorough:
# Rather than fail, just warn
print "Broken test %s: %s" % (self, message)
return
self.fail(message)
def _track_locks(self):
"""Track lock activity during tests."""
self._lock_actions = []
if 'disable_lock_checks' in selftest_debug_flags:
self._lock_check_thorough = False
else:
self._lock_check_thorough = True
self.addCleanup(self._check_locks)
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
self._lock_acquired, None)
_mod_lock.Lock.hooks.install_named_hook('lock_released',
self._lock_released, None)
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
self._lock_broken, None)
def _lock_acquired(self, result):
self._lock_actions.append(('acquired', result))
def _lock_released(self, result):
self._lock_actions.append(('released', result))
def _lock_broken(self, result):
self._lock_actions.append(('broken', result))
def permit_dir(self, name):
"""Permit a directory to be used by this test. See permit_url."""
name_transport = _mod_transport.get_transport_from_path(name)
self.permit_url(name)
self.permit_url(name_transport.base)
def permit_url(self, url):
"""Declare that url is an ok url to use in this test.
Do this for memory transports, temporary test directory etc.
Do not do this for the current working directory, /tmp, or any other
preexisting non isolated url.
"""
if not url.endswith('/'):
url += '/'
self._bzr_selftest_roots.append(url)
def permit_source_tree_branch_repo(self):
"""Permit the source tree bzr is running from to be opened.
Some code such as bzrlib.version attempts to read from the bzr branch
that bzr is executing from (if any). This method permits that directory
to be used in the test suite.
"""
path = self.get_source_path()
self.record_directory_isolation()
try:
try:
workingtree.WorkingTree.open(path)
except (errors.NotBranchError, errors.NoWorkingTree):
raise TestSkipped('Needs a working tree of bzr sources')
finally:
self.enable_directory_isolation()
def _preopen_isolate_transport(self, transport):
"""Check that all transport openings are done in the test work area."""
while isinstance(transport, pathfilter.PathFilteringTransport):
# Unwrap pathfiltered transports
transport = transport.server.backing_transport.clone(
transport._filter('.'))
url = transport.base
# ReadonlySmartTCPServer_for_testing decorates the backing transport
# urls it is given by prepending readonly+. This is appropriate as the
# client shouldn't know that the server is readonly (or not readonly).
# We could register all servers twice, with readonly+ prepending, but
# that makes for a long list; this is about the same but easier to
# read.
if url.startswith('readonly+'):
url = url[len('readonly+'):]
self._preopen_isolate_url(url)
def _preopen_isolate_url(self, url):
if not self._directory_isolation:
return
if self._directory_isolation == 'record':
self._bzr_selftest_roots.append(url)
return
# This prevents all transports, including e.g. sftp ones backed on disk
# from working unless they are explicitly granted permission. We then
# depend on the code that sets up test transports to check that they are
# appropriately isolated and enable their use by calling
# self.permit_transport()
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
raise errors.BzrError("Attempt to escape test isolation: %r %r"
% (url, self._bzr_selftest_roots))
def record_directory_isolation(self):
"""Gather accessed directories to permit later access.
This is used for tests that access the branch bzr is running from.
"""
self._directory_isolation = "record"
def start_server(self, transport_server, backing_server=None):
"""Start transport_server for this test.
This starts the server, registers a cleanup for it and permits the
server's urls to be used.
"""
if backing_server is None:
transport_server.start_server()
else:
transport_server.start_server(backing_server)
self.addCleanup(transport_server.stop_server)
# Obtain a real transport because if the server supplies a password, it
# will be hidden from the base on the client side.
t = _mod_transport.get_transport_from_url(transport_server.get_url())
# Some transport servers effectively chroot the backing transport;
# others like SFTPServer don't - users of the transport can walk up the
# transport to read the entire backing transport. This wouldn't matter
# except that the workdir tests are given - and that they expect the
# server's url to point at - is one directory under the safety net. So
# Branch operations into the transport will attempt to walk up one
# directory. Chrooting all servers would avoid this but also mean that
# we wouldn't be testing directly against non-root urls. Alternatively
# getting the test framework to start the server with a backing server
# at the actual safety net directory would work too, but this then
# means that the self.get_url/self.get_transport methods would need
# to transform all their results. On balance its cleaner to handle it
# here, and permit a higher url when we have one of these transports.
if t.base.endswith('/work/'):
# we have safety net/test root/work
t = t.clone('../..')
elif isinstance(transport_server,
test_server.SmartTCPServer_for_testing):
# The smart server adds a path similar to work, which is traversed
# up from by the client. But the server is chrooted - the actual
# backing transport is not escaped from, and VFS requests to the
# root will error (because they try to escape the chroot).
t2 = t.clone('..')
while t2.base != t.base:
t = t2
t2 = t.clone('..')
self.permit_url(t.base)
def _track_transports(self):
"""Install checks for transport usage."""
# TestCase has no safe place it can write to.
self._bzr_selftest_roots = []
# Currently the easiest way to be sure that nothing is going on is to
# hook into bzr dir opening. This leaves a small window of error for
# transport tests, but they are well known, and we can improve on this
# step.
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
self._preopen_isolate_transport, "Check bzr directories are safe.")
def _ndiff_strings(self, a, b):
"""Return ndiff between two strings containing lines.
A trailing newline is added if missing to make the strings
print properly."""
if b and b[-1] != '\n':
b += '\n'
if a and a[-1] != '\n':
a += '\n'
difflines = difflib.ndiff(a.splitlines(True),
b.splitlines(True),
linejunk=lambda x: False,
charjunk=lambda x: False)
return ''.join(difflines)
def assertEqual(self, a, b, message=''):
try:
if a == b:
return
except UnicodeError, e:
# If we can't compare without getting a UnicodeError, then
# obviously they are different
trace.mutter('UnicodeError: %s', e)
if message:
message += '\n'
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
% (message,
pprint.pformat(a), pprint.pformat(b)))
assertEquals = assertEqual
def assertEqualDiff(self, a, b, message=None):
"""Assert two texts are equal, if not raise an exception.
This is intended for use with multi-line strings where it can
be hard to find the differences by eye.
"""
# TODO: perhaps override assertEquals to call this for strings?
if a == b:
return
if message is None:
message = "texts not equal:\n"
if a + '\n' == b:
message = 'first string is missing a final newline.\n'
if a == b + '\n':
message = 'second string is missing a final newline.\n'
raise AssertionError(message +
self._ndiff_strings(a, b))
def assertEqualMode(self, mode, mode_test):
self.assertEqual(mode, mode_test,
'mode mismatch %o != %o' % (mode, mode_test))
def assertEqualStat(self, expected, actual):
"""assert that expected and actual are the same stat result.
:param expected: A stat result.
:param actual: A stat result.
:raises AssertionError: If the expected and actual stat values differ
other than by atime.
"""
self.assertEqual(expected.st_size, actual.st_size,
'st_size did not match')
self.assertEqual(expected.st_mtime, actual.st_mtime,
'st_mtime did not match')
self.assertEqual(expected.st_ctime, actual.st_ctime,
'st_ctime did not match')
if sys.platform == 'win32':
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
# odd. We just force it to always be 0 to avoid any problems.
self.assertEqual(0, expected.st_dev)
self.assertEqual(0, actual.st_dev)
self.assertEqual(0, expected.st_ino)
self.assertEqual(0, actual.st_ino)
else:
self.assertEqual(expected.st_dev, actual.st_dev,
'st_dev did not match')
self.assertEqual(expected.st_ino, actual.st_ino,
'st_ino did not match')
self.assertEqual(expected.st_mode, actual.st_mode,
'st_mode did not match')
def assertLength(self, length, obj_with_len):
"""Assert that obj_with_len is of length length."""
if len(obj_with_len) != length:
self.fail("Incorrect length: wanted %d, got %d for %r" % (
length, len(obj_with_len), obj_with_len))
def assertLogsError(self, exception_class, func, *args, **kwargs):
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
"""
captured = []
orig_log_exception_quietly = trace.log_exception_quietly
try:
def capture():
orig_log_exception_quietly()
captured.append(sys.exc_info()[1])
trace.log_exception_quietly = capture
func(*args, **kwargs)
finally:
trace.log_exception_quietly = orig_log_exception_quietly
self.assertLength(1, captured)
err = captured[0]
self.assertIsInstance(err, exception_class)
return err
def assertPositive(self, val):
"""Assert that val is greater than 0."""
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
def assertNegative(self, val):
"""Assert that val is less than 0."""
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
def assertStartsWith(self, s, prefix):
if not s.startswith(prefix):
raise AssertionError('string %r does not start with %r' % (s, prefix))
def assertEndsWith(self, s, suffix):
"""Asserts that s ends with suffix."""
if not s.endswith(suffix):
raise AssertionError('string %r does not end with %r' % (s, suffix))
def assertContainsRe(self, haystack, needle_re, flags=0):
"""Assert that a contains something matching a regular expression."""
if not re.search(needle_re, haystack, flags):
if '\n' in haystack or len(haystack) > 60:
# a long string, format it in a more readable way
raise AssertionError(
'pattern "%s" not found in\n"""\\\n%s"""\n'
% (needle_re, haystack))
else:
raise AssertionError('pattern "%s" not found in "%s"'
% (needle_re, haystack))
def assertNotContainsRe(self, haystack, needle_re, flags=0):
"""Assert that a does not match a regular expression"""
if re.search(needle_re, haystack, flags):
raise AssertionError('pattern "%s" found in "%s"'
% (needle_re, haystack))
def assertContainsString(self, haystack, needle):
if haystack.find(needle) == -1:
self.fail("string %r not found in '''%s'''" % (needle, haystack))
def assertNotContainsString(self, haystack, needle):
if haystack.find(needle) != -1:
self.fail("string %r found in '''%s'''" % (needle, haystack))
def assertSubset(self, sublist, superlist):
"""Assert that every entry in sublist is present in superlist."""
missing = set(sublist) - set(superlist)
if len(missing) > 0:
raise AssertionError("value(s) %r not present in container %r" %
(missing, superlist))
def assertListRaises(self, excClass, func, *args, **kwargs):
"""Fail unless excClass is raised when the iterator from func is used.
Many functions can return generators this makes sure
to wrap them in a list() call to make sure the whole generator
is run, and that the proper exception is raised.
"""
try:
list(func(*args, **kwargs))
except excClass, e:
return e
else:
if getattr(excClass,'__name__', None) is not None:
excName = excClass.__name__
else:
excName = str(excClass)
raise self.failureException, "%s not raised" % excName
def assertRaises(self, excClass, callableObj, *args, **kwargs):
"""Assert that a callable raises a particular exception.
:param excClass: As for the except statement, this may be either an
exception class, or a tuple of classes.
:param callableObj: A callable, will be passed ``*args`` and
``**kwargs``.
Returns the exception so that you can examine it.
"""
try:
callableObj(*args, **kwargs)
except excClass, e:
return e
else:
if getattr(excClass,'__name__', None) is not None:
excName = excClass.__name__
else:
# probably a tuple
excName = str(excClass)
raise self.failureException, "%s not raised" % excName
def assertIs(self, left, right, message=None):
if not (left is right):
if message is not None:
raise AssertionError(message)
else:
raise AssertionError("%r is not %r." % (left, right))
def assertIsNot(self, left, right, message=None):
if (left is right):
if message is not None:
raise AssertionError(message)
else:
raise AssertionError("%r is %r." % (left, right))
def assertTransportMode(self, transport, path, mode):
"""Fail if a path does not have mode "mode".
If modes are not supported on this transport, the assertion is ignored.
"""
if not transport._can_roundtrip_unix_modebits():
return
path_stat = transport.stat(path)
actual_mode = stat.S_IMODE(path_stat.st_mode)
self.assertEqual(mode, actual_mode,
'mode of %r incorrect (%s != %s)'
% (path, oct(mode), oct(actual_mode)))
def assertIsSameRealPath(self, path1, path2):
"""Fail if path1 and path2 points to different files"""
self.assertEqual(osutils.realpath(path1),
osutils.realpath(path2),
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
def assertIsInstance(self, obj, kls, msg=None):
"""Fail if obj is not an instance of kls
:param msg: Supplementary message to show if the assertion fails.
"""
if not isinstance(obj, kls):
m = "%r is an instance of %s rather than %s" % (
obj, obj.__class__, kls)
if msg:
m += ": " + msg
self.fail(m)
def assertFileEqual(self, content, path):
"""Fail if path does not contain 'content'."""
self.assertPathExists(path)
f = file(path, 'rb')
try:
s = f.read()
finally:
f.close()
self.assertEqualDiff(content, s)
def assertDocstring(self, expected_docstring, obj):
"""Fail if obj does not have expected_docstring"""
if __doc__ is None:
# With -OO the docstring should be None instead
self.assertIs(obj.__doc__, None)
else:
self.assertEqual(expected_docstring, obj.__doc__)
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
def failUnlessExists(self, path):
return self.assertPathExists(path)
def assertPathExists(self, path):
"""Fail unless path or paths, which may be abs or relative, exist."""
if not isinstance(path, basestring):
for p in path:
self.assertPathExists(p)
else:
self.assertTrue(osutils.lexists(path),
path + " does not exist")
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
def failIfExists(self, path):
return self.assertPathDoesNotExist(path)
def assertPathDoesNotExist(self, path):
"""Fail if path or paths, which may be abs or relative, exist."""
if not isinstance(path, basestring):
for p in path:
self.assertPathDoesNotExist(p)
else:
self.assertFalse(osutils.lexists(path),
path + " exists")
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
"""A helper for callDeprecated and applyDeprecated.
:param a_callable: A callable to call.
:param args: The positional arguments for the callable
:param kwargs: The keyword arguments for the callable
:return: A tuple (warnings, result). result is the result of calling
a_callable(``*args``, ``**kwargs``).
"""
local_warnings = []
def capture_warnings(msg, cls=None, stacklevel=None):
# we've hooked into a deprecation specific callpath,
# only deprecations should getting sent via it.
self.assertEqual(cls, DeprecationWarning)
local_warnings.append(msg)
original_warning_method = symbol_versioning.warn
symbol_versioning.set_warning_method(capture_warnings)
try:
result = a_callable(*args, **kwargs)
finally:
symbol_versioning.set_warning_method(original_warning_method)
return (local_warnings, result)
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
"""Call a deprecated callable without warning the user.
Note that this only captures warnings raised by symbol_versioning.warn,
not other callers that go direct to the warning module.
To test that a deprecated method raises an error, do something like
this (remember that both assertRaises and applyDeprecated delays *args
and **kwargs passing)::
self.assertRaises(errors.ReservedId,
self.applyDeprecated,
deprecated_in((1, 5, 0)),
br.append_revision,
'current:')
:param deprecation_format: The deprecation format that the callable
should have been deprecated with. This is the same type as the
parameter to deprecated_method/deprecated_function. If the
callable is not deprecated with this format, an assertion error
will be raised.
:param a_callable: A callable to call. This may be a bound method or
a regular function. It will be called with ``*args`` and
``**kwargs``.
:param args: The positional arguments for the callable
:param kwargs: The keyword arguments for the callable
:return: The result of a_callable(``*args``, ``**kwargs``)
"""
call_warnings, result = self._capture_deprecation_warnings(a_callable,
*args, **kwargs)
expected_first_warning = symbol_versioning.deprecation_string(
a_callable, deprecation_format)
if len(call_warnings) == 0:
self.fail("No deprecation warning generated by call to %s" %
a_callable)
self.assertEqual(expected_first_warning, call_warnings[0])
return result
def callCatchWarnings(self, fn, *args, **kw):
"""Call a callable that raises python warnings.
The caller's responsible for examining the returned warnings.
If the callable raises an exception, the exception is not
caught and propagates up to the caller. In that case, the list
of warnings is not available.
:returns: ([warning_object, ...], fn_result)
"""
# XXX: This is not perfect, because it completely overrides the
# warnings filters, and some code may depend on suppressing particular
# warnings. It's the easiest way to insulate ourselves from -Werror,
# though. -- Andrew, 20071062
wlist = []
def _catcher(message, category, filename, lineno, file=None, line=None):
# despite the name, 'message' is normally(?) a Warning subclass
# instance
wlist.append(message)
saved_showwarning = warnings.showwarning
saved_filters = warnings.filters
try:
warnings.showwarning = _catcher
warnings.filters = []
result = fn(*args, **kw)
finally:
warnings.showwarning = saved_showwarning
warnings.filters = saved_filters
return wlist, result
def callDeprecated(self, expected, callable, *args, **kwargs):
"""Assert that a callable is deprecated in a particular way.
This is a very precise test for unusual requirements. The
applyDeprecated helper function is probably more suited for most tests
as it allows you to simply specify the deprecation format being used
and will ensure that that is issued for the function being called.
Note that this only captures warnings raised by symbol_versioning.warn,
not other callers that go direct to the warning module. To catch
general warnings, use callCatchWarnings.
:param expected: a list of the deprecation warnings expected, in order
:param callable: The callable to call
:param args: The positional arguments for the callable
:param kwargs: The keyword arguments for the callable
"""
call_warnings, result = self._capture_deprecation_warnings(callable,
*args, **kwargs)
self.assertEqual(expected, call_warnings)
return result
def _startLogFile(self):
"""Send bzr and test log messages to a temporary file.
The file is removed as the test is torn down.
"""
pseudo_log_file = StringIO()
def _get_log_contents_for_weird_testtools_api():
return [pseudo_log_file.getvalue().decode(
"utf-8", "replace").encode("utf-8")]
self.addDetail("log", content.Content(content.ContentType("text",
"plain", {"charset": "utf8"}),
_get_log_contents_for_weird_testtools_api))
self._log_file = pseudo_log_file
self._log_memento = trace.push_log_file(self._log_file)
self.addCleanup(self._finishLogFile)
def _finishLogFile(self):
"""Finished with the log file.
Close the file and delete it.
"""
if trace._trace_file:
# flush the log file, to get all content
trace._trace_file.flush()
trace.pop_log_file(self._log_memento)
def thisFailsStrictLockCheck(self):
"""It is known that this test would fail with -Dstrict_locks.
By default, all tests are run with strict lock checking unless
-Edisable_lock_checks is supplied. However there are some tests which
we know fail strict locks at this point that have not been fixed.
They should call this function to disable the strict checking.
This should be used sparingly, it is much better to fix the locking
issues rather than papering over the problem by calling this function.
"""
debug.debug_flags.discard('strict_locks')
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
"""Overrides an object attribute restoring it after the test.
:note: This should be used with discretion; you should think about
whether it's better to make the code testable without monkey-patching.
:param obj: The object that will be mutated.
:param attr_name: The attribute name we want to preserve/override in
the object.
:param new: The optional value we want to set the attribute to.
:returns: The actual attr value.
"""
value = getattr(obj, attr_name)
# The actual value is captured by the call below
self.addCleanup(setattr, obj, attr_name, value)
if new is not _unitialized_attr:
setattr(obj, attr_name, new)
return value
def overrideEnv(self, name, new):
"""Set an environment variable, and reset it after the test.
:param name: The environment variable name.
:param new: The value to set the variable to. If None, the
variable is deleted from the environment.
:returns: The actual variable value.
"""
value = osutils.set_or_unset_env(name, new)
self.addCleanup(osutils.set_or_unset_env, name, value)
return value
def recordCalls(self, obj, attr_name):
"""Monkeypatch in a wrapper that will record calls.
The monkeypatch is automatically removed when the test concludes.
:param obj: The namespace holding the reference to be replaced;
typically a module, class, or object.
:param attr_name: A string for the name of the attribute to
patch.
:returns: A list that will be extended with one item every time the
function is called, with a tuple of (args, kwargs).
"""
calls = []
def decorator(*args, **kwargs):
calls.append((args, kwargs))
return orig(*args, **kwargs)
orig = self.overrideAttr(obj, attr_name, decorator)
return calls
def _cleanEnvironment(self):
for name, value in isolated_environ.iteritems():
self.overrideEnv(name, value)
def _restoreHooks(self):
for klass, (name, hooks) in self._preserved_hooks.items():
setattr(klass, name, hooks)
self._preserved_hooks.clear()
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
self._preserved_lazy_hooks.clear()
def knownFailure(self, reason):
"""Declare that this test fails for a known reason
Tests that are known to fail should generally be using expectedFailure
with an appropriate reverse assertion if a change could cause the test
to start passing. Conversely if the test has no immediate prospect of
succeeding then using skip is more suitable.
When this method is called while an exception is being handled, that
traceback will be used, otherwise a new exception will be thrown to
provide one but won't be reported.
"""
self._add_reason(reason)
try:
exc_info = sys.exc_info()
if exc_info != (None, None, None):
self._report_traceback(exc_info)
else:
try:
raise self.failureException(reason)
except self.failureException:
exc_info = sys.exc_info()
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
raise testtools.testcase._ExpectedFailure(exc_info)
finally:
del exc_info
def _suppress_log(self):
"""Remove the log info from details."""
self.discardDetail('log')
def _do_skip(self, result, reason):
self._suppress_log()
addSkip = getattr(result, 'addSkip', None)
if not callable(addSkip):
result.addSuccess(result)
else:
addSkip(self, reason)
@staticmethod
def _do_known_failure(self, result, e):
self._suppress_log()
err = sys.exc_info()
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
if addExpectedFailure is not None:
addExpectedFailure(self, err)
else:
result.addSuccess(self)
@staticmethod
def _do_not_applicable(self, result, e):
if not e.args:
reason = 'No reason given'
else:
reason = e.args[0]
self._suppress_log ()
addNotApplicable = getattr(result, 'addNotApplicable', None)
if addNotApplicable is not None:
result.addNotApplicable(self, reason)
else:
self._do_skip(result, reason)
@staticmethod
def _report_skip(self, result, err):
"""Override the default _report_skip.
We want to strip the 'log' detail. If we waint until _do_skip, it has
already been formatted into the 'reason' string, and we can't pull it
out again.
"""
self._suppress_log()
super(TestCase, self)._report_skip(self, result, err)
@staticmethod
def _report_expected_failure(self, result, err):
"""Strip the log.
See _report_skip for motivation.
"""
self._suppress_log()
super(TestCase, self)._report_expected_failure(self, result, err)
@staticmethod
def _do_unsupported_or_skip(self, result, e):
reason = e.args[0]
self._suppress_log()
addNotSupported = getattr(result, 'addNotSupported', None)
if addNotSupported is not None:
result.addNotSupported(self, reason)
else:
self._do_skip(result, reason)
def time(self, callable, *args, **kwargs):
"""Run callable and accrue the time it takes to the benchmark time.
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
this will cause lsprofile statistics to be gathered and stored in
self._benchcalls.
"""
if self._benchtime is None:
self.addDetail('benchtime', content.Content(content.ContentType(
"text", "plain"), lambda:[str(self._benchtime)]))
self._benchtime = 0
start = time.time()
try:
if not self._gather_lsprof_in_benchmarks:
return callable(*args, **kwargs)
else:
# record this benchmark
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
stats.sort()
self._benchcalls.append(((callable, args, kwargs), stats))
return ret
finally:
self._benchtime += time.time() - start
def log(self, *args):
trace.mutter(*args)
def get_log(self):
"""Get a unicode string containing the log from bzrlib.trace.
Undecodable characters are replaced.
"""
return u"".join(self.getDetails()['log'].iter_text())
def requireFeature(self, feature):
"""This test requires a specific feature is available.
:raises UnavailableFeature: When feature is not available.
"""
if not feature.available():
raise UnavailableFeature(feature)
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
working_dir):
"""Run bazaar command line, splitting up a string command line."""
if isinstance(args, basestring):
# shlex don't understand unicode strings,
# so args should be plain string (bialix 20070906)
args = list(shlex.split(str(args)))
return self._run_bzr_core(args, retcode=retcode,
encoding=encoding, stdin=stdin, working_dir=working_dir,
)
def _run_bzr_core(self, args, retcode, encoding, stdin,
working_dir):
# Clear chk_map page cache, because the contents are likely to mask
# locking errors.
chk_map.clear_cache()
if encoding is None:
encoding = osutils.get_user_encoding()
stdout = StringIOWrapper()
stderr = StringIOWrapper()
stdout.encoding = encoding
stderr.encoding = encoding
self.log('run bzr: %r', args)
# FIXME: don't call into logging here
handler = logging.StreamHandler(stderr)
handler.setLevel(logging.INFO)
logger = logging.getLogger('')
logger.addHandler(handler)
old_ui_factory = ui.ui_factory
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
cwd = None
if working_dir is not None:
cwd = osutils.getcwd()
os.chdir(working_dir)
try:
try:
result = self.apply_redirected(
ui.ui_factory.stdin,
stdout, stderr,
_mod_commands.run_bzr_catch_user_errors,
args)
except KeyboardInterrupt:
# Reraise KeyboardInterrupt with contents of redirected stdout
# and stderr as arguments, for tests which are interested in
# stdout and stderr and are expecting the exception.
out = stdout.getvalue()
err = stderr.getvalue()
if out:
self.log('output:\n%r', out)
if err:
self.log('errors:\n%r', err)
raise KeyboardInterrupt(out, err)
finally:
logger.removeHandler(handler)
ui.ui_factory = old_ui_factory
if cwd is not None:
os.chdir(cwd)
out = stdout.getvalue()
err = stderr.getvalue()
if out:
self.log('output:\n%r', out)
if err:
self.log('errors:\n%r', err)
if retcode is not None:
self.assertEquals(retcode, result,
message='Unexpected return code')
return result, out, err
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
working_dir=None, error_regexes=[], output_encoding=None):
"""Invoke bzr, as if it were run from the command line.
The argument list should not include the bzr program name - the
first argument is normally the bzr command. Arguments may be
passed in three ways:
1- A list of strings, eg ["commit", "a"]. This is recommended
when the command contains whitespace or metacharacters, or
is built up at run time.
2- A single string, eg "add a". This is the most convenient
for hardcoded commands.
This runs bzr through the interface that catches and reports
errors, and with logging set to something approximating the
default, so that error reporting can be checked.
This should be the main method for tests that want to exercise the
overall behavior of the bzr application (rather than a unit test
or a functional test of the library.)
This sends the stdout/stderr results into the test's log,
where it may be useful for debugging. See also run_captured.
:keyword stdin: A string to be used as stdin for the command.
:keyword retcode: The status code the command should return;
default 0.
:keyword working_dir: The directory to run the command in
:keyword error_regexes: A list of expected error messages. If
specified they must be seen in the error output of the command.
"""
retcode, out, err = self._run_bzr_autosplit(
args=args,
retcode=retcode,
encoding=encoding,
stdin=stdin,
working_dir=working_dir,
)
self.assertIsInstance(error_regexes, (list, tuple))
for regex in error_regexes:
self.assertContainsRe(err, regex)
return out, err
def run_bzr_error(self, error_regexes, *args, **kwargs):
"""Run bzr, and check that stderr contains the supplied regexes
:param error_regexes: Sequence of regular expressions which
must each be found in the error output. The relative ordering
is not enforced.
:param args: command-line arguments for bzr
:param kwargs: Keyword arguments which are interpreted by run_bzr
This function changes the default value of retcode to be 3,
since in most cases this is run when you expect bzr to fail.
:return: (out, err) The actual output of running the command (in case
you want to do more inspection)
Examples of use::
# Make sure that commit is failing because there is nothing to do
self.run_bzr_error(['no changes to commit'],
['commit', '-m', 'my commit comment'])
# Make sure --strict is handling an unknown file, rather than
# giving us the 'nothing to do' error
self.build_tree(['unknown'])
self.run_bzr_error(['Commit refused because there are unknown files'],
['commit', --strict', '-m', 'my commit comment'])
"""
kwargs.setdefault('retcode', 3)
kwargs['error_regexes'] = error_regexes
out, err = self.run_bzr(*args, **kwargs)
return out, err
def run_bzr_subprocess(self, *args, **kwargs):
"""Run bzr in a subprocess for testing.
This starts a new Python interpreter and runs bzr in there.
This should only be used for tests that have a justifiable need for
this isolation: e.g. they are testing startup time, or signal
handling, or early startup code, etc. Subprocess code can't be
profiled or debugged so easily.
:keyword retcode: The status code that is expected. Defaults to 0. If
None is supplied, the status code is not checked.
:keyword env_changes: A dictionary which lists changes to environment
variables. A value of None will unset the env variable.
The values must be strings. The change will only occur in the
child, so you don't need to fix the environment after running.
:keyword universal_newlines: Convert CRLF => LF
:keyword allow_plugins: By default the subprocess is run with
--no-plugins to ensure test reproducibility. Also, it is possible
for system-wide plugins to create unexpected output on stderr,
which can cause unnecessary test failures.
"""
env_changes = kwargs.get('env_changes', {})
working_dir = kwargs.get('working_dir', None)
allow_plugins = kwargs.get('allow_plugins', False)
if len(args) == 1:
if isinstance(args[0], list):
args = args[0]
elif isinstance(args[0], basestring):
args = list(shlex.split(args[0]))
else:
raise ValueError("passing varargs to run_bzr_subprocess")
process = self.start_bzr_subprocess(args, env_changes=env_changes,
working_dir=working_dir,
allow_plugins=allow_plugins)
# We distinguish between retcode=None and retcode not passed.
supplied_retcode = kwargs.get('retcode', 0)
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
universal_newlines=kwargs.get('universal_newlines', False),
process_args=args)
def start_bzr_subprocess(self, process_args, env_changes=None,
skip_if_plan_to_signal=False,
working_dir=None,
allow_plugins=False, stderr=subprocess.PIPE):
"""Start bzr in a subprocess for testing.
This starts a new Python interpreter and runs bzr in there.
This should only be used for tests that have a justifiable need for
this isolation: e.g. they are testing startup time, or signal
handling, or early startup code, etc. Subprocess code can't be
profiled or debugged so easily.
:param process_args: a list of arguments to pass to the bzr executable,
for example ``['--version']``.
:param env_changes: A dictionary which lists changes to environment
variables. A value of None will unset the env variable.
The values must be strings. The change will only occur in the
child, so you don't need to fix the environment after running.
:param skip_if_plan_to_signal: raise TestSkipped when true and system
doesn't support signalling subprocesses.
:param allow_plugins: If False (default) pass --no-plugins to bzr.
:param stderr: file to use for the subprocess's stderr. Valid values
are those valid for the stderr argument of `subprocess.Popen`.
Default value is ``subprocess.PIPE``.
:returns: Popen object for the started process.
"""
if skip_if_plan_to_signal:
if os.name != "posix":
raise TestSkipped("Sending signals not supported")
if env_changes is None:
env_changes = {}
old_env = {}
def cleanup_environment():
for env_var, value in env_changes.iteritems():
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
def restore_environment():
for env_var, value in old_env.iteritems():
osutils.set_or_unset_env(env_var, value)
bzr_path = self.get_bzr_path()
cwd = None
if working_dir is not None:
cwd = osutils.getcwd()
os.chdir(working_dir)
try:
# win32 subprocess doesn't support preexec_fn
# so we will avoid using it on all platforms, just to
# make sure the code path is used, and we don't break on win32
cleanup_environment()
# Include the subprocess's log file in the test details, in case
# the test fails due to an error in the subprocess.
self._add_subprocess_log(trace._get_bzr_log_filename())
command = [sys.executable]
# frozen executables don't need the path to bzr
if getattr(sys, "frozen", None) is None:
command.append(bzr_path)
if not allow_plugins:
command.append('--no-plugins')
command.extend(process_args)
process = self._popen(command, stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=stderr)
finally:
restore_environment()
if cwd is not None:
os.chdir(cwd)
return process
def _add_subprocess_log(self, log_file_path):
if len(self._log_files) == 0:
# Register an addCleanup func. We do this on the first call to
# _add_subprocess_log rather than in TestCase.setUp so that this
# addCleanup is registered after any cleanups for tempdirs that
# subclasses might create, which will probably remove the log file
# we want to read.
self.addCleanup(self._subprocess_log_cleanup)
# self._log_files is a set, so if a log file is reused we won't grab it
# twice.
self._log_files.add(log_file_path)
def _subprocess_log_cleanup(self):
for count, log_file_path in enumerate(self._log_files):
# We use buffer_now=True to avoid holding the file open beyond
# the life of this function, which might interfere with e.g.
# cleaning tempdirs on Windows.
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
#detail_content = content.content_from_file(
# log_file_path, buffer_now=True)
with open(log_file_path, 'rb') as log_file:
log_file_bytes = log_file.read()
detail_content = content.Content(content.ContentType("text",
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
detail_content)
def _popen(self, *args, **kwargs):
"""Place a call to Popen.
Allows tests to override this method to intercept the calls made to
Popen for introspection.
"""
return subprocess.Popen(*args, **kwargs)
def get_source_path(self):
"""Return the path of the directory containing bzrlib."""
return os.path.dirname(os.path.dirname(bzrlib.__file__))
def get_bzr_path(self):
"""Return the path of the 'bzr' executable for this test suite."""
bzr_path = os.path.join(self.get_source_path(), "bzr")
if not os.path.isfile(bzr_path):
# We are probably installed. Assume sys.argv is the right file
bzr_path = sys.argv[0]
return bzr_path
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
universal_newlines=False, process_args=None):
"""Finish the execution of process.
:param process: the Popen object returned from start_bzr_subprocess.
:param retcode: The status code that is expected. Defaults to 0. If
None is supplied, the status code is not checked.
:param send_signal: an optional signal to send to the process.
:param universal_newlines: Convert CRLF => LF
:returns: (stdout, stderr)
"""
if send_signal is not None:
os.kill(process.pid, send_signal)
out, err = process.communicate()
if universal_newlines:
out = out.replace('\r\n', '\n')
err = err.replace('\r\n', '\n')
if retcode is not None and retcode != process.returncode:
if process_args is None:
process_args = "(unknown args)"
trace.mutter('Output of bzr %s:\n%s', process_args, out)
trace.mutter('Error for bzr %s:\n%s', process_args, err)
self.fail('Command bzr %s failed with retcode %s != %s'
% (process_args, retcode, process.returncode))
return [out, err]
def check_tree_shape(self, tree, shape):
"""Compare a tree to a list of expected names.
Fail if they are not precisely equal.
"""
extras = []
shape = list(shape) # copy
for path, ie in tree.iter_entries_by_dir():
name = path.replace('\\', '/')
if ie.kind == 'directory':
name = name + '/'
if name == "/":
pass # ignore root entry
elif name in shape:
shape.remove(name)
else:
extras.append(name)
if shape:
self.fail("expected paths not found in inventory: %r" % shape)
if extras:
self.fail("unexpected paths found in inventory: %r" % extras)
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
a_callable=None, *args, **kwargs):
"""Call callable with redirected std io pipes.
Returns the return code."""
if not callable(a_callable):
raise ValueError("a_callable must be callable.")
if stdin is None:
stdin = StringIO("")
if stdout is None:
if getattr(self, "_log_file", None) is not None:
stdout = self._log_file
else:
stdout = StringIO()
if stderr is None:
if getattr(self, "_log_file", None is not None):
stderr = self._log_file
else:
stderr = StringIO()
real_stdin = sys.stdin
real_stdout = sys.stdout
real_stderr = sys.stderr
try:
sys.stdout = stdout
sys.stderr = stderr
sys.stdin = stdin
return a_callable(*args, **kwargs)
finally:
sys.stdout = real_stdout
sys.stderr = real_stderr
sys.stdin = real_stdin
def reduceLockdirTimeout(self):
"""Reduce the default lock timeout for the duration of the test, so that
if LockContention occurs during a test, it does so quickly.
Tests that expect to provoke LockContention errors should call this.
"""
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
def make_utf8_encoded_stringio(self, encoding_type=None):
"""Return a StringIOWrapper instance, that will encode Unicode
input to UTF-8.
"""
if encoding_type is None:
encoding_type = 'strict'
sio = StringIO()
output_encoding = 'utf-8'
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
sio.encoding = output_encoding
return sio
def disable_verb(self, verb):
"""Disable a smart server verb for one test."""
from bzrlib.smart import request
request_handlers = request.request_handlers
orig_method = request_handlers.get(verb)
request_handlers.remove(verb)
self.addCleanup(request_handlers.register, verb, orig_method)
class CapturedCall(object):
"""A helper for capturing smart server calls for easy debug analysis."""
def __init__(self, params, prefix_length):
"""Capture the call with params and skip prefix_length stack frames."""
self.call = params
import traceback
# The last 5 frames are the __init__, the hook frame, and 3 smart
# client frames. Beyond this we could get more clever, but this is good
# enough for now.
stack = traceback.extract_stack()[prefix_length:-5]
self.stack = ''.join(traceback.format_list(stack))
def __str__(self):
return self.call.method
def __repr__(self):
return self.call.method
def stack(self):
return self.stack
class TestCaseWithMemoryTransport(TestCase):
"""Common test class for tests that do not need disk resources.
Tests that need disk resources should derive from TestCaseInTempDir
orTestCaseWithTransport.
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
a directory which does not exist. This serves to help ensure test isolation
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
must exist. However, TestCaseWithMemoryTransport does not offer local file
defaults for the transport in tests, nor does it obey the command line
override, so tests that accidentally write to the common directory should
be rare.
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
``.bzr`` directory that stops us ascending higher into the filesystem.
"""
TEST_ROOT = None
_TEST_NAME = 'test'
def __init__(self, methodName='runTest'):
# allow test parameterization after test construction and before test
# execution. Variables that the parameterizer sets need to be
# ones that are not set by setUp, or setUp will trash them.
super(TestCaseWithMemoryTransport, self).__init__(methodName)
self.vfs_transport_factory = default_transport
self.transport_server = None
self.transport_readonly_server = None
self.__vfs_server = None
def get_transport(self, relpath=None):
"""Return a writeable transport.
This transport is for the test scratch space relative to
"self._test_root"
:param relpath: a path relative to the base url.
"""
t = _mod_transport.get_transport_from_url(self.get_url(relpath))
self.assertFalse(t.is_readonly())
return t
def get_readonly_transport(self, relpath=None):
"""Return a readonly transport for the test scratch space
This can be used to test that operations which should only need
readonly access in fact do not try to write.
:param relpath: a path relative to the base url.
"""
t = _mod_transport.get_transport(self.get_readonly_url(relpath))
self.assertTrue(t.is_readonly())
return t
def create_transport_readonly_server(self):
"""Create a transport server from class defined at init.
This is mostly a hook for daughter classes.
"""
return self.transport_readonly_server()
def get_readonly_server(self):
"""Get the server instance for the readonly transport
This is useful for some tests with specific servers to do diagnostics.
"""
if self.__readonly_server is None:
if self.transport_readonly_server is None:
# readonly decorator requested
self.__readonly_server = test_server.ReadonlyServer()
else:
# explicit readonly transport.
self.__readonly_server = self.create_transport_readonly_server()
self.start_server(self.__readonly_server,
self.get_vfs_only_server())
return self.__readonly_server
def get_readonly_url(self, relpath=None):
"""Get a URL for the readonly transport.
This will either be backed by '.' or a decorator to the transport
used by self.get_url()
relpath provides for clients to get a path relative to the base url.
These should only be downwards relative, not upwards.
"""
base = self.get_readonly_server().get_url()
return self._adjust_url(base, relpath)
def get_vfs_only_server(self):
"""Get the vfs only read/write server instance.
This is useful for some tests with specific servers that need
diagnostics.
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
is no means to override it.
"""
if self.__vfs_server is None:
self.__vfs_server = memory.MemoryServer()
self.start_server(self.__vfs_server)
return self.__vfs_server
def get_server(self):
"""Get the read/write server instance.
This is useful for some tests with specific servers that need
diagnostics.
This is built from the self.transport_server factory. If that is None,
then the self.get_vfs_server is returned.
"""
if self.__server is None:
if (self.transport_server is None or self.transport_server is
self.vfs_transport_factory):
self.__server = self.get_vfs_only_server()
else:
# bring up a decorated means of access to the vfs only server.
self.__server = self.transport_server()
self.start_server(self.__server, self.get_vfs_only_server())
return self.__server
def _adjust_url(self, base, relpath):
"""Get a URL (or maybe a path) for the readwrite transport.
This will either be backed by '.' or to an equivalent non-file based
facility.
relpath provides for clients to get a path relative to the base url.
These should only be downwards relative, not upwards.
"""
if relpath is not None and relpath != '.':
if not base.endswith('/'):
base = base + '/'
# XXX: Really base should be a url; we did after all call
# get_url()! But sometimes it's just a path (from
# LocalAbspathServer), and it'd be wrong to append urlescaped data
# to a non-escaped local path.
if base.startswith('./') or base.startswith('/'):
base += relpath
else:
base += urlutils.escape(relpath)
return base
def get_url(self, relpath=None):
"""Get a URL (or maybe a path) for the readwrite transport.
This will either be backed by '.' or to an equivalent non-file based
facility.
relpath provides for clients to get a path relative to the base url.
These should only be downwards relative, not upwards.
"""
base = self.get_server().get_url()
return self._adjust_url(base, relpath)
def get_vfs_only_url(self, relpath=None):
"""Get a URL (or maybe a path for the plain old vfs transport.
This will never be a smart protocol. It always has all the
capabilities of the local filesystem, but it might actually be a
MemoryTransport or some other similar virtual filesystem.
This is the backing transport (if any) of the server returned by
get_url and get_readonly_url.
:param relpath: provides for clients to get a path relative to the base
url. These should only be downwards relative, not upwards.
:return: A URL
"""
base = self.get_vfs_only_server().get_url()
return self._adjust_url(base, relpath)
def _create_safety_net(self):
"""Make a fake bzr directory.
This prevents any tests propagating up onto the TEST_ROOT directory's
real branch.
"""
root = TestCaseWithMemoryTransport.TEST_ROOT
wt = bzrdir.BzrDir.create_standalone_workingtree(root)
# Hack for speed: remember the raw bytes of the dirstate file so that
# we don't need to re-open the wt to check it hasn't changed.
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
wt.control_transport.get_bytes('dirstate'))
def _check_safety_net(self):
"""Check that the safety .bzr directory have not been touched.
_make_test_root have created a .bzr directory to prevent tests from
propagating. This method ensures than a test did not leaked.
"""
root = TestCaseWithMemoryTransport.TEST_ROOT
t = _mod_transport.get_transport(root)
self.permit_url(t.base)
if (t.get_bytes('.bzr/checkout/dirstate') !=
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
# The current test have modified the /bzr directory, we need to
# recreate a new one or all the followng tests will fail.
# If you need to inspect its content uncomment the following line
# import pdb; pdb.set_trace()
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
self._create_safety_net()
raise AssertionError('%s/.bzr should not be modified' % root)
def _make_test_root(self):
if TestCaseWithMemoryTransport.TEST_ROOT is None:
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
suffix='.tmp'))
TestCaseWithMemoryTransport.TEST_ROOT = root
self._create_safety_net()
# The same directory is used by all tests, and we're not
# specifically told when all tests are finished. This will do.
atexit.register(_rmtree_temp_dir, root)
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
self.addCleanup(self._check_safety_net)
def makeAndChdirToTestDir(self):
"""Create a temporary directories for this one test.
This must set self.test_home_dir and self.test_dir and chdir to
self.test_dir.
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
"""
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
self.permit_dir(self.test_dir)
def make_branch(self, relpath, format=None):
"""Create a branch on the transport at relpath."""
repo = self.make_repository(relpath, format=format)
return repo.bzrdir.create_branch()
def make_bzrdir(self, relpath, format=None):
try:
# might be a relative or absolute path
maybe_a_url = self.get_url(relpath)
segments = maybe_a_url.rsplit('/', 1)
t = _mod_transport.get_transport(maybe_a_url)
if len(segments) > 1 and segments[-1] not in ('', '.'):
t.ensure_base()
if format is None:
format = 'default'
if isinstance(format, basestring):
format = bzrdir.format_registry.make_bzrdir(format)
return format.initialize_on_transport(t)
except errors.UninitializableFormat:
raise TestSkipped("Format %s is not initializable." % format)
def make_repository(self, relpath, shared=False, format=None):
"""Create a repository on our default transport at relpath.
Note that relpath must be a relative path, not a full url.
"""
# FIXME: If you create a remoterepository this returns the underlying
# real format, which is incorrect. Actually we should make sure that
# RemoteBzrDir returns a RemoteRepository.
# maybe mbp 20070410
made_control = self.make_bzrdir(relpath, format=format)
return made_control.create_repository(shared=shared)
def make_smart_server(self, path, backing_server=None):
if backing_server is None:
backing_server = self.get_server()
smart_server = test_server.SmartTCPServer_for_testing()
self.start_server(smart_server, backing_server)
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
).clone(path)
return remote_transport
def make_branch_and_memory_tree(self, relpath, format=None):
"""Create a branch on the default transport and a MemoryTree for it."""
b = self.make_branch(relpath, format=format)
return memorytree.MemoryTree.create_on_branch(b)
def make_branch_builder(self, relpath, format=None):
branch = self.make_branch(relpath, format=format)
return branchbuilder.BranchBuilder(branch=branch)
def overrideEnvironmentForTesting(self):
test_home_dir = self.test_home_dir
if isinstance(test_home_dir, unicode):
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
self.overrideEnv('HOME', test_home_dir)
self.overrideEnv('BZR_HOME', test_home_dir)
def setUp(self):
super(TestCaseWithMemoryTransport, self).setUp()
# Ensure that ConnectedTransport doesn't leak sockets
def get_transport_from_url_with_cleanup(*args, **kwargs):
t = orig_get_transport_from_url(*args, **kwargs)
if isinstance(t, _mod_transport.ConnectedTransport):
self.addCleanup(t.disconnect)
return t
orig_get_transport_from_url = self.overrideAttr(
_mod_transport, 'get_transport_from_url',
get_transport_from_url_with_cleanup)
self._make_test_root()
self.addCleanup(os.chdir, os.getcwdu())
self.makeAndChdirToTestDir()
self.overrideEnvironmentForTesting()
self.__readonly_server = None
self.__server = None
self.reduceLockdirTimeout()
def setup_smart_server_with_call_log(self):
"""Sets up a smart server as the transport server with a call log."""
self.transport_server = test_server.SmartTCPServer_for_testing
self.hpss_calls = []
import traceback
# Skip the current stack down to the caller of
# setup_smart_server_with_call_log
prefix_length = len(traceback.extract_stack()) - 2
def capture_hpss_call(params):
self.hpss_calls.append(
CapturedCall(params, prefix_length))
client._SmartClient.hooks.install_named_hook(
'call', capture_hpss_call, None)
def reset_smart_call_log(self):
self.hpss_calls = []
class TestCaseInTempDir(TestCaseWithMemoryTransport):
"""Derived class that runs a test within a temporary directory.
This is useful for tests that need to create a branch, etc.
The directory is created in a slightly complex way: for each
Python invocation, a new temporary top-level directory is created.
All test cases create their own directory within that. If the
tests complete successfully, the directory is removed.
:ivar test_base_dir: The path of the top-level directory for this
test, which contains a home directory and a work directory.
:ivar test_home_dir: An initially empty directory under test_base_dir
which is used as $HOME for this test.
:ivar test_dir: A directory under test_base_dir used as the current
directory when the test proper is run.
"""
OVERRIDE_PYTHON = 'python'
def setUp(self):
super(TestCaseInTempDir, self).setUp()
# Remove the protection set in isolated_environ, we have a proper
# access to disk resources now.
self.overrideEnv('BZR_LOG', None)
def check_file_contents(self, filename, expect):
self.log("check contents of file %s" % filename)
f = file(filename)
try:
contents = f.read()
finally:
f.close()
if contents != expect:
self.log("expected: %r" % expect)
self.log("actually: %r" % contents)
self.fail("contents of %s not as expected" % filename)
def _getTestDirPrefix(self):
# create a directory within the top level test directory
if sys.platform in ('win32', 'cygwin'):
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
# windows is likely to have path-length limits so use a short name
name_prefix = name_prefix[-30:]
else:
name_prefix = re.sub('[/]', '_', self.id())
return name_prefix
def makeAndChdirToTestDir(self):
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
For TestCaseInTempDir we create a temporary directory based on the test
name and then create two subdirs - test and home under it.
"""
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
self._getTestDirPrefix())
name = name_prefix
for i in range(100):
if os.path.exists(name):
name = name_prefix + '_' + str(i)
else:
# now create test and home directories within this dir
self.test_base_dir = name
self.addCleanup(self.deleteTestDir)
os.mkdir(self.test_base_dir)
break
self.permit_dir(self.test_base_dir)
# 'sprouting' and 'init' of a branch both walk up the tree to find
# stacking policy to honour; create a bzr dir with an unshared
# repository (but not a branch - our code would be trying to escape
# then!) to stop them, and permit it to be read.
# control = bzrdir.BzrDir.create(self.test_base_dir)
# control.create_repository()
self.test_home_dir = self.test_base_dir + '/home'
os.mkdir(self.test_home_dir)
self.test_dir = self.test_base_dir + '/work'
os.mkdir(self.test_dir)
os.chdir(self.test_dir)
# put name of test inside
f = file(self.test_base_dir + '/name', 'w')
try:
f.write(self.id())
finally:
f.close()
def deleteTestDir(self):
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
def build_tree(self, shape, line_endings='binary', transport=None):
"""Build a test tree according to a pattern.
shape is a sequence of file specifications. If the final
character is '/', a directory is created.
This assumes that all the elements in the tree being built are new.
This doesn't add anything to a branch.
:type shape: list or tuple.
:param line_endings: Either 'binary' or 'native'
in binary mode, exact contents are written in native mode, the
line endings match the default platform endings.
:param transport: A transport to write to, for building trees on VFS's.
If the transport is readonly or None, "." is opened automatically.
:return: None
"""
if type(shape) not in (list, tuple):
raise AssertionError("Parameter 'shape' should be "
"a list or a tuple. Got %r instead" % (shape,))
# It's OK to just create them using forward slashes on windows.
if transport is None or transport.is_readonly():
transport = _mod_transport.get_transport(".")
for name in shape:
self.assertIsInstance(name, basestring)
if name[-1] == '/':
transport.mkdir(urlutils.escape(name[:-1]))
else:
if line_endings == 'binary':
end = '\n'
elif line_endings == 'native':
end = os.linesep
else:
raise errors.BzrError(
'Invalid line ending request %r' % line_endings)
content = "contents of %s%s" % (name.encode('utf-8'), end)
transport.put_bytes_non_atomic(urlutils.escape(name), content)
build_tree_contents = staticmethod(treeshape.build_tree_contents)
def assertInWorkingTree(self, path, root_path='.', tree=None):
"""Assert whether path or paths are in the WorkingTree"""
if tree is None:
tree = workingtree.WorkingTree.open(root_path)
if not isinstance(path, basestring):
for p in path:
self.assertInWorkingTree(p, tree=tree)
else:
self.assertIsNot(tree.path2id(path), None,
path+' not in working tree.')
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
"""Assert whether path or paths are not in the WorkingTree"""
if tree is None:
tree = workingtree.WorkingTree.open(root_path)
if not isinstance(path, basestring):
for p in path:
self.assertNotInWorkingTree(p,tree=tree)
else:
self.assertIs(tree.path2id(path), None, path+' in working tree.')
class TestCaseWithTransport(TestCaseInTempDir):
"""A test case that provides get_url and get_readonly_url facilities.
These back onto two transport servers, one for readonly access and one for
read write access.
If no explicit class is provided for readonly access, a
ReadonlyTransportDecorator is used instead which allows the use of non disk
based read write transports.
If an explicit class is provided for readonly access, that server and the
readwrite one must both define get_url() as resolving to os.getcwd().
"""
def get_vfs_only_server(self):
"""See TestCaseWithMemoryTransport.
This is useful for some tests with specific servers that need
diagnostics.
"""
if self.__vfs_server is None:
self.__vfs_server = self.vfs_transport_factory()
self.start_server(self.__vfs_server)
return self.__vfs_server
def make_branch_and_tree(self, relpath, format=None):
"""Create a branch on the transport and a tree locally.
If the transport is not a LocalTransport, the Tree can't be created on
the transport. In that case if the vfs_transport_factory is
LocalURLServer the working tree is created in the local
directory backing the transport, and the returned tree's branch and
repository will also be accessed locally. Otherwise a lightweight
checkout is created and returned.
We do this because we can't physically create a tree in the local
path, with a branch reference to the transport_factory url, and
a branch + repository in the vfs_transport, unless the vfs_transport
namespace is distinct from the local disk - the two branch objects
would collide. While we could construct a tree with its branch object
pointing at the transport_factory transport in memory, reopening it
would behaving unexpectedly, and has in the past caused testing bugs
when we tried to do it that way.
:param format: The BzrDirFormat.
:returns: the WorkingTree.
"""
# TODO: always use the local disk path for the working tree,
# this obviously requires a format that supports branch references
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
# RBC 20060208
b = self.make_branch(relpath, format=format)
try:
return b.bzrdir.create_workingtree()
except errors.NotLocalUrl:
# We can only make working trees locally at the moment. If the
# transport can't support them, then we keep the non-disk-backed
# branch and create a local checkout.
if self.vfs_transport_factory is test_server.LocalURLServer:
# the branch is colocated on disk, we cannot create a checkout.
# hopefully callers will expect this.
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
wt = local_controldir.create_workingtree()
if wt.branch._format != b._format:
wt._branch = b
# Make sure that assigning to wt._branch fixes wt.branch,
# in case the implementation details of workingtree objects
# change.
self.assertIs(b, wt.branch)
return wt
else:
return b.create_checkout(relpath, lightweight=True)
def assertIsDirectory(self, relpath, transport):
"""Assert that relpath within transport is a directory.
This may not be possible on all transports; in that case it propagates
a TransportNotPossible.
"""
try:
mode = transport.stat(relpath).st_mode
except errors.NoSuchFile:
self.fail("path %s is not a directory; no such file"
% (relpath))
if not stat.S_ISDIR(mode):
self.fail("path %s is not a directory; has mode %#o"
% (relpath, mode))
def assertTreesEqual(self, left, right):
"""Check that left and right have the same content and properties."""
# we use a tree delta to check for equality of the content, and we
# manually check for equality of other things such as the parents list.
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
differences = left.changes_from(right)
self.assertFalse(differences.has_changed(),
"Trees %r and %r are different: %r" % (left, right, differences))
def setUp(self):
super(TestCaseWithTransport, self).setUp()
self.__vfs_server = None
def disable_missing_extensions_warning(self):
"""Some tests expect a precise stderr content.
There is no point in forcing them to duplicate the extension related
warning.
"""
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
class ChrootedTestCase(TestCaseWithTransport):
"""A support class that provides readonly urls outside the local namespace.
This is done by checking if self.transport_server is a MemoryServer. if it
is then we are chrooted already, if it is not then an HttpServer is used
for readonly urls.
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
be used without needed to redo it when a different
subclass is in use ?
"""
def setUp(self):
from bzrlib.tests import http_server
super(ChrootedTestCase, self).setUp()
if not self.vfs_transport_factory == memory.MemoryServer:
self.transport_readonly_server = http_server.HttpServer
def condition_id_re(pattern):
"""Create a condition filter which performs a re check on a test's id.
:param pattern: A regular expression string.
:return: A callable that returns True if the re matches.
"""
filter_re = re.compile(pattern, 0)
def condition(test):
test_id = test.id()
return filter_re.search(test_id)
return condition
def condition_isinstance(klass_or_klass_list):
"""Create a condition filter which returns isinstance(param, klass).
:return: A callable which when called with one parameter obj return the
result of isinstance(obj, klass_or_klass_list).
"""
def condition(obj):
return isinstance(obj, klass_or_klass_list)
return condition
def condition_id_in_list(id_list):
"""Create a condition filter which verify that test's id in a list.
:param id_list: A TestIdList object.
:return: A callable that returns True if the test's id appears in the list.
"""
def condition(test):
return id_list.includes(test.id())
return condition
def condition_id_startswith(starts):
"""Create a condition filter verifying that test's id starts with a string.
:param starts: A list of string.
:return: A callable that returns True if the test's id starts with one of
the given strings.
"""
def condition(test):
for start in starts:
if test.id().startswith(start):
return True
return False
return condition
def exclude_tests_by_condition(suite, condition):
"""Create a test suite which excludes some tests from suite.
:param suite: The suite to get tests from.
:param condition: A callable whose result evaluates True when called with a
test case which should be excluded from the result.
:return: A suite which contains the tests found in suite that fail
condition.
"""
result = []
for test in iter_suite_tests(suite):
if not condition(test):
result.append(test)
return TestUtil.TestSuite(result)
def filter_suite_by_condition(suite, condition):
"""Create a test suite by filtering another one.
:param suite: The source suite.
:param condition: A callable whose result evaluates True when called with a
test case which should be included in the result.
:return: A suite which contains the tests found in suite that pass
condition.
"""
result = []
for test in iter_suite_tests(suite):
if condition(test):
result.append(test)
return TestUtil.TestSuite(result)
def filter_suite_by_re(suite, pattern):
"""Create a test suite by filtering another one.
:param suite: the source suite
:param pattern: pattern that names must match
:returns: the newly created suite
"""
condition = condition_id_re(pattern)
result_suite = filter_suite_by_condition(suite, condition)
return result_suite
def filter_suite_by_id_list(suite, test_id_list):
"""Create a test suite by filtering another one.
:param suite: The source suite.
:param test_id_list: A list of the test ids to keep as strings.
:returns: the newly created suite
"""
condition = condition_id_in_list(test_id_list)
result_suite = filter_suite_by_condition(suite, condition)
return result_suite
def filter_suite_by_id_startswith(suite, start):
"""Create a test suite by filtering another one.
:param suite: The source suite.
:param start: A list of string the test id must start with one of.
:returns: the newly created suite
"""
condition = condition_id_startswith(start)
result_suite = filter_suite_by_condition(suite, condition)
return result_suite
def exclude_tests_by_re(suite, pattern):
"""Create a test suite which excludes some tests from suite.
:param suite: The suite to get tests from.
:param pattern: A regular expression string. Test ids that match this
pattern will be excluded from the result.
:return: A TestSuite that contains all the tests from suite without the
tests that matched pattern. The order of tests is the same as it was in
suite.
"""
return exclude_tests_by_condition(suite, condition_id_re(pattern))
def preserve_input(something):
"""A helper for performing test suite transformation chains.
:param something: Anything you want to preserve.
:return: Something.
"""
return something
def randomize_suite(suite):
"""Return a new TestSuite with suite's tests in random order.
The tests in the input suite are flattened into a single suite in order to
accomplish this. Any nested TestSuites are removed to provide global
randomness.
"""
tests = list(iter_suite_tests(suite))
random.shuffle(tests)
return TestUtil.TestSuite(tests)
def split_suite_by_condition(suite, condition):
"""Split a test suite into two by a condition.
:param suite: The suite to split.
:param condition: The condition to match on. Tests that match this
condition are returned in the first test suite, ones that do not match
are in the second suite.
:return: A tuple of two test suites, where the first contains tests from
suite matching the condition, and the second contains the remainder
from suite. The order within each output suite is the same as it was in
suite.
"""
matched = []
did_not_match = []
for test in iter_suite_tests(suite):
if condition(test):
matched.append(test)
else:
did_not_match.append(test)
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
def split_suite_by_re(suite, pattern):
"""Split a test suite into two by a regular expression.
:param suite: The suite to split.
:param pattern: A regular expression string. Test ids that match this
pattern will be in the first test suite returned, and the others in the
second test suite returned.
:return: A tuple of two test suites, where the first contains tests from
suite matching pattern, and the second contains the remainder from
suite. The order within each output suite is the same as it was in
suite.
"""
return split_suite_by_condition(suite, condition_id_re(pattern))
def run_suite(suite, name='test', verbose=False, pattern=".*",
stop_on_failure=False,
transport=None, lsprof_timed=None, bench_history=None,
matching_tests_first=None,
list_only=False,
random_seed=None,
exclude_pattern=None,
strict=False,
runner_class=None,
suite_decorators=None,
stream=None,
result_decorators=None,
):
"""Run a test suite for bzr selftest.
:param runner_class: The class of runner to use. Must support the
constructor arguments passed by run_suite which are more than standard
python uses.
:return: A boolean indicating success.
"""
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
if verbose:
verbosity = 2
else:
verbosity = 1
if runner_class is None:
runner_class = TextTestRunner
if stream is None:
stream = sys.stdout
runner = runner_class(stream=stream,
descriptions=0,
verbosity=verbosity,
bench_history=bench_history,
strict=strict,
result_decorators=result_decorators,
)
runner.stop_on_failure=stop_on_failure
# built in decorator factories:
decorators = [
random_order(random_seed, runner),
exclude_tests(exclude_pattern),
]
if matching_tests_first:
decorators.append(tests_first(pattern))
else:
decorators.append(filter_tests(pattern))
if suite_decorators:
decorators.extend(suite_decorators)
# tell the result object how many tests will be running: (except if
# --parallel=fork is being used. Robert said he will provide a better
# progress design later -- vila 20090817)
if fork_decorator not in decorators:
decorators.append(CountingDecorator)
for decorator in decorators:
suite = decorator(suite)
if list_only:
# Done after test suite decoration to allow randomisation etc
# to take effect, though that is of marginal benefit.
if verbosity >= 2:
stream.write("Listing tests only ...\n")
for t in iter_suite_tests(suite):
stream.write("%s\n" % (t.id()))
return True
result = runner.run(suite)
if strict:
return result.wasStrictlySuccessful()
else:
return result.wasSuccessful()
# A registry where get() returns a suite decorator.
parallel_registry = registry.Registry()
def fork_decorator(suite):
if getattr(os, "fork", None) is None:
raise errors.BzrCommandError("platform does not support fork,"
" try --parallel=subprocess instead.")
concurrency = osutils.local_concurrency()
if concurrency == 1:
return suite
from testtools import ConcurrentTestSuite
return ConcurrentTestSuite(suite, fork_for_tests)
parallel_registry.register('fork', fork_decorator)
def subprocess_decorator(suite):
concurrency = osutils.local_concurrency()
if concurrency == 1:
return suite
from testtools import ConcurrentTestSuite
return ConcurrentTestSuite(suite, reinvoke_for_tests)
parallel_registry.register('subprocess', subprocess_decorator)
def exclude_tests(exclude_pattern):
"""Return a test suite decorator that excludes tests."""
if exclude_pattern is None:
return identity_decorator
def decorator(suite):
return ExcludeDecorator(suite, exclude_pattern)
return decorator
def filter_tests(pattern):
if pattern == '.*':
return identity_decorator
def decorator(suite):
return FilterTestsDecorator(suite, pattern)
return decorator
def random_order(random_seed, runner):
"""Return a test suite decorator factory for randomising tests order.
:param random_seed: now, a string which casts to a long, or a long.
:param runner: A test runner with a stream attribute to report on.
"""
if random_seed is None:
return identity_decorator
def decorator(suite):
return RandomDecorator(suite, random_seed, runner.stream)
return decorator
def tests_first(pattern):
if pattern == '.*':
return identity_decorator
def decorator(suite):
return TestFirstDecorator(suite, pattern)
return decorator
def identity_decorator(suite):
"""Return suite."""
return suite
class TestDecorator(TestUtil.TestSuite):
"""A decorator for TestCase/TestSuite objects.
Usually, subclasses should override __iter__(used when flattening test
suites), which we do to filter, reorder, parallelise and so on, run() and
debug().
"""
def __init__(self, suite):
TestUtil.TestSuite.__init__(self)
self.addTest(suite)
def countTestCases(self):
cases = 0
for test in self:
cases += test.countTestCases()
return cases
def debug(self):
for test in self:
test.debug()
def run(self, result):
# Use iteration on self, not self._tests, to allow subclasses to hook
# into __iter__.
for test in self:
if result.shouldStop:
break
test.run(result)
return result
class CountingDecorator(TestDecorator):
"""A decorator which calls result.progress(self.countTestCases)."""
def run(self, result):
progress_method = getattr(result, 'progress', None)
if callable(progress_method):
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
return super(CountingDecorator, self).run(result)
class ExcludeDecorator(TestDecorator):
"""A decorator which excludes test matching an exclude pattern."""
def __init__(self, suite, exclude_pattern):
TestDecorator.__init__(self, suite)
self.exclude_pattern = exclude_pattern
self.excluded = False
def __iter__(self):
if self.excluded:
return iter(self._tests)
self.excluded = True
suite = exclude_tests_by_re(self, self.exclude_pattern)
del self._tests[:]
self.addTests(suite)
return iter(self._tests)
class FilterTestsDecorator(TestDecorator):
"""A decorator which filters tests to those matching a pattern."""
def __init__(self, suite, pattern):
TestDecorator.__init__(self, suite)
self.pattern = pattern
self.filtered = False
def __iter__(self):
if self.filtered:
return iter(self._tests)
self.filtered = True
suite = filter_suite_by_re(self, self.pattern)
del self._tests[:]
self.addTests(suite)
return iter(self._tests)
class RandomDecorator(TestDecorator):
"""A decorator which randomises the order of its tests."""
def __init__(self, suite, random_seed, stream):
TestDecorator.__init__(self, suite)
self.random_seed = random_seed
self.randomised = False
self.stream = stream
def __iter__(self):
if self.randomised:
return iter(self._tests)
self.randomised = True
self.stream.write("Randomizing test order using seed %s\n\n" %
(self.actual_seed()))
# Initialise the random number generator.
random.seed(self.actual_seed())
suite = randomize_suite(self)
del self._tests[:]
self.addTests(suite)
return iter(self._tests)
def actual_seed(self):
if self.random_seed == "now":
# We convert the seed to a long to make it reuseable across
# invocations (because the user can reenter it).
self.random_seed = long(time.time())
else:
# Convert the seed to a long if we can
try:
self.random_seed = long(self.random_seed)
except:
pass
return self.random_seed
class TestFirstDecorator(TestDecorator):
"""A decorator which moves named tests to the front."""
def __init__(self, suite, pattern):
TestDecorator.__init__(self, suite)
self.pattern = pattern
self.filtered = False
def __iter__(self):
if self.filtered:
return iter(self._tests)
self.filtered = True
suites = split_suite_by_re(self, self.pattern)
del self._tests[:]
self.addTests(suites)
return iter(self._tests)
def partition_tests(suite, count):
"""Partition suite into count lists of tests."""
# This just assigns tests in a round-robin fashion. On one hand this
# splits up blocks of related tests that might run faster if they shared
# resources, but on the other it avoids assigning blocks of slow tests to
# just one partition. So the slowest partition shouldn't be much slower
# than the fastest.
partitions = [list() for i in range(count)]
tests = iter_suite_tests(suite)
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
partition.append(test)
return partitions
def workaround_zealous_crypto_random():
"""Crypto.Random want to help us being secure, but we don't care here.
This workaround some test failure related to the sftp server. Once paramiko
stop using the controversial API in Crypto.Random, we may get rid of it.
"""
try:
from Crypto.Random import atfork
atfork()
except ImportError:
pass
def fork_for_tests(suite):
"""Take suite and start up one runner per CPU by forking()
:return: An iterable of TestCase-like objects which can each have
run(result) called on them to feed tests to result.
"""
concurrency = osutils.local_concurrency()
result = []
from subunit import TestProtocolClient, ProtocolTestCase
from subunit.test_results import AutoTimingTestResultDecorator
class TestInOtherProcess(ProtocolTestCase):
# Should be in subunit, I think. RBC.
def __init__(self, stream, pid):
ProtocolTestCase.__init__(self, stream)
self.pid = pid
def run(self, result):
try:
ProtocolTestCase.run(self, result)
finally:
os.waitpid(self.pid, 0)
test_blocks = partition_tests(suite, concurrency)
for process_tests in test_blocks:
process_suite = TestUtil.TestSuite()
process_suite.addTests(process_tests)
c2pread, c2pwrite = os.pipe()
pid = os.fork()
if pid == 0:
workaround_zealous_crypto_random()
try:
os.close(c2pread)
# Leave stderr and stdout open so we can see test noise
# Close stdin so that the child goes away if it decides to
# read from stdin (otherwise its a roulette to see what
# child actually gets keystrokes for pdb etc).
sys.stdin.close()
sys.stdin = None
stream = os.fdopen(c2pwrite, 'wb', 1)
subunit_result = AutoTimingTestResultDecorator(
TestProtocolClient(stream))
process_suite.run(subunit_result)
finally:
os._exit(0)
else:
os.close(c2pwrite)
stream = os.fdopen(c2pread, 'rb', 1)
test = TestInOtherProcess(stream, pid)
result.append(test)
return result
def reinvoke_for_tests(suite):
"""Take suite and start up one runner per CPU using subprocess().
:return: An iterable of TestCase-like objects which can each have
run(result) called on them to feed tests to result.
"""
concurrency = osutils.local_concurrency()
result = []
from subunit import ProtocolTestCase
class TestInSubprocess(ProtocolTestCase):
def __init__(self, process, name):
ProtocolTestCase.__init__(self, process.stdout)
self.process = process
self.process.stdin.close()
self.name = name
def run(self, result):
try:
ProtocolTestCase.run(self, result)
finally:
self.process.wait()
os.unlink(self.name)
# print "pid %d finished" % finished_process
test_blocks = partition_tests(suite, concurrency)
for process_tests in test_blocks:
# ugly; currently reimplement rather than reuses TestCase methods.
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
if not os.path.isfile(bzr_path):
# We are probably installed. Assume sys.argv is the right file
bzr_path = sys.argv[0]
bzr_path = [bzr_path]
if sys.platform == "win32":
# if we're on windows, we can't execute the bzr script directly
bzr_path = [sys.executable] + bzr_path
fd, test_list_file_name = tempfile.mkstemp()
test_list_file = os.fdopen(fd, 'wb', 1)
for test in process_tests:
test_list_file.write(test.id() + '\n')
test_list_file.close()
try:
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
'--subunit']
if '--no-plugins' in sys.argv:
argv.append('--no-plugins')
# stderr=subprocess.STDOUT would be ideal, but until we prevent
# noise on stderr it can interrupt the subunit protocol.
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
bufsize=1)
test = TestInSubprocess(process, test_list_file_name)
result.append(test)
except:
os.unlink(test_list_file_name)
raise
return result
class ProfileResult(testtools.ExtendedToOriginalDecorator):
"""Generate profiling data for all activity between start and success.
The profile data is appended to the test's _benchcalls attribute and can
be accessed by the forwarded-to TestResult.
While it might be cleaner do accumulate this in stopTest, addSuccess is
where our existing output support for lsprof is, and this class aims to
fit in with that: while it could be moved it's not necessary to accomplish
test profiling, nor would it be dramatically cleaner.
"""
def startTest(self, test):
self.profiler = bzrlib.lsprof.BzrProfiler()
# Prevent deadlocks in tests that use lsprof: those tests will
# unavoidably fail.
bzrlib.lsprof.BzrProfiler.profiler_block = 0
self.profiler.start()
testtools.ExtendedToOriginalDecorator.startTest(self, test)
def addSuccess(self, test):
stats = self.profiler.stop()
try:
calls = test._benchcalls
except AttributeError:
test._benchcalls = []
calls = test._benchcalls
calls.append(((test.id(), "", ""), stats))
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
def stopTest(self, test):
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
self.profiler = None
# Controlled by "bzr selftest -E=..." option
# Currently supported:
# -Eallow_debug Will no longer clear debug.debug_flags() so it
# preserves any flags supplied at the command line.
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
# rather than failing tests. And no longer raise
# LockContention when fctnl locks are not being used
# with proper exclusion rules.
# -Ethreads Will display thread ident at creation/join time to
# help track thread leaks
# -Econfig_stats Will collect statistics using addDetail
selftest_debug_flags = set()
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
transport=None,
test_suite_factory=None,
lsprof_timed=None,
bench_history=None,
matching_tests_first=None,
list_only=False,
random_seed=None,
exclude_pattern=None,
strict=False,
load_list=None,
debug_flags=None,
starting_with=None,
runner_class=None,
suite_decorators=None,
stream=None,
lsprof_tests=False,
):
"""Run the whole test suite under the enhanced runner"""
# XXX: Very ugly way to do this...
# Disable warning about old formats because we don't want it to disturb
# any blackbox tests.
from bzrlib import repository
repository._deprecation_warning_done = True
global default_transport
if transport is None:
transport = default_transport
old_transport = default_transport
default_transport = transport
global selftest_debug_flags
old_debug_flags = selftest_debug_flags
if debug_flags is not None:
selftest_debug_flags = set(debug_flags)
try:
if load_list is None:
keep_only = None
else:
keep_only = load_test_id_list(load_list)
if starting_with:
starting_with = [test_prefix_alias_registry.resolve_alias(start)
for start in starting_with]
if test_suite_factory is None:
# Reduce loading time by loading modules based on the starting_with
# patterns.
suite = test_suite(keep_only, starting_with)
else:
suite = test_suite_factory()
if starting_with:
# But always filter as requested.
suite = filter_suite_by_id_startswith(suite, starting_with)
result_decorators = []
if lsprof_tests:
result_decorators.append(ProfileResult)
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
stop_on_failure=stop_on_failure,
transport=transport,
lsprof_timed=lsprof_timed,
bench_history=bench_history,
matching_tests_first=matching_tests_first,
list_only=list_only,
random_seed=random_seed,
exclude_pattern=exclude_pattern,
strict=strict,
runner_class=runner_class,
suite_decorators=suite_decorators,
stream=stream,
result_decorators=result_decorators,
)
finally:
default_transport = old_transport
selftest_debug_flags = old_debug_flags
def load_test_id_list(file_name):
"""Load a test id list from a text file.
The format is one test id by line. No special care is taken to impose
strict rules, these test ids are used to filter the test suite so a test id
that do not match an existing test will do no harm. This allows user to add
comments, leave blank lines, etc.
"""
test_list = []
try:
ftest = open(file_name, 'rt')
except IOError, e:
if e.errno != errno.ENOENT:
raise
else:
raise errors.NoSuchFile(file_name)
for test_name in ftest.readlines():
test_list.append(test_name.strip())
ftest.close()
return test_list
def suite_matches_id_list(test_suite, id_list):
"""Warns about tests not appearing or appearing more than once.
:param test_suite: A TestSuite object.
:param test_id_list: The list of test ids that should be found in
test_suite.
:return: (absents, duplicates) absents is a list containing the test found
in id_list but not in test_suite, duplicates is a list containing the
test found multiple times in test_suite.
When using a prefined test id list, it may occurs that some tests do not
exist anymore or that some tests use the same id. This function warns the
tester about potential problems in his workflow (test lists are volatile)
or in the test suite itself (using the same id for several tests does not
help to localize defects).
"""
# Build a dict counting id occurrences
tests = dict()
for test in iter_suite_tests(test_suite):
id = test.id()
tests[id] = tests.get(id, 0) + 1
not_found = []
duplicates = []
for id in id_list:
occurs = tests.get(id, 0)
if not occurs:
not_found.append(id)
elif occurs > 1:
duplicates.append(id)
return not_found, duplicates
class TestIdList(object):
"""Test id list to filter a test suite.
Relying on the assumption that test ids are built as:
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
notation, this class offers methods to :
- avoid building a test suite for modules not refered to in the test list,
- keep only the tests listed from the module test suite.
"""
def __init__(self, test_id_list):
# When a test suite needs to be filtered against us we compare test ids
# for equality, so a simple dict offers a quick and simple solution.
self.tests = dict().fromkeys(test_id_list, True)
# While unittest.TestCase have ids like:
# <module>.<class>.<method>[(<param+)],
# doctest.DocTestCase can have ids like:
# <module>
# <module>.<class>
# <module>.<function>
# <module>.<class>.<method>
# Since we can't predict a test class from its name only, we settle on
# a simple constraint: a test id always begins with its module name.
modules = {}
for test_id in test_id_list:
parts = test_id.split('.')
mod_name = parts.pop(0)
modules[mod_name] = True
for part in parts:
mod_name += '.' + part
modules[mod_name] = True
self.modules = modules
def refers_to(self, module_name):
"""Is there tests for the module or one of its sub modules."""
return self.modules.has_key(module_name)
def includes(self, test_id):
return self.tests.has_key(test_id)
class TestPrefixAliasRegistry(registry.Registry):
"""A registry for test prefix aliases.
This helps implement shorcuts for the --starting-with selftest
option. Overriding existing prefixes is not allowed but not fatal (a
warning will be emitted).
"""
def register(self, key, obj, help=None, info=None,
override_existing=False):
"""See Registry.register.
Trying to override an existing alias causes a warning to be emitted,
not a fatal execption.
"""
try:
super(TestPrefixAliasRegistry, self).register(
key, obj, help=help, info=info, override_existing=False)
except KeyError:
actual = self.get(key)
trace.note(
'Test prefix alias %s is already used for %s, ignoring %s'
% (key, actual, obj))
def resolve_alias(self, id_start):
"""Replace the alias by the prefix in the given string.
Using an unknown prefix is an error to help catching typos.
"""
parts = id_start.split('.')
try:
parts[0] = self.get(parts[0])
except KeyError:
raise errors.BzrCommandError(
'%s is not a known test prefix alias' % parts[0])
return '.'.join(parts)
test_prefix_alias_registry = TestPrefixAliasRegistry()
"""Registry of test prefix aliases."""
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
# Obvious highest levels prefixes, feel free to add your own via a plugin
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
def _test_suite_testmod_names():
"""Return the standard list of test module names to test."""
return [
'bzrlib.doc',
'bzrlib.tests.blackbox',
'bzrlib.tests.commands',
'bzrlib.tests.doc_generate',
'bzrlib.tests.per_branch',
'bzrlib.tests.per_bzrdir',
'bzrlib.tests.per_controldir',
'bzrlib.tests.per_controldir_colo',
'bzrlib.tests.per_foreign_vcs',
'bzrlib.tests.per_interrepository',
'bzrlib.tests.per_intertree',
'bzrlib.tests.per_inventory',
'bzrlib.tests.per_interbranch',
'bzrlib.tests.per_lock',
'bzrlib.tests.per_merger',
'bzrlib.tests.per_transport',
'bzrlib.tests.per_tree',
'bzrlib.tests.per_pack_repository',
'bzrlib.tests.per_repository',
'bzrlib.tests.per_repository_chk',
'bzrlib.tests.per_repository_reference',
'bzrlib.tests.per_repository_vf',
'bzrlib.tests.per_uifactory',
'bzrlib.tests.per_versionedfile',
'bzrlib.tests.per_workingtree',
'bzrlib.tests.test__annotator',
'bzrlib.tests.test__bencode',
'bzrlib.tests.test__btree_serializer',
'bzrlib.tests.test__chk_map',
'bzrlib.tests.test__dirstate_helpers',
'bzrlib.tests.test__groupcompress',
'bzrlib.tests.test__known_graph',
'bzrlib.tests.test__rio',
'bzrlib.tests.test__simple_set',
'bzrlib.tests.test__static_tuple',
'bzrlib.tests.test__walkdirs_win32',
'bzrlib.tests.test_ancestry',
'bzrlib.tests.test_annotate',
'bzrlib.tests.test_api',
'bzrlib.tests.test_atomicfile',
'bzrlib.tests.test_bad_files',
'bzrlib.tests.test_bisect_multi',
'bzrlib.tests.test_branch',
'bzrlib.tests.test_branchbuilder',
'bzrlib.tests.test_btree_index',
'bzrlib.tests.test_bugtracker',
'bzrlib.tests.test_bundle',
'bzrlib.tests.test_bzrdir',
'bzrlib.tests.test__chunks_to_lines',
'bzrlib.tests.test_cache_utf8',
'bzrlib.tests.test_chk_map',
'bzrlib.tests.test_chk_serializer',
'bzrlib.tests.test_chunk_writer',
'bzrlib.tests.test_clean_tree',
'bzrlib.tests.test_cleanup',
'bzrlib.tests.test_cmdline',
'bzrlib.tests.test_commands',
'bzrlib.tests.test_commit',
'bzrlib.tests.test_commit_merge',
'bzrlib.tests.test_config',
'bzrlib.tests.test_conflicts',
'bzrlib.tests.test_controldir',
'bzrlib.tests.test_counted_lock',
'bzrlib.tests.test_crash',
'bzrlib.tests.test_decorators',
'bzrlib.tests.test_delta',
'bzrlib.tests.test_debug',
'bzrlib.tests.test_diff',
'bzrlib.tests.test_directory_service',
'bzrlib.tests.test_dirstate',
'bzrlib.tests.test_email_message',
'bzrlib.tests.test_eol_filters',
'bzrlib.tests.test_errors',
'bzrlib.tests.test_export',
'bzrlib.tests.test_export_pot',
'bzrlib.tests.test_extract',
'bzrlib.tests.test_features',
'bzrlib.tests.test_fetch',
'bzrlib.tests.test_fixtures',
'bzrlib.tests.test_fifo_cache',
'bzrlib.tests.test_filters',
'bzrlib.tests.test_filter_tree',
'bzrlib.tests.test_ftp_transport',
'bzrlib.tests.test_foreign',
'bzrlib.tests.test_generate_docs',
'bzrlib.tests.test_generate_ids',
'bzrlib.tests.test_globbing',
'bzrlib.tests.test_gpg',
'bzrlib.tests.test_graph',
'bzrlib.tests.test_groupcompress',
'bzrlib.tests.test_hashcache',
'bzrlib.tests.test_help',
'bzrlib.tests.test_hooks',
'bzrlib.tests.test_http',
'bzrlib.tests.test_http_response',
'bzrlib.tests.test_https_ca_bundle',
'bzrlib.tests.test_i18n',
'bzrlib.tests.test_identitymap',
'bzrlib.tests.test_ignores',
'bzrlib.tests.test_index',
'bzrlib.tests.test_import_tariff',
'bzrlib.tests.test_info',
'bzrlib.tests.test_inv',
'bzrlib.tests.test_inventory_delta',
'bzrlib.tests.test_knit',
'bzrlib.tests.test_lazy_import',
'bzrlib.tests.test_lazy_regex',
'bzrlib.tests.test_library_state',
'bzrlib.tests.test_lock',
'bzrlib.tests.test_lockable_files',
'bzrlib.tests.test_lockdir',
'bzrlib.tests.test_log',
'bzrlib.tests.test_lru_cache',
'bzrlib.tests.test_lsprof',
'bzrlib.tests.test_mail_client',
'bzrlib.tests.test_matchers',
'bzrlib.tests.test_memorytree',
'bzrlib.tests.test_merge',
'bzrlib.tests.test_merge3',
'bzrlib.tests.test_merge_core',
'bzrlib.tests.test_merge_directive',
'bzrlib.tests.test_mergetools',
'bzrlib.tests.test_missing',
'bzrlib.tests.test_msgeditor',
'bzrlib.tests.test_multiparent',
'bzrlib.tests.test_mutabletree',
'bzrlib.tests.test_nonascii',
'bzrlib.tests.test_options',
'bzrlib.tests.test_osutils',
'bzrlib.tests.test_osutils_encodings',
'bzrlib.tests.test_pack',
'bzrlib.tests.test_patch',
'bzrlib.tests.test_patches',
'bzrlib.tests.test_permissions',
'bzrlib.tests.test_plugins',
'bzrlib.tests.test_progress',
'bzrlib.tests.test_pyutils',
'bzrlib.tests.test_read_bundle',
'bzrlib.tests.test_reconcile',
'bzrlib.tests.test_reconfigure',
'bzrlib.tests.test_registry',
'bzrlib.tests.test_remote',
'bzrlib.tests.test_rename_map',
'bzrlib.tests.test_repository',
'bzrlib.tests.test_revert',
'bzrlib.tests.test_revision',
'bzrlib.tests.test_revisionspec',
'bzrlib.tests.test_revisiontree',
'bzrlib.tests.test_rio',
'bzrlib.tests.test_rules',
'bzrlib.tests.test_sampler',
'bzrlib.tests.test_scenarios',
'bzrlib.tests.test_script',
'bzrlib.tests.test_selftest',
'bzrlib.tests.test_serializer',
'bzrlib.tests.test_setup',
'bzrlib.tests.test_sftp_transport',
'bzrlib.tests.test_shelf',
'bzrlib.tests.test_shelf_ui',
'bzrlib.tests.test_smart',
'bzrlib.tests.test_smart_add',
'bzrlib.tests.test_smart_request',
'bzrlib.tests.test_smart_transport',
'bzrlib.tests.test_smtp_connection',
'bzrlib.tests.test_source',
'bzrlib.tests.test_ssh_transport',
'bzrlib.tests.test_status',
'bzrlib.tests.test_store',
'bzrlib.tests.test_strace',
'bzrlib.tests.test_subsume',
'bzrlib.tests.test_switch',
'bzrlib.tests.test_symbol_versioning',
'bzrlib.tests.test_tag',
'bzrlib.tests.test_test_server',
'bzrlib.tests.test_testament',
'bzrlib.tests.test_textfile',
'bzrlib.tests.test_textmerge',
'bzrlib.tests.test_cethread',
'bzrlib.tests.test_timestamp',
'bzrlib.tests.test_trace',
'bzrlib.tests.test_transactions',
'bzrlib.tests.test_transform',
'bzrlib.tests.test_transport',
'bzrlib.tests.test_transport_log',
'bzrlib.tests.test_tree',
'bzrlib.tests.test_treebuilder',
'bzrlib.tests.test_treeshape',
'bzrlib.tests.test_tsort',
'bzrlib.tests.test_tuned_gzip',
'bzrlib.tests.test_ui',
'bzrlib.tests.test_uncommit',
'bzrlib.tests.test_upgrade',
'bzrlib.tests.test_upgrade_stacked',
'bzrlib.tests.test_urlutils',
'bzrlib.tests.test_utextwrap',
'bzrlib.tests.test_version',
'bzrlib.tests.test_version_info',
'bzrlib.tests.test_versionedfile',
'bzrlib.tests.test_weave',
'bzrlib.tests.test_whitebox',
'bzrlib.tests.test_win32utils',
'bzrlib.tests.test_workingtree',
'bzrlib.tests.test_workingtree_4',
'bzrlib.tests.test_wsgi',
'bzrlib.tests.test_xml',
]
def _test_suite_modules_to_doctest():
"""Return the list of modules to doctest."""
if __doc__ is None:
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
return []
return [
'bzrlib',
'bzrlib.branchbuilder',
'bzrlib.decorators',
'bzrlib.inventory',
'bzrlib.iterablefile',
'bzrlib.lockdir',
'bzrlib.merge3',
'bzrlib.option',
'bzrlib.pyutils',
'bzrlib.symbol_versioning',
'bzrlib.tests',
'bzrlib.tests.fixtures',
'bzrlib.timestamp',
'bzrlib.transport.http',
'bzrlib.version_info_formats.format_custom',
]
def test_suite(keep_only=None, starting_with=None):
"""Build and return TestSuite for the whole of bzrlib.
:param keep_only: A list of test ids limiting the suite returned.
:param starting_with: An id limiting the suite returned to the tests
starting with it.
This function can be replaced if you need to change the default test
suite on a global basis, but it is not encouraged.
"""
loader = TestUtil.TestLoader()
if keep_only is not None:
id_filter = TestIdList(keep_only)
if starting_with:
# We take precedence over keep_only because *at loading time* using
# both options means we will load less tests for the same final result.
def interesting_module(name):
for start in starting_with:
if (
# Either the module name starts with the specified string
name.startswith(start)
# or it may contain tests starting with the specified string
or start.startswith(name)
):
return True
return False
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
elif keep_only is not None:
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
def interesting_module(name):
return id_filter.refers_to(name)
else:
loader = TestUtil.TestLoader()
def interesting_module(name):
# No filtering, all modules are interesting
return True
suite = loader.suiteClass()
# modules building their suite with loadTestsFromModuleNames
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
for mod in _test_suite_modules_to_doctest():
if not interesting_module(mod):
# No tests to keep here, move along
continue
try:
# note that this really does mean "report only" -- doctest
# still runs the rest of the examples
doc_suite = IsolatedDocTestSuite(
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
except ValueError, e:
print '**failed to get doctest for: %s\n%s' % (mod, e)
raise
if len(doc_suite._tests) == 0:
raise errors.BzrError("no doctests found in %s" % (mod,))
suite.addTest(doc_suite)
default_encoding = sys.getdefaultencoding()
for name, plugin in _mod_plugin.plugins().items():
if not interesting_module(plugin.module.__name__):
continue
plugin_suite = plugin.test_suite()
# We used to catch ImportError here and turn it into just a warning,
# but really if you don't have --no-plugins this should be a failure.
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
if plugin_suite is None:
plugin_suite = plugin.load_plugin_tests(loader)
if plugin_suite is not None:
suite.addTest(plugin_suite)
if default_encoding != sys.getdefaultencoding():
trace.warning(
'Plugin "%s" tried to reset default encoding to: %s', name,
sys.getdefaultencoding())
reload(sys)
sys.setdefaultencoding(default_encoding)
if keep_only is not None:
# Now that the referred modules have loaded their tests, keep only the
# requested ones.
suite = filter_suite_by_id_list(suite, id_filter)
# Do some sanity checks on the id_list filtering
not_found, duplicates = suite_matches_id_list(suite, keep_only)
if starting_with:
# The tester has used both keep_only and starting_with, so he is
# already aware that some tests are excluded from the list, there
# is no need to tell him which.
pass
else:
# Some tests mentioned in the list are not in the test suite. The
# list may be out of date, report to the tester.
for id in not_found:
trace.warning('"%s" not found in the test suite', id)
for id in duplicates:
trace.warning('"%s" is used as an id by several tests', id)
return suite
def multiply_scenarios(*scenarios):
"""Multiply two or more iterables of scenarios.
It is safe to pass scenario generators or iterators.
:returns: A list of compound scenarios: the cross-product of all
scenarios, with the names concatenated and the parameters
merged together.
"""
return reduce(_multiply_two_scenarios, map(list, scenarios))
def _multiply_two_scenarios(scenarios_left, scenarios_right):
"""Multiply two sets of scenarios.
:returns: the cartesian product of the two sets of scenarios, that is
a scenario for every possible combination of a left scenario and a
right scenario.
"""
return [
('%s,%s' % (left_name, right_name),
dict(left_dict.items() + right_dict.items()))
for left_name, left_dict in scenarios_left
for right_name, right_dict in scenarios_right]
def multiply_tests(tests, scenarios, result):
"""Multiply tests_list by scenarios into result.
This is the core workhorse for test parameterisation.
Typically the load_tests() method for a per-implementation test suite will
call multiply_tests and return the result.
:param tests: The tests to parameterise.
:param scenarios: The scenarios to apply: pairs of (scenario_name,
scenario_param_dict).
:param result: A TestSuite to add created tests to.
This returns the passed in result TestSuite with the cross product of all
the tests repeated once for each scenario. Each test is adapted by adding
the scenario name at the end of its id(), and updating the test object's
__dict__ with the scenario_param_dict.
>>> import bzrlib.tests.test_sampler
>>> r = multiply_tests(
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
... [('one', dict(param=1)),
... ('two', dict(param=2))],
... TestUtil.TestSuite())
>>> tests = list(iter_suite_tests(r))
>>> len(tests)
2
>>> tests[0].id()
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
>>> tests[0].param
1
>>> tests[1].param
2
"""
for test in iter_suite_tests(tests):
apply_scenarios(test, scenarios, result)
return result
def apply_scenarios(test, scenarios, result):
"""Apply the scenarios in scenarios to test and add to result.
:param test: The test to apply scenarios to.
:param scenarios: An iterable of scenarios to apply to test.
:return: result
:seealso: apply_scenario
"""
for scenario in scenarios:
result.addTest(apply_scenario(test, scenario))
return result
def apply_scenario(test, scenario):
"""Copy test and apply scenario to it.
:param test: A test to adapt.
:param scenario: A tuple describing the scenarion.
The first element of the tuple is the new test id.
The second element is a dict containing attributes to set on the
test.
:return: The adapted test.
"""
new_id = "%s(%s)" % (test.id(), scenario[0])
new_test = clone_test(test, new_id)
for name, value in scenario[1].items():
setattr(new_test, name, value)
return new_test
def clone_test(test, new_id):
"""Clone a test giving it a new id.
:param test: The test to clone.
:param new_id: The id to assign to it.
:return: The new test.
"""
new_test = copy.copy(test)
new_test.id = lambda: new_id
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
# causes cloned tests to share the 'details' dict. This makes it hard to
# read the test output for parameterized tests, because tracebacks will be
# associated with irrelevant tests.
try:
details = new_test._TestCase__details
except AttributeError:
# must be a different version of testtools than expected. Do nothing.
pass
else:
# Reset the '__details' dict.
new_test._TestCase__details = {}
return new_test
def permute_tests_for_extension(standard_tests, loader, py_module_name,
ext_module_name):
"""Helper for permutating tests against an extension module.
This is meant to be used inside a modules 'load_tests()' function. It will
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
against both implementations. Setting 'test.module' to the appropriate
module. See bzrlib.tests.test__chk_map.load_tests as an example.
:param standard_tests: A test suite to permute
:param loader: A TestLoader
:param py_module_name: The python path to a python module that can always
be loaded, and will be considered the 'python' implementation. (eg
'bzrlib._chk_map_py')
:param ext_module_name: The python path to an extension module. If the
module cannot be loaded, a single test will be added, which notes that
the module is not available. If it can be loaded, all standard_tests
will be run against that module.
:return: (suite, feature) suite is a test-suite that has all the permuted
tests. feature is the Feature object that can be used to determine if
the module is available.
"""
from bzrlib.tests.features import ModuleAvailableFeature
py_module = pyutils.get_named_object(py_module_name)
scenarios = [
('python', {'module': py_module}),
]
suite = loader.suiteClass()
feature = ModuleAvailableFeature(ext_module_name)
if feature.available():
scenarios.append(('C', {'module': feature.module}))
else:
# the compiled module isn't available, so we add a failing test
class FailWithoutFeature(TestCase):
def test_fail(self):
self.requireFeature(feature)
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
result = multiply_tests(standard_tests, scenarios, suite)
return result, feature
def _rmtree_temp_dir(dirname, test_id=None):
# If LANG=C we probably have created some bogus paths
# which rmtree(unicode) will fail to delete
# so make sure we are using rmtree(str) to delete everything
# except on win32, where rmtree(str) will fail
# since it doesn't have the property of byte-stream paths
# (they are either ascii or mbcs)
if sys.platform == 'win32':
# make sure we are using the unicode win32 api
dirname = unicode(dirname)
else:
dirname = dirname.encode(sys.getfilesystemencoding())
try:
osutils.rmtree(dirname)
except OSError, e:
# We don't want to fail here because some useful display will be lost
# otherwise. Polluting the tmp dir is bad, but not giving all the
# possible info to the test runner is even worse.
if test_id != None:
ui.ui_factory.clear_term()
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
# Ugly, but the last thing we want here is fail, so bear with it.
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
).encode('ascii', 'replace')
sys.stderr.write('Unable to remove testing dir %s\n%s'
% (os.path.basename(dirname), printable_e))
def probe_unicode_in_user_encoding():
"""Try to encode several unicode strings to use in unicode-aware tests.
Return first successfull match.
:return: (unicode value, encoded plain string value) or (None, None)
"""
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
for uni_val in possible_vals:
try:
str_val = uni_val.encode(osutils.get_user_encoding())
except UnicodeEncodeError:
# Try a different character
pass
else:
return uni_val, str_val
return None, None
def probe_bad_non_ascii(encoding):
"""Try to find [bad] character with code [128..255]
that cannot be decoded to unicode in some encoding.
Return None if all non-ascii characters is valid
for given encoding.
"""
for i in xrange(128, 256):
char = chr(i)
try:
char.decode(encoding)
except UnicodeDecodeError:
return char
return None
# Only define SubUnitBzrRunner if subunit is available.
try:
from subunit import TestProtocolClient
from subunit.test_results import AutoTimingTestResultDecorator
class SubUnitBzrProtocolClient(TestProtocolClient):
def addSuccess(self, test, details=None):
# The subunit client always includes the details in the subunit
# stream, but we don't want to include it in ours.
if details is not None and 'log' in details:
del details['log']
return super(SubUnitBzrProtocolClient, self).addSuccess(
test, details)
class SubUnitBzrRunner(TextTestRunner):
def run(self, test):
result = AutoTimingTestResultDecorator(
SubUnitBzrProtocolClient(self.stream))
test.run(result)
return result
except ImportError:
pass
@deprecated_function(deprecated_in((2, 5, 0)))
def ModuleAvailableFeature(name):
from bzrlib.tests import features
return features.ModuleAvailableFeature(name)
|