/stdhome

To get this branch, use:
bzr branch http://bzr.ed.am/stdhome

« back to all changes in this revision

Viewing changes to lib/stdhome/vcs/bzr.py

  • Committer: Tim Marston
  • Date: 2013-12-08 19:28:11 UTC
  • Revision ID: tim@ed.am-20131208192811-r20qj7cgmn4duw11
initial commit; basic app startup and initial command-line processing

Show diffs side-by-side

added added

removed removed

1
 
# bzr.py
2
 
#
3
 
# Copyright (C) 2014 Tim Marston <tim@edm.am>
4
 
#
5
 
# This file is part of stdhome (hereafter referred to as "this program").
6
 
# See http://ed.am/dev/stdhome for more information.
7
 
#
8
 
# This program is free software: you can redistribute it and/or modify
9
 
# it under the terms of the GNU General Public License as published by
10
 
# the Free Software Foundation, either version 3 of the License, or
11
 
# (at your option) any later version.
12
 
#
13
 
# This program is distributed in the hope that it will be useful,
14
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 
# GNU General Public License for more details.
17
 
#
18
 
# You should have received a copy of the GNU General Public License
19
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
 
 
21
 
 
22
 
import subprocess, os, re, shutil
23
 
from subprocess import Popen
24
 
import StringIO
25
 
from vcs import Vcs
26
 
from stdhome import the
27
 
 
28
 
 
29
 
class BzrVcs( Vcs ):
30
 
 
31
 
 
32
 
        def __init__( self, dir ):
33
 
                """Init class
34
 
 
35
 
                @param dir the fully-qualified directory to work in.
36
 
                """
37
 
 
38
 
                self.dir = dir
39
 
                self.ignored_files = [ '.bzr', '.bzrignore' ]
40
 
 
41
 
 
42
 
        def has_authority( self ):
43
 
                """Check that the directory is under this VCS's control.
44
 
                """
45
 
 
46
 
                return os.path.exists( os.path.join( self.dir, '.bzr' ) )
47
 
 
48
 
 
49
 
        def expand_repo_url( self, url ):
50
 
                """Convert a simple hostname in to an URL that the VCS can use.
51
 
                """
52
 
 
53
 
                return 'bzr+ssh://%s/%s/%s' % ( url, the.dir, the.repo.name )
54
 
 
55
 
 
56
 
        def init( self ):
57
 
                """Create a new, empty branch
58
 
                """
59
 
 
60
 
                # the directory shouldn't exist
61
 
                os.mkdir( self.dir )
62
 
 
63
 
                # bzr init
64
 
                try:
65
 
                        self.run( [ 'bzr', 'init', '.' ] )
66
 
                except self.VcsError as e:
67
 
 
68
 
                        # attempt to clean-up dir
69
 
                        try:
70
 
                                shutil.rmtree( self.dir )
71
 
                        except OSError:
72
 
                                pass
73
 
 
74
 
                        raise
75
 
 
76
 
 
77
 
        def checkout( self, url ):
78
 
                """Checkout a new copy of a remote branch.
79
 
 
80
 
                @param url the remote repository URL
81
 
                """
82
 
 
83
 
                # the directory shouldn't exist
84
 
                os.mkdir( self.dir )
85
 
 
86
 
                # bzr co
87
 
                try:
88
 
                        self.run( [ 'bzr', 'checkout', url, '.' ] )
89
 
                except self.VcsError as e:
90
 
 
91
 
                        # attempt to clean-up dir
92
 
                        try:
93
 
                                shutil.rmtree( self.dir )
94
 
                        except OSError:
95
 
                                pass
96
 
 
97
 
                        raise
98
 
 
99
 
 
100
 
        def get_revno( self ):
101
 
                """Obtain some sort of revision identifier
102
 
                """
103
 
 
104
 
                # bzr revno
105
 
                output = self.run( [ 'bzr', 'revno', '--tree' ] )
106
 
 
107
 
                # parse revno
108
 
                buf = StringIO.StringIO( output )
109
 
                return buf.readline().rstrip()
110
 
 
111
 
 
112
 
        def revert( self, revno = None ):
113
 
                """Revert the branch so that there are no outstanding changes or unknown files.
114
 
                If a revno is supplied, then the repository is reverted to that
115
 
                revision.
116
 
                """
117
 
 
118
 
                # bzr st
119
 
                output = self.run( [ 'bzr', 'status' ] )
120
 
                files = self.parse_file_blocks( output )
121
 
 
122
 
                # remove kind changed files (or they can cause `bzr revert` to break in
123
 
                # strange situations, like when a directory has been replaced with a
124
 
                # symlink to a non-existant file)
