]> scripts.mit.edu Git - wizard.git/commitdiff
Permute the ordering of test script names in docs.
authorEdward Z. Yang <ezyang@mit.edu>
Sun, 4 Sep 2011 21:49:31 +0000 (17:49 -0400)
committerEdward Z. Yang <ezyang@mit.edu>
Sun, 4 Sep 2011 21:49:31 +0000 (17:49 -0400)
Signed-off-by: Edward Z. Yang <ezyang@mit.edu>
doc/create.rst

index a87f407ef3615bd7b2c2b5746837a13733a08f7a..94b0e7770255862ced76b8ee9204f217c4c7db63 100644 (file)
@@ -279,14 +279,14 @@ Some tips and tricks for writing :meth:`wizard.app.Application.install`:
       to the connection, you can perform implicit execution.
 
 To test if your installation function works, it's probably convenient to
-create a test script in :file:`tests`; :file:`tests/test-install-wordpress.sh`
+create a test script in :file:`tests`; :file:`tests/wordpress-install-test.sh`
 in the case of Wordpress.  It will look something like::
 
     #!/bin/bash -e
     cd `dirname $0`
 
     DEFAULT_HEAD=1
-    TESTNAME="install_wordpress"
+    TESTNAME="wordpress_install"
     source ./setup
 
     wizard install "wordpress-$VERSION-scripts" "$TESTDIR" --non-interactive -- --title="My Blog"
@@ -301,11 +301,11 @@ in the case of Wordpress.  It will look something like::
 ``DEFAULT_HEAD=1`` indicates that this script can perform a reasonable
 operation without any version specified (since we haven't tagged any of our
 commits yet, we can't use the specific version functionality; not that we'd want
-to, though).  ``TESTNAME`` is simply the name of the file with the leading
-``test-`` stripped and dashes converted to underscores.  Run the script with
+to, though).  ``TESTNAME`` is simply the name of the file with the trailing
+``-test`` stripped and dashes converted to underscores.  Run the script with
 verbose debugging information by using::
 
-    env WIZARD_DEBUG=1 ./test-install-wordpress.sh
+    env WIZARD_DEBUG=1 ./wordpress-install-test.sh
 
 The test scripts will try to conserve databases by running ``wizard remove`` on the
 old directory, but this requires :meth:`~wizard.app.remove` be implemented.
@@ -329,7 +329,7 @@ exhibit different behavior depending on server configuration, you should run
 the installation on a Scripts server.  You can do this manually or use
 the test script you created::
 
-    env WIZARD_NO_COMMIT=1 ./test-install-wordpress.sh
+    env WIZARD_NO_COMMIT=1 ./wordpress-install-test.sh
 
 :envvar:`WIZARD_NO_COMMIT` (command line equivalent to ``--no-commit``)
 prevents the installer from generating a Git commit after the install, and will
@@ -547,7 +547,7 @@ Here is short version for quick reference:
 #. *For PHP:* Copy in :file:`php.ini` file and run ``athrun scripts fix-php-ini``,
 #. Commit with ``-m "$APPLICATION $VERSION"``, but *don't* tag,
 #. Implement :data:`~wizard.app.Application.install_schema` and :meth:`~wizard.app.Application.install`,
-#. Create :file:`tests/test-install-$APP.sh`,
+#. Create :file:`tests/$APP-install-test.sh`,
 #. On a scripts server, run ``wizard install $APP --no-commit`` and check changes with ``git status``,
 #. Implement :attr:`~wizard.app.Application.extractors`,
    :attr:`~wizard.app.Application.substitutions`, :attr:`~wizard.app.Application.parametrized_files`,