Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

While Dovetail does not have hard requirement on a specific operating system type or version, these have been validated by the community through some level of exercise in OPNFV labs or PlugFests.

  • 64-bit version of Xenial 16.04 (LTS)
  • 64-bit version of Trusty 14.04 (LTS)
  • 64-bit version of CentOS 7 /*?????*/
  • 64-bit version of RHEL 7 /*???*/
  • 64-bit version of Fedora 24 or 25 /*??*/

Additional examples of operating systems known to work well can be found in OPNFV Dovetail wiki pages. /* Suggest we maintain such a wiki for support purpose - Wenjing?? */

Non-Linux operating systems, such as Windows, Mac OS, have not been tested at this time.

The tester should also validate that the jumphost can reach the public Internet. For example,

% ping 8.8.8.8

% ping https://www.google.comopnfv.org/cvp

/* Need login credential to cvp server */

And also validate that the jumphost can reach the Openstack API, for example,

/* Need refinement on how to test this */

% ping x.x.x.x

 

2.2.2 Configuring the Jumphost Environment

/* First, openstack env variables to be passed to Functest */

The jumphost needs to have the right environmental variable setting to enable access to the Openstack API. This is usually done through the Openstack credential file (See https://docs.openstack.org/developer/python-openstackclient/man/openstack.html#environment-variables).

...

% wget testingURL .... /* need some help */
% API use example /*add service list example */

/* Other env variables to ?? */

/* create a home directory for dovetail */
 

% sudo mkdir <home_dir_home>

 

% export DOVETAIL_HOME=$HOME/cvp

2.2.3 Installing Prerequisite

 

  1. update( yum, apt-ge,pip)

  2. install docker


Dovetail requires Python 2.7 or later and git /*version??*/, anything else?

...

/* reference web links to install python, git, ... */

 

sudo dnf -y update

 

sudo dnf -y install python-pip

 

sudo dnf -y install python-devel

 sudo dnf -y install gcc

/* install docker */


2.2.4 Installing Dovetail

...

/* Version of dovetail is not specified yet? we are still using the latest in the master - this needs to be fixed before launch. */

First , create a home directory for Dovetail,

% cd

% sudo mkdir dovetail

% export DOVETAIL_HOME=$HOME/dovetail change directory to $DOVETAIL_HOME,

% cd $DOVETAIL_HOME

sudo git clone https://git.opnfv.org/dovetail

...

/* steps missing in installing dovetail after the git clone */

sudo pip install -e ./

/* test dovetail install is successful */

to be completed

% dovetail -h

2.2.

...

5 Installing Dovetail Docker Container

TBD. Is this useful or necessary? It seems the overall complexity is about the same.

2.3 Running CVP Test Suite

2.

...

3.1 Running

...

Test Suite

The Dovetail client CLI allows the tester to specify which test suite to run. By default the results are stored in a local file $DOVETAIL_HOME/results.


% dovetail run --testsuite <test suite name> --openrc <path-to-openrc-file> /*?? */

Multiple test suites may be available, but for the purpose of running CVP test suite, the test suite name follows the following format,

CVP.<major>.<minor>.<patch>  /* test if this format works */

For example, CVP._1._0._0.

% dovetail run --testsuite CVP._1._0._0

When the SUT's VIM (Virtual Infrastructure Manager) is Openstack, its configuration is commonly defined in the openrc file. In that case, you can specify the openrc file in the command line,

% dovetail run --testsuite CVP._1._0._0 --openrc <path-to-openrc-file>

In order to report official results to OPNFV, run the CVP test suite and report to OPNFV official URL,

% dovetail run --testsuite <test suite name> --openrc <path-to-openrc-file> --report https://www.opnfv.org/cvp

2.

...

3.2 Making Sense of CVP Test Results

When a tester is performing trial runs, Dovetail stores results in a local file by default.

% cd $DOVETAIL_HOME/dovetail/results

 

...

/* local file */

Log file: dovetail.log

/* review the dovetail.log to see if all important information has been captured - in default mode without DEBUG */

/* the end of the log file has a summary of all test case test results */

Additional log files may be of interests: refstack.log, ...

Example: Openstack refstack test case example

Example: OPNFV test case example

 

/* OPNFV web interface */

2.3.3 Updating Dovetail or Test Suite

% cd $DOVETAIL_HOME/dovetail

% sudo git pull

sudo pip install -e ./

This step is necessary if dovetail software or the CVP test suite have updates.

 

2.4 Other Dovetail Usage

 

2.

...

4.1 Running Dovetail Locally 

 /*DB*/

2.

...

4.2 Running Dovetail with Experimental Test Cases

 

2.4.3 Running Individual Test Cases or for Special Cases

 

3 Dovetail Client CLI Manual

This section contains a brief manual for all the features available through the Dovetail client command line interface (CLI).

...

3.1 Check dovetail commands

% dovetail -h

dovetail.PNG

Dovetail has three commands: list, run and show.

...