Mailing-List: contact cloudstack-commits-help@incubator.apache.org;
 run by ezmlm
Precedence: bulk
Reply-To: cloudstack-dev@incubator.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: chipchilders@apache.org
To: cloudstack-commits@incubator.apache.org
Subject: [22/50] [abbrv] git commit: Uniting all the READMEs from tools and
 test
Message-Id: <20121015202947.A73A4472D4@tyr.zones.apache.org>
Date: Mon, 15 Oct 2012 20:29:47 +0000 (UTC)

Uniting all the READMEs from tools and test

There are various READMEs under Cloudstack. This makes it confusing for
finding the purpose of each directory and tool within the project. All
the necessary information can now be found in the top-level README.tools
that is markdown editable. For the most updated information however it
is best to provide a wiki link to the tool you have added. Each tool
lies in a seperate section, please keep formatting unchanged.


Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/ea4b642d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/ea4b642d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/ea4b642d

Branch: refs/heads/junit-tests
Commit: ea4b642d0c3556492c044c7e874cbf6cb8da4846
Parents: efd3d83
Author: Prasanna Santhanam <tsp@apache.org>
Authored: Fri Oct 12 17:01:20 2012 +0530
Committer: Chip Childers <chip.childers@gmail.com>
Committed: Mon Oct 15 16:19:19 2012 -0400

----------------------------------------------------------------------
 README.tools.md              |  220 +++++++++++++++++++++++++++++++++++++
 test/conf/README             |    8 --
 test/integration/README      |   74 -------------
 tools/devcloud/README        |   56 ----------
 tools/devcloud/veewee/README |    5 -
 tools/marvin/README          |   29 -----
 6 files changed, 220 insertions(+), 172 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/ea4b642d/README.tools.md
