From 93227e362aee5de718f37e214bd3886649f4b2bb Mon Sep 17 00:00:00 2001 From: Pavel Raiskup Date: Wed, 5 Nov 2014 13:46:19 +0100 Subject: controller/README: reworked from top-srcdir README * README: Made as symlink to controller/README. * controller/Makefile.am: Distribute the README and configuration file template. * controller/README: Reworked version of README following current API. * controller/doc/dtf-controller/OSID.sh.template: New configuration template. * tester/dtf-prepare-testsuite: Prepare also basic taskdir structure. --- README | 57 +-------------------------------------------------------- 1 file changed, 1 insertion(+), 56 deletions(-) mode change 100644 => 120000 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index de16e14..0000000 --- a/README +++ /dev/null @@ -1,56 +0,0 @@ -GENERAL INFO -============ - -System checking (dummy) testsuite fw. The tests are *expected* to be -destructive and always performed under root account; test writer should only -make sure that no test conflicts with others (so that all tests are able to run -on one machine successfully in any order). - -TODO: bash-only, unix.. - -OVERVIEW -======== - - -Each file should consist of config.sh and runtest.sh. Both are supposed to be -"sourced" into another scripts (so no need to have execute permissions). Each -test case should have its own directory. - -USAGE (locally) -=============== - -The most simple usage is like `./run`. Script is able to search for available -test-cases and then run them on local machine. Note that this is not generaly -safe and you should avoid that in most cases. For more info, run -`./run --help`. TODO: The testsuite is root-only. - -REMOTE RUN -========== - -You need to have OpenStack credentials file in ./private/ostack.yml configured. -The file should look like (be sure that only you can read that file): - $ cat ./private/ostack.yml: - --- - os_username: os1username - os_tenant_id: 9df30fc192f5xxxxxxxxxxxxxxxx0110 - os_nova_password: your_os_password - -Then it should be enough to run: - - $ ./run_remote - -API for config.sh file -====================== - -Variables which should/may be defined in config.sh file. - -$DTF_TEST_ID - unique ID of task. Without spaces. - -$DTF_TEST_DESCRIPTION - descriptive info about test, will be used for -generating html or otherwise formated result output. - -REQUIREMENTS -============ - -Packages needed to successful run - * ansible (remote running) diff --git a/README b/README new file mode 120000 index 0000000..6f1e091 --- /dev/null +++ b/README @@ -0,0 +1 @@ +controller/README \ No newline at end of file -- cgit