TODO

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