9.2. Dovetail Command Line Interface Reference

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.

9.2.1. Commands List

Commands Action
dovetail –help | -h Show usage of command “dovetail”
dovetail –version Show version number
Dovetail List Commands
dovetail list –help | -h Show usage of command “dovetail list”
dovetail list List all available test suites and all test cases within each test suite
dovetail list <test_suite_name> List all available test areas within test suite <test_suite_name>
Dovetail Show Commands
dovetail show –help | -h Show usage of command “dovetail show”
dovetail show <test_case_name> Show the details of one test case
Dovetail Run Commands
dovetail run –help | -h Show usage of command “dovetail run”
dovetail run Run Dovetail with all test cases within default test suite
dovetail run –testsuite <test_suite_name> Run Dovetail with all test cases 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>. Test area can be chosen from (vping, tempest, security, ha, stress, bgpvpn, vnf, snaps). Repeat option to set multiple test areas.
dovetail run –testcase <test_case_name> Run Dovetail with one or more specified test cases. Repeat option to set multiple test cases.
dovetail run –mandatory –testsuite <test_suite_name> Run Dovetail with all mandatory test cases within test suite <test_suite_name>
dovetail run –optional –testsuite <test_suite_name> Run Dovetail with all optional test cases within test suite <test_suite_name>
dovetail run –debug | -d Run Dovetail with debug mode and show all debug logs
dovetail run –offline Run Dovetail offline, use local docker images instead of download online
dovetail run –report | -r <db_url> Package the results directory which can be used to upload to OVP web portal
dovetail run –deploy-scenario <deploy_scenario_name> Specify the deploy scenario having as project name ‘ovs’
dovetail run –no-api-validation Disable strict API response validation
dovetail run –no-clean | -n Keep all Containers created for debuging
dovetail run –stop | -s Stop immediately when one test case failed

9.2.2. Commands Examples

9.2.2.1. Dovetail Commands

root@1f230e719e44:~/dovetail/dovetail# dovetail --help
Usage: dovetail [OPTIONS] COMMAND [ARGS]...

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  list  list the testsuite details
  run   run the testcases
  show  show the testcases details
root@1f230e719e44:~/dovetail/dovetail# dovetail --version
dovetail, version 2018.9.0

9.2.2.2. Dovetail List Commands

root@1f230e719e44:~/dovetail/dovetail# dovetail list --help
Usage: dovetail list [OPTIONS] [TESTSUITE]

  list the testsuite details

Options:
  -h, --help  Show this message and exit.
root@1f230e719e44:~/dovetail/dovetail# dovetail list ovp.2019.12
- mandatory
    functest.vping.userdata
    functest.vping.ssh
    functest.tempest.osinterop
    functest.tempest.compute
    functest.tempest.identity_v3
    functest.tempest.image
    functest.tempest.network_api
    functest.tempest.volume
    functest.tempest.neutron_trunk_ports
    functest.tempest.ipv6_api
    functest.security.patrole
    yardstick.ha.nova_api
    yardstick.ha.neutron_server
    yardstick.ha.keystone
    yardstick.ha.glance_api
    yardstick.ha.cinder_api
    yardstick.ha.cpu_load
    yardstick.ha.disk_load
    yardstick.ha.haproxy
    yardstick.ha.rabbitmq
    yardstick.ha.database
    bottlenecks.stress.ping
- optional
    functest.tempest.ipv6_scenario
    functest.tempest.multi_node_scheduling
    functest.tempest.network_security
    functest.tempest.vm_lifecycle
    functest.tempest.network_scenario
    functest.tempest.bgpvpn
    functest.security.patrole_vxlan_dependent
    yardstick.ha.neutron_l3_agent
    yardstick.ha.controller_restart
    functest.vnf.vims
    functest.vnf.vepc

9.2.2.3. Dovetail Show Commands

root@1f230e719e44:~/dovetail/dovetail# dovetail show --help
Usage: dovetail show [OPTIONS] TESTCASE

  show the testcases details

Options:
  -h, --help  Show this message and exit.
root@1f230e719e44:~/dovetail/dovetail# dovetail show functest.vping.ssh
---
functest.vping.ssh:
  name: functest.vping.ssh
  objective: testing for vping using ssh
  validate:
    type: functest
    testcase: vping_ssh
    image_name: opnfv/functest-healthcheck
  report:
    source_archive_files:
      - functest.log
    dest_archive_files:
      - vping_logs/functest.vping.ssh.log
    check_results_file:
      - 'functest_results.txt'
    portal_key_file: vping_logs/functest.vping.ssh.log
    sub_testcase_list:
