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
|
# Copyright (C) 2005 Aaron Bentley and Panometrics, Inc.
# <abentley@panoramicfeedback.com>
#
# 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
from subprocess import Popen, PIPE
import os
import os.path
from socket import gethostname
import re
import sys
import tempfile
import shutil
import unittest
import doctest
from utility import Dir, search_parent_directories
def _get_matching_rcs(matchfn):
"""Return the first module for which matchfn(RCS_instance) is true"""
import arch
import bzr
import hg
import git
for module in [arch, bzr, hg, git]:
rcs = module.new()
if matchfn(rcs) == True:
return rcs
else:
del(rcs)
return RCS()
def rcs_by_name(rcs_name):
"""Return the module for the RCS with the given name"""
return _get_matching_rcs(lambda rcs: rcs.name == rcs_name)
def detect_rcs(dir):
"""Return an RCS instance for the rcs being used in this directory"""
return _get_matching_rcs(lambda rcs: rcs.detect(dir))
def installed_rcs():
"""Return an instance of an installed RCS"""
return _get_matching_rcs(lambda rcs: rcs.installed())
class CommandError(Exception):
def __init__(self, err_str, status):
Exception.__init__(self, "Command failed (%d): %s" % (status, err_str))
self.err_str = err_str
self.status = status
class SettingIDnotSupported(NotImplementedError):
pass
class RCSnotRooted(Exception):
def __init__(self):
msg = "RCS not rooted"
Exception.__init__(self, msg)
class PathNotInRoot(Exception):
def __init__(self, path, root):
msg = "Path '%s' not in root '%s'" % (path, root)
Exception.__init__(self, msg)
self.path = path
self.root = root
class NoSuchFile(Exception):
def __init__(self, pathname):
Exception.__init__(self, "No such file: %s" % pathname)
def new():
return RCS()
class RCS(object):
"""
This class implements a 'no-rcs' interface.
Support for other RCSs can be added by subclassing this class, and
overriding methods _rcs_*() with code appropriate for your RCS.
The methods _u_*() are utility methods available to the _rcs_*()
methods.
"""
name = "None"
client = "" # command-line tool for _u_invoke_client
versioned = False
def __init__(self, paranoid=False):
self.paranoid = paranoid
self.verboseInvoke = False
self.rootdir = None
self._duplicateBasedir = None
self._duplicateDirname = None
def __del__(self):
self.cleanup()
def _rcs_help(self):
"""
Return the command help string.
(Allows a simple test to see if the client is installed.)
"""
pass
def _rcs_detect(self, path=None):
"""
Detect whether a directory is revision controlled with this RCS.
"""
return True
def _rcs_root(self, path):
"""
Get the RCS root. This is the default working directory for
future invocations. You would normally set this to the root
directory for your RCS.
"""
if os.path.isdir(path)==False:
path = os.path.dirname(path)
if path == "":
path = os.path.abspath(".")
return path
def _rcs_init(self, path):
"""
Begin versioning the tree based at path.
"""
pass
def _rcs_cleanup(self):
"""
Remove any cruft that _rcs_init() created outside of the
versioned tree.
"""
pass
def _rcs_get_user_id(self):
"""
Get the RCS's suggested user id (e.g. "John Doe <jdoe@example.com>").
If the RCS has not been configured with a username, return None.
"""
return None
def _rcs_set_user_id(self, value):
"""
Set the RCS's suggested user id (e.g "John Doe <jdoe@example.com>").
This is run if the RCS has not been configured with a usename, so
that commits will have a reasonable FROM value.
"""
raise SettingIDnotSupported
def _rcs_add(self, path):
"""
Add the already created file at path to version control.
"""
pass
def _rcs_remove(self, path):
"""
Remove the file at path from version control. Optionally
remove the file from the filesystem as well.
"""
pass
def _rcs_update(self, path):
"""
Notify the versioning system of changes to the versioned file
at path.
"""
pass
def _rcs_get_file_contents(self, path, revision=None):
"""
Get the file contents as they were in a given revision. Don't
worry about decoding the contents, the RCS.get_file_contents()
method will handle that.
Revision==None specifies the current revision.
"""
assert revision == None, \
"The %s RCS does not support revision specifiers" % self.name
return file(os.path.join(self.rootdir, path), "rb").read()
def _rcs_duplicate_repo(self, directory, revision=None):
"""
Get the repository as it was in a given revision.
revision==None specifies the current revision.
dir specifies a directory to create the duplicate in.
"""
shutil.copytree(self.rootdir, directory, True)
def _rcs_commit(self, commitfile):
"""
Commit the current working directory, using the contents of
commitfile as the comment. Return the name of the old
revision.
"""
return None
def installed(self):
try:
self._rcs_help()
return True
except OSError, e:
if e.errno == errno.ENOENT:
return False
raise e
def detect(self, path="."):
"""
Detect whether a directory is revision controlled with this RCS.
"""
return self._rcs_detect(path)
def root(self, path):
"""
Set the root directory to the path's RCS root. This is the
default working directory for future invocations.
"""
self.rootdir = self._rcs_root(path)
def init(self, path):
"""
Begin versioning the tree based at path.
Also roots the rcs at path.
"""
if os.path.isdir(path)==False:
path = os.path.dirname(path)
self._rcs_init(path)
self.root(path)
def cleanup(self):
self._rcs_cleanup()
def get_user_id(self):
"""
Get the RCS's suggested user id (e.g. "John Doe <jdoe@example.com>").
If the RCS has not been configured with a username, return the user's
id. You can override the automatic lookup procedure by setting the
RCS.user_id attribute to a string of your choice.
"""
if hasattr(self, "user_id"):
if self.user_id != None:
return self.user_id
id = self._rcs_get_user_id()
if id == None:
name = self._u_get_fallback_username()
email = self._u_get_fallback_email()
id = self._u_create_id(name, email)
print >> sys.stderr, "Guessing id '%s'" % id
try:
self.set_user_id(id)
except SettingIDnotSupported:
pass
return id
def set_user_id(self, value):
"""
Set the RCS's suggested user id (e.g "John Doe <jdoe@example.com>").
This is run if the RCS has not been configured with a usename, so
that commits will have a reasonable FROM value.
"""
self._rcs_set_user_id(value)
def add(self, path):
"""
Add the already created file at path to version control.
"""
self._rcs_add(self._u_rel_path(path))
def remove(self, path):
"""
Remove a file from both version control and the filesystem.
"""
self._rcs_remove(self._u_rel_path(path))
if os.path.exists(path):
os.remove(path)
def recursive_remove(self, dirname):
"""
Remove a file/directory and all its decendents from both
version control and the filesystem.
"""
if not os.path.exists(dirname):
raise NoSuchFile(dirname)
for dirpath,dirnames,filenames in os.walk(dirname, topdown=False):
filenames.extend(dirnames)
for path in filenames:
fullpath = os.path.join(dirpath, path)
if os.path.exists(fullpath) == False:
continue
self._rcs_remove(self._u_rel_path(fullpath))
if os.path.exists(dirname):
shutil.rmtree(dirname)
def update(self, path):
"""
Notify the versioning system of changes to the versioned file
at path.
"""
self._rcs_update(self._u_rel_path(path))
def get_file_contents(self, path, revision=None, allow_no_rcs=False):
"""
Get the file as it was in a given revision.
Revision==None specifies the current revision.
"""
if not os.path.exists(path):
raise NoSuchFile(path)
if self._use_rcs(path, allow_no_rcs):
relpath = self._u_rel_path(path)
contents = self._rcs_get_file_contents(relpath,revision)
else:
contents = file(path, "rb").read()
return contents.decode("utf-8")
def set_file_contents(self, path, contents, allow_no_rcs=False):
"""
Set the file contents under version control.
"""
add = not os.path.exists(path)
file(path, "wb").write(contents.encode("utf-8"))
if self._use_rcs(path, allow_no_rcs):
if add:
self.add(path)
else:
self.update(path)
def mkdir(self, path, allow_no_rcs=False):
"""
Create (if neccessary) a directory at path under version
control.
"""
if not os.path.exists(path):
os.mkdir(path)
if self._use_rcs(path, allow_no_rcs):
self.add(path)
else:
assert os.path.isdir(path)
if self._use_rcs(path, allow_no_rcs):
self.update(path)
def duplicate_repo(self, revision=None):
"""
Get the repository as it was in a given revision.
revision==None specifies the current revision.
Return the path to the arbitrary directory at the base of the new repo.
"""
# Dirname in Baseir to protect against simlink attacks.
if self._duplicateBasedir == None:
self._duplicateBasedir = tempfile.mkdtemp(prefix='BErcs')
self._duplicateDirname = \
os.path.join(self._duplicateBasedir, "duplicate")
self._rcs_duplicate_repo(directory=self._duplicateDirname,
revision=revision)
return self._duplicateDirname
def remove_duplicate_repo(self):
"""
Clean up a duplicate repo created with duplicate_repo().
"""
if self._duplicateBasedir != None:
shutil.rmtree(self._duplicateBasedir)
self._duplicateBasedir = None
self._duplicateDirname = None
def commit(self, summary, body=None):
"""
Commit the current working directory, with a commit message
string summary and body. Return the name of the old revision
(or None if versioning is not supported).
"""
if body is not None:
summary += '\n' + body
descriptor, filename = tempfile.mkstemp()
revision = None
try:
temp_file = os.fdopen(descriptor, 'wb')
temp_file.write(summary)
temp_file.flush()
revision = self._rcs_commit(filename)
temp_file.close()
finally:
os.remove(filename)
return revision
def precommit(self, directory):
pass
def postcommit(self, directory):
pass
def _u_invoke(self, args, expect=(0,), cwd=None):
if cwd == None:
cwd = self.rootdir
if self.verboseInvoke == True:
print >> sys.stderr, "%s$ %s" % (cwd, " ".join(args))
try :
if sys.platform != "win32":
q = Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE, cwd=cwd)
else:
# win32 don't have os.execvp() so have to run command in a shell
q = Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE,
shell=True, cwd=cwd)
except OSError, e :
strerror = "%s\nwhile executing %s" % (e.args[1], args)
raise CommandError(strerror, e.args[0])
output, error = q.communicate()
status = q.wait()
if self.verboseInvoke == True:
print >> sys.stderr, "%d\n%s%s" % (status, output, error)
if status not in expect:
strerror = "%s\nwhile executing %s\n%s" % (args[1], args, error)
raise CommandError(strerror, status)
return status, output, error
def _u_invoke_client(self, *args, **kwargs):
directory = kwargs.get('directory',None)
expect = kwargs.get('expect', (0,))
cl_args = [self.client]
cl_args.extend(args)
return self._u_invoke(cl_args, expect, cwd=directory)
def _u_search_parent_directories(self, path, filename):
"""
Find the file (or directory) named filename in path or in any
of path's parents.
e.g.
search_parent_directories("/a/b/c", ".be")
will return the path to the first existing file from
/a/b/c/.be
/a/b/.be
/a/.be
/.be
or None if none of those files exist.
"""
return search_parent_directories(path, filename)
def _use_rcs(self, path, allow_no_rcs):
"""
Try and decide if _rcs_add/update/mkdir/etc calls will
succeed. Returns True is we think the rcs_call would
succeeed, and False otherwise.
"""
use_rcs = True
exception = None
if self.rootdir != None:
if self.path_in_root(path) == False:
use_rcs = False
exception = PathNotInRoot(path, self.rootdir)
else:
use_rcs = False
exception = RCSnotRooted
if use_rcs == False and allow_no_rcs==False:
raise exception
return use_rcs
def path_in_root(self, path, root=None):
"""
Return the relative path to path from root.
>>> rcs = new()
>>> rcs.path_in_root("/a.b/c/.be", "/a.b/c")
True
>>> rcs.path_in_root("/a.b/.be", "/a.b/c")
False
"""
if root == None:
if self.rootdir == None:
raise RCSnotRooted
root = self.rootdir
path = os.path.abspath(path)
absRoot = os.path.abspath(root)
absRootSlashedDir = os.path.join(absRoot,"")
if not path.startswith(absRootSlashedDir):
return False
return True
def _u_rel_path(self, path, root=None):
"""
Return the relative path to path from root.
>>> rcs = new()
>>> rcs._u_rel_path("/a.b/c/.be", "/a.b/c")
'.be'
"""
if root == None:
if self.rootdir == None:
raise RCSnotRooted
root = self.rootdir
path = os.path.abspath(path)
absRoot = os.path.abspath(root)
absRootSlashedDir = os.path.join(absRoot,"")
if not path.startswith(absRootSlashedDir):
raise PathNotInRoot(path, absRootSlashedDir)
assert path != absRootSlashedDir, \
"file %s == root directory %s" % (path, absRootSlashedDir)
relpath = path[len(absRootSlashedDir):]
return relpath
def _u_abspath(self, path, root=None):
"""
Return the absolute path from a path realtive to root.
>>> rcs = new()
>>> rcs._u_abspath(".be", "/a.b/c")
'/a.b/c/.be'
"""
if root == None:
assert self.rootdir != None, "RCS not rooted"
root = self.rootdir
return os.path.abspath(os.path.join(root, path))
def _u_create_id(self, name, email=None):
"""
>>> rcs = new()
>>> rcs._u_create_id("John Doe", "jdoe@example.com")
'John Doe <jdoe@example.com>'
>>> rcs._u_create_id("John Doe")
'John Doe'
"""
assert len(name) > 0
if email == None or len(email) == 0:
return name
else:
return "%s <%s>" % (name, email)
def _u_parse_id(self, value):
"""
>>> rcs = new()
>>> rcs._u_parse_id("John Doe <jdoe@example.com>")
('John Doe', 'jdoe@example.com')
>>> rcs._u_parse_id("John Doe")
('John Doe', None)
>>> try:
... rcs._u_parse_id("John Doe <jdoe@example.com><what?>")
... except AssertionError:
... print "Invalid match"
Invalid match
"""
emailexp = re.compile("(.*) <([^>]*)>(.*)")
match = emailexp.search(value)
if match == None:
email = None
name = value
else:
assert len(match.groups()) == 3
assert match.groups()[2] == "", match.groups()
email = match.groups()[1]
name = match.groups()[0]
assert name != None
assert len(name) > 0
return (name, email)
def _u_get_fallback_username(self):
name = None
for envariable in ["LOGNAME", "USERNAME"]:
if os.environ.has_key(envariable):
name = os.environ[envariable]
break
assert name != None
return name
def _u_get_fallback_email(self):
hostname = gethostname()
name = self._u_get_fallback_username()
return "%s@%s" % (name, hostname)
def _u_parse_commitfile(self, commitfile):
"""
Split the commitfile created in self.commit() back into
summary and header lines.
"""
f = file(commitfile, "rb")
summary = f.readline()
body = f.read()
body.lstrip('\n')
if len(body) == 0:
body = None
f.close
return (summary, body)
class RCSTestCase(unittest.TestCase):
Class = RCS
def __init__(self, *args, **kwargs):
unittest.TestCase.__init__(self, *args, **kwargs)
self.dirname = None
def instantiateRCS(self):
return self.Class()
def setUp(self):
self.dir = Dir()
self.dirname = self.dir.path
self.rcs = self.instantiateRCS()
def tearDown(self):
del(self.rcs)
del(self.dirname)
def fullPath(self, path):
return os.path.join(self.dirname, path)
def assertPathExists(self, path):
fullpath = self.fullPath(path)
self.failUnless(os.path.exists(fullpath)==True,
"path %s does not exist" % fullpath)
def uidTest(self):
user_id = self.rcs.get_user_id()
self.failUnless(user_id != None,
"unable to get a user id")
user_idB = "John Doe <jdoe@example.com>"
if self.rcs.name in ["None", "hg"]:
self.assertRaises(SettingIDnotSupported, self.rcs.set_user_id,
user_idB)
else:
self.rcs.set_user_id(user_idB)
self.failUnless(self.rcs.get_user_id() == user_idB,
"user id not set correctly (was %s, is %s)" \
% (user_id, self.rcs.get_user_id()))
self.failUnless(self.rcs.set_user_id(user_id) == None,
"unable to restore user id %s" % user_id)
self.failUnless(self.rcs.get_user_id() == user_id,
"unable to restore user id %s" % user_id)
def versionTest(self, path):
origpath = path
path = self.fullPath(path)
contentsA = "Lorem ipsum"
contentsB = "dolor sit amet"
self.rcs.set_file_contents(path,contentsA)
self.failUnless(self.rcs.get_file_contents(path)==contentsA,
"File contents not set or read correctly")
revision = self.rcs.commit("Commit current status")
self.failUnless(self.rcs.get_file_contents(path)==contentsA,
"Committing File contents not set or read correctly")
if self.rcs.versioned == True:
self.rcs.set_file_contents(path,contentsB)
self.failUnless(self.rcs.get_file_contents(path)==contentsB,
"File contents not set correctly after commit")
contentsArev = self.rcs.get_file_contents(path, revision)
self.failUnless(contentsArev==contentsA, \
"Original file contents not saved in revision %s\n%s\n%s\n" \
% (revision, contentsA, contentsArev))
dup = self.rcs.duplicate_repo(revision)
duppath = os.path.join(dup, origpath)
dupcont = file(duppath, "rb").read()
self.failUnless(dupcont == contentsA)
self.rcs.remove_duplicate_repo()
def testRun(self):
self.failUnless(self.rcs.installed() == True,
"%s RCS not found" % self.Class.name)
if self.Class.name != "None":
self.failUnless(self.rcs.detect(self.dirname)==False,
"Detected %s RCS before initializing" \
% self.Class.name)
self.rcs.init(self.dirname)
self.failUnless(self.rcs.detect(self.dirname)==True,
"Did not detect %s RCS after initializing" \
% self.Class.name)
rp = os.path.realpath(self.rcs.rootdir)
dp = os.path.realpath(self.dirname)
self.failUnless(dp == rp or rp == None,
"%s RCS root in wrong dir (%s %s)" \
% (self.Class.name, dp, rp))
self.uidTest()
self.rcs.mkdir(self.fullPath('a'))
self.rcs.mkdir(self.fullPath('a/b'))
self.rcs.mkdir(self.fullPath('c'))
self.assertPathExists('a')
self.assertPathExists('a/b')
self.assertPathExists('c')
self.versionTest('a/text')
self.versionTest('a/b/text')
self.rcs.recursive_remove(self.fullPath('a'))
def make_rcs_testcase_subclasses(rcs_class, namespace):
""" Make RCSTestCase subclasses for rcs_class in the namespace. """
rcs_testcase_classes = [
c for c in (
ob for ob in globals().values() if isinstance(ob, type))
if issubclass(c, RCSTestCase)]
for base_class in rcs_testcase_classes:
testcase_class_name = rcs_class.__name__ + base_class.__name__
testcase_class_bases = (base_class,)
testcase_class_dict = dict(base_class.__dict__)
testcase_class_dict['Class'] = rcs_class
testcase_class = type(
testcase_class_name, testcase_class_bases, testcase_class_dict)
setattr(namespace, testcase_class_name, testcase_class)
unitsuite = unittest.TestLoader().loadTestsFromModule(sys.modules[__name__])
suite = unittest.TestSuite([unitsuite, doctest.DocTestSuite()])
|