Updates

[bacula/bacula] / regress / README

diff --git a/regress/README b/regress/README
index fb6547d1561cefcc67a5c44d392a242eada64cbd..5c121b2ecd42557d6b2dae85e51bf5152fdfaca2 100644 (file)
--- a/regress/README
+++ b/regress/README
@@ -1,33 +1,44 @@
-     Bacula Regression
-     Kern Sibbald
-     April 2003
+             Bacula Regression
+               Kern Sibbald
 
-This is Bacula's regression script directory.  At this time
-(May 2003), it is still in development, so all the tests are
-not complete.
+This is Bacula's regression script directory.
 
-To set it up, first edit Makefile and set BACULA-SOURCE to point
-to your source.
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+Warning!!!! Make sure not to run it on the same system 
+with your production Catalog because the tables will all
+be cleared. You can run it on the your production system
+if you use a different database.
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
-!!!!!!!!!! IMPORTANT !!!!!!!!
-Second, edit the EMAIL address in the Makefile to be your
-email address and not mine or I will get LOTS of unwanted
-email!
 
-Third, edit the DEPKGS path in the Makefile to point to the
-depkgs directory.
+To set it up, create your personal configuration file, by
+copying prototype.conf to xxx.conf or simply editing prototype.conf
+directly.
 
-Fourth, make sure that depkgs is pre-built if it isn't 
+Then edit your conf file and define appropriate values
+for the variables that are in that file.  If you want to see
+a real example, look at kern.conf, but please don't use my
+email address!
+
+Make sure that depkgs is pre-built if it isn't 
 already: (cd your-depkgs; make sqlite).
+Using the .conf file, you can now select between any Catalog type:
+SQLite, SQLite3, MySQL, or PostgreSQL.  Be aware, however, if you
+use an installed database on a production server, running these
+tests will delete all the tables !!!!!!!!!!!!!!!!!!  I run my
+tests on a non-production machine, and in addition, I normally use
+SQLite as the database, while my production uses MySQL.
 
 Then do:
 
+   ./config xxx.conf
    make setup
 
-You run the above one time.  This will copy the Bacula
-source, configure, build it, and configure all the scripts
-and conf files.  If you change your source, you will need
-to redo this command. 
+You run the above one time.  This will build a Makefile from
+Makefile.in and your xxx.conf file, copy the Bacula source,
+configure, build it, and configure all the Bacula scripts
+and conf files.  If you change your source, you will need to
+redo this command.
 
 Then you can run any of the tests in the tests subdirectory.
 Each test whose name ends in -root requires you to be root for
@@ -37,7 +48,8 @@ self-initalizing and should clean up after itself.
 
 Not all the tests yet report OK.  This is simply because there are
 some spurious differences that I haven't yet taken the time to
-eliminate.  The working scrips as of 24 Apr 03 are:
+eliminate.  The working scrips as of 24 Apr 03 are (this is
+way out of date!):
 
 backup-bacula-test
 sparse-test
@@ -50,6 +62,18 @@ verify-vol-test
 The tests expect you to execute them from the main regress 
 directory!               
 
+You can run all the disk based tests by doing:
+
+  ./do_file
+
+You can run all the disk and most of the tape tests by doing:
+
+  ./do_all
+
+Each of the above calls one or more scripts. By looking at the
+scripts available in this directory, you can see that there are a number
+of options for running tests.
+
 You can run them individually as:
 
    tests/two-jobs-test
@@ -71,3 +95,21 @@ to do:
 
 this cleans up any files that may be created with root permissions.
 
+If you want to add more tests, do so by putting the shell script 
+in the tests subdirectory. Be careful when adding (or better not)
+new clients, pools, and such to the test-bacula-dir.conf.in file
+as it may invalidate a good number of tests, which respond to
+questions by answering with a number (i.e. the order of the selection
+list is known). It might be better to add your own testb-bacula...
+configuration file.  
+
+To avoid re-doing a make setup if you have made a change to the
+conf files, and you do not need a new copy of the source, you can simply do:
+
+   make sed
+
+Debugging failed tests:
+The simplest thing to do is to edit tests/xxxx where xxxx is the name of
+the test, and change the line "debug=0" to "debug=1".  If the test has
+not been updated to have the debug variable, please notify Kern, and I
+will be happy to fix it -- I am upgrading them one at a time.