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