----------------------------------------------------------------------
diff --git a/README.tools.md b/README.tools.md
new file mode 100644
index 0000000..0319707
--- /dev/null
+++ b/README.tools.md
@@ -0,0 +1,220 @@
+> Licensed to the Apache Software Foundation (ASF) under one
+> or more contributor license agreements.  See the NOTICE file
+> distributed with this work for additional information
+> regarding copyright ownership.  The ASF licenses this file
+> to you under the Apache License, Version 2.0 (the
+> "License"); you may not use this file except in compliance
+> with the License.  You may obtain a copy of the License at
+> 
+>   http://www.apache.org/licenses/LICENSE-2.0
+> 
+> Unless required by applicable law or agreed to in writing,
+> software distributed under the License is distributed on an
+> "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+> KIND, either express or implied.  See the License for the
+> specific language governing permissions and limitations
+> under the License.
+
+
+---------------------------------------------------------------------------
+This README describes the various tools available with Apache Cloudstack -
+for compiling, deploying, building and testing the project
+---------------------------------------------------------------------------
+
+DevCloud
+=========================================================
+Under tools/devcloud
+
+NOTE - DevCloud (tools/devcloud) is a work in progress.  The project has not
+determined how to best establish a nightly DevCloud build process, or how to
+distribute the image. 
+
+#### Contents: ####
+
+Under tools/devcloud are various scripts used to build the devcloud image.
+devcloudsetup.sh - the origional devcloud build script (assumes an Ubuntu 12.04
+VM image)
+
+        $ cd tools/devcloud
+
+* build_vagrant_basebox.sh - a script that uses VirtualBox, VeeWee, Vagrant
+(patched) and puppet to create a devcloud basebox
+* veewee - configuration files used to build a basic Ubuntu 12.04 vagrant box
+via VeeWee
+* basebuild - The Vagrantfile and puppet module that gets applied to the basic
+Ubuntu 12.04 box
+* devcloudbox - The Vagrantfile and puppet module that is used with the
+[hopefully] distributed devcloud base box
+
+#### Instructions: ####
+
+To build a "devcloud base box", run you need a system with VirtualBox and rvm
+installed (use ruby 1.9.2).  Run build_vagrant_basebox.sh to build the base
+box.
+
+To use the "devcloud base box" that is created in the previous step, you need
+to have installed a forked version of Vagrant (until we make the changes
+plugins instead of direct source patches) that can be found here:
+
+Once installed per the Vagrant installation process, run:
+
+        $ vagrant box add devcloud [path to devcloud.box]
+
+Then, either go into the devcloudbox folder of your checked out version of the
+CloudStack code (incubator-cloudstack/tools/devcloud/devcloudbox), or copy the
+contents of that folder to another location.
+
+Assuming the patched Vagrant installation is working, you then
+simply run "vagrant up" from within that directory.
+
+#### Installation ####
+
+Install DevCloud Base system:
+
+1. get code from https://github.com/jedi4ever/veewee, and install
+2. veewee vbox define devcloud ubuntu-12.04-server-i386
+3. put these two files(definition.rb and preseed.cfg) under ./definition/devcloud/
+3. veewee vbox build devcloud
+
+
+Marvin
+=========================================================
+Under tools/marvin
+
+Marvin is the functional testing framework for CloudStack written in python.
+Writing of unittests and functional tests with Marvin makes testing with
+cloudstack easier 
+
+Visit the
+[wiki](https://cwiki.apache.org/confluence/display/CLOUDSTACK/Testing+with+Python)
+for the most updated information
+
+#### Installation ####
+
+        $ untar Marvin-0.1.0.tar.gz 
+        $ cd Marvin-0.1.0
+        $ python setup.py install
+
+#### Features ####
+
+1. very handy cloudstack API python wrapper
+2. support async job executing in parallel
+3. remote ssh login/execute command
+4. mysql query 
+
+#### Examples ####
+
+Examples on how to develop your own configuration can be found in the marvin sandbox.
+Under tools/marvin/marvin/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
+
+#### Tests #### 
+
+Functional Tests written using marvin can be found under test/integration
+folder. These are tests that are written to be run against a live deployed
+system.
+
+To run the tests - you should have marvin installed and correctly importable.
+The tests are long running and are best monitored by external hudson jobs.
+
+Also you will have to point marvin to the right configuration file that has
+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) ####
+
+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 on tests #####
+
+BVT test cases are being developed using Python 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 #####
+Under test/integration/smoke
+
+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 Tests #####
+Under test/integration/component
+
+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)
+
+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
+
+
+test/conf - EC2 script
+=========================================================
+
+To run submitCertEC2 and deleteCertEC2 scripts, update parameters in conf/tool.properties file:
+
+* host - ip address of the host where cloud-bridge software is installed
+* port - port cloud-bridge software is listening to
+* accesspoint - access point for cloud-bridge REST request
+* version - Amazon EC2 api version supported by cloud-bridge
+* signaturemethod - HmacSHA1 or HmacSHA256
+* expires - the date when certificate expires

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/ea4b642d/test/conf/README
----------------------------------------------------------------------
diff --git a/test/conf/README b/test/conf/README
deleted file mode 100644
index 6836c0f..0000000
--- a/test/conf/README
+++ /dev/null
@@ -1,8 +0,0 @@
-To run submitCertEC2 and deleteCertEC2 scripts, update parameters in conf/tool.properties file:
-
-* host - ip address of the host where cloud-bridge software is installed
-* port - port cloud-bridge software is listening to
-* accesspoint - access point for cloud-bridge REST request
-* version - Amazon EC2 api version supported by cloud-bridge
-* signaturemethod - HmacSHA1 or HmacSHA256
-* expires - the date when certificate expires
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/ea4b642d/test/integration/README
----------------------------------------------------------------------
diff --git a/test/integration/README b/test/integration/README
deleted file mode 100644
index c5abd6c..0000000
--- a/test/integration/README
+++ /dev/null
@@ -1,74 +0,0 @@
-To run the tests - you should have marvin installed and correctly importable.
-The tests are long running and are best monitored by external hudson jobs.
-
-Also you will have to point marvin to the right configuration file that has
-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

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/ea4b642d/tools/devcloud/README
----------------------------------------------------------------------
diff --git a/tools/devcloud/README b/tools/devcloud/README
deleted file mode 100644
index b016154..0000000
--- a/tools/devcloud/README
+++ /dev/null
@@ -1,56 +0,0 @@
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements.  See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership.  The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License.  You may obtain a copy of the License at
-
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied.  See the License for the
-specific language governing permissions and limitations
-under the License.
-
-===========================================================
-
-NOTE - This folder is a work in progress.  The project has not determined
-how to best establish a nightly DevCloud build process, or how to distribute
-the image.
-
-===========================================================
-Contents:
-
-This folder contains various scripts used to build the devcloud image.
-devcloudsetup.sh - the origional devcloud build script (assumes an Ubuntu 12.04 VM image)
-
-build_vagrant_basebox.sh - a script that uses VirtualBox, VeeWee, Vagrant (patched) and puppet to create a devcloud basebox
-veewee - configuration files used to build a basic Ubuntu 12.04 vagrant box via VeeWee
-basebuild - The Vagrantfile and puppet module that gets applied to the basic Ubuntu 12.04 box
-devcloudbox - The Vagrantfile and puppet module that is used with the [hopefully] distributed devcloud base box
-
-===========================================================
-Instructions:
-
-To build a "devcloud base box", run you need a system with VirtualBox and rvm
-installed (use ruby 1.9.2).  Run build_vagrant_basebox.sh to build the base box.
-
-To use the "devcloud base box" that is created in the previous step, you
-need to have installed a forked version of Vagrant (until we make the changes
-plugins instead of direct source patches) that can be found here:
-
-
-Once installed per the Vagrant installation process, run:
-
-vagrant box add devcloud [path to devcloud.box]
-
-Then, either go into the devcloudbox folder of your checked out 
-version of the CloudStack code (incubator-cloudstack/tools/devcloud/devcloudbox),
-or copy the contents of that folder to another location.
-
-Assuming the patched Vagrant installation is working, you then
-simply run "vagrant up" from within that directory.
-

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/ea4b642d/tools/devcloud/veewee/README
----------------------------------------------------------------------
diff --git a/tools/devcloud/veewee/README b/tools/devcloud/veewee/README
deleted file mode 100644
index c9299e5..0000000
--- a/tools/devcloud/veewee/README
+++ /dev/null
@@ -1,5 +0,0 @@
-Install DevCloud Base system:
-1. get code from https://github.com/jedi4ever/veewee, and install
-2. veewee vbox define devcloud ubuntu-12.04-server-i386
-3. put these two files(definition.rb and preseed.cfg) under ./definition/devcloud/
-3. veewee vbox build devcloud

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/ea4b642d/tools/marvin/README
----------------------------------------------------------------------
diff --git a/tools/marvin/README b/tools/marvin/README
deleted file mode 100644
index b7e9af9..0000000
--- a/tools/marvin/README
+++ /dev/null
@@ -1,29 +0,0 @@
-Marvin is the testing framework for CloudStack written in python. Writing of
-unittests and functional tests with Marvin makes testing with cloudstack easier
-
-1. INSTALL 
-    untar Marvin-0.1.0.tar.gz 
-    cd Marvin-0.1.0
-    python setup.py install
-
-2. Facility it provides:
-   1. very handy cloudstack API python wrapper
-   2. support async job executing in parallel
-   3. remote ssh login/execute command
-   4. mysql query 
-
-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
-