kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2025-09-09 11:47:14 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
a1130e33d7e28b3c7c31ab6fb20b286cd3ce43ba
computer-playbook/tests/unit
History
Kevin Veen-Birkenbach 5e550ce3a3 sys-ctl-rpr-docker-soft: switch to STRICT label mode and adapt tests 
- script.py now resolves docker-compose project and working_dir strictly from container labels
- removed container-name fallback logic
- adjusted sys-ctl-hlth-docker-container to include sys-ctl-rpr-docker-soft
- cleaned up sys-svc-docker dependencies
- updated unit tests to mock docker inspect and os.path.isfile for STRICT mode

Conversation: https://chatgpt.com/share/68b80927-b800-800f-a909-0fe8d110fd0e
2025-09-03 11:24:14 +02:00
..
cli
Enhance tree builder: detect include_role dependencies from tasks/*.yml
2025-08-19 19:00:03 +02:00
filter_plugins
Implement filter checks: ensure all defined filters are used and remove dead code
2025-09-01 11:47:51 +02:00
lookup_plugins
Implement filter checks: ensure all defined filters are used and remove dead code
2025-09-01 11:47:51 +02:00
module_utils
Refactor and extend role dependency resolution:
2025-08-20 02:42:07 +02:00
roles
sys-ctl-rpr-docker-soft: switch to STRICT label mode and adapt tests
2025-09-03 11:24:14 +02:00
utils
Restructured server config
2025-08-07 11:31:06 +02:00
__init__.py
Added gid to applications to make them posix group ldap compatible
2025-07-03 23:51:14 +02:00
README.md
Renamed web-app-port-ui to web-app-desktop
2025-08-26 11:35:22 +02:00
test_main.py
Optimized test_main.py
2025-07-16 08:25:16 +02:00

README.md

Unit Tests

This directory contains unit tests for various custom components in the project, such as the custom lookup plugin docker_cards used in the web-app-desktop role.

Overview

The unit tests are written using Python’s built-in unittest framework. They are designed to verify that your custom logic works as expected—such as extracting metadata from role files—without needing to run the entire playbook.

Running the Tests

You can run the tests using one of the following methods:

  1. Using Unittest Discovery:

    From the project's root directory, run:

    python -m unittest discover -s tests/unit

    This command will discover and execute all test files within the tests/unit directory.

  2. Running a Specific Test File:

    If you want to run only the Docker cards test, execute:

    python tests/unit/test_docker_cards.py

How It Works

  • Setup:
    The test script creates a temporary directory to simulate your roles folder. It then creates a sample role (web-app-desktop) with a README.md file (containing a header for the title) and a meta/main.yml file (with the required metadata).

  • Execution:
    Dummy variable values for domains and applications are provided (these are the variables the lookup plugin expects). The lookup plugin is then run, which processes the sample role and returns the card information.

  • Verification:
    The test uses assertions to ensure that the output contains the expected title, description, icon information, constructed URL, and the correct iframe flag.

  • Cleanup:
    After the test completes, the temporary directory is removed, ensuring that no test artifacts remain.

Requirements

  • Python 3.6 or newer is recommended.
  • All necessary dependencies for your project should be installed.

These tests help ensure that your custom code is reliable and behaves as expected, and they can be easily integrated into a Continuous Integration (CI) pipeline.

Happy testing!