125
 
                if 'kind changed' in files:
126
 
                        for file in files[ 'kind changed' ]:
127
 
                                matches = re.search( '^(.+?)[/@+]? \([^)]+\)$', file )
128
 
                                if not matches:
129
 
                                        raise RunTimeError(
130
 
                                                'failed to parse bzr kind change: %s' % file )
131
 
                                file = matches.group( 1 )
132
 
                                if the.verbose >= 2: print "removing (kind changed): " + file
133
 
                                full_file = os.path.join( self.dir, file )
134
 
                                if os.path.isfile( full_file ) or os.path.islink( full_file ):
135
 
                                        os.unlink( full_file )
136
 
                                elif os.path.isdir( full_file ):
137
 
                                        shutil.rmtree( full_file )
138
 
                                else:
139
 
                                        raise RuntimeError( 'exotic file in repo: %s' % file )
140
 
 
141
 
                # bzr revert
142
 
                self.run( [ 'bzr', 'revert', '--no-backup' ] )
143
 
 
144
 
                # bzr st
145
 
                output = self.run( [ 'bzr', 'status' ] )
146
 
                files = self.parse_file_blocks( output )
147
 
 
148
 
                # remove unknown files
149
 
                if 'unknown' in files:
150
 
                        for file in files[ 'unknown' ]:
151
 
                                matches = re.search( r'^(.+?)[/@+]?$', file )
152
 
                                if not matches:
153
 
                                        raise RunTimeError(
154
 
                                                'failed to parse bzr unknowns: %s' % file )
155
 
                                file = matches.group( 1 )
156
 
                                if the.verbose >= 2: print "removing (unknown): " + file
157
 
                                full_file = os.path.join( self.dir, file )
158
 
                                if os.path.isfile( full_file ) or os.path.islink( full_file ):
159
 
                                        os.unlink( full_file )
160
 
                                elif os.path.isdir( full_file ):
161
 
                                        shutil.rmtree( full_file )
162
 
                                else:
163
 
                                        raise RuntimeError( 'exotic file in repo: %s' % file )
164
 
 
165
 
                # if a revision identifier has been given, ensure we're updated to that
166
 
                if revno is not None and self.get_revno() != revno:
167
 
 
168
 
                        # bzr update
169
 
                        self.run( [ 'bzr', 'update', '-r', revno ] )
170
 
 
171
 
 
172
 
        def update( self ):
173
 
                """Update the branch, pulling down any upstream changes and merging them.  This
174
 
                method returns a list of the files that were modified as part of this
175
 
                operation.
176
 
                """
177
 
 
178
 
#               WARNING: the following might cause bzr to ask for your ssh password more than
179
 
#               once during an update!!!
180
 
#
181
 
#               # get revno
182
 
#               revno = self.get_revno()
183
 
#
184
 
#               # update to current revision (pull in history without updating tree)
185
 
#               self.run( [ 'bzr', 'update', '-r', revno ] )
186
 
#
187
 
#               # get log output
188
 
#               next_revno = str( int( revno ) + 1 )
189
 
#               output = self.run( [ 'bzr', 'log', '-r', next_revno + '..' ] )
190
 
#
191
 
#               # parse output
192
 
#               keep_files = list()
193
 
#               buf = StringIO.StringIO( output )
194
 
#               in_message = False
195
 
#               for line in buf:
196
 
#                       line = line.rstrip( '\n' )
197
 
#                       if line.lower() == 'message:':
198
 
#                               in_message = True
199
 
#                       elif in_message:
200
 
#                               if line[ : 2 ] != '  ':
201
 
#                                       in_message = False
202
 
#                               else:
203
 
#                                       line = line[ 2 : ]
204
 
#
205
 
#                                       # process directives
206
 
#                                       if line[ : 6 ].lower() == 'keep: ':
207
 
#                                               file = line[ 6 : ]
208
 
#                                               if file in rename_files: file = rename_files[ file ]
209
 
#                                               keep_files.append( file )
210
 
#                                       elif line[ : 8 ].lower() == 'rename: ':
211
 
#                                               rename_from = line[ 8 : ]
212
 
#                                       elif line[ : 4 ].lower() == 'to: ':
213
 
#                                               if rename_from in rename_files:
214
 
#                                                       rename_from = rename_files[ rename_from ]
215
 
#                                               rename_files[ line[ 4 : ] ] = rename_from
216
 
 
217
 
                # bzr update properly
218
 
                output = self.run( [ 'bzr', 'update' ] )
219
 
 
220
 
                # parse output (see logic in report() in bzrlib/delta.py)
221
 
                files = list()
222
 
                buf = StringIO.StringIO( output )
