TODO

   1 The Git Autoinstaller
   2
   3 TODO NOW:
   4
   5 - Symlinked rerere to get awesomeness. Problems:
   6     - Permissions
   7     - Might not make a huge difference; how does it handle empty file
   8       and removed file cases?
   9     - Need to manually run git rerere subsequently to reap benefits
  10     - Majority of resolutions have to happen pre-merge (see below)
  11     - Consider workflow: run wizard mass-upgrade, and then begin
  12       resolving working copies one by one.  Each time we resolve
  13       a copy, it should cause other copies to start magically resolving.
  14       So, ordering should be:
  15         1. Perform merge
  16         2. If it fails, merge the rr-cache with central rr-cache
  17            (this operation needs to be atomic) and replace it
  18            with a symlink.  File permissions preferably should
  19            be made correct, but don't have to be since only root
  20            will be touching subsequently.  If the hash already exists,
  21            don't do anything (maybe record this for the benefit
  22            of Mister Kite aka so we don't have to do a full traversal,
  23            this optimization might be essential)
  24         3. When a human is resolving the merges, they are "low
  25            concurrency", i.e. only one commit recording rerere will
  26            happen at a time.  This means that rr-cache does not
  27            need to be concurrent safe.  Some number of hashes in
  28            the rr-cache will start having postimages; we'll use
  29            a full-scan to figure that out.  Then cross-reference those
  30            with the recorded pending resolutions, and figure out which
  31            checkouts we can run rerere on (this gets permissions kind
  32            of tricky).  We'll try an alternative plan: manually require
  33            the user run some sort of retry command that does this as
  34            root; presumably they'd run this every ten installs or
  35            something.  A user can run git rerere to get a resolution
  36            early.
  37       This requires some new data-structures:
  38         - Besides the merge.txt file (which should never ever change),
  39           we should have an outstanding.txt file which gets modified
  40           as our scripts do resolutions behind our back.  Those modifications
  41           might a little annoying for a human to keep up with, so we should
  42           recommend something like watch -n2 "head file" or something
  43         - We need to keep track of the hashes and the cross-referencing.
  44           A very small sqlite database might be a good idea here, although
  45           the type of information we're interested in a somewhat unnatural
  46           query.  Alternatively, we just have a very simple text file.
  47 - Create 'wizard merge' command
  48     - Uses application specific hinting to prematurely resolve
  49       conflicts.
  50     - Newline resolution gets done prior-merge (presently is done
  51       post merge).
  52     - Classes of disappeared files made ok.
  53     - Make this general utility(?)
  54 - Need to make script to tell us about all installs that we don't support
  55   versions of (i.e. this mismatches)
  56
  57 - Wizard needs a correct arch/ setup
  58 - The wizard command, when not on scripts, should automatically SSH to
  59   scripts and start executing there?
  60 - Write the code to make Wordpress figure out its URL from the database
  61
  62 - Remerges aren't reflected in the parent files, so `git diff` output is
  63   spurious.  Not sure how to fix this w/o tree hackery.
  64 - Sometimes users remove files. Well, if those files change, they automatically
  65   get marked as conflicted.  Maybe we should say for certain files "if they're
  66   gone, they're gone forever"?  What is the proper resolution?
  67
  68 - Parse output HTML for class="error" and give those errors back to the user (done),
  69   then boot them back into configure so they can enter in something different
  70
  71 - Replace gaierror with a more descriptive name (this is a DNS error)
  72
  73 - Pre-emptively check if daemon/scripts-security-upd
  74   is not on scripts-security-upd list (/mit/moira/bin/blanche)
  75 - If you try to do an install on scripts w/o sql, it will sign you up but fail to write
  76   the sql.cnf file. This sucks.
  77
  78 - Web application for installing autoinstalls has a hard problem
  79   with credentials (as well as installations that are not conducted
  80   on an Athena machine.)  We have some crazy ideas involving a signed
  81   Java applet that uses jsch to SSH into athena.dialup and perform
  82   operations.
  83
  84 - Pay back code debt
  85     - Tidy up common code in callAsUser and drop_priviledges in shell;
  86       namely cooking up the sudo and environment variable lines
  87     - Summary script should be more machine friendly, and should not
  88       output summary charts when I increase specificity
  89     - Report code in wizard/command/__init__.py is ugly as sin.  Also,
  90       the Report object should operate at a higher level of abstraction
  91       so we don't have to manually increment fails. (in fact, that should
  92       probably be called something different).  The by-percent errors should
  93       also be automated.
  94     - Move resolutions in mediawiki.py to a text file? (the parsing overhead
  95       may not be worth it)
  96     - PHP end of file allows omitted semicolon, can result in parse error
  97       if merge resolutions aren't careful.  `php -l` can be a quick stopgap
  98
  99 - Other stuff
 100     - Figure out why Sphinx sometimes fails to crossref :func: but wil
 101       crossref :meth:, even though the dest is very clearly a function.
 102       Example: :func:`wizard.app.php.re_var`
 103     - The TODO extension for Sphinx doesn't properly force a full-rebuild
 104     - Code annotation!
 105     - Make single user mass-migrate work when not logged in as root.  The
 106       primary difficulty is making the parallel-find information easily
 107       accessible to individual users: perhaps we can do a single-user
 108       parallel-find on the fly.
 109     - Don't use the scripts heuristics unless we're on scripts with the
 110       AFS patch.  Check with `fs sysname`
 111     - Make 'wizard summary' generate nice pretty graphs of installs by date
 112       (more histograms, will need to check actual .scripts-version files.)
 113     - It should be able to handle installs like Django where there's a component
 114       that gets installed in web_scripts and another directory that gets installed
 115       in Scripts.
 116
 117 - ACLs is a starting point for sending mail to users, but it has
 118   several failure modes:
 119     - Old maintainers who don't care who are still on the ACL
 120     - Private AFS groups that aren't mailing lists and that we
 121       can't get to
 122   A question is whether or not sending mail actually helps us:
 123   many users will probably have to come back to us for help; many
 124   other users won't care.
 125
 126 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
 127
 128 advancedpoll: Template file to fill out
 129 django: Noodles of template files
 130 gallery2: Multistage install process
 131 joomla: Template file
 132 mediawiki: One-step install process
 133 phpbb: Multistage install process
 134 phpical: Template file
 135 trac: NFC
 136 turbogears: NFC
 137 wordpress: Multistage install process
 138
 139 COMMIT MESSAGE FIELDS:
 140
 141 Installed-by: username@hostname
 142 Pre-commit-by: Real Name <username@mit.edu>
 143 Upgraded-by: Real Name <username@mit.edu>
 144 Migrated-by: Real Name <username@mit.edu>
 145 Wizard-revision: abcdef1234567890
 146 Wizard-args: /wizard/bin/wizard foo bar baz
 147
 148 GIT COMMIT FIELDS:
 149
 150 Committer: Real Name <username@mit.edu>
 151 Author: lockername locker <lockername@scripts.mit.edu>
 152
 153 NOTES:
 154
 155 - It is not required nor expected for update scripts to exist for all
 156   intervening versions that were present pre-migration; only for it
 157   to work on the most recent migration.
 158
 159 - Currently all repositories are initialized with --shared, which
 160   means they have basically ~no space footprint.  However, it
 161   also means that /mit/scripts/wizard/srv MUST NOT lose revs after
 162   deployment.
 163
 164 OVERALL PLAN:
 165
 166 * Some parts of the infrastructure will not be touched, although I plan
 167   on documenting them.  Specifically, we will be keeping:
 168
 169     - parallel-find.pl, and the resulting
 170       /mit/scripts/.htaccess/scripts/sec-tools/store/scriptslist
 171
 172 * The new procedure for generating an update is as follows:
 173   (check out the mass-migration instructions for something in this spirit,
 174   although uglier in some ways; A indicates the step /should/ be automated)
 175
 176     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
 177        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 178
 179     1. [ see doc/upgrade.rst ]
 180
 181     [ENTER HERE FROM CREATING A NEW REPO]
 182
 183     9. Push all of your changes in a public place, and encourage others
 184        to test, using --srv-path and a full path.
 185
 186 [ XXX: doc/deploy.rst ]
 187       GET APPROVAL BEFORE PROCEEDING ANY FURTHER;
 188       THIS IS PUSHING THE CHANGES TO THE PUBLIC
 189
 190       NOTE: The following commands are to be run on not-backward.mit.edu.
 191       You'll need to add daemon.scripts-security-upd to
 192       scripts-security-upd to get bits to do this.  Make sure you remove
 193       these bits when you're done.
 194
 195    10. Run `wizard research appname`
 196        which uses Git commands to check how many
 197        working copies apply the change cleanly, and writes out a logfile
 198        with the working copies that don't apply cleanly.  It also tells
 199        us about "corrupt" working copies, i.e. working copies that
 200        have over a certain threshold of changes.
 201
 202    11. Run `wizard mass-upgrade appname`, which applies the update to all working
 203        copies possible.
 204
 205    12. Run parallel-find.pl to update our inventory
 206
 207 [ XXX: doc/upgrade.rst ]
 208 * For mass importing into the repository, there are a few extra things:
 209
 210     * When mass producing updates, if the patch has changed you will have to
 211       do a special procedure for your merge:
 212
 213         git checkout pristine
 214         # NOTE: Now, the tricky part (this is different from a real update)
 215         git symbolic-ref HEAD refs/heads/master
 216         # NOTE: Now, we think we're on the master branch, but we have
 217         # pristine copy checked out
 218         # NOTE: -p0 might need to be twiddled
 219         patch -p0 < ../app-1.2.3/app-1.2.3.patch
 220         git add .
 221         # reconstitute .scripts directory
 222         git checkout v1.2.2-scripts -- .scripts
 223         git add .scripts
 224         # NOTE: Fake the merge
 225         git rev-parse pristine > .git/MERGE_HEAD
 226
 227       You could also just try your luck with a manual merge using the patch
 228       as your guide.
 229
 230 [ XXX: doc/layout.rst ]
 231 * The repository for a given application will contain the following files:
 232
 233     - The actual application's files, as from the official tarball
 234
 235     - A .scripts directory, with the intent of holding Scripts specific files
 236       if they become necessary.
 237
 238         - .scripts/dsn, overriding database source name
 239