test/ directory contains a library of Python modules that
+make end-to-end testing of BOINC easy.
+
+
+ cd boinc/test && ./test_uc.py
+
+
+Full test suite:
+
+ cd boinc/test && make check
+
--Many BOINC features involve multiple projects and/or multiple hosts. -It would be prohibitively complex to do automated testing -on multiple physical hosts. -Fortunately the BOINC architecture makes it possible for -multiple projects and (virtual) hosts to reside on a single physical host. -So the testing framework uses this approach. + +Many BOINC features involve multiple projects and/or multiple hosts. It would +be prohibitively complex to do automated testing on multiple physical hosts. +Fortunately the BOINC architecture makes it possible for multiple projects and +(virtual) hosts to reside on a single physical host. So the testing framework +uses this approach.
The framework lets you test systems with any of the following attributes: @@ -43,332 +55,186 @@ The following system attributes are planned but not implemented yet: (out of disk space, crash/reboot, etc.). -
-boinc_projects/ - proj1/ - cgi/ - download/ /*this is where the real download directory*/ - download0/ /*these are optional, they are soft links to the - real download directory*/ - download1/ - ... - html_ops/ - html_user/ - keys/ - upload/ - proj2/ - ... --where proj1, proj2 etc. are the names of the projects in your scripts. +
-Similarly, you must designate a 'BOINC hosts' directory on your test host. -The framework will create subdirectories as follows: -
-boinc_hosts/ - host1/ - projects/ - slots/ - client_state.xml - log_flags.xml - host2/ - ... --where host1, host2 etc. are the names of the hosts in your scripts. +Note that a performance web server with PHP is required for running a real +server, but that requires a lot of path and permissions configuration so we +opt not to use them in testing. -
-class Project { // represents a project
- var $name; // defaults to 'test'; override if needed
- var $generate_keys; // set to true if you want to generate
- // encryption keys for this project (slow)
- function add_user($user); // add a User to project's DB
- function add_app($app); // add an application
- function add_app_version($app_version); // add an app version
- function install(optional: $scheduler_file);
- //set up directories and DB. If $scheduler_file is provided, then
- //there will be installed schedulers at the directories pointed by
- //the schedulers
- function start(); // start feeder
- function stop(); // stop feeder
- function compare_file($out, $correct);
- // verify that a result file matches a known-correct file
- function check_results($n, $result);
- // check that there are n results
- // and that they match 'result'
- // (for all fields that are defined)
+
- // The functions below are used to interrupt or remove certain
- // functionalities of the project for a desired time in order to be
- // able to test persistence across these failures. All the
- // parameters of the functions below are optional.
- // $cgi_num,$download_dir_num,
- // $handler_num refer to the number of the corresponding parts of
- // the system to be disabled temporarily. if they are not
- // the default cgi, download, and file_upload_handler respectively.
- // multiple cgis can be handles with passing in a file with
- // scheduler_urls to project->install. Multiple download URLS are
- // handled by adding a numer in between the download_url and the
- // file to be downloaded in the wu_template file of the Work class
- // for example:
-A test script instantiates one or more instances of
-these classes, links them as needed,
-installs them, starts the projects, runs the hosts.
-It then checks the final state
-(typically, that results are done and result files are correct).
-
--setenv BOINC_PROJECTS_DIR /home/david/boinc_projects -# BOINC projects directory -setenv BOINC_HOSTS_DIR /home/david/boinc_hosts -# BOINC hosts directory -setenv BOINC_USER_NAME david -# part of DB name, and prepended to web error log entries -setenv BOINC_SRC_DIR /home/david/boinc_cvs/boinc -# BOINC source directory -setenv BOINC_CGI_DIR /home/david/cgi-bin -# path of a CGI directory -setenv BOINC_CGI_URL http://localhost/cgi-bin -# URL of that directory -setenv BOINC_HTML_DIR /home/david/html -# path of a web-page directory -setenv BOINC_HTML_URL http://localhost -# URL of that directory -setenv BOINC_KEY_DIR /home/david/boinc_keys -# path of some pre-generated security keys -setenv BOINC_PLATFORM i686-pc-linux-gnu -# platform name of this machine -setenv BOINC_SHMEM_KEY 0x3abc1234 -# shared-memory key; must be less than 2^31 --
-#! /usr/local/bin/php -<?php - include_once(\"test.inc\"); - - $project = new Project; - $user = new User(); - $host = new Host($user); - $app = new App(\"upper_case\"); - $app_version = new App_Version($app); - - $project->add_user($user); - $project->add_app($app); - $project->add_app_version($app_version); - $project->install(); // must install projects before adding to hosts - - $host->log_flags = \"log_flags.xml\"; - $host->add_project($project); - $host->install(); - - echo \"adding work\n\"; - - $work = new Work($app); - $work->wu_template = \"uc_wu\"; - $work->result_template = \"uc_result\"; - $work->nresults = 2; - array_push($work->input_files, \"input\"); - $work->install($project); - - $project->start(); - $host->run(\"-exit_when_idle\"); - $project->stop(); - - $result->state = RESULT_STATE_DONE; - $result->stderr_out = \"APP: upper_case: starting, argc 1\"; - $result->exit_status = 0; - $project->check_results(2, $result); - $project->compare_file(\"uc_wu_0_0\", \"uc_correct_output\"); - $project->compare_file(\"uc_wu_1_0\", \"uc_correct_output\"); -?> -- -
apps directory contains the following test applications:
upper_case: converts a file to upper case.
+ concat: concatenates its input files.
+ 1sec: uses 1 second of CPU time.
+ uc_slow: like upper_case, but processes only one character per
+ second. Checkpoints every 5 characters. Restartable.
test/ directory contains various python scripts named with
+prefix test_. Each of these is a test case which runs an
+end-to-end test of BOINC (creates directory structure for project(s) and
+host(s), starts a web server, server daemons, host client(s), and checks
+output is as expected).
+test_uc.py |
+ The basic test using uppercase |
test_concat.py |
+ tests command-line arguments and + filenames |
test_uc_slow.py |
+ tests checkpoint/restart mechanism |
test_prefs.py |
+ tests some aspects of preferences. |
test_water.py |
+ tests some aspects of water marks. |
test_rsc.py |
+ tests that scheduling server only sends + feasible work units. |
test_pers.py |
+ tests the persistent file transfers for + download and upload. It interrupts them in the middle and makes sure + that the filesize never decreases along interrupted transfers. |
test_masterurl_failure.py |
+ tests the exponential backoff + mechanism on the client in case of master IURL failures. This test is + not automated. It has to be run, and then client.out (in the host + directory) must be looked at to examine whether everything is working + correctly. |
test_sched_failure.py |
+ tests the exponential backoff mechanism + on the client in case of scheduling server failures. + This test is not automated. + It has to be run, and then client.out (in the host + directory) must be looked at to examine whether everything + is working correctly. |
-Host->install() does the following: -
-The apps directory contains the following test applications: -
-The test directory contains PHP scripts, together with XML -templates and sample input files, for initializing and testing the -entire system: -
BOINC_TEST_USER_NAME
+
+ User name to use for setting up database name. Defaults to $USER
+
+
+BOINC_TEST_VERBOSE
++ Verbosity level. ++ ++
++ 0print nothing 1[default]print some. if output is a tty, overwrite lines. +2print all +
BOINC_TEST_DELETE
++ Specifies whether or not to delete testbed after the test finishes. Only + relevant when BOINC_TEST_AUTO_SETUP=0. Possible values (case doesn't + matter): +++
++ No+ If-Successful[default]+ Always
BOINC_TEST_INSTALL_METHOD
++ Specifies how to install html/php, cgi from source directories to testbed + location. ++ ++
+ Copying is useful because it preserves what version of the file was used + in a particular test run and hardlinking is best because compiled cgi and + scheduler programs are not disrupted by parallel builds. ++ linkhardlink + symlink[default]symbolic link + copycopy
++ ++BOINC_TEST_AUTO_SETUP=0 [default=1] +BOINC_TEST_KEY_DIR +BOINC_TEST_PROJECTS_DIR +BOINC_TEST_CGI_URL +BOINC_TEST_HTML_URL +BOINC_TEST_CGI_DIR +BOINC_TEST_HTML_DIR +BOINC_TEST_HOSTS_DIR ++
+ QHOME=/disks/philmor/a/users/quarl/proj + TOP=$QHOME/test-boinc + URL=http://milhouse.ssl.berkeley.edu/quarl + + export BOINC_TEST_PROJECTS_DIR=$TOP/projects + export BOINC_TEST_USER_NAME=quarl + export BOINC_TEST_SRC_DIR=$QHOME/boinc + export BOINC_TEST_CGI_DIR=$TOP/boinc_cgi + export BOINC_TEST_CGI_URL=$URL/boinc_cgi + export BOINC_TEST_HTML_DIR=$TOP/boinc_html + export BOINC_TEST_HTML_URL=$URL/boinc_html + export BOINC_TEST_SHMEM_KEY=0x1717f00f + export BOINC_TEST_KEY_DIR=$TOP/keys + export BOINC_TEST_HOSTS_DIR=$TOP/host ++ +Apache configuration: +
+ <Directory /disks/philmor/a/users/quarl/proj/test-boinc> + AllowOverride FileInfo AuthConfig Limit + Options Indexes SymLinksIfOwnerMatch IncludesNoExec ExecCGI + <Limit GET POST OPTIONS PROPFIND> + Order allow,deny + Allow from all + </Limit> + </Directory> + + ScriptAlias /quarl/boinc_cgi/ "/disks/philmor/a/users/quarl/proj/test-boinc/boinc_cgi/" + Alias /quarl/ "/disks/philmor/a/users/quarl/proj/test-boinc/" ++ + + + diff --git a/test/README b/test/README deleted file mode 100644 index 4c36b87cde..0000000000 --- a/test/README +++ /dev/null @@ -1,124 +0,0 @@ - -$Id$ - -TEST SCRIPTS -============ -These test scripts will test that BOINC works as expected/designed. - -PREREQUISITES -------------- -1. MySQL installed and running. Currently the script expects it to be running - on localhost but that could be changed. -2. Python 2.2, Python module MySQLdb -3. Perl - -COREQUISITES ------------- -1. Webserver. Normally boinc.py will use an included custom webserver - cgiserver.py, but any webserver could be used if configured. See below. -2. PHP. Used if found, otherwise uses fake_php.py - -OTHER RECOMMENDED TOOLS ------------------------ -1. PHPMyAdmin. Useful for viewing database. - -RUNNING -------- - -Type: (in either the test/ directory or the boinc source root directory) - - make check - - - - - - -APPENDICES -========== - -OPTIONAL ENVIRONMENT VARIABLES ------------------------------- -The following environment variables are optional and apply whatever web server -you use: - -BOINC_TEST_USER_NAME - User name to use for setting up database name. Defaults to $USER - -BOINC_TEST_VERBOSE - Verbosity level. - 0 print nothing - 1 [default] print some - if output is a tty, overwrite lines. - 2 print all - -BOINC_TEST_DELETE - Specifies whether or not to delete testbed after the test finishes. Only - relevant when BOINC_TEST_AUTO_SETUP=0. Possible values (case doesn't - matter): - No - If-Successful [default] - Always - -BOINC_TEST_INSTALL_METHOD - Specifies how to install html/php, cgi from source directories to testbed - location. - link - hardlink - symlink [default] - symbolic link - copy - copy - - Copying is useful because it preserves what version of the file was used - in a particular test run and - - Hardlinking is best because compiled cgi and scheduler programs are not - disrupted by parallel builds. - - -WEB SERVER ----------- -By default, the test script will use a custom web server that has no security -and minimal cgi/php capability. You can also use Apache or some other -web server with manually initialized directories by setting these environment -variables: - -BOINC_TEST_AUTO_SETUP=0 [default=1] -BOINC_TEST_KEY_DIR -BOINC_TEST_PROJECTS_DIR -BOINC_TEST_CGI_URL -BOINC_TEST_HTML_URL -BOINC_TEST_CGI_DIR -BOINC_TEST_HTML_DIR -BOINC_TEST_HOSTS_DIR - -Example: - -Bourne shell: - - QHOME=/disks/philmor/a/users/quarl/proj - TOP=$QHOME/test-boinc - URL=http://milhouse.ssl.berkeley.edu/quarl - - export BOINC_TEST_PROJECTS_DIR=$TOP/projects - export BOINC_TEST_USER_NAME=quarl - export BOINC_TEST_SRC_DIR=$QHOME/boinc - export BOINC_TEST_CGI_DIR=$TOP/boinc_cgi - export BOINC_TEST_CGI_URL=$URL/boinc_cgi - export BOINC_TEST_HTML_DIR=$TOP/boinc_html - export BOINC_TEST_HTML_URL=$URL/boinc_html - export BOINC_TEST_SHMEM_KEY=0x1717f00f - export BOINC_TEST_KEY_DIR=$TOP/keys - export BOINC_TEST_HOSTS_DIR=$TOP/host - -Apache config: - -