/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: 2021-07-05 21:01:29 UTC
  • Revision ID: tim@ed.am-20210705210129-gc746mez1vhzobz7
add stage-status command; add common stage notice to helps

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/stdhome/vcs/bzr.py
21
21
 
22
22
import subprocess, os, re, shutil
23
23
from subprocess import Popen
24
 
import StringIO
25
 
from vcs import Vcs
 
24
import io
 
25
from .vcs import Vcs
26
26
from stdhome import the
27
27
 
28
28
 
29
 
class VcsBzr( Vcs ):
 
29
class BzrVcs( Vcs ):
30
30
 
31
31
 
32
32
        def __init__( self, dir ):
34
34
 
35
35
                @param dir the fully-qualified directory to work in.
36
36
                """
 
37
 
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 )
38
54
 
39
55
 
40
56
        def init( self ):
45
61
                os.mkdir( self.dir )
46
62
 
47
63
                # bzr init
48
 
                p = Popen( [ 'bzr', 'init', '.' ], cwd = self.dir,
49
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
50
 
                output = p.communicate()[ 0 ]
51
 
                if p.returncode > 0:
 
64
                try:
 
65
                        self.run( [ 'bzr', 'init', '.' ] )
 
66
                except self.VcsError as e:
52
67
 
53
68
                        # attempt to clean-up dir
54
69
                        try:
56
71
                        except OSError:
57
72
                                pass
58
73
 
59
 
                        raise self.VcsError( 'bzr init failed', output )
 
74
                        raise
60
75
 
61
76
 
62
77
        def checkout( self, url ):
69
84
                os.mkdir( self.dir )
70
85
 
71
86
                # bzr co
72
 
                p = Popen( [ 'bzr', 'co', url, '.' ], cwd = self.dir,
73
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
74
 
                output = p.communicate()[ 0 ]
75
 
                if p.returncode > 0:
 
87
                try:
 
88
                        self.run( [ 'bzr', 'checkout', url, '.' ] )
 
89
                except self.VcsError as e:
76
90
 
77
91
                        # attempt to clean-up dir
78
92
                        try:
80
94
                        except OSError:
81
95
                                pass
82
96
 
83
 
                        raise self.VcsError( 'bzr checkout failed', output )
84
 
 
85
 
 
86
 
        def revert( self ):
 
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 = io.StringIO( output )
 
109
                return buf.readline().rstrip()
 
110
 
 
111
 
 
112
        def revert( self, revno = None ):
87
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.
88
116
                """
89
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
 
90
141
                # bzr revert