root@1f230e719e44:~/dovetail/dovetail# dovetail show functest.tempest.image
---
functest.tempest.image:
  name: functest.tempest.image
  objective: tempest smoke test cases about image
  validate:
    type: functest
    testcase: tempest_custom
    pre_condition:
      - 'cp /home/opnfv/userconfig/pre_config/tempest_conf.yaml /usr/lib/python2.7/site-packages/functest/opnfv_tests/openstack/tempest/custom_tests/tempest_conf.yaml'
      - 'cp /home/opnfv/userconfig/tempest_custom_testcases.yaml /usr/lib/python2.7/site-packages/xtesting/ci/testcases.yaml'
      - 'cp /home/opnfv/functest/results/tempest_custom.txt /usr/lib/python2.7/site-packages/functest/opnfv_tests/openstack/tempest/custom_tests/test_list.txt'
  report:
    source_archive_files:
      - functest.log
      - tempest_custom/rally.log
      - tempest_custom/tempest-report.html
    dest_archive_files:
      - tempest_logs/functest.tempest.image.functest.log
      - tempest_logs/functest.tempest.image.log
      - tempest_logs/functest.tempest.image.html
    check_results_file:
      - 'functest_results.txt'
    portal_key_file: tempest_logs/functest.tempest.image.html
    sub_testcase_list:
      - tempest.api.image.v2.test_images.BasicOperationsImagesTest.test_register_upload_get_image_file[id-139b765e-7f3d-4b3d-8b37-3ca3876ee318,smoke]
      - tempest.api.image.v2.test_versions.VersionsTest.test_list_versions[id-659ea30a-a17c-4317-832c-0f68ed23c31d,smoke]

9.2.2.4. Dovetail Run Commands

root@1f230e719e44:~/dovetail/dovetail# dovetail run --help
Usage: run.py [OPTIONS]

Dovetail compliance test entry!

Options:
--opnfv-ci              Only enabled when running with OPNFV CI jobs and pushing results to TestAPI DB
--optional              Run all optional test cases.
--mandatory             Run all mandatory test cases.
--deploy-scenario TEXT  Specify the DEPLOY_SCENARIO which will be used as input by each testcase respectively
-n, --no-clean          Keep all Containers created for debuging.
--no-api-validation     disable strict API response validation
--offline               run in offline method, which means not to update the docker upstream images, functest, yardstick, etc.
-r, --report            Create a tarball file to upload to OVP web portal
-s, --stop              Flag for stopping on test case failure.
-d, --debug             Flag for showing debug log on screen.
--testcase TEXT         Compliance testcase. Specify option multiple times to include multiple test cases.
--testarea TEXT         Compliance testarea within testsuite. Specify option multiple times to include multiple test areas.
--testsuite TEXT        compliance testsuite.
-h, --help              Show this message and exit.
root@1f230e719e44:~/dovetail/dovetail# dovetail run --testcase functest.vping.ssh --offline -r --deploy-scenario os-nosdn-ovs-ha
2019-12-06 02:51:52,634 - run - INFO - ================================================
2019-12-06 02:51:52,634 - run - INFO - Dovetail compliance: ovp.2019.12!
2019-12-06 02:51:52,634 - run - INFO - ================================================
2019-12-06 02:51:52,634 - run - INFO - Build tag: daily-master-5b58584a-17d3-11ea-878a-0242ac110002
2019-12-06 02:51:52,634 - run - INFO - DEPLOY_SCENARIO : os-nosdn-ovs-ha
2019-12-06 02:51:53,077 - run - INFO - >>[testcase]: functest.vping.ssh
2019-12-06 02:51:53,078 - dovetail.test_runner.DockerRunner - WARNING - There is no hosts file /home/ovp/pre_config/hosts.yaml. This may cause some issues with domain name resolution.
2019-12-06 02:51:54,048 - dovetail.test_runner.DockerRunner - INFO - Get hardware info of all nodes list in file /home/ovp/pre_config/pod.yaml ...
2019-12-06 02:51:54,049 - dovetail.test_runner.DockerRunner - INFO - Hardware info of all nodes are stored in file /home/dovetail/results/all_hosts_info.json.
2019-12-06 02:51:54,073 - dovetail.container.Container - WARNING - There is no hosts file /home/ovp/pre_config/hosts.yaml. This may cause some issues with domain name resolution.
2019-12-06 02:52:57,982 - dovetail.report.Report - INFO - Results have been stored with files: ['/home/ovp/results/functest_results.txt'].
2019-12-06 02:52:57,986 - dovetail.report.Report - INFO -

Dovetail Report
Version: 2019.12
Build Tag: daily-master-5b58584a-17d3-11ea-878a-0242ac110002
Test Date: 2019-12-06 02:52:57 UTC
Duration: 64.91 s

Pass Rate: 100.00% (1/1)
vping:                     pass rate 100.00%
-functest.vping.ssh        PASS