Page Comparison

Dovetail command line is to have a simple command line interface in Dovetail to make easier for users to handle the functions that dovetail framework provides.

python module "click" is used.

Proposal (draft)

Table of Contents

1. Commands

commands	Action	example	comments
dovetail --help	show dovetail CLI usage		comments here
dovetail -v\|—version	show version number

\| -h	Show usage of command "dovetail"
dovetail --version	Show version number
dovetail list
dovetail list --help \| -h	Show usage of command "dovetail list"
dovetail list	List all available test suites	debug - nfvi - ipv6 proposed_tests -nfvi -l3vpn
dovetail list <SUITE_NAME>	List the <SUITE_NAME> ’s testarea and testacses	- nfvi -nfvi_tc001 -nfvi_tc002 - ipv6 -ipv6_tc001
dovetail show <TESTCASE_NAME>	show the <TESTCASE> details	testcases details, include its description, sub-testcases, etc

dovetail run —SUT_TYPE <SUT_TYPE>	SUT_TYPE configuration/update	These should work together with dovetail run, such as 1)dovetail run —SUT_TYPE compass, which means to run debug test suite with SUT_TYPE compass 2)dovetail run —SUT_TYPE compass —testsuite proposed_tests if you just want to config the parameters, just do export SUT_TYPE=compass or to amend the config info in .yaml file
dovetail run —SUT_IP <SUT_IP>
dovetail run —debug <true/false>
dovetail run —yardstick_tag <latest/stable>
dovetail run —functest_tag <latest/stable>
dovetail run —creds <creds file>
dovetail run —config_file <config file>

dovetail run	run default testsuite “debug”
dovetail run —testsuite <SUITE_NAME>	run a specific testsuite
dovetail run —testsuite <SUITE_NAME> —testarea <AREA_NAME>	run a specific testsuite/testarea

dovetail report	test results report to dashboard		this "dovetail report" section should be redesigned after encryption and dashboard work is settled.and all test cases within each test suite
dovetail list <test_suite_name>	List all available test areas within test suite <test_suite_name> and all test cases within each test area
dovetail show
dovetail show --help \| -h	Show usage of command "dovetail show"
dovetail show <test_case_name>	Show the details of one test case
dovetail run
dovetail run --help \| -h	Show usage of command "dovetail run"
dovetail run	Run Dovetail with all test areas within default test suite "compliance_set"
dovetail run --testsuite <test_suite_name>	Run Dovetail with all test areas within test suite <test_suite_name>
dovetail run --testsuite <test_suite_name> --testarea <test_area_name>	Run Dovetail with test area <test_area_name> within test suite <test_suite_name>
dovetail run --debug \| -d	Run Dovetail with a debug mode and show all debug logs
dovetail run --offline	Run Dovetail offline, use local docker images and will not update them
dovetail run --report \| -r <db_url>	Push results to local or official DB
dovetail run --yard_tag \| -y <yardstick_docker_image_tag>	Specify yardstick's docker image tag, default is danube.3.2
dovetail run --func_tag \| -f <functest_docker_image_tag>	Specify functest's docker image tag, default is cvp.0.5.0
dovetail run --bott_tag \| -b <bottlenecks_docker_image_tag>	Specify bottlenecks' docker image tag, default is cvp.0.4.0