TODO

   1 The Git Autoinstaller
   2
   3 TODO NOW:
   4
   5 - The calling web code invocations are a mess, with stubs living
   6   in the install, deploy modules and the real deal living in util.  Furthermore,
   7   we use the scripts-specific heuristic to determine where the app
   8   lives, and the only reason my test scripts work is because they
   9   get manually fed the domain and path by my environment variables.
  10
  11   We will record the URL used for the initial installation, and save it in
  12   .scripts/url.  If autodetection in either direction is
  13   available, we verify this value against the actual file path the installation
  14   lives in (for the scripts case, we can do a file-level comparison because we
  15   know the web root of any given file).  If they mismatch, we error out
  16   and have someone manually resolve the problem.  If autodetection is not
  17   available, we use the saved .scripts/url for operations.
  18
  19 - wizard install wordpress should ask for password
  20 - Test code should auto-nuke the database using `wizard remove` before doing a new install
  21 - git diff :1:$file :2:$file to find out what the user did, or is it :3:?
  22 - Document how to fix a broken upgrade
  23 - php.ini needs to get substituted!
  24 - Make wizard install accept appname-head (so that you can do a test with
  25   head, and do things without tags).  Also make it accept commit hashes.
  26   In fact, let it accept any committish.  Figure out what to do if we
  27   do a test script with x.y.z when we REALLY mean x.y.z-scripts. XXX!!!
  28 - Do early validation of inputs for configuration
  29 - Let 'wizard configure' be interactive
  30 - Parse output HTML for class="error" and give those errors back to the user,
  31   then boot them back into configure
  32 - Get rid of our custom sizing code and use dialog's built-in sizing (i.e. width=0, height=0).
  33   Maybe our sizing code is superior, maybe not.
  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
  40 - Redo Wordpress conversion, with an eye for automating everything
  41   possible (such as downloading the tarball and unpacking)
  42
  43 - Web application for installing autoinstalls has a hard problem
  44   with credentials (as well as installations that are not conducted
  45   on an Athena machine.)  Possible solutions include asking the user
  46   to SSH into an athena machine and run a bunch of commands, or writing
  47   a Java applet (possibly in Clojure or Scala) which gets filesystem
  48   permissions and then performs the operations.
  49
  50 - Pay back code debt
  51     - Genericize callAsUser and drop_priviledges in shell
  52     - Summary script should be more machine friendly, and should not
  53       output summary charts when I increase specificity
  54     - Summary script should do something intelligent when distinguishing
  55       between old-style and new-style installs
  56     - Report code in wizard/command/__init__.py is ugly as sin.  Also,
  57       the Report object should operate at a higher level of abstraction
  58       so we don't have to manually increment fails. (in fact, that should
  59       probably be called something different).  The by-percent errors should
  60       also be automated.
  61     - Move resolutions in mediawiki.py to a text file? (the parsing overhead
  62       may not be worth it)
  63     - If a process is C-ced, it can result in a upgrade that has
  64       an updated filesystem but not updated database. Make this more
  65       resilient
  66     - PHP end of file allows omitted semicolon, can result in parse error
  67       if merge resolutions aren't careful.  `php -l` can be a quick stopgap
  68
  69 - Other stuff
  70     - Figure out why Sphinx sometimes fails to crossref :func: but wil
  71       crossref :meth:, even though the dest is very clearly a function.
  72       Example: :func:`wizard.app.php.re_var`
  73     - The TODO extension for Sphinx doesn't properly force a full-rebuild
  74     - Code annotation!
  75     - Make single user mass-migrate work when not logged in as root
  76     - Don't use the scripts heuristics unless we're on scripts with the
  77       AFS patch.  Check with `fs sysname`
  78     - Make 'wizard summary' generate nice pretty graphs of installs by date
  79       (more histograms, will need to check actual .scripts-version files.)
  80     - It should be able to handle installs like Django where there's a component
  81       that gets installed in web_scripts and another directory that gets installed
  82       in Scripts.
  83     - ACLs is a starting point for sending mail to users, but it has
  84       several failure modes:
  85         - Old maintainers who don't care who are still on the ACL
  86         - Private AFS groups that aren't mailing lists and that we
  87           can't get to
  88       A question is whether or not sending mail actually helps us:
  89       many users will probably have to come back to us for help; many
  90       other users won't care.
  91
  92 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
  93
  94 advancedpoll: Template file to fill out
  95 django: Noodles of template files
  96 gallery2: Multistage install process
  97 joomla: Template file
  98 mediawiki: One-step install process
  99 phpbb: Multistage install process
 100 phpical: Template file
 101 trac: NFC
 102 turbogears: NFC
 103 wordpress: Multistage install process
 104
 105 COMMIT MESSAGE FIELDS:
 106
 107 Installed-by: username@hostname
 108 Pre-commit-by: Real Name <username@mit.edu>
 109 Upgraded-by: Real Name <username@mit.edu>
 110 Migrated-by: Real Name <username@mit.edu>
 111 Wizard-revision: abcdef1234567890
 112 Wizard-args: /wizard/bin/wizard foo bar baz
 113
 114 GIT COMMIT FIELDS:
 115
 116 Committer: Real Name <username@mit.edu>
 117 Author: lockername locker <lockername@scripts.mit.edu>
 118
 119 NOTES:
 120
 121 - It is not required nor expected for update scripts to exist for all
 122   intervening versions that were present pre-migration; only for it
 123   to work on the most recent migration.
 124
 125 - Currently all repositories are initialized with --shared, which
 126   means they have basically ~no space footprint.  However, it
 127   also means that /mit/scripts/wizard/srv MUST NOT lose revs after
 128   deployment.
 129
 130 OVERALL PLAN:
 131
 132 * Some parts of the infrastructure will not be touched, although I plan
 133   on documenting them.  Specifically, we will be keeping:
 134
 135     - parallel-find.pl, and the resulting
 136       /mit/scripts/.htaccess/scripts/sec-tools/store/scriptslist
 137
 138 * The new procedure for generating an update is as follows:
 139   (check out the mass-migration instructions for something in this spirit,
 140   although uglier in some ways; A indicates the step /should/ be automated)
 141
 142     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
 143        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 144
 145     1. [ see doc/upgrade.rst ]
 146
 147     [ENTER HERE FROM CREATING A NEW REPO]
 148
 149     9. Push all of your changes in a public place, and encourage others
 150        to test, using --srv-path and a full path.
 151
 152 [ XXX: doc/deploy.rst ]
 153       GET APPROVAL BEFORE PROCEEDING ANY FURTHER;
 154       THIS IS PUSHING THE CHANGES TO THE PUBLIC
 155
 156       NOTE: The following commands are to be run on not-backward.mit.edu.
 157       You'll need to add daemon.scripts-security-upd to
 158       scripts-security-upd to get bits to do this.  Make sure you remove
 159       these bits when you're done.
 160
 161    10. Run `wizard research appname`
 162        which uses Git commands to check how many
 163        working copies apply the change cleanly, and writes out a logfile
 164        with the working copies that don't apply cleanly.  It also tells
 165        us about "corrupt" working copies, i.e. working copies that
 166        have over a certain threshold of changes.
 167
 168    11. Run `wizard mass-upgrade appname`, which applies the update to all working
 169        copies possible.
 170
 171    12. Run parallel-find.pl to update our inventory
 172
 173 [ XXX: doc/upgrade.rst ]
 174 * For mass importing into the repository, there are a few extra things:
 175
 176     * When mass producing updates, if the patch has changed you will have to
 177       do a special procedure for your merge:
 178
 179         git checkout pristine
 180         # NOTE: Now, the tricky part (this is different from a real update)
 181         git symbolic-ref HEAD refs/heads/master
 182         # NOTE: Now, we think we're on the master branch, but we have
 183         # pristine copy checked out
 184         # NOTE: -p0 might need to be twiddled
 185         patch -p0 < ../app-1.2.3/app-1.2.3.patch
 186         git add .
 187         # reconstitute .scripts directory
 188         git checkout v1.2.2-scripts -- .scripts
 189         git add .scripts
 190         # NOTE: Fake the merge
 191         git rev-parse pristine > .git/MERGE_HEAD
 192
 193       You could also just try your luck with a manual merge using the patch
 194       as your guide.
 195
 196 [ XXX: doc/layout.rst ]
 197 * The repository for a given application will contain the following files:
 198
 199     - The actual application's files, as from the official tarball
 200
 201     - A .scripts directory, with the intent of holding Scripts specific files
 202       if they become necessary.
 203