91
 
                p = Popen( [ 'bzr', 'revert', '--no-backup' ], cwd = self.dir,
92
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
93
 
                output = p.communicate()[ 0 ]
94
 
                if p.returncode > 0:
95
 
                        raise self.VcsError( 'bzr revert failed', output )
 
142
                self.run( [ 'bzr', 'revert', '--no-backup' ] )
96
143
 
97
144
                # bzr st
98
 
                p = Popen( [ 'bzr', 'st' ], cwd = self.dir,
99
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
100
 
                output = p.communicate()[ 0 ]
101
 
                if p.returncode > 0:
102
 
                        raise self.VcsError( 'bzr status failed', output )
 
145
                output = self.run( [ 'bzr', 'status' ] )
103
146
                files = self.parse_file_blocks( output )
104
147
 
105
148
                # remove unknown files
106
149
                if 'unknown' in files:
107
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)
108
157
                                full_file = os.path.join( self.dir, file )
109
 
                                if os.path.isfile( full_file ):
 
158
                                if os.path.isfile( full_file ) or os.path.islink( full_file ):
110
159
                                        os.unlink( full_file )
111
 
                                elif os.full_file.isdir( full_file ):
 
160
                                elif os.path.isdir( full_file ):
112
161
                                        shutil.rmtree( full_file )
113
162
                                else:
114
163
                                        raise RuntimeError( 'exotic file in repo: %s' % file )
115
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
 
116
171
 
117
172
        def update( self ):
118
173
                """Update the branch, pulling down any upstream changes and merging them.  This
120
175
                operation.
121
176
                """
122
177
 
123
 
                # bzr update
124
 
                p = Popen( [ 'bzr', 'update' ], cwd = self.dir,
125
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
126
 
                output = p.communicate()[ 0 ]
127
 
                if p.returncode > 0:
128
 
                        raise self.VcsError( 'bzr update failed', output )
 
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' ] )
129
219
 
130
220
                # parse output (see logic in report() in bzrlib/delta.py)
131
221
                files = list()
132
 
                buf = StringIO.StringIO( output )
 
222
                buf = io.StringIO( output )
133
223
                for line in buf:
134
224
                        if not re.search( '^[-R+ ?][K NMD!][* ] ', line ): continue
135
225
                        line = line.rstrip()
136
 
                        if the.verbose: print '  %s' % line
137
226
 
138
227
                        # renames show before and after file names
139
228
                        matches = re.search( '^R.. (.*?)[/@+]? => (.*?)[/@+]?$', line )
155
244
                                continue
156
245
 
157
246
                        raise RuntimeError(
158
 
                                'failed to parse bzr update output line:\n%' % line )
 
247
                                'failed to parse bzr update output line:\n%s' % line )
159
248
 
160
249
                return files
161
250
 
162
251
 
 
252
        def status( self ):
 
253
                """Get a list of any local modifications.  This method returns a list of files
 
254
                which are modified.
 
255
 
 
256
                """
 
257
 
 
258
                # bzr status
 
259
                output = self.run( [ 'bzr', 'status', '--no-pending' ] )
 
260
 
 
261
                # parse output
 
262
                return self.parse_file_blocks( output )
 
263
 
 
264
 
163
265
        def has_changes( self ):
164
266
                """Check if the branch has any local modifications.
165
267
                """
166
268
 
167
269
                # bzr status
168
 
                p = Popen( [ 'bzr', 'status', '--no-pending' ], cwd = self.dir,
169
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
170
 
                output = p.communicate()[ 0 ]
171
 
                if p.returncode > 0:
172
 
                        raise self.VcsError( 'bzr status failed', output )
 
270
                output = self.run( [ 'bzr', 'status', '--no-pending' ] )
 
271
 
 
272
                # parse output
173
273
                files = self.parse_file_blocks( output )
174
274
                return True if len( files ) else False
175
275
 
179
279
                """
180
280
 
181
281
                # bzr status
182
 
                p = Popen( [ 'bzr', 'status', '--no-pending' ], cwd = self.dir,
183
 
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
184
 
                output = p.communicate()[ 0 ]
185
 
                if p.returncode > 0:
186
 
                        raise self.VcsError( 'bzr status failed', output )
 
282
                output = self.run( [ 'bzr', 'status', '--no-pending' ] )
 
283
 
 
284
                # parse output
187
285
                files = self.parse_file_blocks( output )
188
286
                return files['conflicts'] if 'conflicts' in files else None
189
287
 
190
288
 
 
289
        def add( self, files ):
 
290
                """Make sure files are added to version control.
 
291
                @param files a list of relative filenames
 
292
                """
 
293
 
 
294
                # bzr add
 
295
                self.run( [ 'bzr', 'add', '-N' ] + files )
 
296
 
 
297
 
 
298
        def commit( self ):
 
299
                """Commit changes to the repo.
 
300
                """
 
301
 
 
302
                # bzr commit
 
303
                try:
 
304
                        self.run( [ 'bzr', 'commit', '-m', '' ] )
 
305
                except self.VcsError as e:
 
306
                        if re.search( 'Working tree is out of date', e.output ):
 
307
                                raise the.program.FatalError(
 
308
                                        'you must update your files first.\n' +
 
309
                                        'Hint: see "%s update --help"' % the.program.name );
 
310
                        else:
 
311
                                raise e
 
312
 
 
313
 
 
314
        def run( self, cmd ):
 
315
                if the.verbose >= 2: print('exec: %s' % ' '.join( cmd ))
 
316
                p = Popen( cmd, cwd = self.dir,
 
317
                                   stdout = subprocess.PIPE, stderr = subprocess.STDOUT )
 
318
                output = p.communicate()[ 0 ].decode()
 
319
                if p.returncode > 0:
 
320
                        raise self.VcsError( ' '.join( cmd[ : 2 ] ), output )
 
321
                if the.verbose >= 2:
 
322
                        verbose_output = output.rstrip()
 
323
                        if len( verbose_output ):
 
324
                                print(re.sub( '(^|\n)', '\\1  : ', verbose_output ))
 
325
                return output
 
326
 
 
327
 
191
328
        def parse_file_blocks( self, output ):
192
329
                res = dict()
193
330
                current = None
194
 
                buf = StringIO.StringIO( output )
 
331
                buf = io.StringIO( output )
195
332
                for line in buf:
196
333
                        matches = re.search( '^([a-z ]+):$', line, re.I )
197
334
                        if matches:
204
341
                                                res[ current ] = list()
205
342
                                        res[ current ].append( matches.group( 1 ) )
206
343
                                        continue
207
 
                        if re.search( '^[0-9]+ shelf exists', line ): continue
 
344
                        if re.search( '^[0-9]+ shel(?:f|ves) exists?', line ): continue
208
345
                        if re.search( '^working tree is out of date', line ): continue
209
346
                        raise self.ParseError( "unrecognised line: %s" % line )
210
347
                return res