crud_tests (#66)

* Create `test_crud.py` to run test playbooks with pytest
* Remove Display import as it leads to import errors and it is not
needed
* Extend contribution documentation. Add steps to provide needed stuff when someone want to contribute.

Author: cmeissner

CONTRIBUTING.md

@@ -30,6 +30,38 @@
 
 * If you want to start to work on a new module we suggest to read [How to write new phpipam [email protected]](https://codeaffen.org/2021-01-07-writing-phpipam-ansible-modules/).
 
+### Create your feature in a branch of your fork
+
+Fork our repository and create a new branch for your feature. Then start to work on your feature.
+
+### Add tests for your new feature
+
+To make sure that your feature is working as expected and to make sure that it is not breaking any existing functionality, you should add tests for your new feature. To do so, you
+
+1. need to have a working phpipam installation.
+2. export the following environment variables:
+   * PHPIPAM_URL - the URL of your phpipam installation (e.g. `https://localhost`)
+   * PHPIPAM_USERNAME - the username to login to phpipam
+   * PHPIPAM_PASSWORD - the password to login to phpipam
+   * PHPIPAM_APPID - the appid to login to phpipam
+3. add a new task definition for your new feature in tests/test_playbooks/tasks/
+4. add a vars definition for your new feature in tests/test_playbooks/vars/
+5. add a crud playbook for your new feature in tests/test_playbooks/
+   The playbook should contain the following steps:
+   * import vars files `vars/server.yml` and `vars/<yourtest>.yml`
+   * tasks for
+     * create a new entity
+     * create a new entity again to make sure that it will not changed
+     * update the entity
+     * delete the entity
+6. run your test with `ansible-playbook --inventory=tests/inventory/hosts tests/test_playbooks/<yourtest>.yml -vvv` to make sure that your feature is working as expected
+7. run your test again with `make test-<yourtest>`
+8. run all tests with `make test-all` to make sure that your feature does not break any existing functionality
+
+### Create pull request for your new feature
+
+When you are done, push your changes to your fork and create a pull request. Please make sure that you have squashed your changes before you create the pull request. Provide a clear description of your feature and the changes you made.
+
 ## Do you wnat to contribute to documentation?
 
 * Fork me.

Makefile

@@ -1,3 +1,4 @@
+YAML_INSTALLED:=$(shell pip install pyyaml)
 NAMESPACE := $(shell python -c 'import yaml; print(yaml.safe_load(open("galaxy.yml"))["namespace"])')
 NAME := $(shell python -c 'import yaml; print(yaml.safe_load(open("galaxy.yml"))["name"])')
 VERSION := $(shell python -c 'import yaml; print(yaml.safe_load(open("galaxy.yml"))["version"])')
@@ -15,6 +16,9 @@ SANITY_OPTS = --venv
 TEST =
 PYTEST = pytest -n 4 --boxed -v
 
+SHELL = bash
+.ONESHELL:
+
 default: help
 
 help:
@@ -43,6 +47,9 @@ $(NAMESPACE)-$(NAME)-$(VERSION).tar.gz: $(addprefix build/src/,$(DEPENDENCIES))
 
 dist: $(NAMESPACE)-$(NAME)-$(VERSION).tar.gz
 
+install: $(NAMESPACE)-$(NAME)-$(VERSION).tar.gz
+	ansible-galaxy collection install $< --force
+
 release-%:
 	bumpversion $*
 	antsibull-changelog release
@@ -67,6 +74,21 @@ doc: $(MANIFEST)
 	antsibull-docs collection --use-current --squash-hierarchy --dest-dir ./docs/plugins codeaffen.phpipam
 	make -C docs html
 
+test-setup: | tests/test_playbooks/vars/server.yml install-deps install
+	test -f tests/test_playbooks/vars/server.yml
+
+test-all:
+	coverage run -m pytest -n 4 --forked -vv 'tests/test_crud.py::test_crud'
+
+test-%:
+	coverage run -m pytest --forked -vv 'tests/test_crud.py::test_case_crud' --testcase $*
+
+tests/test_playbooks/vars/server.yml:
+	sed -e "s#~~url~~#$(PHPIPAM_URL)#" -e "s#~~app_id~~#$(PHPIPAM_APPID)#" -e "s#~~username~~#$(PHPIPAM_USERNAME)#" -e "s#~~password~~#$(PHPIPAM_PASSWORD)#" $@.example > $@
+
+install-deps:
+	pip install -r requirements-dev.txt
+
 FORCE:
 
-.PHONY: help dist lint doc-setup doc publish FORCE
+.PHONY: help dist lint doc-setup doc publish test-setup test-all test-% install-deps FORCE

plugins/module_utils/phpipam_helper.py

@@ -25,9 +25,6 @@
 
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib
 
-from ansible.utils.display import Display
-display = Display()
-
 
 class PhpipamAnsibleException(Exception):
     pass

requirements-dev.txt

@@ -1,6 +1,7 @@
 ansible
-colour
-geopy
+ansible_runner<2.0; python_version < '3.6'
+ansible_runner; python_version >= '3.6'
+coverage
 wheel
 jinja2 # pyup: ignore
 PyYAML~=5.3
@@ -9,6 +10,7 @@ packaging
 requests
 phpypam
 pytest
+pytest-forked
 pytest-xdist
 flake8
 docker

tests/__init__.py

@@ -0,0 +1,61 @@
+import os
+
+import ansible_runner
+import pytest
+import py.path  # type: ignore
+import yaml
+
+
+TEST_PLAYBOOKS_PATH = py.path.local(__file__).realpath() / '..' / 'test_playbooks'
+
+
+def find_all_test_playbooks():
+    for playbook in TEST_PLAYBOOKS_PATH.listdir(sort=True):
+        playbook = playbook.basename
+        if playbook.endswith('.yml'):
+            yield playbook.replace('.yml', '')
+
+
+TEST_PLAYBOOKS = list(find_all_test_playbooks())
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--testcase",
+        action="store",
+        default="",
+        help="testcase to run",
+    )
+
+
+@pytest.fixture
+def testcase(request):
+    return request.config.getoption('testcase')
+
+
+def get_phpipam_url():
+    server_yml = py.path.local(__file__).realpath() / '..' / 'test_playbooks/vars/server.yml'
+    with open(server_yml.strpath) as server_yml_file:
+        server_yml_content = yaml.safe_load(server_yml_file)
+
+    return server_yml_content['phpipam_server_url']
+
+
+def run_playbook(module, extra_vars=None, limit=None, inventory=None, check_mode=False, extra_env=None):
+    # Assemble parameters for playbook call
+    os.environ['ANSIBLE_CONFIG'] = os.path.join(os.getcwd(), 'ansible.cfg')
+    if extra_env is not None:
+        os.environ.update(extra_env)
+    kwargs = {}
+    kwargs['playbook'] = os.path.join(os.getcwd(), 'tests', 'test_playbooks', '{}.yml'.format(module))
+    if inventory is None:
+        inventory = os.path.join(os.getcwd(), 'tests', 'inventory', 'hosts')
+    kwargs['inventory'] = inventory
+    kwargs['verbosity'] = 4
+    if extra_vars:
+        kwargs['extravars'] = extra_vars
+    if limit:
+        kwargs['limit'] = limit
+    if check_mode:
+        kwargs['cmdline'] = "--check"
+    return ansible_runner.run(**kwargs)

tests/conftest.py

@@ -0,0 +1,42 @@
+import os
+import sys
+
+import pytest
+
+from .conftest import TEST_PLAYBOOKS, run_playbook
+
+IGNORED_WARNINGS = [
+    "Activation Key 'Test Activation Key Copy' already exists.",
+]
+
+if sys.version_info[0] == 2:
+    for envvar in os.environ.keys():
+        try:
+            os.environ[envvar] = os.environ[envvar].decode('utf-8').encode('ascii', 'ignore')
+        except UnicodeError:
+            os.environ.pop(envvar)
+
+
+@pytest.mark.parametrize('module', TEST_PLAYBOOKS)
+def test_crud(module):
+    run = run_playbook(module)
+    assert run.rc == 0
+
+    _assert_no_warnings(run)
+
+
+def test_case_crud(testcase):
+    run = run_playbook(testcase)
+    assert run.rc == 0
+
+    _assert_no_warnings(run)
+
+
+def _assert_no_warnings(run):
+    for event in run.events:
+        # check for play level warnings
+        assert not event.get('event_data', {}).get('warning', False)
+
+        # check for task level warnings
+        event_warnings = [warning for warning in event.get('event_data', {}).get('res', {}).get('warnings', []) if warning not in IGNORED_WARNINGS]
+        assert [] == event_warnings, str(event_warnings)

tests/test_crud.py

@@ -1,6 +1,6 @@
 ---
 # Parameter for all tests
-phpipam_server_url: "https://ipam.example.com"
-phpipam_app_id: ansible
-phpipam_username: test
-phpipam_password: "test123"
+phpipam_server_url: '~~url~~'
+phpipam_app_id: ~~app_id~~
+phpipam_username: ~~username~~
+phpipam_password: ~~password~~