/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/command/update.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

lib/stdhome/command/update.py
1
 
# command_update.py
 
1
# update.py
2
2
#
3
3
# Copyright (C) 2014 Tim Marston <tim@edm.am>
4
4
#
20
20
 
21
21
 
22
22
import sys, re, getopt
23
 
import the
24
 
from deployment import Deployment
25
 
 
26
 
 
27
 
class CommandUpdate:
 
23
from .command import Command
 
24
import stdhome.the as the
 
25
from stdhome.deployment import Deployment
 
26
 
 
27
 
 
28
class UpdateCommand( Command ):
28
29
 
29
30
 
30
31
        def __init__( self ):
31
 
                self.repo = None
 
32
                self.quiet = False
32
33
 
33
34
 
34
35
        def print_help( self ):
35
 
                print "Usage: " + the.program.name + " update [--repo=REPO]"
36
 
                print
 
36
                print("Usage: " + the.program.name + " update [--repo=REPO]")
 
37
                print()
37
38
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
38
 
                print "Update a local repository and deploy changes."
39
 
                print
40
 
                print "Files in your home directory are copied in to the local repository, the local"
41
 
                print "repository is then updated (i.e., changes made to it are pulled down and merged)"
42
 
                print "and files from the local repository are then redeployed to your home directory."
43
 
                print
44
 
                print "If any conflicts occur, either during the merge or during the redeployment, no"
45
 
                print "files will be deployed and you will be expected to manually intervene.  Merge"
46
 
                print "conflicts should be dealt with the same way as you'd expect for version control."
47
 
                print "Conflicts that arise from files already existing in your home directory must be"
48
 
                print "dealt with by moving those files aside (currently)."
49
 
                print
50
 
                print "You can resume the redeployment of your repository by typing:"
51
 
                print "    " + the.program.name + " resolve"
52
 
                print
53
 
                print "You can list outstanding conflicts by typing:"
54
 
                print "    " + the.program.name + " conflicts"
55
 
                print
56
 
                print "Options:"
57
 
                print "  -r, --repo=REPO  select the repo to check-out or create (defaults to 'home')"
58
 
                print "  -v, --verbose    display information about what is being done"
59
 
                print "      --help       display help and exit"
 
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()
 
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:")
 
56
                print("    " + the.program.name + " resolve")
 
57
                print()
 
58
                print("To back out of trying to update and revert the local repository, type:")
 
59
                print("    " + the.program.name + " stage-revert")
 
60
                print()
 
61
                print("Options:")
 
62
                print("      --quiet      do not report changes to the home directory")
 
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")
60
66
                exit( 0 )
61
67
 
62
68
 
63
69
        def parse_command_line( self ):
64
70
                opts, args = getopt.gnu_getopt(
65
 
                        sys.argv[ 1: ], "r:v",
66
 
                        [ "repo=", "verbose", "help" ] )
 
71
                        sys.argv[ 1: ], "qr:v",
 
72
                        [ "quiet", "repo=", "verbose", "help" ] )
67
73
                for opt, optarg in opts:
68
 
                        if opt in [ '--repo', '-r' ]:
69
 
                                if not re.match( '^[-a-zA-z0-9.]+$', optarg ):
 
74
                        if opt == '--quiet':
 
75
                                self.quiet = True
 
76
                        elif opt in [ '--repo', '-r' ]:
 
77
                                if not re.search( '^[-a-zA-z0-9.]+$', optarg ):
70
78
                                        raise the.program.FatalError(
71
79
                                                'invalid repository name: ' + optarg )
72
 
                                self.repo = optarg
 
80
                                the.repo = optarg
73
81
                        elif opt in [ '--verbose', '-v' ]:
74
 
                                the.verbose = True
 
82
                                the.verbose += 1
75
83
                        elif opt == "--help":
76
84
                                self.print_help()
77
 
                
 
85
 
78
86
                # discard first argument (the command)
79
87
                args.pop( 0 )
80
88
 
86
94
        def run( self ):
87
95
 
88
96
                # set up repo and check it exists
89
 
                the.set_repo( self.repo )
90
97
                the.repo.check_dir_exists()
91
98
 
92
 
                # initialise deployment (check it's valid)
 
99
                # initialise deployment (and check it)
93
100
                deployment = Deployment()
94
101
                deployment.check_ongoing( False )
95
102
 
97
104
                if the.repo.vcs.has_changes():
98
105
                        raise the.program.FatalError(
99
106
                                'repo has local changes: %s\n'
100
 
                                'Hint: see "%s stage-revert --help"' % 
 
107
                                'Hint: see "%s stage-revert --help"' %
101
108
                                ( the.repo.name, the.program.name ) )
102
109
 
103
110
                # copy-in changes to repo
104
 
                try:
105
 
                        deployment.copy_in()
106
 
                except deployment.CopyInConflicts as e:
107
 
                        raise the.program.FatalError(
108
 
                                'Files in %s differ too severly from %s:\n  %s\n' % \
109
 
                                ( the.fsdir, the.repo.dir, '\n  '.join( e.conflicts ) ) )
 
111
                deployment.copy_in()
110
112
 
111
113
                # perform vcs update
112
 
                if the.verbose: print "updating %s" % the.repo.dir
 
114
                if the.verbose >= 1: print("updating %s" % the.repo.dir)
113
115
                updated_files = the.repo.vcs.update()
114
116
 
115
117
                message = ''
117
119
                # check for conflicts in repo
118
120
                files = the.repo.vcs.get_conflicts()
119
121
                if files:
120
 
                        message += 'Conflicts in %s:\n  %s' % \
 
122
                        message += 'conflicts in %s:\n  %s' % \
121
123
                                           ( the.repo.name, '\n  '.join( files ) )
122
124
 
123
125
                # check for deployment conclicts
124
126
                conflicts = deployment.get_conflicts( updated_files )
125
127
                if conflicts:
126
 
                        message += 'Deployment conflicts:\n  %s' % \
 
128
                        message += 'deployment conflicts:\n  %s' % \
127
129
                                           '\n  '.join( conflicts )
128
130
 
129
131
                # stop if there are conflicts
132
134
                                'there were conflicts...\n' + message )
133
135
 
134
136
                # copy-out changes from repo
135
 
                deployment.copy_out()
 
137
                deployment.copy_out( self.quiet )
136
138
 
137
139
                # now we've copied-out, revert any copied-in changes!
138
 
                if the.verbose: print "reverting %s" % the.repo.dir
 
140
                if the.verbose >= 1: print("reverting %s" % the.repo.dir)
139
141
                the.repo.vcs.revert()