TODO

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