1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/tests/unit/plugins/modules/interfaces_file/interfaces_file-README.md
Felix Fontein b531ecdc9b
Unflatmap community.general (#5461)
* Move files.

* Update imports and references.

* Move wrongly placed files.

* Reverse redirects, deprecate long → short name redirects.

* Simplify contribution guidelines for new modules.

* Rewrite BOTMETA.

* Add changelog fragment.

* Fix ignore.txt files.
2022-11-02 20:42:29 +00:00

1.5 KiB

interfaces_file unit tests

Tests structure

  • input directory contains interfaces configuration files
  • test_interfaces_file.py runs each hardcoded test against all configurations in input directory and compares results with golden outputs in golden_output

Running unit tests with docker

  1. Clone project to ansible_collections/community/general
  2. Change directory to the project one cd ansible_collections/community/general
  3. Run ansible-test units --docker -v --python 3.10 tests/unit/plugins/modules/system/interfaces_file/test_interfaces_file.py

Adding tests

  1. New configurations should added to input directory
  2. New test cases should be defined in test_interfaces_file.py. Same for new test functions if needed
  3. On first test run for a new combination of a test case and an interface configuration new set of golden files will be generated. In case of docker-based test approach that's going to fail due to RO mount option. The workaround is to run tests locally with Python 3 (3.7 in this example):
    1. Install required modules with pip3.7 install pytest-xdist pytest-mock mock
    2. Run tests with ansible-test units --python 3.10 tests/unit/plugins/modules/system/interfaces_file/test_interfaces_file.py
  4. Carefully verify newly created golden output files!