TODO

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