TODO

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