Simon Pasquier c08788f393 Generate documentation automatically

This change adds a new tox target to generate the documentation from
the code. It also modifies the prepare_env.sh script so it doesn't try
to recreate everything when the virtual environment already exists.

Change-Id: Ia3ef1ec843ecfde83219cd6d5a3193b36bbf5371

2016-05-20 16:49:07 +02:00

2.2 KiB

Raw Blame History

StackLight tests

This project contains the functional tests for the StackLight plugins.

It is based on two other projects:

Fuel-Devops (documentation).
Fuel-QA (documentation).

Getting started

Provision the SQL database for fuel-qa (see the official documentation for the detailed procedure).

Prepare the environment:

 cp openrc.default openrc
 # Edit the openrc file as needed
 . openrc
 ./utils/fuel-qa-builder/prepare_env.sh

Activate the Python virtual environment:
```
 . $VENV_PATH/bin/activate
```

Run the tests:

 ./utils/jenkins/system_tests.sh -k -K -j fuelweb_test -t test -w $(pwd) -o --group=<your_test_group_to_run>

Documentation

The test cases include comments that can be turned into human-readable documentation:

    tox -edocs

The generated documentation is available at doc/_build/html/index.html.

Contributing

If you would like to contribute to the development of this plugin, you must follow the OpenStack development workflow instructions.

Patch reviews take place on the OpenStack Gerrit system.

Guidelines:

Run tox before submitting a review.
Declare test groups using the @test decorator (see the Proboscis documentation for details)

@test(groups=["<full_unique_name_of_test>",
              "<test_method_purpose>",
              "<plugin_name>",
              "<test_category>"])

For example

@test(groups=["install_influxdb_grafana",
              "install",
              "influxdb_grafana",
              "smoke"])
def install_influxdb_grafana():
    ....

Communication

The OpenStack Development Mailing List is the preferred way to communicate with the members of the project. Emails should be sent to openstack-dev@lists.openstack.org with the subject prefixed by [fuel][plugins][lma].