TODO

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