/[drupal]/contributions/modules/DAST/README.txt

Diff of /contributions/modules/DAST/README.txt

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.10,
Fri Dec  7 23:38:07 2007 UTC
+revision 1.11,
Mon Mar 17 10:58:49 2008 UTC
 Line 1
- $Id: README.txt,v 1.9 2007/12/07 17:40:32 allisterbeharry Exp $
+ $Id: README.txt,v 1.10 2007/12/07 23:38:07 allisterbeharry Exp $
  Drupal Automated Staging Toolkit README
  ---------------------------------------
 Line 41 
 Phing(http://www.phing.info) framework f
  testing and staging scenarios. The goal of DAST is to provide a formal,
  repeatable, reusable process using an existing build framework for 'building' a
  Drupal site using a formal build tool and build language. DAST is targeted at
- Drupal testers and developers who must repeatably
+ Drupal testers and developers who must repeatably setup a Drupal site using
- setup a Drupal site using different configurations and code revisions for
+ different configurations and code revisions for profile and module development
- profile and module development and testing, patch testing, and configuration
+ and testing, patch testing,and configuration stability testing and benchmarking.
- stability testing and benchmarking. But DAST can also be used by Drupal
+ But DAST can also be used by Drupal end-users - for example an installation
- end-users - for example an installation profile developer can bundle a DAST
+ profile developer can bundle a DAST script with her profile so that the user of
- script with her profile so that the user of the profile can have her Drupal
+ the profile can have her Drupal site setup and bootstrapped with a minimum of
- site setup and bootstrapped with a minimum of effort - this would be a lot
+ effort - this would be a lot easier than the current manual and error-prone
- easier than the current manual and error-prone process of bringing up a Drupal
+ process of bringing up a Drupal site from scratch before running the profile.
- site from scratch before running the profile.
  If you're tired of the download/untar/copy/drop/create database routine and you
  want to automate testing patches and modules then you're in the right place. If
-Line 105 
 DAST on Vista as soon as I get the oppor
+Line 104 
 DAST on Vista as soon as I get the oppor
 . External tools - DAST and Phing build scripts may require the presence of
  external command-line tools normally present on a development environment. DAST
- currently requires cvs, wget, and patch available on the command line. Windows
+ currently requires cvs, wget, and patch available on the command line.
- users can download a version of wget for  Windows at
+ Windows users can download a version of wget for  Windows at
  http://www.abeharry.info/stuff/dast-ext-tools/wget.exe.
-Line 175 
 the -D parameter:
+Line 174 
 the -D parameter:
  ./bin/dast -f ...<myfile>.xml -D"propertiesFile=myprops.properties"
+ You can also use the -p parameter which indicates a project name. Projects
+ are simply build files together with their properties files which reside in
+ their own directory under the DAST_HOME/projects directory. If you have a
+ myproject.xml build file and you put it in the directory
+ DAST_HOME/projects/myproject together with myproject.properties and/or
+ myproject-base.properties you can then run:
+             ./bin/dast -p myproject
+ This is equivalent to
+             ./bin/dast -f ./projects/myproject -D"propertiesFile=
+             ./projects/myproject/myproject.properties" -D"basePropertiesFile=
+             ./projects/myproject/myproject-base.properties"
  The -D parameter is actually a general parameter that denotes properties you
  wish to pass in to the build process. The 'propertiesFile' property denotes the
  location of the .properties file to load all the remaining properties to
-Line 214 
 assumed relative to the DAST_HOME direct
+Line 226 
 assumed relative to the DAST_HOME direct
  directory is when you run the build command. If you want to use build files or
  property files or other files outside DAST_HOME, use a fully qualified name.
 . Check the status of the build when the script completes - Phing logs
  extensive status information to the screen; check the results of each task in
  the build to see if it completed successfully or if any errors were reported.
-Line 222 
 DAST also logs extensive info to the log
+Line 233 
 DAST also logs extensive info to the log
  (default /var/log/DAST or E:\var\log) so if you encounter any errors be sure to
  check these logs.
-. Access your new Drupal site to complete the installation. The remaining
+. That's it, you're done. You now have a complete working Drupal site for
- installation tasks for your new Drupal site can be accessed at
+ development or testing or deployment. For the default profile you only have to
- ${drupal.Url}install.php?profile=${drupal.profile}&locale=${drupal.locale}
+ create the admin account next. Profiles like drupalorg_testing will do this
- where you will set the site-name, email, the first user account and so on.
+ automatically.
- If the profile you are using already does this, like drupalorg_testing,
- then these will have already been set and the site will be ready to use
- immediately at ${drupal.Url}index.php.
-. That's it, you're done. You now have a complete working Drupal site for
- development or testing or deployment.
  Command-line Args
-Line 258 
 Phing uses the following additional comm
+Line 264 
 Phing uses the following additional comm
  Colour codes
  ------------
- Under *nix the Phing ANSI logger is used which allows the use of colour-coded text messages. Phing builds always
+ Under *nix the Phing ANSI logger is used which allows the use of colour-coded
- provide detailed logging to the screen as the build progresses; the following is a guide to the different
+ text messages. Phing builds always provide detailed logging to the screen as the
- colours used in the screen log text:
+ build progresses; the following is a guide to the different colours used in the
+ screen log text:
   -Blue OK, informational messages echoed to the screen, also 'verbose' output
         from task operations
   -Green OK, informational messages indicating which tasks are executing
-Line 276 
 Known Issues
+Line 283 
 Known Issues
  ------------
 . Under Windows certain versions of wget (my version at least - MINGWport) may
  ignore any part of the Url after the ampersand even when escaped.
- wget  "http://localhost/drupal6/dev/dast/index.php?profile=default&locale=en"
+ wget  "http://localhost/drupal5/dev/dast/index.php?profile=default&locale=en"
- only fetches http://localhost/drupal6/dev/dast/index.php?profile=default This
+ only fetches http://localhost/drupal5/dev/dast/index.php?profile=default This
  means that you still need to go through the 'Choose locale' part. This isn't how
  wget is supposed to behave (if the Url is quoted) so I have to confirm if this
  is just an eccentricity of the version I have on my system.
-. Task log files paths can't contain spaces all - if say you have DAST installed in e:\Drupal projects\dast then setting a tast log file to
+. Task log files paths can't contain spaces all - if say you have DAST
- point at .\logs\dast-patch-install-wget.log won't work because the path will expand to e:\Drupal projects\dast. This doesn't apply to the
+ installed in e:\Drupal projects\dast then setting a task log file to point at
- Phing log file which you set using the -logfile parameter.
+ .\logs\dast-patch-install-wget.log won't work because the path will expand to
+ e:\Drupal projects\dast. This doesn't apply to the Phing log file which you set
+ using the -logfile parameter.
+. If you use the create-files-dir task, which creates the files directory under
+ drupal.dir and chmods it to 0777, the tasks works as expected but cleaning the
+ site after will fail because the .htaccess Drupal drops in there is
+ readonly and the build file will not be able to delete it. The default-site and
+ do_testing-site projects come with a task call clean-files with which you can
+ sudo run to remove the files directory cleanly before the main build so you
+ could go
+              sudo ./bin/dast -p default-site clean-files
+              ./bin/dast -p default-site
+ The next version I will try to figure out a way to delete the .htaccess file
+ (suggestions are welcome.) For many testing and dev scenarios you may not need
+ to use the files directory though.
  Docs
  ----
 . The main documentation page is on Google Docs at http://docs.google.com/Doc?id=dcgv33zb_25d26w5n.
 . See also the Phing user manual in DAST_HOME/phing/docs/phing_guide and also the Diving into Phing...series of
  articles in the SoC2007 group on the Drupal website -
- http://groups.drupal.org/soc-2007 and the DAST wiki page
+ http://groups.drupal.org/soc-2007 and the DAST wiki page @
- @ http://groups.drupal.org/node/3913
+ http://groups.drupal.org/node/3913

 Legend:



Removed from v.1.10
 


changed lines


 
Added in v.1.11
 Legend:



Removed from v.1.10
 


changed lines


 
Added in v.1.11
-Removed from v.1.10
+Added in v.1.11

	ViewVC Help
Powered by ViewVC 1.1.2