.. _tempest_list_allowed_module:


tempest_list_allowed -- Parse filtered tests to tempest
=======================================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Parse filtered tests to be executed by tempest






Parameters
----------

  yaml_file (True, str, None)
    Path to a yaml file containing the tests in openstack\-tempest\-skiplist format


  job (False, str, None)
    Name of the job to be used in the filter.


  groups (False, list, None)
    List of groups to be used in the filter. It has more precedence than job


  release (optional, str, master)
    Release version









Examples
--------

.. code-block:: yaml+jinja

    
    - name: Get list of allowed tests
      cifmw.general.tempest_list_allowed:
        yaml_file: /tmp/allowed.yaml
        job: tripleo-ci-centos-8-standalone
        groups:
         - default



Return Values
-------------

allowed_tests (Always, list, ['tempest.api.volume.test_volumes_snapshots.VolumesSnapshotTestJSON'])
  List of tests filtered





Status
------





Authors
~~~~~~~

- Arx Cruz (@arxcruz)