From 780468659ffcd9cf5950eb043159c78c6ee652da Mon Sep 17 00:00:00 2001 From: Prasanna Santhanam Date: Fri, 12 Oct 2012 16:07:03 +0530 Subject: [PATCH] uniting the READMEs Many READMEs spread over the integration and marvin test related information can now be found in the single top-level directory --- test/integration/README | 66 +++++++++++++++++++ test/integration/component/README | 41 ------------ test/integration/smoke/README | 41 ------------ tools/marvin/README | 13 +++- tools/marvin/marvin/sandbox/demo/live/README | 8 --- .../marvin/sandbox/demo/simulator/README | 12 ---- 6 files changed, 78 insertions(+), 103 deletions(-) delete mode 100644 test/integration/component/README delete mode 100644 test/integration/smoke/README delete mode 100644 tools/marvin/marvin/sandbox/demo/live/README delete mode 100644 tools/marvin/marvin/sandbox/demo/simulator/README diff --git a/test/integration/README b/test/integration/README index e137a070030..c5abd6c5ed2 100644 --- a/test/integration/README +++ b/test/integration/README @@ -6,3 +6,69 @@ details about your cloudstack deployment. For more help on how to write the config file and run tests check the tutorial at : https://cwiki.apache.org/confluence/display/CLOUDSTACK/Testing+with+Python + +========================== +Build Verification Testing (BVT) Cases +-------------------------------------- +These test cases are the core functionality tests that ensure the application is stable and can be tested thoroughly. +These BVT cases definitions are located at : https://docs.google.com/a/cloud.com/spreadsheet/ccc?key=0Ak8acbfxQG8ndEppOGZSLV9mUF9idjVkTkZkajhTZkE&invite=CPij0K0L + +Guidelines +---------- +BVT test cases are being developed using Python's unittests2. Following are certain guidelines being followed + 1. Tests exercised for the same resource should ideally be present under a single suite or file. + + 2. Time-consuming operations that create new cloud resources like server creation, volume creation etc + should not necessarily be exercised per unit test. The resources can be shared by creating them at + the class-level using setUpClass and shared across all instances during a single run. + + 3. Certain tests pertaining to NAT, Firewall and Load Balancing warrant fresh resources per test. Hence a call should be + taken by the stakeholders regarding sharing resources. + + 4. Ensure that the tearDown/tearDownClass functions clean up all the resources created during the test run. + +For more information about unittests: http://docs.python.org/library/unittest.html + +BVT Tests +---------- +The following files contain these BVT cases: + +1. test_vm_life_cycle.py - VM Life Cycle tests +2. test_volumes.py - Volumes related tests +3. test_snapshots.py - Snapshots related tests +4. test_disk_offerings.py - Disk Offerings related tests +5. test_service_offerings.py - Service Offerings related tests +6. test_hosts.py - Hosts and Clusters related tests +7. test_iso.py - ISO related tests +8. test_network.py - Network related tests +9. test_primary_storage.py - Primary storage related tests +10. test_secondary_storage.py - Secondary storage related tests +11. test_ssvm.py - SSVM & CPVM related tests +12. test_templates.py - Templates related tests +13. test_routers.py - Router related tests + +========================== + +P1 Cases +-------------------------------------- +These test cases are the core functionality tests that ensure the application is stable and can be tested thoroughly. +These P1 cases definitions are located at : https://docs.google.com/a/clogeny.com/spreadsheet/ccc?key=0Aq5M2ldK6eyedDJBa0EzM0RPNmdVNVZOWnFnOVJJcHc&hl=en_US + +P1 Tests +---------- +The following files contain these P1 cases: + +1. test_snapshots.py - Snapshots related tests +2. test_routers.py - Router related tests +3. test_usage.py - Usage realted tests +4. test_account.py - Account related tests +5. test_resource_limits.py - Resource limits tests +6. test_security_groups.py - Security groups related tests +7. test_templates.py - templates related tests +8. test_volumes.py - Volumes related tests +9. test_blocker_bugs.py - Blocker bugs tests +10. test_project_configs.py - Project global configuration related tests +11. test_project_limits.py - Project resource limits related tests +12. test_project_resources.py - Project resource creation related tests +13. test_project_usage.py - Project usage related tests +14. test_projects - Projects functionality tests diff --git a/test/integration/component/README b/test/integration/component/README deleted file mode 100644 index 2fd8d4be795..00000000000 --- a/test/integration/component/README +++ /dev/null @@ -1,41 +0,0 @@ -P1 Cases --------------------------------------- -These test cases are the core functionality tests that ensure the application is stable and can be tested thoroughly. -These P1 cases definitions are located at : https://docs.google.com/a/clogeny.com/spreadsheet/ccc?key=0Aq5M2ldK6eyedDJBa0EzM0RPNmdVNVZOWnFnOVJJcHc&hl=en_US - - -Guidelines ----------- -P1 test cases are being developed using Python's unittests2. Following are certain guidelines being followed - 1. Tests exercised for the same resource should ideally be present under a single suite or file. - - 2. Time-consuming operations that create new cloud resources like server creation, volume creation etc - should not necessarily be exercised per unit test. The resources can be shared by creating them at - the class-level using setUpClass and shared across all instances during a single run. - - 3. Certain tests pertaining to NAT, Firewall and Load Balancing warrant fresh resources per test. Hence a call should be - taken by the stakeholders regarding sharing resources. - - 4. Ensure that the tearDown/tearDownClass functions clean up all the resources created during the test run. - -For more information about unittests: http://docs.python.org/library/unittest.html - - -P1 Tests ----------- -The following files contain these P1 cases: - -1. test_snapshots.py - Snapshots related tests -2. test_routers.py - Router related tests -3. test_usage.py - Usage realted tests -4. test_account.py - Account related tests -5. test_resource_limits.py - Resource limits tests -6. test_security_groups.py - Security groups related tests -7. test_templates.py - templates related tests -8. test_volumes.py - Volumes related tests -9. test_blocker_bugs.py - Blocker bugs tests -10. test_project_configs.py - Project global configuration related tests -11. test_project_limits.py - Project resource limits related tests -12. test_project_resources.py - Project resource creation related tests -13. test_project_usage.py - Project usage related tests -14. test_projects - Projects functionality tests diff --git a/test/integration/smoke/README b/test/integration/smoke/README deleted file mode 100644 index b4c5d82ac19..00000000000 --- a/test/integration/smoke/README +++ /dev/null @@ -1,41 +0,0 @@ -Build Verification Testing (BVT) Cases --------------------------------------- -These test cases are the core functionality tests that ensure the application is stable and can be tested thoroughly. -These BVT cases definitions are located at : https://docs.google.com/a/cloud.com/spreadsheet/ccc?key=0Ak8acbfxQG8ndEppOGZSLV9mUF9idjVkTkZkajhTZkE&invite=CPij0K0L - - -Guidelines ----------- -BVT test cases are being developed using Python's unittests2. Following are certain guidelines being followed - 1. Tests exercised for the same resource should ideally be present under a single suite or file. - - 2. Time-consuming operations that create new cloud resources like server creation, volume creation etc - should not necessarily be exercised per unit test. The resources can be shared by creating them at - the class-level using setUpClass and shared across all instances during a single run. - - 3. Certain tests pertaining to NAT, Firewall and Load Balancing warrant fresh resources per test. Hence a call should be - taken by the stakeholders regarding sharing resources. - - 4. Ensure that the tearDown/tearDownClass functions clean up all the resources created during the test run. - -For more information about unittests: http://docs.python.org/library/unittest.html - - -BVT Tests ----------- -The following files contain these BVT cases: - -1. test_vm_life_cycle.py - VM Life Cycle tests -2. test_volumes.py - Volumes related tests -3. test_snapshots.py - Snapshots related tests -4. test_disk_offerings.py - Disk Offerings related tests -5. test_service_offerings.py - Service Offerings related tests -6. test_hosts.py - Hosts and Clusters related tests -7. test_iso.py - ISO related tests -8. test_network.py - Network related tests -9. test_primary_storage.py - Primary storage related tests -10. test_secondary_storage.py - Secondary storage related tests -11. test_ssvm.py - SSVM & CPVM related tests -12. test_templates.py - Templates related tests -13. test_routers.py - Router related tests - diff --git a/tools/marvin/README b/tools/marvin/README index 785f078804b..b7e9af9cd62 100644 --- a/tools/marvin/README +++ b/tools/marvin/README @@ -12,7 +12,18 @@ unittests and functional tests with Marvin makes testing with cloudstack easier 3. remote ssh login/execute command 4. mysql query -3. sample code is under sandbox +3. sample code is under sandbox. To generate the config for a deployment. + +Alter the .properties file in the sandbox. For example the +simualtordemo.properties after modification can generate the config file as +shown below + +$ python simulator_setup.py -i simulatordemo.properties -o simulatordemo.cfg + +To deploy the environment and run the tests + +$ python -m marvin.deployAndRun -c simulatordemo.cfg -t /tmp/t.log -r /tmp/r.log -d testcase 4. WIKI page https://cwiki.apache.org/confluence/display/CLOUDSTACK/Testing+with+Python + diff --git a/tools/marvin/marvin/sandbox/demo/live/README b/tools/marvin/marvin/sandbox/demo/live/README deleted file mode 100644 index 8ca0f4cf763..00000000000 --- a/tools/marvin/marvin/sandbox/demo/live/README +++ /dev/null @@ -1,8 +0,0 @@ - -Download Marvin source from hudson - -Install Marvin: -pip install Marvin-0.1.0.tar.gz - -To Run the test: -python -m marvin.deployAndRun -c demo.cfg -t /tmp/t.log -r /tmp/r.log -f testSshDeployVM.py -l diff --git a/tools/marvin/marvin/sandbox/demo/simulator/README b/tools/marvin/marvin/sandbox/demo/simulator/README deleted file mode 100644 index d34ca9f80ec..00000000000 --- a/tools/marvin/marvin/sandbox/demo/simulator/README +++ /dev/null @@ -1,12 +0,0 @@ -To generate the config -Alter the .properties file to point to your simulator installed environment - -python simulator_setup.py -i simulatordemo.properties -o simulatordemo.cfg - - -To deploy the environment and run the tests - -python -m marvin.deployAndRun -c simulatordemo.cfg -t /tmp/t.log -r /tmp/r.log -d testcase - - -