TODO

   1 The Git Autoinstaller
   2
   3 TODO NOW:
   4
   5 - If you try to do an install on scripts w/o sql, it will sign you up but fail to write
   6   the sql.cnf file. This sucks.
   7 - Make an awesome wizard subcommand that you can point at a file that is DOS
   8   when the source wants it to be UNIX, or the other way around, and it will
   9   redo the merge on that file correctly.
  10
  11 - wizard install wordpress should ask for password.  One problem with this is that
  12   Wordpress will still send mail with the wrong username and password, so Wordpress
  13   will need to be patched to not do that.  Alternatively we can initally set the admin
  14   email to a null address and then fix it manually.
  15 - --raw parameter for install which means an arbitrary commit can be installed
  16 - Parse output HTML for class="error" and give those errors back to the user (done),
  17   then boot them back into configure so they can enter in something different
  18 - Get rid of our custom sizing code and use dialog's built-in sizing (i.e. width=0, height=0).
  19   Maybe our sizing code is superior, maybe not.
  20
  21 - Replace gaierror with a more descriptive name (this is a DNS error)
  22
  23 - Pre-emptively check if daemon/scripts-security-upd
  24   is not on scripts-security-upd list (/mit/moira/bin/blanche)
  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     - Summary script should be more machine friendly, and should not
  35       output summary charts when I increase specificity
  36     - Summary script should do something intelligent when distinguishing
  37       between old-style and new-style installs
  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     - If a process is C-ced, it can result in a upgrade that has
  46       an updated filesystem but not updated database. Make this more
  47       resilient
  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     - ACLs is a starting point for sending mail to users, but it has
  69       several failure modes:
  70         - Old maintainers who don't care who are still on the ACL
  71         - Private AFS groups that aren't mailing lists and that we
  72           can't get to
  73       A question is whether or not sending mail actually helps us:
  74       many users will probably have to come back to us for help; many
  75       other users won't care.
  76
  77 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
  78
  79 advancedpoll: Template file to fill out
  80 django: Noodles of template files
  81 gallery2: Multistage install process
  82 joomla: Template file
  83 mediawiki: One-step install process
  84 phpbb: Multistage install process
  85 phpical: Template file
  86 trac: NFC
  87 turbogears: NFC
  88 wordpress: Multistage install process
  89
  90 COMMIT MESSAGE FIELDS:
  91
  92 Installed-by: username@hostname
  93 Pre-commit-by: Real Name <username@mit.edu>
  94 Upgraded-by: Real Name <username@mit.edu>
  95 Migrated-by: Real Name <username@mit.edu>
  96 Wizard-revision: abcdef1234567890
  97 Wizard-args: /wizard/bin/wizard foo bar baz
  98
  99 GIT COMMIT FIELDS:
 100
 101 Committer: Real Name <username@mit.edu>
 102 Author: lockername locker <lockername@scripts.mit.edu>
 103
 104 NOTES:
 105
 106 - It is not required nor expected for update scripts to exist for all
 107   intervening versions that were present pre-migration; only for it
 108   to work on the most recent migration.
 109
 110 - Currently all repositories are initialized with --shared, which
 111   means they have basically ~no space footprint.  However, it
 112   also means that /mit/scripts/wizard/srv MUST NOT lose revs after
 113   deployment.
 114
 115 OVERALL PLAN:
 116
 117 * Some parts of the infrastructure will not be touched, although I plan
 118   on documenting them.  Specifically, we will be keeping:
 119
 120     - parallel-find.pl, and the resulting
 121       /mit/scripts/.htaccess/scripts/sec-tools/store/scriptslist
 122
 123 * The new procedure for generating an update is as follows:
 124   (check out the mass-migration instructions for something in this spirit,
 125   although uglier in some ways; A indicates the step /should/ be automated)
 126
 127     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
 128        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 129
 130     1. [ see doc/upgrade.rst ]
 131
 132     [ENTER HERE FROM CREATING A NEW REPO]
 133
 134     9. Push all of your changes in a public place, and encourage others
 135        to test, using --srv-path and a full path.
 136
 137 [ XXX: doc/deploy.rst ]
 138       GET APPROVAL BEFORE PROCEEDING ANY FURTHER;
 139       THIS IS PUSHING THE CHANGES TO THE PUBLIC
 140
 141       NOTE: The following commands are to be run on not-backward.mit.edu.
 142       You'll need to add daemon.scripts-security-upd to
 143       scripts-security-upd to get bits to do this.  Make sure you remove
 144       these bits when you're done.
 145
 146    10. Run `wizard research appname`
 147        which uses Git commands to check how many
 148        working copies apply the change cleanly, and writes out a logfile
 149        with the working copies that don't apply cleanly.  It also tells
 150        us about "corrupt" working copies, i.e. working copies that
 151        have over a certain threshold of changes.
 152
 153    11. Run `wizard mass-upgrade appname`, which applies the update to all working
 154        copies possible.
 155
 156    12. Run parallel-find.pl to update our inventory
 157
 158 [ XXX: doc/upgrade.rst ]
 159 * For mass importing into the repository, there are a few extra things:
 160
 161     * When mass producing updates, if the patch has changed you will have to
 162       do a special procedure for your merge:
 163
 164         git checkout pristine
 165         # NOTE: Now, the tricky part (this is different from a real update)
 166         git symbolic-ref HEAD refs/heads/master
 167         # NOTE: Now, we think we're on the master branch, but we have
 168         # pristine copy checked out
 169         # NOTE: -p0 might need to be twiddled
 170         patch -p0 < ../app-1.2.3/app-1.2.3.patch
 171         git add .
 172         # reconstitute .scripts directory
 173         git checkout v1.2.2-scripts -- .scripts
 174         git add .scripts
 175         # NOTE: Fake the merge
 176         git rev-parse pristine > .git/MERGE_HEAD
 177
 178       You could also just try your luck with a manual merge using the patch
 179       as your guide.
 180
 181 [ XXX: doc/layout.rst ]
 182 * The repository for a given application will contain the following files:
 183
 184     - The actual application's files, as from the official tarball
 185
 186     - A .scripts directory, with the intent of holding Scripts specific files
 187       if they become necessary.
 188
 189         - .scripts/dsn, overriding database source name
 190