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
|
# 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
"""Tests for Transport implementations.
Transport implementations tested here are supplied by
TransportTestProviderAdapter.
"""
import itertools
import os
from cStringIO import StringIO
from StringIO import StringIO as pyStringIO
import stat
import sys
from bzrlib import (
errors,
osutils,
pyutils,
tests,
transport as _mod_transport,
urlutils,
)
from bzrlib.errors import (ConnectionError,
FileExists,
InvalidURL,
NoSuchFile,
PathError,
TransportNotPossible,
)
from bzrlib.osutils import getcwd
from bzrlib.smart import medium
from bzrlib.tests import (
TestSkipped,
TestNotApplicable,
multiply_tests,
)
from bzrlib.tests import test_server
from bzrlib.tests.test_transport import TestTransportImplementation
from bzrlib.transport import (
ConnectedTransport,
_get_transport_modules,
)
from bzrlib.transport.memory import MemoryTransport
def get_transport_test_permutations(module):
"""Get the permutations module wants to have tested."""
if getattr(module, 'get_test_permutations', None) is None:
raise AssertionError(
"transport module %s doesn't provide get_test_permutations()"
% module.__name__)
return []
return module.get_test_permutations()
def transport_test_permutations():
"""Return a list of the klass, server_factory pairs to test."""
result = []
for module in _get_transport_modules():
try:
permutations = get_transport_test_permutations(
pyutils.get_named_object(module))
for (klass, server_factory) in permutations:
scenario = ('%s,%s' % (klass.__name__, server_factory.__name__),
{"transport_class":klass,
"transport_server":server_factory})
result.append(scenario)
except errors.DependencyNotPresent, e:
# Continue even if a dependency prevents us
# from adding this test
pass
return result
def load_tests(standard_tests, module, loader):
"""Multiply tests for tranport implementations."""
result = loader.suiteClass()
scenarios = transport_test_permutations()
return multiply_tests(standard_tests, scenarios, result)
class TransportTests(TestTransportImplementation):
def setUp(self):
super(TransportTests, self).setUp()
self.overrideEnv('BZR_NO_SMART_VFS', None)
def check_transport_contents(self, content, transport, relpath):
"""Check that transport.get_bytes(relpath) == content."""
self.assertEqualDiff(content, transport.get_bytes(relpath))
def test_ensure_base_missing(self):
""".ensure_base() should create the directory if it doesn't exist"""
t = self.get_transport()
t_a = t.clone('a')
if t_a.is_readonly():
self.assertRaises(TransportNotPossible,
t_a.ensure_base)
return
self.assertTrue(t_a.ensure_base())
self.assertTrue(t.has('a'))
def test_ensure_base_exists(self):
""".ensure_base() should just be happy if it already exists"""
t = self.get_transport()
if t.is_readonly():
return
t.mkdir('a')
t_a = t.clone('a')
# ensure_base returns False if it didn't create the base
self.assertFalse(t_a.ensure_base())
def test_ensure_base_missing_parent(self):
""".ensure_base() will fail if the parent dir doesn't exist"""
t = self.get_transport()
if t.is_readonly():
return
t_a = t.clone('a')
t_b = t_a.clone('b')
self.assertRaises(NoSuchFile, t_b.ensure_base)
def test_external_url(self):
""".external_url either works or raises InProcessTransport."""
t = self.get_transport()
try:
t.external_url()
except errors.InProcessTransport:
pass
def test_has(self):
t = self.get_transport()
files = ['a', 'b', 'e', 'g', '%']
self.build_tree(files, transport=t)
self.assertEqual(True, t.has('a'))
self.assertEqual(False, t.has('c'))
self.assertEqual(True, t.has(urlutils.escape('%')))
self.assertEqual(list(t.has_multi(['a', 'b', 'c', 'd',
'e', 'f', 'g', 'h'])),
[True, True, False, False,
True, False, True, False])
self.assertEqual(True, t.has_any(['a', 'b', 'c']))
self.assertEqual(False, t.has_any(['c', 'd', 'f',
urlutils.escape('%%')]))
self.assertEqual(list(t.has_multi(iter(['a', 'b', 'c', 'd',
'e', 'f', 'g', 'h']))),
[True, True, False, False,
True, False, True, False])
self.assertEqual(False, t.has_any(['c', 'c', 'c']))
self.assertEqual(True, t.has_any(['b', 'b', 'b']))
def test_has_root_works(self):
if self.transport_server is test_server.SmartTCPServer_for_testing:
raise TestNotApplicable(
"SmartTCPServer_for_testing intentionally does not allow "
"access to /.")
current_transport = self.get_transport()
self.assertTrue(current_transport.has('/'))
root = current_transport.clone('/')
self.assertTrue(root.has(''))
def test_get(self):
t = self.get_transport()
files = ['a', 'b', 'e', 'g']
contents = ['contents of a\n',
'contents of b\n',
'contents of e\n',
'contents of g\n',
]
self.build_tree(files, transport=t, line_endings='binary')
self.check_transport_contents('contents of a\n', t, 'a')
content_f = t.get_multi(files)
# Use itertools.izip() instead of use zip() or map(), since they fully
# evaluate their inputs, the transport requests should be issued and
# handled sequentially (we don't want to force transport to buffer).
for content, f in itertools.izip(contents, content_f):
self.assertEqual(content, f.read())
content_f = t.get_multi(iter(files))
# Use itertools.izip() for the same reason
for content, f in itertools.izip(contents, content_f):
self.assertEqual(content, f.read())
def test_get_unknown_file(self):
t = self.get_transport()
files = ['a', 'b']
contents = ['contents of a\n',
'contents of b\n',
]
self.build_tree(files, transport=t, line_endings='binary')
self.assertRaises(NoSuchFile, t.get, 'c')
def iterate_and_close(func, *args):
for f in func(*args):
# We call f.read() here because things like paramiko actually
# spawn a thread to prefetch the content, which we want to
# consume before we close the handle.
content = f.read()
f.close()
self.assertRaises(NoSuchFile, iterate_and_close,
t.get_multi, ['a', 'b', 'c'])
self.assertRaises(NoSuchFile, iterate_and_close,
t.get_multi, iter(['a', 'b', 'c']))
def test_get_directory_read_gives_ReadError(self):
"""consistent errors for read() on a file returned by get()."""
t = self.get_transport()
if t.is_readonly():
self.build_tree(['a directory/'])
else:
t.mkdir('a%20directory')
# getting the file must either work or fail with a PathError
try:
a_file = t.get('a%20directory')
except (errors.PathError, errors.RedirectRequested):
# early failure return immediately.
return
# having got a file, read() must either work (i.e. http reading a dir
# listing) or fail with ReadError
try:
a_file.read()
except errors.ReadError:
pass
def test_get_bytes(self):
t = self.get_transport()
files = ['a', 'b', 'e', 'g']
contents = ['contents of a\n',
'contents of b\n',
'contents of e\n',
'contents of g\n',
]
self.build_tree(files, transport=t, line_endings='binary')
self.check_transport_contents('contents of a\n', t, 'a')
for content, fname in zip(contents, files):
self.assertEqual(content, t.get_bytes(fname))
def test_get_bytes_unknown_file(self):
t = self.get_transport()
self.assertRaises(NoSuchFile, t.get_bytes, 'c')
def test_get_with_open_write_stream_sees_all_content(self):
t = self.get_transport()
if t.is_readonly():
return
handle = t.open_write_stream('foo')
try:
handle.write('b')
self.assertEqual('b', t.get_bytes('foo'))
finally:
handle.close()
def test_get_bytes_with_open_write_stream_sees_all_content(self):
t = self.get_transport()
if t.is_readonly():
return
handle = t.open_write_stream('foo')
try:
handle.write('b')
self.assertEqual('b', t.get_bytes('foo'))
f = t.get('foo')
try:
self.assertEqual('b', f.read())
finally:
f.close()
finally:
handle.close()
def test_put_bytes(self):
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.put_bytes, 'a', 'some text for a\n')
return
t.put_bytes('a', 'some text for a\n')
self.assertTrue(t.has('a'))
self.check_transport_contents('some text for a\n', t, 'a')
# The contents should be overwritten
t.put_bytes('a', 'new text for a\n')
self.check_transport_contents('new text for a\n', t, 'a')
self.assertRaises(NoSuchFile,
t.put_bytes, 'path/doesnt/exist/c', 'contents')
def test_put_bytes_non_atomic(self):
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.put_bytes_non_atomic, 'a', 'some text for a\n')
return
self.assertFalse(t.has('a'))
t.put_bytes_non_atomic('a', 'some text for a\n')
self.assertTrue(t.has('a'))
self.check_transport_contents('some text for a\n', t, 'a')
# Put also replaces contents
t.put_bytes_non_atomic('a', 'new\ncontents for\na\n')
self.check_transport_contents('new\ncontents for\na\n', t, 'a')
# Make sure we can create another file
t.put_bytes_non_atomic('d', 'contents for\nd\n')
# And overwrite 'a' with empty contents
t.put_bytes_non_atomic('a', '')
self.check_transport_contents('contents for\nd\n', t, 'd')
self.check_transport_contents('', t, 'a')
self.assertRaises(NoSuchFile, t.put_bytes_non_atomic, 'no/such/path',
'contents\n')
# Now test the create_parent flag
self.assertRaises(NoSuchFile, t.put_bytes_non_atomic, 'dir/a',
'contents\n')
self.assertFalse(t.has('dir/a'))
t.put_bytes_non_atomic('dir/a', 'contents for dir/a\n',
create_parent_dir=True)
self.check_transport_contents('contents for dir/a\n', t, 'dir/a')
# But we still get NoSuchFile if we can't make the parent dir
self.assertRaises(NoSuchFile, t.put_bytes_non_atomic, 'not/there/a',
'contents\n',
create_parent_dir=True)
def test_put_bytes_permissions(self):
t = self.get_transport()
if t.is_readonly():
return
if not t._can_roundtrip_unix_modebits():
# Can't roundtrip, so no need to run this test
return
t.put_bytes('mode644', 'test text\n', mode=0644)
self.assertTransportMode(t, 'mode644', 0644)
t.put_bytes('mode666', 'test text\n', mode=0666)
self.assertTransportMode(t, 'mode666', 0666)
t.put_bytes('mode600', 'test text\n', mode=0600)
self.assertTransportMode(t, 'mode600', 0600)
# Yes, you can put_bytes a file such that it becomes readonly
t.put_bytes('mode400', 'test text\n', mode=0400)
self.assertTransportMode(t, 'mode400', 0400)
# The default permissions should be based on the current umask
umask = osutils.get_umask()
t.put_bytes('nomode', 'test text\n', mode=None)
self.assertTransportMode(t, 'nomode', 0666 & ~umask)
def test_put_bytes_non_atomic_permissions(self):
t = self.get_transport()
if t.is_readonly():
return
if not t._can_roundtrip_unix_modebits():
# Can't roundtrip, so no need to run this test
return
t.put_bytes_non_atomic('mode644', 'test text\n', mode=0644)
self.assertTransportMode(t, 'mode644', 0644)
t.put_bytes_non_atomic('mode666', 'test text\n', mode=0666)
self.assertTransportMode(t, 'mode666', 0666)
t.put_bytes_non_atomic('mode600', 'test text\n', mode=0600)
self.assertTransportMode(t, 'mode600', 0600)
t.put_bytes_non_atomic('mode400', 'test text\n', mode=0400)
self.assertTransportMode(t, 'mode400', 0400)
# The default permissions should be based on the current umask
umask = osutils.get_umask()
t.put_bytes_non_atomic('nomode', 'test text\n', mode=None)
self.assertTransportMode(t, 'nomode', 0666 & ~umask)
# We should also be able to set the mode for a parent directory
# when it is created
t.put_bytes_non_atomic('dir700/mode664', 'test text\n', mode=0664,
dir_mode=0700, create_parent_dir=True)
self.assertTransportMode(t, 'dir700', 0700)
t.put_bytes_non_atomic('dir770/mode664', 'test text\n', mode=0664,
dir_mode=0770, create_parent_dir=True)
self.assertTransportMode(t, 'dir770', 0770)
t.put_bytes_non_atomic('dir777/mode664', 'test text\n', mode=0664,
dir_mode=0777, create_parent_dir=True)
self.assertTransportMode(t, 'dir777', 0777)
def test_put_file(self):
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.put_file, 'a', StringIO('some text for a\n'))
return
result = t.put_file('a', StringIO('some text for a\n'))
# put_file returns the length of the data written
self.assertEqual(16, result)
self.assertTrue(t.has('a'))
self.check_transport_contents('some text for a\n', t, 'a')
# Put also replaces contents
result = t.put_file('a', StringIO('new\ncontents for\na\n'))
self.assertEqual(19, result)
self.check_transport_contents('new\ncontents for\na\n', t, 'a')
self.assertRaises(NoSuchFile,
t.put_file, 'path/doesnt/exist/c',
StringIO('contents'))
def test_put_file_non_atomic(self):
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.put_file_non_atomic, 'a', StringIO('some text for a\n'))
return
self.assertFalse(t.has('a'))
t.put_file_non_atomic('a', StringIO('some text for a\n'))
self.assertTrue(t.has('a'))
self.check_transport_contents('some text for a\n', t, 'a')
# Put also replaces contents
t.put_file_non_atomic('a', StringIO('new\ncontents for\na\n'))
self.check_transport_contents('new\ncontents for\na\n', t, 'a')
# Make sure we can create another file
t.put_file_non_atomic('d', StringIO('contents for\nd\n'))
# And overwrite 'a' with empty contents
t.put_file_non_atomic('a', StringIO(''))
self.check_transport_contents('contents for\nd\n', t, 'd')
self.check_transport_contents('', t, 'a')
self.assertRaises(NoSuchFile, t.put_file_non_atomic, 'no/such/path',
StringIO('contents\n'))
# Now test the create_parent flag
self.assertRaises(NoSuchFile, t.put_file_non_atomic, 'dir/a',
StringIO('contents\n'))
self.assertFalse(t.has('dir/a'))
t.put_file_non_atomic('dir/a', StringIO('contents for dir/a\n'),
create_parent_dir=True)
self.check_transport_contents('contents for dir/a\n', t, 'dir/a')
# But we still get NoSuchFile if we can't make the parent dir
self.assertRaises(NoSuchFile, t.put_file_non_atomic, 'not/there/a',
StringIO('contents\n'),
create_parent_dir=True)
def test_put_file_permissions(self):
t = self.get_transport()
if t.is_readonly():
return
if not t._can_roundtrip_unix_modebits():
# Can't roundtrip, so no need to run this test
return
t.put_file('mode644', StringIO('test text\n'), mode=0644)
self.assertTransportMode(t, 'mode644', 0644)
t.put_file('mode666', StringIO('test text\n'), mode=0666)
self.assertTransportMode(t, 'mode666', 0666)
t.put_file('mode600', StringIO('test text\n'), mode=0600)
self.assertTransportMode(t, 'mode600', 0600)
# Yes, you can put a file such that it becomes readonly
t.put_file('mode400', StringIO('test text\n'), mode=0400)
self.assertTransportMode(t, 'mode400', 0400)
# The default permissions should be based on the current umask
umask = osutils.get_umask()
t.put_file('nomode', StringIO('test text\n'), mode=None)
self.assertTransportMode(t, 'nomode', 0666 & ~umask)
def test_put_file_non_atomic_permissions(self):
t = self.get_transport()
if t.is_readonly():
return
if not t._can_roundtrip_unix_modebits():
# Can't roundtrip, so no need to run this test
return
t.put_file_non_atomic('mode644', StringIO('test text\n'), mode=0644)
self.assertTransportMode(t, 'mode644', 0644)
t.put_file_non_atomic('mode666', StringIO('test text\n'), mode=0666)
self.assertTransportMode(t, 'mode666', 0666)
t.put_file_non_atomic('mode600', StringIO('test text\n'), mode=0600)
self.assertTransportMode(t, 'mode600', 0600)
# Yes, you can put_file_non_atomic a file such that it becomes readonly
t.put_file_non_atomic('mode400', StringIO('test text\n'), mode=0400)
self.assertTransportMode(t, 'mode400', 0400)
# The default permissions should be based on the current umask
umask = osutils.get_umask()
t.put_file_non_atomic('nomode', StringIO('test text\n'), mode=None)
self.assertTransportMode(t, 'nomode', 0666 & ~umask)
# We should also be able to set the mode for a parent directory
# when it is created
sio = StringIO()
t.put_file_non_atomic('dir700/mode664', sio, mode=0664,
dir_mode=0700, create_parent_dir=True)
self.assertTransportMode(t, 'dir700', 0700)
t.put_file_non_atomic('dir770/mode664', sio, mode=0664,
dir_mode=0770, create_parent_dir=True)
self.assertTransportMode(t, 'dir770', 0770)
t.put_file_non_atomic('dir777/mode664', sio, mode=0664,
dir_mode=0777, create_parent_dir=True)
self.assertTransportMode(t, 'dir777', 0777)
def test_put_bytes_unicode(self):
# Expect put_bytes to raise AssertionError or UnicodeEncodeError if
# given unicode "bytes". UnicodeEncodeError doesn't really make sense
# (we don't want to encode unicode here at all, callers should be
# strictly passing bytes to put_bytes), but we allow it for backwards
# compatibility. At some point we should use a specific exception.
# See https://bugs.launchpad.net/bzr/+bug/106898.
t = self.get_transport()
if t.is_readonly():
return
unicode_string = u'\u1234'
self.assertRaises(
(AssertionError, UnicodeEncodeError),
t.put_bytes, 'foo', unicode_string)
def test_put_file_unicode(self):
# Like put_bytes, except with a StringIO.StringIO of a unicode string.
# This situation can happen (and has) if code is careless about the type
# of "string" they initialise/write to a StringIO with. We cannot use
# cStringIO, because it never returns unicode from read.
# Like put_bytes, UnicodeEncodeError isn't quite the right exception to
# raise, but we raise it for hysterical raisins.
t = self.get_transport()
if t.is_readonly():
return
unicode_file = pyStringIO(u'\u1234')
self.assertRaises(UnicodeEncodeError, t.put_file, 'foo', unicode_file)
def test_mkdir(self):
t = self.get_transport()
if t.is_readonly():
# cannot mkdir on readonly transports. We're not testing for
# cache coherency because cache behaviour is not currently
# defined for the transport interface.
self.assertRaises(TransportNotPossible, t.mkdir, '.')
self.assertRaises(TransportNotPossible, t.mkdir, 'new_dir')
self.assertRaises(TransportNotPossible, t.mkdir_multi, ['new_dir'])
self.assertRaises(TransportNotPossible, t.mkdir, 'path/doesnt/exist')
return
# Test mkdir
t.mkdir('dir_a')
self.assertEqual(t.has('dir_a'), True)
self.assertEqual(t.has('dir_b'), False)
t.mkdir('dir_b')
self.assertEqual(t.has('dir_b'), True)
t.mkdir_multi(['dir_c', 'dir_d'])
t.mkdir_multi(iter(['dir_e', 'dir_f']))
self.assertEqual(list(t.has_multi(
['dir_a', 'dir_b', 'dir_c', 'dir_q',
'dir_d', 'dir_e', 'dir_f', 'dir_b'])),
[True, True, True, False,
True, True, True, True])
# we were testing that a local mkdir followed by a transport
# mkdir failed thusly, but given that we * in one process * do not
# concurrently fiddle with disk dirs and then use transport to do
# things, the win here seems marginal compared to the constraint on
# the interface. RBC 20051227
t.mkdir('dir_g')
self.assertRaises(FileExists, t.mkdir, 'dir_g')
# Test get/put in sub-directories
t.put_bytes('dir_a/a', 'contents of dir_a/a')
t.put_file('dir_b/b', StringIO('contents of dir_b/b'))
self.check_transport_contents('contents of dir_a/a', t, 'dir_a/a')
self.check_transport_contents('contents of dir_b/b', t, 'dir_b/b')
# mkdir of a dir with an absent parent
self.assertRaises(NoSuchFile, t.mkdir, 'missing/dir')
def test_mkdir_permissions(self):
t = self.get_transport()
if t.is_readonly():
return
if not t._can_roundtrip_unix_modebits():
# no sense testing on this transport
return
# Test mkdir with a mode
t.mkdir('dmode755', mode=0755)
self.assertTransportMode(t, 'dmode755', 0755)
t.mkdir('dmode555', mode=0555)
self.assertTransportMode(t, 'dmode555', 0555)
t.mkdir('dmode777', mode=0777)
self.assertTransportMode(t, 'dmode777', 0777)
t.mkdir('dmode700', mode=0700)
self.assertTransportMode(t, 'dmode700', 0700)
t.mkdir_multi(['mdmode755'], mode=0755)
self.assertTransportMode(t, 'mdmode755', 0755)
# Default mode should be based on umask
umask = osutils.get_umask()
t.mkdir('dnomode', mode=None)
self.assertTransportMode(t, 'dnomode', 0777 & ~umask)
def test_opening_a_file_stream_creates_file(self):
t = self.get_transport()
if t.is_readonly():
return
handle = t.open_write_stream('foo')
try:
self.assertEqual('', t.get_bytes('foo'))
finally:
handle.close()
def test_opening_a_file_stream_can_set_mode(self):
t = self.get_transport()
if t.is_readonly():
return
if not t._can_roundtrip_unix_modebits():
# Can't roundtrip, so no need to run this test
return
def check_mode(name, mode, expected):
handle = t.open_write_stream(name, mode=mode)
handle.close()
self.assertTransportMode(t, name, expected)
check_mode('mode644', 0644, 0644)
check_mode('mode666', 0666, 0666)
check_mode('mode600', 0600, 0600)
# The default permissions should be based on the current umask
check_mode('nomode', None, 0666 & ~osutils.get_umask())
def test_copy_to(self):
# FIXME: test: same server to same server (partly done)
# same protocol two servers
# and different protocols (done for now except for MemoryTransport.
# - RBC 20060122
def simple_copy_files(transport_from, transport_to):
files = ['a', 'b', 'c', 'd']
self.build_tree(files, transport=transport_from)
self.assertEqual(4, transport_from.copy_to(files, transport_to))
for f in files:
self.check_transport_contents(transport_to.get_bytes(f),
transport_from, f)
t = self.get_transport()
temp_transport = MemoryTransport('memory:///')
simple_copy_files(t, temp_transport)
if not t.is_readonly():
t.mkdir('copy_to_simple')
t2 = t.clone('copy_to_simple')
simple_copy_files(t, t2)
# Test that copying into a missing directory raises
# NoSuchFile
if t.is_readonly():
self.build_tree(['e/', 'e/f'])
else:
t.mkdir('e')
t.put_bytes('e/f', 'contents of e')
self.assertRaises(NoSuchFile, t.copy_to, ['e/f'], temp_transport)
temp_transport.mkdir('e')
t.copy_to(['e/f'], temp_transport)
del temp_transport
temp_transport = MemoryTransport('memory:///')
files = ['a', 'b', 'c', 'd']
t.copy_to(iter(files), temp_transport)
for f in files:
self.check_transport_contents(temp_transport.get_bytes(f),
t, f)
del temp_transport
for mode in (0666, 0644, 0600, 0400):
temp_transport = MemoryTransport("memory:///")
t.copy_to(files, temp_transport, mode=mode)
for f in files:
self.assertTransportMode(temp_transport, f, mode)
def test_create_prefix(self):
t = self.get_transport()
sub = t.clone('foo').clone('bar')
try:
sub.create_prefix()
except TransportNotPossible:
self.assertTrue(t.is_readonly())
else:
self.assertTrue(t.has('foo/bar'))
def test_append_file(self):
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.append_file, 'a', 'add\nsome\nmore\ncontents\n')
return
t.put_bytes('a', 'diff\ncontents for\na\n')
t.put_bytes('b', 'contents\nfor b\n')
self.assertEqual(20,
t.append_file('a', StringIO('add\nsome\nmore\ncontents\n')))
self.check_transport_contents(
'diff\ncontents for\na\nadd\nsome\nmore\ncontents\n',
t, 'a')
# a file with no parent should fail..
self.assertRaises(NoSuchFile,
t.append_file, 'missing/path', StringIO('content'))
# And we can create new files, too
self.assertEqual(0,
t.append_file('c', StringIO('some text\nfor a missing file\n')))
self.check_transport_contents('some text\nfor a missing file\n',
t, 'c')
def test_append_bytes(self):
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.append_bytes, 'a', 'add\nsome\nmore\ncontents\n')
return
self.assertEqual(0, t.append_bytes('a', 'diff\ncontents for\na\n'))
self.assertEqual(0, t.append_bytes('b', 'contents\nfor b\n'))
self.assertEqual(20,
t.append_bytes('a', 'add\nsome\nmore\ncontents\n'))
self.check_transport_contents(
'diff\ncontents for\na\nadd\nsome\nmore\ncontents\n',
t, 'a')
# a file with no parent should fail..
self.assertRaises(NoSuchFile,
t.append_bytes, 'missing/path', 'content')
def test_append_multi(self):
t = self.get_transport()
if t.is_readonly():
return
t.put_bytes('a', 'diff\ncontents for\na\n'
'add\nsome\nmore\ncontents\n')
t.put_bytes('b', 'contents\nfor b\n')
self.assertEqual((43, 15),
t.append_multi([('a', StringIO('and\nthen\nsome\nmore\n')),
('b', StringIO('some\nmore\nfor\nb\n'))]))
self.check_transport_contents(
'diff\ncontents for\na\n'
'add\nsome\nmore\ncontents\n'
'and\nthen\nsome\nmore\n',
t, 'a')
self.check_transport_contents(
'contents\nfor b\n'
'some\nmore\nfor\nb\n',
t, 'b')
self.assertEqual((62, 31),
t.append_multi(iter([('a', StringIO('a little bit more\n')),
('b', StringIO('from an iterator\n'))])))
self.check_transport_contents(
'diff\ncontents for\na\n'
'add\nsome\nmore\ncontents\n'
'and\nthen\nsome\nmore\n'
'a little bit more\n',
t, 'a')
self.check_transport_contents(
'contents\nfor b\n'
'some\nmore\nfor\nb\n'
'from an iterator\n',
t, 'b')
self.assertEqual((80, 0),
t.append_multi([('a', StringIO('some text in a\n')),
('d', StringIO('missing file r\n'))]))
self.check_transport_contents(
'diff\ncontents for\na\n'
'add\nsome\nmore\ncontents\n'
'and\nthen\nsome\nmore\n'
'a little bit more\n'
'some text in a\n',
t, 'a')
self.check_transport_contents('missing file r\n', t, 'd')
def test_append_file_mode(self):
"""Check that append accepts a mode parameter"""
# check append accepts a mode
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.append_file, 'f', StringIO('f'), mode=None)
return
t.append_file('f', StringIO('f'), mode=None)
def test_append_bytes_mode(self):
# check append_bytes accepts a mode
t = self.get_transport()
if t.is_readonly():
self.assertRaises(TransportNotPossible,
t.append_bytes, 'f', 'f', mode=None)
return
t.append_bytes('f', 'f', mode=None)
def test_delete(self):
# TODO: Test Transport.delete
t = self.get_transport()
# Not much to do with a readonly transport
if t.is_readonly():
self.assertRaises(TransportNotPossible, t.delete, 'missing')
return
t.put_bytes('a', 'a little bit of text\n')
self.assertTrue(t.has('a'))
t.delete('a')
self.assertFalse(t.has('a'))
self.assertRaises(NoSuchFile, t.delete, 'a')
t.put_bytes('a', 'a text\n')
t.put_bytes('b', 'b text\n')
t.put_bytes('c', 'c text\n')
self.assertEqual([True, True, True],
list(t.has_multi(['a', 'b', 'c'])))
t.delete_multi(['a', 'c'])
self.assertEqual([False, True, False],
list(t.has_multi(['a', 'b', 'c'])))
self.assertFalse(t.has('a'))
self.assertTrue(t.has('b'))
self.assertFalse(t.has('c'))
self.assertRaises(NoSuchFile,
t.delete_multi, ['a', 'b', 'c'])
self.assertRaises(NoSuchFile,
t.delete_multi, iter(['a', 'b', 'c']))
t.put_bytes('a', 'another a text\n')
t.put_bytes('c', 'another c text\n')
t.delete_multi(iter(['a', 'b', 'c']))
# We should have deleted everything
# SftpServer creates control files in the
# working directory, so we can just do a
# plain "listdir".
# self.assertEqual([], os.listdir('.'))
def test_recommended_page_size(self):
"""Transports recommend a page size for partial access to files."""
t = self.get_transport()
self.assertIsInstance(t.recommended_page_size(), int)
def test_rmdir(self):
t = self.get_transport()
# Not much to do with a readonly transport
if t.is_readonly():
self.assertRaises(TransportNotPossible, t.rmdir, 'missing')
return
t.mkdir('adir')
t.mkdir('adir/bdir')
t.rmdir('adir/bdir')
# ftp may not be able to raise NoSuchFile for lack of
# details when failing
self.assertRaises((NoSuchFile, PathError), t.rmdir, 'adir/bdir')
t.rmdir('adir')
self.assertRaises((NoSuchFile, PathError), t.rmdir, 'adir')
def test_rmdir_not_empty(self):
"""Deleting a non-empty directory raises an exception
sftp (and possibly others) don't give us a specific "directory not
empty" exception -- we can just see that the operation failed.
"""
t = self.get_transport()
if t.is_readonly():
return
t.mkdir('adir')
t.mkdir('adir/bdir')
self.assertRaises(PathError, t.rmdir, 'adir')
def test_rmdir_empty_but_similar_prefix(self):
"""rmdir does not get confused by sibling paths.
A naive implementation of MemoryTransport would refuse to rmdir
".bzr/branch" if there is a ".bzr/branch-format" directory, because it
uses "path.startswith(dir)" on all file paths to determine if directory
is empty.
"""
t = self.get_transport()
if t.is_readonly():
return
t.mkdir('foo')
t.put_bytes('foo-bar', '')
t.mkdir('foo-baz')
t.rmdir('foo')
self.assertRaises((NoSuchFile, PathError), t.rmdir, 'foo')
self.assertTrue(t.has('foo-bar'))
def test_rename_dir_succeeds(self):
t = self.get_transport()
if t.is_readonly():
raise TestSkipped("transport is readonly")
t.mkdir('adir')
t.mkdir('adir/asubdir')
t.rename('adir', 'bdir')
self.assertTrue(t.has('bdir/asubdir'))
self.assertFalse(t.has('adir'))
def test_rename_dir_nonempty(self):
"""Attempting to replace a nonemtpy directory should fail"""
t = self.get_transport()
if t.is_readonly():
raise TestSkipped("transport is readonly")
t.mkdir('adir')
t.mkdir('adir/asubdir')
t.mkdir('bdir')
t.mkdir('bdir/bsubdir')
# any kind of PathError would be OK, though we normally expect
# DirectoryNotEmpty
self.assertRaises(PathError, t.rename, 'bdir', 'adir')
# nothing was changed so it should still be as before
self.assertTrue(t.has('bdir/bsubdir'))
self.assertFalse(t.has('adir/bdir'))
self.assertFalse(t.has('adir/bsubdir'))
def test_rename_across_subdirs(self):
t = self.get_transport()
if t.is_readonly():
raise TestNotApplicable("transport is readonly")
t.mkdir('a')
t.mkdir('b')
ta = t.clone('a')
tb = t.clone('b')
ta.put_bytes('f', 'aoeu')
ta.rename('f', '../b/f')
self.assertTrue(tb.has('f'))
self.assertFalse(ta.has('f'))
self.assertTrue(t.has('b/f'))
def test_delete_tree(self):
t = self.get_transport()
# Not much to do with a readonly transport
if t.is_readonly():
self.assertRaises(TransportNotPossible, t.delete_tree, 'missing')
return
# and does it like listing ?
t.mkdir('adir')
try:
t.delete_tree('adir')
except TransportNotPossible:
# ok, this transport does not support delete_tree
return
# did it delete that trivial case?
self.assertRaises(NoSuchFile, t.stat, 'adir')
self.build_tree(['adir/',
'adir/file',
'adir/subdir/',
'adir/subdir/file',
'adir/subdir2/',
'adir/subdir2/file',
], transport=t)
t.delete_tree('adir')
# adir should be gone now.
self.assertRaises(NoSuchFile, t.stat, 'adir')
def test_move(self):
t = self.get_transport()
if t.is_readonly():
return
# TODO: I would like to use os.listdir() to
# make sure there are no extra files, but SftpServer
# creates control files in the working directory
# perhaps all of this could be done in a subdirectory
t.put_bytes('a', 'a first file\n')
self.assertEquals([True, False], list(t.has_multi(['a', 'b'])))
t.move('a', 'b')
self.assertTrue(t.has('b'))
self.assertFalse(t.has('a'))
self.check_transport_contents('a first file\n', t, 'b')
self.assertEquals([False, True], list(t.has_multi(['a', 'b'])))
# Overwrite a file
t.put_bytes('c', 'c this file\n')
t.move('c', 'b')
self.assertFalse(t.has('c'))
self.check_transport_contents('c this file\n', t, 'b')
# TODO: Try to write a test for atomicity
# TODO: Test moving into a non-existent subdirectory
# TODO: Test Transport.move_multi
def test_copy(self):
t = self.get_transport()
if t.is_readonly():
return
t.put_bytes('a', 'a file\n')
t.copy('a', 'b')
self.check_transport_contents('a file\n', t, 'b')
self.assertRaises(NoSuchFile, t.copy, 'c', 'd')
os.mkdir('c')
# What should the assert be if you try to copy a
# file over a directory?
#self.assertRaises(Something, t.copy, 'a', 'c')
t.put_bytes('d', 'text in d\n')
t.copy('d', 'b')
self.check_transport_contents('text in d\n', t, 'b')
# TODO: test copy_multi
def test_connection_error(self):
"""ConnectionError is raised when connection is impossible.
The error should be raised from the first operation on the transport.
"""
try:
url = self._server.get_bogus_url()
except NotImplementedError:
raise TestSkipped("Transport %s has no bogus URL support." %
self._server.__class__)
t = _mod_transport.get_transport(url)
self.assertRaises((ConnectionError, NoSuchFile), t.get, '.bzr/branch')
def test_stat(self):
# TODO: Test stat, just try once, and if it throws, stop testing
from stat import S_ISDIR, S_ISREG
t = self.get_transport()
try:
st = t.stat('.')
except TransportNotPossible, e:
# This transport cannot stat
return
paths = ['a', 'b/', 'b/c', 'b/d/', 'b/d/e']
sizes = [14, 0, 16, 0, 18]
self.build_tree(paths, transport=t, line_endings='binary')
for path, size in zip(paths, sizes):
st = t.stat(path)
if path.endswith('/'):
self.assertTrue(S_ISDIR(st.st_mode))
# directory sizes are meaningless
else:
self.assertTrue(S_ISREG(st.st_mode))
self.assertEqual(size, st.st_size)
remote_stats = list(t.stat_multi(paths))
remote_iter_stats = list(t.stat_multi(iter(paths)))
self.assertRaises(NoSuchFile, t.stat, 'q')
self.assertRaises(NoSuchFile, t.stat, 'b/a')
self.assertListRaises(NoSuchFile, t.stat_multi, ['a', 'c', 'd'])
self.assertListRaises(NoSuchFile, t.stat_multi, iter(['a', 'c', 'd']))
self.build_tree(['subdir/', 'subdir/file'], transport=t)
subdir = t.clone('subdir')
st = subdir.stat('./file')
st = subdir.stat('.')
def test_hardlink(self):
from stat import ST_NLINK
t = self.get_transport()
source_name = "original_target"
link_name = "target_link"
self.build_tree([source_name], transport=t)
try:
t.hardlink(source_name, link_name)
self.assertTrue(t.has(source_name))
self.assertTrue(t.has(link_name))
st = t.stat(link_name)
self.assertEqual(st[ST_NLINK], 2)
except TransportNotPossible:
raise TestSkipped("Transport %s does not support hardlinks." %
self._server.__class__)
def test_symlink(self):
from stat import S_ISLNK
t = self.get_transport()
source_name = "original_target"
link_name = "target_link"
self.build_tree([source_name], transport=t)
try:
t.symlink(source_name, link_name)
self.assertTrue(t.has(source_name))
self.assertTrue(t.has(link_name))
st = t.stat(link_name)
self.assertTrue(S_ISLNK(st.st_mode),
"expected symlink, got mode %o" % st.st_mode)
except TransportNotPossible:
raise TestSkipped("Transport %s does not support symlinks." %
self._server.__class__)
except IOError:
raise tests.KnownFailure("Paramiko fails to create symlinks during tests")
def test_list_dir(self):
# TODO: Test list_dir, just try once, and if it throws, stop testing
t = self.get_transport()
if not t.listable():
self.assertRaises(TransportNotPossible, t.list_dir, '.')
return
def sorted_list(d, transport):
l = list(transport.list_dir(d))
l.sort()
return l
self.assertEqual([], sorted_list('.', t))
# c2 is precisely one letter longer than c here to test that
# suffixing is not confused.
# a%25b checks that quoting is done consistently across transports
tree_names = ['a', 'a%25b', 'b', 'c/', 'c/d', 'c/e', 'c2/']
if not t.is_readonly():
self.build_tree(tree_names, transport=t)
else:
self.build_tree(tree_names)
self.assertEqual(
['a', 'a%2525b', 'b', 'c', 'c2'], sorted_list('', t))
self.assertEqual(
['a', 'a%2525b', 'b', 'c', 'c2'], sorted_list('.', t))
self.assertEqual(['d', 'e'], sorted_list('c', t))
# Cloning the transport produces an equivalent listing
self.assertEqual(['d', 'e'], sorted_list('', t.clone('c')))
if not t.is_readonly():
t.delete('c/d')
t.delete('b')
else:
os.unlink('c/d')
os.unlink('b')
self.assertEqual(['a', 'a%2525b', 'c', 'c2'], sorted_list('.', t))
self.assertEqual(['e'], sorted_list('c', t))
self.assertListRaises(PathError, t.list_dir, 'q')
self.assertListRaises(PathError, t.list_dir, 'c/f')
# 'a' is a file, list_dir should raise an error
self.assertListRaises(PathError, t.list_dir, 'a')
def test_list_dir_result_is_url_escaped(self):
t = self.get_transport()
if not t.listable():
raise TestSkipped("transport not listable")
if not t.is_readonly():
self.build_tree(['a/', 'a/%'], transport=t)
else:
self.build_tree(['a/', 'a/%'])
names = list(t.list_dir('a'))
self.assertEqual(['%25'], names)
self.assertIsInstance(names[0], str)
def test_clone_preserve_info(self):
t1 = self.get_transport()
if not isinstance(t1, ConnectedTransport):
raise TestSkipped("not a connected transport")
t2 = t1.clone('subdir')
self.assertEquals(t1._scheme, t2._scheme)
self.assertEquals(t1._user, t2._user)
self.assertEquals(t1._password, t2._password)
self.assertEquals(t1._host, t2._host)
self.assertEquals(t1._port, t2._port)
def test__reuse_for(self):
t = self.get_transport()
if not isinstance(t, ConnectedTransport):
raise TestSkipped("not a connected transport")
def new_url(scheme=None, user=None, password=None,
host=None, port=None, path=None):
"""Build a new url from t.base changing only parts of it.
Only the parameters different from None will be changed.
"""
if scheme is None: scheme = t._scheme
if user is None: user = t._user
if password is None: password = t._password
if user is None: user = t._user
if host is None: host = t._host
if port is None: port = t._port
if path is None: path = t._path
return t._unsplit_url(scheme, user, password, host, port, path)
if t._scheme == 'ftp':
scheme = 'sftp'
else:
scheme = 'ftp'
self.assertIsNot(t, t._reuse_for(new_url(scheme=scheme)))
if t._user == 'me':
user = 'you'
else:
user = 'me'
self.assertIsNot(t, t._reuse_for(new_url(user=user)))
# passwords are not taken into account because:
# - it makes no sense to have two different valid passwords for the
# same user
# - _password in ConnectedTransport is intended to collect what the
# user specified from the command-line and there are cases where the
# new url can contain no password (if the url was built from an
# existing transport.base for example)
# - password are considered part of the credentials provided at
# connection creation time and as such may not be present in the url
# (they may be typed by the user when prompted for example)
self.assertIs(t, t._reuse_for(new_url(password='from space')))
# We will not connect, we can use a invalid host
self.assertIsNot(t, t._reuse_for(new_url(host=t._host + 'bar')))
if t._port == 1234:
port = 4321
else:
port = 1234
self.assertIsNot(t, t._reuse_for(new_url(port=port)))
# No point in trying to reuse a transport for a local URL
self.assertIs(None, t._reuse_for('/valid_but_not_existing'))
def test_connection_sharing(self):
t = self.get_transport()
if not isinstance(t, ConnectedTransport):
raise TestSkipped("not a connected transport")
c = t.clone('subdir')
# Some transports will create the connection only when needed
t.has('surely_not') # Force connection
self.assertIs(t._get_connection(), c._get_connection())
# Temporary failure, we need to create a new dummy connection
new_connection = None
t._set_connection(new_connection)
# Check that both transports use the same connection
self.assertIs(new_connection, t._get_connection())
self.assertIs(new_connection, c._get_connection())
def test_reuse_connection_for_various_paths(self):
t = self.get_transport()
if not isinstance(t, ConnectedTransport):
raise TestSkipped("not a connected transport")
t.has('surely_not') # Force connection
self.assertIsNot(None, t._get_connection())
subdir = t._reuse_for(t.base + 'whatever/but/deep/down/the/path')
self.assertIsNot(t, subdir)
self.assertIs(t._get_connection(), subdir._get_connection())
home = subdir._reuse_for(t.base + 'home')
self.assertIs(t._get_connection(), home._get_connection())
self.assertIs(subdir._get_connection(), home._get_connection())
def test_clone(self):
# TODO: Test that clone moves up and down the filesystem
t1 = self.get_transport()
self.build_tree(['a', 'b/', 'b/c'], transport=t1)
self.assertTrue(t1.has('a'))
self.assertTrue(t1.has('b/c'))
self.assertFalse(t1.has('c'))
t2 = t1.clone('b')
self.assertEqual(t1.base + 'b/', t2.base)
self.assertTrue(t2.has('c'))
self.assertFalse(t2.has('a'))
t3 = t2.clone('..')
self.assertTrue(t3.has('a'))
self.assertFalse(t3.has('c'))
self.assertFalse(t1.has('b/d'))
self.assertFalse(t2.has('d'))
self.assertFalse(t3.has('b/d'))
if t1.is_readonly():
self.build_tree_contents([('b/d', 'newfile\n')])
else:
t2.put_bytes('d', 'newfile\n')
self.assertTrue(t1.has('b/d'))
self.assertTrue(t2.has('d'))
self.assertTrue(t3.has('b/d'))
def test_clone_to_root(self):
orig_transport = self.get_transport()
# Repeatedly go up to a parent directory until we're at the root
# directory of this transport
root_transport = orig_transport
new_transport = root_transport.clone("..")
# as we are walking up directories, the path must be
# growing less, except at the top
self.assertTrue(len(new_transport.base) < len(root_transport.base)
or new_transport.base == root_transport.base)
while new_transport.base != root_transport.base:
root_transport = new_transport
new_transport = root_transport.clone("..")
# as we are walking up directories, the path must be
# growing less, except at the top
self.assertTrue(len(new_transport.base) < len(root_transport.base)
or new_transport.base == root_transport.base)
# Cloning to "/" should take us to exactly the same location.
self.assertEqual(root_transport.base, orig_transport.clone("/").base)
# the abspath of "/" from the original transport should be the same
# as the base at the root:
self.assertEqual(orig_transport.abspath("/"), root_transport.base)
# At the root, the URL must still end with / as its a directory
self.assertEqual(root_transport.base[-1], '/')
def test_clone_from_root(self):
"""At the root, cloning to a simple dir should just do string append."""
orig_transport = self.get_transport()
root_transport = orig_transport.clone('/')
self.assertEqual(root_transport.base + '.bzr/',
root_transport.clone('.bzr').base)
def test_base_url(self):
t = self.get_transport()
self.assertEqual('/', t.base[-1])
def test_relpath(self):
t = self.get_transport()
self.assertEqual('', t.relpath(t.base))
# base ends with /
self.assertEqual('', t.relpath(t.base[:-1]))
# subdirs which don't exist should still give relpaths.
self.assertEqual('foo', t.relpath(t.base + 'foo'))
# trailing slash should be the same.
self.assertEqual('foo', t.relpath(t.base + 'foo/'))
def test_relpath_at_root(self):
t = self.get_transport()
# clone all the way to the top
new_transport = t.clone('..')
while new_transport.base != t.base:
t = new_transport
new_transport = t.clone('..')
# we must be able to get a relpath below the root
self.assertEqual('', t.relpath(t.base))
# and a deeper one should work too
self.assertEqual('foo/bar', t.relpath(t.base + 'foo/bar'))
def test_abspath(self):
# smoke test for abspath. Corner cases for backends like unix fs's
# that have aliasing problems like symlinks should go in backend
# specific test cases.
transport = self.get_transport()
self.assertEqual(transport.base + 'relpath',
transport.abspath('relpath'))
# This should work without raising an error.
transport.abspath("/")
# the abspath of "/" and "/foo/.." should result in the same location
self.assertEqual(transport.abspath("/"), transport.abspath("/foo/.."))
self.assertEqual(transport.clone("/").abspath('foo'),
transport.abspath("/foo"))
# GZ 2011-01-26: Test in per_transport but not using self.get_transport?
def test_win32_abspath(self):
# Note: we tried to set sys.platform='win32' so we could test on
# other platforms too, but then osutils does platform specific
# things at import time which defeated us...
if sys.platform != 'win32':
raise TestSkipped(
'Testing drive letters in abspath implemented only for win32')
# smoke test for abspath on win32.
# a transport based on 'file:///' never fully qualifies the drive.
transport = _mod_transport.get_transport("file:///")
self.assertEqual(transport.abspath("/"), "file:///")
# but a transport that starts with a drive spec must keep it.
transport = _mod_transport.get_transport("file:///C:/")
self.assertEqual(transport.abspath("/"), "file:///C:/")
def test_local_abspath(self):
transport = self.get_transport()
try:
p = transport.local_abspath('.')
except (errors.NotLocalUrl, TransportNotPossible), e:
# should be formattable
s = str(e)
else:
self.assertEqual(getcwd(), p)
def test_abspath_at_root(self):
t = self.get_transport()
# clone all the way to the top
new_transport = t.clone('..')
while new_transport.base != t.base:
t = new_transport
new_transport = t.clone('..')
# we must be able to get a abspath of the root when we ask for
# t.abspath('..') - this due to our choice that clone('..')
# should return the root from the root, combined with the desire that
# the url from clone('..') and from abspath('..') should be the same.
self.assertEqual(t.base, t.abspath('..'))
# '' should give us the root
self.assertEqual(t.base, t.abspath(''))
# and a path should append to the url
self.assertEqual(t.base + 'foo', t.abspath('foo'))
def test_iter_files_recursive(self):
transport = self.get_transport()
if not transport.listable():
self.assertRaises(TransportNotPossible,
transport.iter_files_recursive)
return
self.build_tree(['isolated/',
'isolated/dir/',
'isolated/dir/foo',
'isolated/dir/bar',
'isolated/dir/b%25z', # make sure quoting is correct
'isolated/bar'],
transport=transport)
paths = set(transport.iter_files_recursive())
# nb the directories are not converted
self.assertEqual(paths,
set(['isolated/dir/foo',
'isolated/dir/bar',
'isolated/dir/b%2525z',
'isolated/bar']))
sub_transport = transport.clone('isolated')
paths = set(sub_transport.iter_files_recursive())
self.assertEqual(paths,
set(['dir/foo', 'dir/bar', 'dir/b%2525z', 'bar']))
def test_copy_tree(self):
# TODO: test file contents and permissions are preserved. This test was
# added just to ensure that quoting was handled correctly.
# -- David Allouche 2006-08-11
transport = self.get_transport()
if not transport.listable():
self.assertRaises(TransportNotPossible,
transport.iter_files_recursive)
return
if transport.is_readonly():
return
self.build_tree(['from/',
'from/dir/',
'from/dir/foo',
'from/dir/bar',
'from/dir/b%25z', # make sure quoting is correct
'from/bar'],
transport=transport)
transport.copy_tree('from', 'to')
paths = set(transport.iter_files_recursive())
self.assertEqual(paths,
set(['from/dir/foo',
'from/dir/bar',
'from/dir/b%2525z',
'from/bar',
'to/dir/foo',
'to/dir/bar',
'to/dir/b%2525z',
'to/bar',]))
def test_copy_tree_to_transport(self):
transport = self.get_transport()
if not transport.listable():
self.assertRaises(TransportNotPossible,
transport.iter_files_recursive)
return
if transport.is_readonly():
return
self.build_tree(['from/',
'from/dir/',
'from/dir/foo',
'from/dir/bar',
'from/dir/b%25z', # make sure quoting is correct
'from/bar'],
transport=transport)
from_transport = transport.clone('from')
to_transport = transport.clone('to')
to_transport.ensure_base()
from_transport.copy_tree_to_transport(to_transport)
paths = set(transport.iter_files_recursive())
self.assertEqual(paths,
set(['from/dir/foo',
'from/dir/bar',
'from/dir/b%2525z',
'from/bar',
'to/dir/foo',
'to/dir/bar',
'to/dir/b%2525z',
'to/bar',]))
def test_unicode_paths(self):
"""Test that we can read/write files with Unicode names."""
t = self.get_transport()
# With FAT32 and certain encodings on win32
# '\xe5' and '\xe4' actually map to the same file
# adding a suffix kicks in the 'preserving but insensitive'
# route, and maintains the right files
files = [u'\xe5.1', # a w/ circle iso-8859-1
u'\xe4.2', # a w/ dots iso-8859-1
u'\u017d', # Z with umlat iso-8859-2
u'\u062c', # Arabic j
u'\u0410', # Russian A
u'\u65e5', # Kanji person
]
no_unicode_support = getattr(self._server, 'no_unicode_support', False)
if no_unicode_support:
raise tests.KnownFailure("test server cannot handle unicode paths")
try:
self.build_tree(files, transport=t, line_endings='binary')
except UnicodeError:
raise TestSkipped("cannot handle unicode paths in current encoding")
# A plain unicode string is not a valid url
for fname in files:
self.assertRaises(InvalidURL, t.get, fname)
for fname in files:
fname_utf8 = fname.encode('utf-8')
contents = 'contents of %s\n' % (fname_utf8,)
self.check_transport_contents(contents, t, urlutils.escape(fname))
def test_connect_twice_is_same_content(self):
# check that our server (whatever it is) is accessible reliably
# via get_transport and multiple connections share content.
transport = self.get_transport()
if transport.is_readonly():
return
transport.put_bytes('foo', 'bar')
transport3 = self.get_transport()
self.check_transport_contents('bar', transport3, 'foo')
# now opening at a relative url should give use a sane result:
transport.mkdir('newdir')
transport5 = self.get_transport('newdir')
transport6 = transport5.clone('..')
self.check_transport_contents('bar', transport6, 'foo')
def test_lock_write(self):
"""Test transport-level write locks.
These are deprecated and transports may decline to support them.
"""
transport = self.get_transport()
if transport.is_readonly():
self.assertRaises(TransportNotPossible, transport.lock_write, 'foo')
return
transport.put_bytes('lock', '')
try:
lock = transport.lock_write('lock')
except TransportNotPossible:
return
# TODO make this consistent on all platforms:
# self.assertRaises(LockError, transport.lock_write, 'lock')
lock.unlock()
def test_lock_read(self):
"""Test transport-level read locks.
These are deprecated and transports may decline to support them.
"""
transport = self.get_transport()
if transport.is_readonly():
file('lock', 'w').close()
else:
transport.put_bytes('lock', '')
try:
lock = transport.lock_read('lock')
except TransportNotPossible:
return
# TODO make this consistent on all platforms:
# self.assertRaises(LockError, transport.lock_read, 'lock')
lock.unlock()
def test_readv(self):
transport = self.get_transport()
if transport.is_readonly():
file('a', 'w').write('0123456789')
else:
transport.put_bytes('a', '0123456789')
d = list(transport.readv('a', ((0, 1),)))
self.assertEqual(d[0], (0, '0'))
d = list(transport.readv('a', ((0, 1), (1, 1), (3, 2), (9, 1))))
self.assertEqual(d[0], (0, '0'))
self.assertEqual(d[1], (1, '1'))
self.assertEqual(d[2], (3, '34'))
self.assertEqual(d[3], (9, '9'))
def test_readv_out_of_order(self):
transport = self.get_transport()
if transport.is_readonly():
file('a', 'w').write('0123456789')
else:
transport.put_bytes('a', '01234567890')
d = list(transport.readv('a', ((1, 1), (9, 1), (0, 1), (3, 2))))
self.assertEqual(d[0], (1, '1'))
self.assertEqual(d[1], (9, '9'))
self.assertEqual(d[2], (0, '0'))
self.assertEqual(d[3], (3, '34'))
def test_readv_with_adjust_for_latency(self):
transport = self.get_transport()
# the adjust for latency flag expands the data region returned
# according to a per-transport heuristic, so testing is a little
# tricky as we need more data than the largest combining that our
# transports do. To accomodate this we generate random data and cross
# reference the returned data with the random data. To avoid doing
# multiple large random byte look ups we do several tests on the same
# backing data.
content = osutils.rand_bytes(200*1024)
content_size = len(content)
if transport.is_readonly():
self.build_tree_contents([('a', content)])
else:
transport.put_bytes('a', content)
def check_result_data(result_vector):
for item in result_vector:
data_len = len(item[1])
self.assertEqual(content[item[0]:item[0] + data_len], item[1])
# start corner case
result = list(transport.readv('a', ((0, 30),),
adjust_for_latency=True, upper_limit=content_size))
# we expect 1 result, from 0, to something > 30
self.assertEqual(1, len(result))
self.assertEqual(0, result[0][0])
self.assertTrue(len(result[0][1]) >= 30)
check_result_data(result)
# end of file corner case
result = list(transport.readv('a', ((204700, 100),),
adjust_for_latency=True, upper_limit=content_size))
# we expect 1 result, from 204800- its length, to the end
self.assertEqual(1, len(result))
data_len = len(result[0][1])
self.assertEqual(204800-data_len, result[0][0])
self.assertTrue(data_len >= 100)
check_result_data(result)
# out of order ranges are made in order
result = list(transport.readv('a', ((204700, 100), (0, 50)),
adjust_for_latency=True, upper_limit=content_size))
# we expect 2 results, in order, start and end.
self.assertEqual(2, len(result))
# start
data_len = len(result[0][1])
self.assertEqual(0, result[0][0])
self.assertTrue(data_len >= 30)
# end
data_len = len(result[1][1])
self.assertEqual(204800-data_len, result[1][0])
self.assertTrue(data_len >= 100)
check_result_data(result)
# close ranges get combined (even if out of order)
for request_vector in [((400,50), (800, 234)), ((800, 234), (400,50))]:
result = list(transport.readv('a', request_vector,
adjust_for_latency=True, upper_limit=content_size))
self.assertEqual(1, len(result))
data_len = len(result[0][1])
# minimum length is from 400 to 1034 - 634
self.assertTrue(data_len >= 634)
# must contain the region 400 to 1034
self.assertTrue(result[0][0] <= 400)
self.assertTrue(result[0][0] + data_len >= 1034)
check_result_data(result)
def test_readv_with_adjust_for_latency_with_big_file(self):
transport = self.get_transport()
# test from observed failure case.
if transport.is_readonly():
file('a', 'w').write('a'*1024*1024)
else:
transport.put_bytes('a', 'a'*1024*1024)
broken_vector = [(465219, 800), (225221, 800), (445548, 800),
(225037, 800), (221357, 800), (437077, 800), (947670, 800),
(465373, 800), (947422, 800)]
results = list(transport.readv('a', broken_vector, True, 1024*1024))
found_items = [False]*9
for pos, (start, length) in enumerate(broken_vector):
# check the range is covered by the result
for offset, data in results:
if offset <= start and start + length <= offset + len(data):
found_items[pos] = True
self.assertEqual([True]*9, found_items)
def test_get_with_open_write_stream_sees_all_content(self):
t = self.get_transport()
if t.is_readonly():
return
handle = t.open_write_stream('foo')
try:
handle.write('bcd')
self.assertEqual([(0, 'b'), (2, 'd')], list(t.readv('foo', ((0,1), (2,1)))))
finally:
handle.close()
def test_get_smart_medium(self):
"""All transports must either give a smart medium, or know they can't.
"""
transport = self.get_transport()
try:
client_medium = transport.get_smart_medium()
self.assertIsInstance(client_medium, medium.SmartClientMedium)
except errors.NoSmartMedium:
# as long as we got it we're fine
pass
def test_readv_short_read(self):
transport = self.get_transport()
if transport.is_readonly():
file('a', 'w').write('0123456789')
else:
transport.put_bytes('a', '01234567890')
# This is intentionally reading off the end of the file
# since we are sure that it cannot get there
self.assertListRaises((errors.ShortReadvError, errors.InvalidRange,
# Can be raised by paramiko
AssertionError),
transport.readv, 'a', [(1,1), (8,10)])
# This is trying to seek past the end of the file, it should
# also raise a special error
self.assertListRaises((errors.ShortReadvError, errors.InvalidRange),
transport.readv, 'a', [(12,2)])
def test_stat_symlink(self):
# if a transport points directly to a symlink (and supports symlinks
# at all) you can tell this. helps with bug 32669.
t = self.get_transport()
try:
t.symlink('target', 'link')
except TransportNotPossible:
raise TestSkipped("symlinks not supported")
t2 = t.clone('link')
st = t2.stat('')
self.assertTrue(stat.S_ISLNK(st.st_mode))
|