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