/stdhome

To get this branch, use:
bzr branch http://bzr.ed.am/stdhome
8 by Tim Marston
added diff command; moved all command to commands subdir; made stage-revert
1
# update.py
4 by Tim Marston
added more commands
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 sys, re, getopt
8 by Tim Marston
added diff command; moved all command to commands subdir; made stage-revert
23
from command import Command
24
import stdhome.the as the
25
from stdhome.deployment import Deployment
26
27
28
class UpdateCommand( Command ):
4 by Tim Marston
added more commands
29
30
61 by Tim Marston
added home directory change reporting to CopyOutWalker; added --quiet option to
31
	def __init__( self ):
32
		self.quiet = False
33
34
4 by Tim Marston
added more commands
35
	def print_help( self ):
36
		print "Usage: " + the.program.name + " update [--repo=REPO]"
37
		print
38
		#      01234567890123456789012345678901234567890123456789012345678901234567890123456789
39
		print "Update a local repository and deploy changes."
40
		print
41
		print "Files in your home directory are copied in to the local repository, the local"
42
		print "repository is then updated (i.e., changes made to it are pulled down and merged)"
43
		print "and files from the local repository are then redeployed to your home directory."
44
		print
45
		print "If any conflicts occur, either during the merge or during the redeployment, no"
46
		print "files will be deployed and you will be expected to manually intervene.  Merge"
47
		print "conflicts should be dealt with the same way as you'd expect for version control."
48
		print "Conflicts that arise from files already existing in your home directory must be"
49
		print "dealt with by moving those files aside (currently)."
50
		print
17 by Tim Marston
read ~/.stdhomerc; commands set repo before run(); program performs late
51
		print "After a failed update, you can list outstanding conflicts by typing:"
52
		print "    " + the.program.name + " conflicts"
53
		print
54
		print "After fixing outstanding conflicts, you can re-attempt the redeployment of"
55
		print "your repository by typing:"
4 by Tim Marston
added more commands
56
		print "    " + the.program.name + " resolve"
57
		print
17 by Tim Marston
read ~/.stdhomerc; commands set repo before run(); program performs late
58
		print "To back out of trying to update and revert the local repository, type:"
59
		print "    " + the.program.name + " stage-revert"
4 by Tim Marston
added more commands
60
		print
61
		print "Options:"
61 by Tim Marston
added home directory change reporting to CopyOutWalker; added --quiet option to
62
		print "      --quiet      do not report changes to the home directory"
4 by Tim Marston
added more commands
63
		print "  -r, --repo=REPO  select the repo to check-out or create (defaults to 'home')"
64
		print "  -v, --verbose    display information about what is being done"
65
		print "      --help       display help and exit"
66
		exit( 0 )
67
68
69
	def parse_command_line( self ):
70
		opts, args = getopt.gnu_getopt(
61 by Tim Marston
added home directory change reporting to CopyOutWalker; added --quiet option to
71
			sys.argv[ 1: ], "qr:v",
72
			[ "quiet", "repo=", "verbose", "help" ] )
4 by Tim Marston
added more commands
73
		for opt, optarg in opts:
61 by Tim Marston
added home directory change reporting to CopyOutWalker; added --quiet option to
74
			if opt == '--quiet':
75
				self.quiet = True
76
			elif opt in [ '--repo', '-r' ]:
77
				if not re.search( '^[-a-zA-z0-9.]+$', optarg ):
4 by Tim Marston
added more commands
78
					raise the.program.FatalError(
79
						'invalid repository name: ' + optarg )
17 by Tim Marston
read ~/.stdhomerc; commands set repo before run(); program performs late
80
				the.repo = optarg
4 by Tim Marston
added more commands
81
			elif opt == "--help":
82
				self.print_help()
55 by Tim Marston
moved handling of --verbose to main program; manuall parse config file (because
83
4 by Tim Marston
added more commands
84
		# discard first argument (the command)
85
		args.pop( 0 )
86
87
		# remaining arguments
88
		if len( args ):
89
			raise the.program.UsageError( 'too many arguments' )
90
91
92
	def run( self ):
93
94
		# set up repo and check it exists
95
		the.repo.check_dir_exists()
96
8 by Tim Marston
added diff command; moved all command to commands subdir; made stage-revert
97
		# initialise deployment (and check it)
4 by Tim Marston
added more commands
98
		deployment = Deployment()
99
		deployment.check_ongoing( False )
100
101
		# check for local changes
102
		if the.repo.vcs.has_changes():
103
			raise the.program.FatalError(
104
				'repo has local changes: %s\n'
55 by Tim Marston
moved handling of --verbose to main program; manuall parse config file (because
105
				'Hint: see "%s stage-revert --help"' %
4 by Tim Marston
added more commands
106
				( the.repo.name, the.program.name ) )
107
108
		# copy-in changes to repo
59 by Tim Marston
switched init command (and update command) to checking for conflicts prior to
109
		deployment.copy_in()
4 by Tim Marston
added more commands
110
111
		# perform vcs update
35 by Tim Marston
made checks for verbose >= 1 explicit
112
		if the.verbose >= 1: print "updating %s" % the.repo.dir
5 by Tim Marston
moved copy-in, copy-out and deployment conflict checking to a set of "walkers";
113
		updated_files = the.repo.vcs.update()
4 by Tim Marston
added more commands
114
115
		message = ''
5 by Tim Marston
moved copy-in, copy-out and deployment conflict checking to a set of "walkers";
116
117
		# check for conflicts in repo
4 by Tim Marston
added more commands
118
		files = the.repo.vcs.get_conflicts()
119
		if files:
13 by Tim Marston
changed working of output
120
			message += 'conflicts in %s:\n  %s' % \
4 by Tim Marston
added more commands
121
					   ( the.repo.name, '\n  '.join( files ) )
5 by Tim Marston
moved copy-in, copy-out and deployment conflict checking to a set of "walkers";
122
123
		# check for deployment conclicts
124
		conflicts = deployment.get_conflicts( updated_files )
125
		if conflicts:
13 by Tim Marston
changed working of output
126
			message += 'deployment conflicts:\n  %s' % \
5 by Tim Marston
moved copy-in, copy-out and deployment conflict checking to a set of "walkers";
127
					   '\n  '.join( conflicts )
128
129
		# stop if there are conflicts
4 by Tim Marston
added more commands
130
		if message:
131
			raise the.program.FatalError(
132
				'there were conflicts...\n' + message )
60 by Tim Marston
fixed init command
133
4 by Tim Marston
added more commands
134
		# copy-out changes from repo
61 by Tim Marston
added home directory change reporting to CopyOutWalker; added --quiet option to
135
		deployment.copy_out( self.quiet )
4 by Tim Marston
added more commands
136
137
		# now we've copied-out, revert any copied-in changes!
35 by Tim Marston
made checks for verbose >= 1 explicit
138
		if the.verbose >= 1: print "reverting %s" % the.repo.dir
4 by Tim Marston
added more commands
139
		the.repo.vcs.revert()