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 - --raw parameter for install which means an arbitrary commit can be installed
  25 - Do early validation of inputs for configuration
  26 - Parse output HTML for class="error" and give those errors back to the user (done),
  27   then boot them back into configure
  28 - Get rid of our custom sizing code and use dialog's built-in sizing (i.e. width=0, height=0).
  29   Maybe our sizing code is superior, maybe not.
  30
  31 - Replace gaierror with a more descriptive name (this is a DNS error)
  32
  33 - Pre-emptively check if daemon/scripts-security-upd
  34   is not on scripts-security-upd list (/mit/moira/bin/blanche)
  35
  36 - Web application for installing autoinstalls has a hard problem
  37   with credentials (as well as installations that are not conducted
  38   on an Athena machine.)  We have some crazy ideas involving a signed
  39   Java applet that uses jsch to SSH into athena.dialup and perform
  40   operations.
  41
  42 - Pay back code debt
  43     - Genericize callAsUser and drop_priviledges in shell
  44     - Summary script should be more machine friendly, and should not
  45       output summary charts when I increase specificity
  46     - Summary script should do something intelligent when distinguishing
  47       between old-style and new-style installs
  48     - Report code in wizard/command/__init__.py is ugly as sin.  Also,
  49       the Report object should operate at a higher level of abstraction
  50       so we don't have to manually increment fails. (in fact, that should
  51       probably be called something different).  The by-percent errors should
  52       also be automated.
  53     - Move resolutions in mediawiki.py to a text file? (the parsing overhead
  54       may not be worth it)
  55     - If a process is C-ced, it can result in a upgrade that has
  56       an updated filesystem but not updated database. Make this more
  57       resilient
  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
  68     - Don't use the scripts heuristics unless we're on scripts with the
  69       AFS patch.  Check with `fs sysname`
  70     - Make 'wizard summary' generate nice pretty graphs of installs by date
  71       (more histograms, will need to check actual .scripts-version files.)
  72     - It should be able to handle installs like Django where there's a component
  73       that gets installed in web_scripts and another directory that gets installed
  74       in Scripts.
  75     - ACLs is a starting point for sending mail to users, but it has
  76       several failure modes:
  77         - Old maintainers who don't care who are still on the ACL
  78         - Private AFS groups that aren't mailing lists and that we
  79           can't get to
  80       A question is whether or not sending mail actually helps us:
  81       many users will probably have to come back to us for help; many
  82       other users won't care.
  83
  84 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
  85
  86 advancedpoll: Template file to fill out
  87 django: Noodles of template files
  88 gallery2: Multistage install process
  89 joomla: Template file
  90 mediawiki: One-step install process
  91 phpbb: Multistage install process
  92 phpical: Template file
  93 trac: NFC
  94 turbogears: NFC
  95 wordpress: Multistage install process
  96
  97 COMMIT MESSAGE FIELDS:
  98
  99 Installed-by: username@hostname
 100 Pre-commit-by: Real Name <username@mit.edu>
 101 Upgraded-by: Real Name <username@mit.edu>
 102 Migrated-by: Real Name <username@mit.edu>
 103 Wizard-revision: abcdef1234567890
 104 Wizard-args: /wizard/bin/wizard foo bar baz
 105
 106 GIT COMMIT FIELDS:
 107
 108 Committer: Real Name <username@mit.edu>
 109 Author: lockername locker <lockername@scripts.mit.edu>
 110
 111 NOTES:
 112
 113 - It is not required nor expected for update scripts to exist for all
 114   intervening versions that were present pre-migration; only for it
 115   to work on the most recent migration.
 116
 117 - Currently all repositories are initialized with --shared, which
 118   means they have basically ~no space footprint.  However, it
 119   also means that /mit/scripts/wizard/srv MUST NOT lose revs after
 120   deployment.
 121
 122 OVERALL PLAN:
 123
 124 * Some parts of the infrastructure will not be touched, although I plan
 125   on documenting them.  Specifically, we will be keeping:
 126
 127     - parallel-find.pl, and the resulting
 128       /mit/scripts/.htaccess/scripts/sec-tools/store/scriptslist
 129
 130 * The new procedure for generating an update is as follows:
 131   (check out the mass-migration instructions for something in this spirit,
 132   although uglier in some ways; A indicates the step /should/ be automated)
 133
 134     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
 135        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 136
 137     1. [ see doc/upgrade.rst ]
 138
 139     [ENTER HERE FROM CREATING A NEW REPO]
 140
 141     9. Push all of your changes in a public place, and encourage others
 142        to test, using --srv-path and a full path.
 143
 144 [ XXX: doc/deploy.rst ]
 145       GET APPROVAL BEFORE PROCEEDING ANY FURTHER;
 146       THIS IS PUSHING THE CHANGES TO THE PUBLIC
 147
 148       NOTE: The following commands are to be run on not-backward.mit.edu.
 149       You'll need to add daemon.scripts-security-upd to
 150       scripts-security-upd to get bits to do this.  Make sure you remove
 151       these bits when you're done.
 152
 153    10. Run `wizard research appname`
 154        which uses Git commands to check how many
 155        working copies apply the change cleanly, and writes out a logfile
 156        with the working copies that don't apply cleanly.  It also tells
 157        us about "corrupt" working copies, i.e. working copies that
 158        have over a certain threshold of changes.
 159
 160    11. Run `wizard mass-upgrade appname`, which applies the update to all working
 161        copies possible.
 162
 163    12. Run parallel-find.pl to update our inventory
 164
 165 [ XXX: doc/upgrade.rst ]
 166 * For mass importing into the repository, there are a few extra things:
 167
 168     * When mass producing updates, if the patch has changed you will have to
 169       do a special procedure for your merge:
 170
 171         git checkout pristine
 172         # NOTE: Now, the tricky part (this is different from a real update)
 173         git symbolic-ref HEAD refs/heads/master
 174         # NOTE: Now, we think we're on the master branch, but we have
 175         # pristine copy checked out
 176         # NOTE: -p0 might need to be twiddled
 177         patch -p0 < ../app-1.2.3/app-1.2.3.patch
 178         git add .
 179         # reconstitute .scripts directory
 180         git checkout v1.2.2-scripts -- .scripts
 181         git add .scripts
 182         # NOTE: Fake the merge
 183         git rev-parse pristine > .git/MERGE_HEAD
 184
 185       You could also just try your luck with a manual merge using the patch
 186       as your guide.
 187
 188 [ XXX: doc/layout.rst ]
 189 * The repository for a given application will contain the following files:
 190
 191     - The actual application's files, as from the official tarball
 192
 193     - A .scripts directory, with the intent of holding Scripts specific files
 194       if they become necessary.
 195