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