unit_tests
==========

.. py:module:: unit_tests

.. autoapi-nested-parse::

   These are utilities for working with CaC/content unit tests, as built by
   the CaC/content built system.

   To satisfy various use cases, the logic is modularized into functions:

    - iter_rules() iterates over all built tests, yielding rules

    - iter_tests() iterates over .sh tests for one rule, yielding partial
      UnitTest with info from the rule directory (rule, test, is_pass)

    - fill_in_metadata() reads the .sh contents and completes UnitTest
      based on metadata contained in the .sh file







Module Contents
---------------

.. py:class:: UnitTest

   Bases: :py:obj:`tuple`


   .. py:attribute:: rule


   .. py:attribute:: test


   .. py:attribute:: is_pass


   .. py:attribute:: packages


   .. py:attribute:: profiles


   .. py:attribute:: variables


   .. py:attribute:: remediation


   .. py:attribute:: check


.. py:function:: parse_variables(line)

.. py:function:: fill_in_metadata(unit_test, test_file)

   Given an (incomplete) UnitTest tuple as 'unit_test', fill in values
   from unit test file metadata, returning the complete UnitTest.


.. py:function:: iter_tests(rule_dir)

   Given a rule directory containing tests, yield tuples of
   (partial UnitTest , test file path) representing tests found in that
   directory.


.. py:function:: iter_rules(built_tests_dir)

   Given a directory with built tests, yield pathlib.Path directories
   with tests, the names of which should correspond to rule names,
   plus the special directory 'shared'.