This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Skip to end of metadata
Go to start of metadata

Marvin as a framework provides few facilities viz., deploying a datacenter, deleting a datacenter, running tests(both selfservice and provisioning), generating api information using spec file, retrieve and generate api information through cs endpoint  etc. Using nose, python unit testing module, and few other python packages, marvin framework provides these facilitation. To use these facilities, users need to be aware of few usages of marvin, few python packages, basic installation etc.

To simplify usage of these facilities, marvincli will be added. using this new cli, all the above tasks mentioned can be easily achieved. It provides an easy to use command and cli approach for users. marvincli, gets installed as part of marvin installation, so no new additional installation is required and marvin still continues to function as it is in its current form.

So, once marvin is installed, users can run the following commands using the new cli:

S.NoCommand NameCommand textDescription 
1.deploy

marvincli deploy config-file=<marvin-config-file>

EX: marvincli deploy config-file=setup/dev/advanced.cfg

Deploys a data center under CS.

Args:

  1. *config-file:config file to use for deploying the datacenter. EX: setup/dev/advanced.cfg
 
2.generatepis<fromspecfile>

marvincli generateapis api-spec-file= <api-spec-file> folder-path=<path where the output cloudstackAPI information is dumped>

EX: marvincli generateapis api-spec-file=/etc/cloud/cli/commands.xml folder-path=tools/marvin/marvin/

Generates the CloudStack API directory containing CS api information references, which is further used by marvin when making api calls to CS. It uses /etc/cloud/cli/commands.xml to generate these.

Args:

  1. api-spec-file: sample spec file path as similar to one /etc/cloud/cli/commands.xml. If no spec-file is provided, it uses /etc/cloud/cli/commands.xml file.
  2. folder-path : output folder path where cloudstackAPI directory will be created with all cs api reference information. If no path is provided, it will use the default path as tools/marvin/marvin to generate these.

Note: This currently, is generated as part of mvn profile, with this we can remove the particular mvn profile.

 
3.generatepis<fromendpoint>

marvincli generateapis end-point=<CS Endpoint ip> folder-path=<path where the output cloudstackAPI information is dumped>

EX: marvincli generateapis end-point=localhost folder-path=tools/marvin/marvin/


Generates the CloudStack API directory containing CS api information references, which is further used by marvin when making api calls to CS. Host ip of CS machine, is used to retrieve this information.

Args:

  1. *end-point: ip or name of the cs end point to be used to retrieve api information
  2. folder-path : output folder path where cloudstackAPI directory will be created with all cs api reference information. If no path is provided, it will use the default path as tools/marvin/marvin to generate these.

Note: This currently, is generated as part of mvn profile, with this we can remove the particular mvn profile.

 
 4.deploydc_and_runtest

marvincli deploydc_and_runtest config-file=<path_to_marvin_cfg> tc-path=<test suite or test case folder path> zone=<name of the zone> hyp-type=<hypervisor_type> required_hardware=<true\false>

EX: marvincli deploydc_and_runtest config-file=setup/dev/advanced.cfg tc-path=test/integration/smoke zone=sandbox-siumulator hyp-type=simulator required-hardware=false

Deploys a datacenter "and" runs test cases as well.

Args:

  1. *config-file: Config file path to deploy dc and for running tests. EX: setup/dev/advanced.cfg. Its a mandatory argument. If not provided, it will throw error and exit.
  2. *tc-path: Test Case folder or file path to pick tests from.
  3. zone: Name of the zone to be used for running test cases. If nothing is provided, picks up the first zone inside cfg for testing.
  4. hyp-type: Signifies hypervisor type to be used for running tests, EX: xenserver,kvm,vmware etc. So, if we have four different hosts under different clusters, this will help to run tests against a particular hypervisor type, helps in running multiple tracks against multiple hypervisors at a given time. If nothing is provided, will pick up the first hypervisor from config file.
  5. required-hardware: If set to False, picks up test cases which does not require hardware to run, helps in running when we dont have simulator and to test business logic of cs.
 
5.--cli-help

marvincli --h

