Implement 'append-by-default' reports, --redo for mass-upgrade.

[wizard.git] / TODO

diff --git a/TODO b/TODO
index 79de13564d6fc7b5d3b569a1db577b2ebc132374..5457c380c998c6108a30ae4f9d0e101375b2cd5d 100644 (file)
--- a/TODO
+++ b/TODO
@@ -2,45 +2,77 @@ The Git Autoinstaller
 
 TODO NOW:
 
 
 TODO NOW:
 

-- Consider adding user config to repository
-- Put php.ini links in repos (probably will need another
-  script in .scripts)
-- Version configuration
-
-- Consider making usermode wizard operation a support mode
-  (mostly for letting users upgrade things themself)
-
-- Add repository flag to migrate so that we can specify an
-  arbitrary repository to migrate to
-
-- The great initial deploy:
-    - Turn on mediawiki new autoinstaller
-    - Migrate all mediawik installs
-
-- Implement proper deploy log parsing; this basically means we
-  need to be able to introspect Git Log. Consider using git-python
-  for this.  There's also missing functionality, bad error handling
-  and hacks in the prototype implementation of upgrade
-
-- Wordpress needs to have .scripts dir in all -scripts versions
-  (remember --no-walk!) (also make .scripts/.htaccess)
-- Wordpress needs to have a .scripts/update script written for
-  its latest version (do this after its migration)
-- Wordpress needs to check for php.ini files (which it almost
-  certianly has) and commit messages
-
-- Summary script should be more machine friendly, and should not
-  output summary charts when I increase specificity
-- Check how many autoinstalls are missing w bits for
-  daemon.scripts (this would need pyafs)
-- Consider fixing Wizard's commit messages
+- Keep my sanity when upgrading 1000 installs
+    - Distinguish between errors(?)
+    - Custom merge algo: absolute php.ini symlinks to relative symlinks (this
+      does not seem to have been a problem in practice)
+    - Custom merge algo: check if it's got extra \r's in the file,
+      and dos2unix it if it does, before performing the merge
+    - `vos exa` in order to check what a person's quota is.  We can
+      figure out roughly how big the upgrade is going to be by
+      doing a size comparison of the tars: `git pull` MUST NOT
+      fail, otherwise things are left conflicted, and not easy to fix.
+    - Prune -7 call errors and automatically reprocess them (with a
+      strike out counter of 3)--this requires better error parsing
+    - Report stats if I C-C the process
+
+- Distinguish from logging and reporting (so we can easily send mail
+  to users)
+    - Figure out a way of collecting blacklist data from .scripts/blacklisted
+      and aggregate it together
+    - Failed migrations should be wired to have wizard commands in them
+      automatically log to the relevant file.  In addition, the seen file
+      should get updated when one of them gets fixed.
+    - Failed migration should report how many unmerged files there are
+      (so we can auto-punt if it's over a threshold)
+
+- Let users use Wizard when ssh'ed into Scripts
+    - Make single user mass-migrate work when not logged in as root
+
+- Make the rest of the world use Wizard
+    - Make parallel-find.pl use `sudo -u username git describe --tags`
+      to determine version.  Make parallel-find.pl have this have greater
+      precedence.  This also means, however, that we get
+      full mediawiki-1.2.3-2-abcdef names (Have patch, pending testing and commit)
+    - Make deployed installer use 'wizard install' /or/ do a migration
+      after doing a normal install (the latter makes it easier
+      for mass-rollbacks).
+
+- Pre-emptively check if daemon/scripts-security-upd
+  is not on scripts-security-upd list (/mit/moira/bin/blanche)
+
+- Redo Wordpress conversion, with an eye for automating everything
+  possible (such as downloading the tarball and unpacking)
+
+- Pay back code debt
+    - Genericize callAsUser and drop_priviledges in shell
+    - Summary script should be more machine friendly, and should not
+      output summary charts when I increase specificity
+    - Summary script should do something intelligent when distinguishing
+      between old-style and new-style installs
+    - Report code in wizard/command/__init__.py is ugly as sin
+
+- Other stuff
+    - Don't use the scripts heuristics unless we're on scripts with the
+      AFS patch.  Check with `fs sysname`
+    - Make 'wizard summary' generate nice pretty graphs of installs by date
+      (more histograms, will need to check actual .scripts-version files.)
+    - It should be able to handle installs like Django where there's a component
+      that gets installed in web_scripts and another directory that gets installed
+      in Scripts.
+    - ACLs is a starting point for sending mail to users, but it has
+      several failure modes:
+        - Old maintainers who don't care who are still on the ACL
+        - Private AFS groups that aren't mailing lists and that we
+          can't get to
+      A question is whether or not sending mail actually helps us:
+      many users will probably have to come back to us for help; many
+      other users won't care.

 
 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
 
 
 PULLING OUT CONFIGURATION FILES IN AN AUTOMATED MANNER
 

-advancedbook: Two template files to fill out

 advancedpoll: Template file to fill out
 django: Noodles of template files
 advancedpoll: Template file to fill out
 django: Noodles of template files

-e107: Multistage install process

 gallery2: Multistage install process
 joomla: Template file
 mediawiki: One-step install process
 gallery2: Multistage install process
 joomla: Template file
 mediawiki: One-step install process


@@ -50,6 +82,37 @@ trac: NFC
 turbogears: NFC
 wordpress: Multistage install process
 
 turbogears: NFC
 wordpress: Multistage install process
 

+PHILOSOPHY ABOUT LOGGING
+
+Logging is most useful when performing a mass run.  This
+includes things such as mass-migration as well as when running
+summary reports.  An interesting property about mass-migration
+or mass-upgrade, however, is that if they fail, they are
+idempotent, so an individual case can be debugged simply running
+the single-install equivalent with --debug on.  (This, indeed,
+may be easier to do than sifting through a logfile).
+
+It is a different story when you are running a summary report:
+you are primarily bound by your AFS cache and how quickly you can
+iterate through all of the autoinstalls.  Checking if a file
+exists on a cold AFS cache may
+take several minutes to perform; on a hot cache the same report
+may take a mere 3 seconds.  When you get to more computationally
+expensive calculations, however, even having a hot AFS cache
+is not enough to cut down your runtime.
+
+There are certain calculations that someone may want to be
+able to perform on manipulated data.  As such, this data should
+be cached on disk, if the process for extracting this data takes
+a long time.  Also, for usability sake, Wizard should generate
+the common case reports.
+
+Ensuring that machine parseable reports are made, and then making
+the machinery to reframe this data, increases complexity.  Therefore,
+the recommendation is to assume that if you need to run iteratively,
+you'll have a hot AFS cache at your fingerprints, and if that's not
+fast enough, then cache the data.
+

 COMMIT MESSAGE FIELDS:
 
 Installed-by: username@hostname
 COMMIT MESSAGE FIELDS:
 
 Installed-by: username@hostname


@@ -66,18 +129,14 @@ Author: lockername locker <lockername@scripts.mit.edu>
 
 NOTES:
 
 
 NOTES:
 

-- A perfectly formed autoinstall with upgrade paths for all of
-  the intervening versions is not really feasible to implement.
-  As such, we want to migrate everything to -scripts, and then
-  generate a -scripts2 with the correct .scripts directory.
-  We will then nop update some installs, but this will prevent
-  us from having to migrate and update concurrently.  Treat
-  a scripts2 upgrade from migration the same way you would treat
-  a botched scripts upgrade.
+- It is not expected or required for update scripts to exist for all
+  intervening versions that were present pre-migration; only for it
+  to work on the most recent migration.

 
 - Currently all repositories are initialized with --shared, which
   means they have basically ~no space footprint.  However, it
 
 - Currently all repositories are initialized with --shared, which
   means they have basically ~no space footprint.  However, it

-  also means that /mit/scripts/wizard/srv MUST NOT lose revs.
+  also means that /mit/scripts/wizard/srv MUST NOT lose revs after
+  deployment.

 
 - Full fledged logging options. Namely:
   x all loggers (delay implementing this until we actually have debug stmts)
 
 - Full fledged logging options. Namely:
   x all loggers (delay implementing this until we actually have debug stmts)


@@ -86,20 +145,9 @@ NOTES:
   x stdout logger
     - default is WARNING (see below for exception)
     - verbose   => loglevel = INFO
   x stdout logger
     - default is WARNING (see below for exception)
     - verbose   => loglevel = INFO

-  x file logger (only allowed for serial processing)
+  x file logger (creates a dir and lots of little logfiles)

     - default is OFF
     - log-file   => loglevel = INFO
     - default is OFF
     - log-file   => loglevel = INFO

-  x database logger (necessary for parallel processing, not implemented)
-    - default is OFF
-    - log-db    => loglevel = INFO
-
-- More on the database logger: it will be very simple with one
-  table named `logs` in SQLite, with columns: `job`, `level`,
-  `message`.  Job identifies the subprocess/thread that emitted
-  the log, so things can be correlated together.  We will then
-  have `wizard dump` which takes a database like this and dumps
-  it into a file logger type file.  The database may also store
-  a queue like structure which can be used to coordinate jobs.

 
 OVERALL PLAN:
 
 
 OVERALL PLAN:
 


@@ -107,37 +155,34 @@ OVERALL PLAN:
   on documenting them.  Specifically, we will be keeping:
 
     - parallel-find.pl, and the resulting
   on documenting them.  Specifically, we will be keeping:
 
     - parallel-find.pl, and the resulting

-      /mitalso make .scripts/.htaccess/scripts/sec-tools/store/scriptslist
-      This script might need to be adapted if we decide to nuke
-      .scripts-version files.
-
-    - The current install scripts will be kept in place, sans changes
-      necessary to make them use Git install of copying the script over.
-      Porting these scripts to Python and making them modular would be
-      nice, but is priority.  For the long term, seeing this scripts
-      be packaged with rest of our code would be optimal.
+      /mit/scripts/.htaccess/scripts/sec-tools/store/scriptslist

 
 * The new procedure for generating an update is as follows:
   (check out the mass-migration instructions for something in this spirit,
 
 * The new procedure for generating an update is as follows:
   (check out the mass-migration instructions for something in this spirit,

-  although uglier in some ways)
+  although uglier in some ways; A indicates the step /should/ be automated)

 
     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 
     1. Have the Git repository and working copy for the project on hand.
 
 
     0. ssh into not-backward, temporarily give the daemon.scripts-security-upd
        bits by blanching it on system:scripts-security-upd, and run parallel-find.pl
 
     1. Have the Git repository and working copy for the project on hand.
 

-    2. Checkout the pristine branch
+/- wizard prepare-pristine --
+
+A   2. Checkout the pristine branch

 
 

-    3. Remove all files from the working copy.  Use `wipe-working-dir`
+A   3. Remove all files from the working copy.  Use `wipe-working-dir`

 
 

-    4. Download the new tarball
+A   4. Download the new tarball

 
 

-    5. Extract the tarball over the working copy (`cp -R a/. b` works well,
-       remember that the working copy is empty)
+A   5. Extract the tarball over the working copy (`cp -R a/. b` works well,
+       remember that the working copy is empty; this needs some intelligent
+       input)

 
 

-    6. Check for empty directories and add stub files as necessary.
+A   6. Check for empty directories and add stub files as necessary.

        Use `preserve-empty-dir`
 
        Use `preserve-empty-dir`
 

+\---
+

     7. Git add it all, and then commit as a new pristine version (v1.2.3)
 
     8. Checkout the master branch
     7. Git add it all, and then commit as a new pristine version (v1.2.3)
 
     8. Checkout the master branch


@@ -149,33 +194,40 @@ OVERALL PLAN:
        to keep our history clean
 
        [FOR NEW REPOSITORIES]
        to keep our history clean
 
        [FOR NEW REPOSITORIES]

-       See if any patches are needed to make this run smoothly on
-       scripts.
-
-    [FOR NEW REPOSITORIES]
-        mkdir .scripts
-        echo "Deny from all" > .scripts/.htaccess
-        touch .scripts/update
-        chmod a+x .scripts/update
-
-   10. Check if there are any special update procedures, and update/create the
-       .scripts/update shell script as necessary (this means that any
-       application specific update logic will be kept with the actual
-       source code.  The language of this update script will vary
-       depending on context.)
-
-   11. Commit your changes, and tag as v1.2.3-scripts (or scripts2, if
+       Check if any patches are needed to make the application work
+       on Scripts (ideally, it shouldn't.
+
+/- wizard prepare-new --
+
+    Currently not used for anything besides parallel-find.pl, but
+    we reserve the right to place files in here in the future.
+
+A       mkdir .scripts
+A       echo "Deny from all" > .scripts/.htaccess
+
+\---
+
+   10. Check if there are any special update procedures, and update
+       the wizard.app.APPNAME module accordingly (or create it, if
+       need be).
+
+   11. Run 'wizard prepare-config' on a scripts server while in a checkout
+       of this newest version.  This will prepare a new version of the
+       configuration file based on the application's latest installer.
+       Manually merge back in any custom changes we may have made.
+       Check if any of the regular expressions need tweaking by inspecting
+       the configuration files for user-specific gunk, and modify
+       wizard.app.APPNAME accordingly.
+
+   12. Commit your changes, and tag as v1.2.3-scripts (or scripts2, if

        you are amending an install without an upstream changes)
 
        you are amending an install without an upstream changes)
 

-   12. Test the new update procedure using
-       `wizard upgrade --with=/path/to/repo /your/autoinstall` (this will
-       read out master as your "latest" version).
-       Use git commit --amend to fix any bugs (alternatively, squash them
-       together later).
+      NOTE: These steps should be run on a scripts server
+
+   13. Test the new update procedure using our test scripts.  See integration
+       tests for more information on how to do this.

 
 

-   13. You can also do a "mass" version of this using:
-       `wizard -d testbed.txt massupgrade --with=/path/to/repo app`
-       You'll need perms for any testbed stuff you want.
+        http://scripts.mit.edu/wizard/testing.html#acceptance-tests

 
       GET APPROVAL BEFORE PROCEEDING ANY FURTHER
 
 
       GET APPROVAL BEFORE PROCEEDING ANY FURTHER
 


@@ -184,121 +236,53 @@ OVERALL PLAN:
       scripts-security-upd to get bits to do this.  Make sure you remove
       these bits when you're done.
 
       scripts-security-upd to get bits to do this.  Make sure you remove
       these bits when you're done.
 

-   14. Run `wizard research appname`
+A  14. Run `wizard research appname`

        which uses Git commands to check how many
        working copies apply the change cleanly, and writes out a logfile
        with the working copies that don't apply cleanly.  It also tells
        which uses Git commands to check how many
        working copies apply the change cleanly, and writes out a logfile
        with the working copies that don't apply cleanly.  It also tells

-       us about "corrupt" working copies.
+       us about "corrupt" working copies, i.e. working copies that
+       have over a certain threshold of changes.

 
 

-   15. Run `wizard massupgrade appname`, which applies the update to all working
+A  15. Run `wizard mass-upgrade appname`, which applies the update to all working

        copies possible, and sends mail to users to whom the working copy
        copies possible, and sends mail to users to whom the working copy

-       did not apply cleanly. It also frobs .scripts-version for successful
-       upgrades (maybe not, depending on our plans).
+       did not apply cleanly.

 
    16. Run parallel-find.pl to update our inventory
 
 
    16. Run parallel-find.pl to update our inventory
 

-* For mass importing into the repository, the steps are:
-  (this probably won't ever be automated, becuase there are fiddly bits)
-
-[TO SET IT UP]
-# let app-1.2.3 be the scripts folder originally in deploydev
-# let this folder be srv/
-# you can also do a git clone
-    mkdir app
-    cd app
-    git init
-    cd ..
-unfurl app-1.2.3 app  # [FIDDLY BIT]
-# NOTE: contents of application are now in app directory
-cd app
-git add .
-git commit -s -m "App 1.2.3"
-git tag v1.2.3
-git branch pristine
-# NOTE: you're still on master branch
-# WARNING: the following operation might require -p1
-patch -p0 < ../app-1.2.3/app-1.2.3.patch  # [FIDDLY BIT]
-# NOTE: please sanity check the patch!
-git add .
-# NOTE: -a flag is to handle if the patch deleted something
-git commit -as -m "App 1.2.3-scripts"
-git tag v1.2.3-scripts
-
-[TO ADD AN UPDATE]
-# let this folder be srv/app.git
-git checkout pristine
-# NOTE: this preserves your .git folder, but removes everything
-wipe-working-dir .
-cd ..
-unfurl app-1.2.3 app  # [FIDDLY BIT]
-cd app
-# NOTE: please sanity check app directory
-git add .
-# NOTE: -a is to take care of deletions
-git commit -as -m "App 1.2.3"
-git tag v1.2.3
-[FIDDLE AROUND. FIDDLE AROUND]
-[IF THE PATCH HAS CHANGED]
-    # You are on the pristine branch
-    # NOTE: Now, the tricky part (this is different from a real update)
-    git symbolic-ref HEAD refs/heads/master
-    # NOTE: Now, we think we're on the master branch, but we have
-    # pristine copy checked out
-    # NOTE: -p0 might need to be twiddled
-    patch -p0 < ../app-1.2.3/app-1.2.3.patch
-    git add .
-    # COMMENT: used to git checkout .scripts here
-    # then check if the directory needs an updated update script
-    # NOTE: Fake the merge
-    git rev-parse pristine > .git/MERGE_HEAD
-[IF THE PATCH HASN'T CHANGED]
-    git checkout master
-    git merge --no-commit pristine
-git commit -as -m "App 1.2.3-scripts"
-git tag v1.2.3-scripts
+* For mass importing into the repository, there are a few extra things:

 
 

-* The repository for a given application will contain the following files:
-
-    - The actual application's files, as from the official tarball
+    * Many applications had patches associated with them.  Be sure to
+      apply them, so later merges work better.

 
 

-    - A .scripts directory, which contains the following information:
+        # the following operation might require -p1
+        patch -p0 < ../app-1.2.3/app-1.2.3.patch  # [FIDDLY BIT]

 
 

-        * .scripts/update shell script (with the +x bit set appropriately),
-          which performs the commands necessary to update a script.  This can
-          be in any language.
+    * When running updates, if the patch has changed you will have to
+      do a special procedure for your merge:

 
 

-        * .scripts/.htaccess to prevent this directory from being accessed
-          from the web.
+        git checkout pristine
+        # NOTE: Now, the tricky part (this is different from a real update)
+        git symbolic-ref HEAD refs/heads/master
+        # NOTE: Now, we think we're on the master branch, but we have
+        # pristine copy checked out
+        # NOTE: -p0 might need to be twiddled
+        patch -p0 < ../app-1.2.3/app-1.2.3.patch
+        git add .
+        # reconstitute .scripts directory
+        git checkout v1.2.2-scripts -- .scripts
+        git add .scripts
+        # NOTE: Fake the merge
+        git rev-parse pristine > .git/MERGE_HEAD

 
 

-        * .scripts/database (generated) contains the database the
-          user installed the script to, so scripts-remove can clean it
+      You could also just try your luck with a manual merge using the patch
+      as your guide.

 
 

-            XXX: Could cause problems if a user copies the autoinstall,
-            fiddles with the DB credentials, and then scripts-remove's
-            the autoinstall.  Possible fix is to add the original
-            directory as a sanity check.  Additionally, we could have
-            the application read out of this file.
-
-        * .scripts/old-version (optional) the old value of .scripts-versoin
-
-        * .scripts/install (eventually) interactively installs the
-          applicatoin from command line.
-
-* The autoupgrade shall be the process of:
+* The repository for a given application will contain the following files:

 
 

-    # Make the directory not accessible by the outside world (htaccess, but be careful!)
-    git add -u .
-    git commit -m 'automatically generated backup'
-    git pull origin master
-    if [ $? ne 0 ]; then git reset --hard; echo 'conflicts during upgrade'; fi
-    ./.scripts/update
-    # Make it accessible
+    - The actual application's files, as from the official tarball

 
 

-  (with some more robust error checking, a proper dry run mechanism to, and
-  lots of su'ing)
+    - A .scripts directory, with the intent of holding Scripts specific files
+      if they become necessary.

 
 

-* Make 'wizard summary' generate nice pretty graphs of installs by date
-  (more histograms, will need to check actual .scripts-version files.)
+        * .scripts/lock (generated) which locks an autoinstall during upgrade

 
 

-* Update AFS patch to advertise its existence, so we can check for it
-  here.