kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2025-10-22 05:55:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
dd43722e0298110d01aa29b023b574c0390b4728
computer-playbook/tests/unit
History
Kevin Veen-Birkenbach 05d7ddc491 svc-bkp-rmt-2-loc: migrate pull script to Python + add unit tests; lock down backup-provider ACLs 
- Replace Bash pull-specific-host.sh with Python pull-specific-host.py (argparse, identical logic)
- Update role vars and runner template to call python script
- Add __init__.py files for test discovery/imports
- Add unittest: tests/unit/roles/svc-bkp-rmt-2-loc/files/test_pull_specific_host.py (mocks subprocess/os/time; covers success, no types, find-fail, retry-exhaustion)
- Backup provider SSH wrapper: align allowed ls path (backup-docker-to-local)
- Split user role tasks: 01_core (sudoers), 02_permissions_ssh (SSH keys + wrapper), 03_permissions_folders (ownership + default ACLs + depth-limited chown/chmod)
- Ensure default ACLs grant rwx to 'backup' and none to group/other; keep sudo rsync working

Ref: ChatGPT discussion (2025-10-14) — https://chatgpt.com/share/68ee920a-9b98-800f-8806-ddcfe0255149
2025-10-14 20:10:49 +02:00
..
cli
…
filter_plugins
…
lookup_plugins
…
module_utils
Improve get_app_conf robustness and add skip_missing_app parameter support
2025-10-14 17:25:37 +02:00
roles
svc-bkp-rmt-2-loc: migrate pull script to Python + add unit tests; lock down backup-provider ACLs
2025-10-14 20:10:49 +02:00
utils
…
__init__.py
…
README.md
…
test_main.py
…

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!