(or)

marvincli --cli-help

Prints the marvincli help. Its commands usage and args information in colored text.

 
6.--version

marvincli --v

(or)

marvincli --version

 

Prints the marvincli version information, as similar to marvin version information. 
7.build_and_install

marvincli build_and_install cs-folder-path=<cloudstack code root dir > api-spec-file=<api spec file generated by CS EX: /etc/cloud/cli/commands.xml>

EX: marvincli build_and_install cs-folder-path=/root/cs-4.5/cloudstack/ api-spec-file=EX: /etc/cloud/cli/commands.xml

Builds and install marvin. It uses api spec file

EX: /etc/cloud/cli/commands.xml

file to build cs apis, used for marvin reference and then installs marvin.

Args:

*1. cs-folder-path : CS code root folder path EX: /root/cs-4.5/cloudstack/

2. api-spec-file: api spec file generated by CS EX: /etc/cloud/cli/commands.xml

Note : api-spec-file is not a mandatory field. If nothing is provided, it will use /etc/cloud/cli/commands.xml

 
8.sync_and_install

marvincli sync_and_install cs-folder-path=<cloudstack code root dir > end-point=<CS installed host ip>

EX: marvincli sync_and_install cs-folder-path=/root/cs-4.5/cloudstack/ end-point=localhost

 

Builds and install marvin. Its the same as previous command except that it uses an installed CS endpoint to generate apis, build and install marvin instead.

EX: /etc/cloud/cli/commands.xml

file to build cs apis, used for marvin reference and then installs marvin.

Args:

*1. cs-folder-path : CS code root folder path EX: /root/cs-4.5/cloudstack/

2. end-point: CS installed host ip EX: localhost

Note : end-point is not a mandatory field. If nothing is provided, it will use localhost

 
9.runtest

marvincli runtest config-file=<path_to_marvin_config> tc-path=<path to test case suite or test suite directory> zone=<name of zone> hyp-type=<xenserver or kvm or vmware> required_hardware=<true\false>


EX: marvincli runtest config-file=setup/dev/advanced.cfg tc-ath=test/integration/smoke zone=sandbox-siumulator hyp-type=simulator required-hardware=false

Runs a single test suite or list of suites, mentioned either smoke or component mentioned with below options.

Args:

  1. *config-file: Config file path to deploy dc and for running tests. EX: setup/dev/advanced.cfg. Its a mandatory argument. If not provided, it will throw error and exit.
  2. *tc-path: Test Case folder or file path to pick tests from.
  3. zone: Name of the zone to be used for running test cases. If nothing is provided, picks up the first zone inside cfg for testing.
  4. hyp-type: Signifies hypervisor type to be used for running tests, EX: xenserver,kvm,vmware etc. So, if we have four different hosts under different clusters, this will help to run tests against a particular hypervisor type, helps in running multiple tracks against multiple hypervisors at a given time. If nothing is provided, will pick up the first hypervisor from config file.
  5. required-hardware: If set to False, picks up test cases which does not require hardware to run, helps in running when we dont have simulator and to test business logic of cs.
 

Sample Workflow:

  1. Build CloudStack.             EX: mvn -P developer clean install
  2. Build and Install Marvin.   EX: marvincli cs-folder-path=/root/cs-4.5/cloudstack/ 
  3. Deploys a DataCenter.    EX:  marvincli deploy config-file=setup/dev/advanced.cfg
  4. Runs Test Cases.            EX:  marvincli runtest config-file=setup/dev/advanced.cfg zone=sandbox-siumulator hyp-type=simulator tc-path=test/integration/smoke required-hardware=false 

This will help take few marvin facilities easily from cli, printing its help and using it from cli iteself, with out looking at wikis and other information required.

Currently, there are few mvn profiles under tools/marvin/pom.xml, viz., marvin.sync, marvin.setup,marvin.test etc which are dealing with marvin building,usage etc. These usages are available through mvn commands through its profiles. We can now remove these profiles and decouple these usages of marvin from mvn, instead use the above cli commands for ease and maintenance. 

  • No labels