fuel-docs/plugindocs/fuel-plugin-sdk-guide/create-environment/plugin-ci/plugin-ci-workflow.rst

CI workflow

The Fuel developers team recommends that you follow this CI workflow:

1. Prepare labs and start or update the lab:

   • Download the ISO from Fuel CI. Depending on the Fuel version specified in plugin’s requirements, Jenkins downloads the released ISO and/or the currently developed and passed BVT test on core CI.

   • Deploy the downloaded ISO and prepare the required labs for testing using the fuel-dev and fuel-qa repositories:

     $ fuel-main/utils/jenkins/system_tests -t test -j \
     dis_fuelweb_test -i (path to downloaded Fuel-ISO) \
     -o --group=setup -V ${VIRTUAL_ENV} -k

   • Create or restore the required empty VMs from snapshots.

2. A Gerrit review job starts building your plugin. See Gerrit workflow.

   1. Use a preconfigured Gerrit Trigger to start your job after a new Gerrit patch arrives.
   2. Run a code syntax checker and unit tests according to the instructions from Testing.
   3. Run a Puppet linter. See Puppet OpenStack.
   4. Build the plugin.
   5. Trigger the plugin testing.

3. Vote on the Gerrit patch page and add review the result in the comment using Gerrit Trigger.

4. Test the plugin:

   1. Install the plugin.
   2. Configure the environment.
   3. Deploy the environment with the inactive plugin.
   4. Run the OSTF tests.

5. Run plugin-specific functional tests to check that the current plugin version provides expected functionality.

6. Publish the resulting aggregated logs to the log storage.

   You can do this by archiving logs.