TODO

   1 The Git Autoinstaller
   2
   3 TODO NOW:
   4
   5 - Add support for mypristine workflow
   6 - Wordpress needs to get rid of the siteurl hack, so that it actually
   7   has a fully-qualified URL http://foo.scripts.mit.edu/blah.  This will
   8   also fix Wordpress's cron functionality.  We should be careful not
   9   to write over users who are on vhosts.  We should figure out who is
  10   still on twiddle paths.  We should make sure the redirect is handled
  11   correctly.
  12 - Wizard needs a correct arch/ setup
  13 - The wizard command, when not on scripts, should automatically SSH to
  14   scripts and start executing there?
  15
  16 - Remerges aren't reflected in the parent files, so `git diff` output is
  17   spurious.  Not sure how to fix this w/o tree hackery.
  18 - Sometimes users remove files. Well, if those files change, they automatically
  19   get marked as conflicted.  Maybe we should say for certain files "if they're
  20   gone, they're gone forever"?  What is the proper resolution?
  21
  22 - Parse output HTML for class="error" and give those errors back to the user (done),
  23   then boot them back into configure so they can enter in something different
  24
  25 - Pre-emptively check if daemon/scripts-security-upd
  26   is not on scripts-security-upd list (/mit/moira/bin/blanche)
  27 - If you try to do an install on scripts w/o sql, it will sign you up but fail to write
  28   the sql.cnf file. This sucks.
  29
  30 - Web application for installing autoinstalls has a hard problem
  31   with credentials (as well as installations that are not conducted
  32   on an Athena machine.)  We have some crazy ideas involving a signed
  33   Java applet that uses jsch to SSH into athena.dialup and perform
  34   operations.
  35
  36 - Pay back code debt
  37     - Tidy up common code in callAsUser and drop_priviledges in shell;
  38       namely cooking up the sudo and environment variable lines
  39     - Summary script should be more machine friendly, and should not
  40       output summary charts when I increase specificity
  41     - PHP end of file allows omitted semicolon, can result in parse error
  42       if merge resolutions aren't careful.  `php -l` can be a quick stopgap
  43
  44 - Other stuff
  45     - Figure out why Sphinx sometimes fails to crossref :func: but wil
  46       crossref :meth:, even though the dest is very clearly a function.
  47       Example: :func:`wizard.app.php.re_var`
  48     - The TODO extension for Sphinx doesn't properly force a full-rebuild
  49     - Code annotation!
  50     - Make single user mass-migrate work when not logged in as root.  The
  51       primary difficulty is making the parallel-find information easily
  52       accessible to individual users: perhaps we can do a single-user
  53       parallel-find on the fly.
  54     - Don't use the scripts heuristics unless we're on scripts with the
  55       AFS patch.  Check with `fs sysname`
  56     - Make 'wizard summary' generate nice pretty graphs of installs by date
  57       (more histograms, will need to check actual .scripts-version files.)
  58     - It should be able to handle installs like Django where there's a component
  59       that gets installed in web_scripts and another directory that gets installed
  60       in Scripts.
  61
  62 - ACLs is a starting point for sending mail to users, but it has
  63   several failure modes:
  64     - Old maintainers who don't care who are still on the ACL
  65     - Private AFS groups that aren't mailing lists and that we
  66       can't get to
  67   A question is whether or not sending mail actually helps us:
  68   many users will probably have to come back to us for help; many
  69   other users won't care.
  70
  71 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
  72
  73 advancedpoll: Template file to fill out
  74 django: Noodles of template files
  75 gallery2: Multistage install process
  76 joomla: Template file
  77 mediawiki: One-step install process
  78 phpbb: Multistage install process
  79 phpical: Template file
  80 trac: NFC
  81 turbogears: NFC
  82 wordpress: Multistage install process
  83
  84 COMMIT MESSAGE FIELDS:
  85
  86 Installed-by: username@hostname
  87 Pre-commit-by: Real Name <username@mit.edu>
  88 Upgraded-by: Real Name <username@mit.edu>
  89 Migrated-by: Real Name <username@mit.edu>
  90 Wizard-revision: abcdef1234567890
  91 Wizard-args: /wizard/bin/wizard foo bar baz
  92
  93 GIT COMMIT FIELDS:
  94
  95 Committer: Real Name <username@mit.edu>
  96 Author: lockername locker <lockername@scripts.mit.edu>
  97
  98 NOTES:
  99
 100 - It is not required nor expected for update scripts to exist for all
 101   intervening versions that were present pre-migration; only for it
 102   to work on the most recent migration.
 103
 104 - Currently all repositories are initialized with --shared, which
 105   means they have basically ~no space footprint.  However, it
 106   also means that /mit/scripts/wizard/srv MUST NOT lose revs after
 107   deployment.
 108
 109 OVERALL PLAN:
 110
 111 * Some parts of the infrastructure will not be touched, although I plan
 112   on documenting them.  Specifically, we will be keeping:
 113
 114     - parallel-find.pl, and the resulting
 115       /mit/scripts/.htaccess/scripts/sec-tools/store/scriptslist
 116
 117 * The new procedure for generating an update is as follows:
 118   (check out the mass-migration instructions for something in this spirit,
 119   although uglier in some ways; A indicates the step /should/ be automated)
 120
 121     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
 122        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 123
 124     1. [ see doc/upgrade.rst ]
 125
 126     [ENTER HERE FROM CREATING A NEW REPO]
 127
 128     9. Push all of your changes in a public place, and encourage others
 129        to test, using --srv-path and a full path.
 130
 131 [ XXX: doc/deploy.rst ]
 132       GET APPROVAL BEFORE PROCEEDING ANY FURTHER;
 133       THIS IS PUSHING THE CHANGES TO THE PUBLIC
 134
 135       NOTE: The following commands are to be run on not-backward.mit.edu.
 136       You'll need to add daemon.scripts-security-upd to
 137       scripts-security-upd to get bits to do this.  Make sure you remove
 138       these bits when you're done.
 139
 140    10. Run `wizard research appname`
 141        which uses Git commands to check how many
 142        working copies apply the change cleanly, and writes out a logfile
 143        with the working copies that don't apply cleanly.  It also tells
 144        us about "corrupt" working copies, i.e. working copies that
 145        have over a certain threshold of changes.
 146
 147    11. Run `wizard mass-upgrade appname`, which applies the update to all working
 148        copies possible.
 149
 150    12. Run parallel-find.pl to update our inventory
 151
 152 [ XXX: doc/upgrade.rst ]
 153 * For mass importing into the repository, there are a few extra things:
 154
 155     * When mass producing updates, if the patch has changed you will have to
 156       do a special procedure for your merge:
 157
 158         git checkout pristine
 159         # NOTE: Now, the tricky part (this is different from a real update)
 160         git symbolic-ref HEAD refs/heads/master
 161         # NOTE: Now, we think we're on the master branch, but we have
 162         # pristine copy checked out
 163         # NOTE: -p0 might need to be twiddled
 164         patch -p0 < ../app-1.2.3/app-1.2.3.patch
 165         git add .
 166         # reconstitute .scripts directory
 167         git checkout v1.2.2-scripts -- .scripts
 168         git add .scripts
 169         # NOTE: Fake the merge
 170         git rev-parse pristine > .git/MERGE_HEAD
 171
 172       You could also just try your luck with a manual merge using the patch
 173       as your guide.
 174
 175 [ XXX: doc/layout.rst ]
 176 * The repository for a given application will contain the following files:
 177
 178     - The actual application's files, as from the official tarball
 179
 180     - A .scripts directory, with the intent of holding Scripts specific files
 181       if they become necessary.
 182
 183         - .scripts/dsn, overriding database source name
 184