223
 
                for line in buf:
224
 
                        if not re.search( '^[-R+ ?][K NMD!][* ] ', line ): continue
225
 
                        line = line.rstrip()
226
 
 
227
 
                        # renames show before and after file names
228
 
                        matches = re.search( '^R.. (.*?)[/@+]? => (.*?)[/@+]?$', line )
229
 
                        if matches:
230
 
                                files.append( matches.group( 1 ) )
231
 
                                files.append( matches.group( 2 ) )
232
 
                                continue
233
 
 
234
 
                        # kind changes shows the same name twice
235
 
                        matches = re.search( '^.K. (.*?)[/@+]? => (.*?)[/@+]?$', line )
236
 
                        if matches:
237
 
                                files.append( matches.group( 1 ) )
238
 
                                continue
239
 
 
240
 
                        # other entries have only one filename
241
 
                        matches = re.search( '^... (.*?)[/@+]?$', line )
242
 
                        if matches:
243
 
                                files.append( matches.group( 1 ) )
244
 
                                continue
245
 
 
246
 
                        raise RuntimeError(
247
 
                                'failed to parse bzr update output line:\n%s' % line )
248
 
 
249
 
                return files
250
 
 
251
 
 
252
 
        def has_changes( self ):
253
 
                """Check if the branch has any local modifications.
254
 
                """
255
 
 
256
 
                # bzr status
257
 
                output = self.run( [ 'bzr', 'status', '--no-pending' ] )
258
 
 
259
 
                # parse output
260
 
                files = self.parse_file_blocks( output )
261
 
                return True if len( files ) else False
262
 
 
263
 
 
264
 
        def get_conflicts( self ):
265
 
                """Return a list of files that have conflicts.
266
 
                """
267
 
 
268
 
                # bzr status
269
 
                output = self.run( [ 'bzr', 'status', '--no-pending' ] )
270
 
 
271
 
                # parse output
272
 
                files = self.parse_file_blocks( output )
273
 
                return files['conflicts'] if 'conflicts' in files else None
274
 
 
275
 
 
276
 
        def add( self, files ):
277
 
                """Make sure files are added to version control.
278
 
                @param files a list of relative filenames
279
 
                """
280
 
 
281
 
                # bzr add
282
 
                self.run( [ 'bzr', 'add', '-N' ] + files )
283
 
 
284
 
 
285
 
        def commit( self ):
286
 
                """Commit changes to the repo.
287
 
                """
288
 
 
289
 
                # bzr commit
290
 
                try:
291
 
                        self.run( [ 'bzr', 'commit', '-m', '' ] )
292
 
                except self.VcsError as e:
293
 
                        if re.search( 'Working tree is out of date', e.output ):
294
 
                                raise the.program.FatalError(
295
 
                                        'you must update your files first.\n' +
296
 
                                        'Hint: see "%s update --help"' % the.program.name );
297
 
                        else:
298
 
                                raise e
299
 
 
300
 
 
301
 
        def run( self, cmd ):
302
 
                if the.verbose >= 2: print 'exec: %s' % ' '.join( cmd )
303
 
                p = Popen( cmd, cwd = self.dir,
304
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
305
 
                output = p.communicate()[ 0 ]
306
 
                if p.returncode > 0:
307
 
                        raise self.VcsError( ' '.join( cmd[ : 2 ] ), output )
308
 
                if the.verbose >= 2:
309
 
                        verbose_output = output.rstrip()
310
 
                        if len( verbose_output ):
311
 
                                print re.sub( '(^|\n)', '\\1  : ', verbose_output )
312
 
                return output
313
 
 
314
 
 
315
 
        def parse_file_blocks( self, output ):
316
 
                res = dict()
317
 
                current = None
318
 
                buf = StringIO.StringIO( output )
319
 
                for line in buf:
320
 
                        matches = re.search( '^([a-z ]+):$', line, re.I )
321
 
                        if matches:
322
 
                                current = matches.group( 1 )
323
 
                                continue
324
 
                        if current:
325
 
                                matches = re.search( '^  ([^ ].*)$', line )
326
 
                                if matches:
327
 
                                        if not current in res:
328
 
                                                res[ current ] = list()
329
 
                                        res[ current ].append( matches.group( 1 ) )
330
 
                                        continue
331
 
                        if re.search( '^[0-9]+ shel(?:f|ves) exists?', line ): continue
332
 
                        if re.search( '^working tree is out of date', line ): continue
333
 
                        raise self.ParseError( "unrecognised line: %s" % line )
334
 
                return res
335
 
 
336
 
 
337
 
        class ParseError( Exception ):
338
 
                pass