Prepare test environment (#34)

* Setup test environment

As we want to run automated tests we have to implement a environment to
solve this task.
We refactored existing tests to run with `pytest`.
Following things were done:

* Add packages for automated testing to requirements
** add pytest, pytest-vcr
** add coverage
** add flake8-docstrings to provide better documentation

* Refactor section tests
* Refactor connection tests

* Refactor makefile for test framework
  Add new targets to prepare environment for testing and run all tests at
  once.
** `test-setup` to setup test environment
** `test-all` to run all tests
** `test-<test>` to run a specific test
* Add documentation for new targets.

* Refactor controller method tests
* Refactor address search tests
* Refactor search subnets tests
* Refactor vlan tests
* Refactor nameserver tests
* Refactor section search tests

* Add coverage target to makefile
  Add target to output a simple coverage report for `phpypam` and `tests`
  folder.
* run each test in conjunction with coverage

* Extend clean target
** Add housekeeping of coverage data to `clean` target.
** Add pytest cache to clean target

* Add some more tests for missing code fragments
** Add test for all exceptions
** Add test for custom `user_agent` header

* add some badges to readme

* fix issues from codacy report

Author: cmeissner

Makefile

@@ -16,9 +16,17 @@ default: help
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of:"
-		@echo "  help - to show this message"
-		@echo "  dist - to build the collection archive"
-		@echo "  lint - to run code linting"
+		@echo "  help  			  - to show this message"
+		@echo "  dist  			  - to build the collection archive"
+		@echo "  lint  			  - to run code linting"
+		@echo "  clean 			  - clean workspace"
+		@echo "  doc-setup    - prepare environment for creating documentation"
+		@echo "  doc          - create documentation"
+		@echo "  test-setup   - prepare environment for tests"
+		@echo "  test-all     - run all tests"
+		@echo "  test-<test>  - run a specifig test"
+		@echo "  coverage     - display code coverage"
+		@echo "  coverage-xml - create xml coverage report"
 
 lint:
 	flake8 phpypam
@@ -33,11 +41,12 @@ publish: check
 	$(TWINE_CMD) upload $(TWINE_OPTIONS) dist/*
 
 clean:
-	rm -Rf docs/{build,_build} {build,dist} *.egg-info
+	rm -Rf docs/{build,_build} {build,dist} *.egg-info coverage.xml .pytest_cache
 	find . -name '*.pyc' -exec rm -f {} +
 	find . -name '*.pyo' -exec rm -f {} +
 	find . -name '*~' -exec rm -f {} +
 	find . -name '__pycache__' -exec rm -rf {} +
+	coverage erase
 
 doc-setup:
 	pip install --upgrade -r docs/requirements.txt
@@ -47,6 +56,21 @@ doc:
 	sphinx-apidoc -M -f -o docs/plugins/ phpypam
 	make -C docs html
 
+test-setup:
+	pip install --upgrade -r requirements-dev.txt
+
+test-all:
+	coverage run -m pytest tests/test_cases/* -v
+
+test-%:
+	coverage run -m pytest tests/test_cases/$*.py -v
+
+coverage: test-all
+	coverage report -m --include 'phpypam/*','phpypam/**/*','tests/**/*'
+
+coverage-xml: test-all
+	coverage xml --include 'phpypam/*','phpypam/**/*','tests/**/*'
+
 FORCE:
 
 .PHONY: help dist lint publish FORCE

README.md

@@ -1,6 +1,8 @@
 # phpypam: Python API client library for phpIPAM installation
 
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/6b89ed13b6694197944cddea94c953ed)](https://app.codacy.com/gh/codeaffen/phpypam?utm_source=github.com&utm_medium=referral&utm_content=codeaffen/phpypam&utm_campaign=Badge_Grade_Settings)
+[![PyPI version](https://badge.fury.io/py/phpypam.svg)](https://badge.fury.io/py/phpypam)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ed3511c33a254bfe942777c9ef3251e3)](https://www.codacy.com/gh/codeaffen/phpypam/dashboard?utm_source=github.com&utm_medium=referral&utm_content=codeaffen/phpypam&utm_campaign=Badge_Grade)
+[![Documentation Status](https://readthedocs.org/projects/phpypam/badge/?version=latest)](https://phpypam.readthedocs.io/en/latest/?badge=latest)
 
 phpypam is intended to be a complete library for speaking with phpIPAM API.
 

requirements-dev.txt

@@ -1,9 +1,13 @@
 wheel
 flake8
 flake8-colors
+flake8-docstrings
 requests
 inflection
 twine
 setuptools
 PyYAML
 bumpversion
+pytest
+pytest-vcr
+coverage

tests/api_connection.py

@@ -0,0 +1,57 @@
+"""Tests to check connection to API."""
+import phpypam
+import pytest
+import yaml
+
+from phpypam.core.exceptions import PHPyPAMInvalidCredentials
+
+with open('tests/vars/server.yml') as c:
+    server = yaml.safe_load(c)
+
+connection_params = dict(
+    url=server['url'],
+    app_id=server['app_id'],
+    username=server['username'],
+    password=server['password'],
+    ssl_verify=True
+)
+
+
+def test_connection_success():
+    """Test whether a connection to API can be done."""
+    pi = phpypam.api(**connection_params)
+
+    token = pi.get_token()
+
+    assert isinstance(pi, phpypam.api)
+    assert len(token) == 24
+
+
+def test_connection_failure():
+    """Test faulty connection.
+
+    Test if failure where reported correctly if there is faulty login data.
+    """
+    connection_kwargs = connection_params.copy()
+    connection_kwargs.update({'password': 'wrong_password'})
+
+    pytest.raises(PHPyPAMInvalidCredentials, phpypam.api, **connection_kwargs)
+
+    connection_kwargs = connection_params.copy()
+    connection_kwargs.update({'username': 'wrong_username'})
+
+    pytest.raises(PHPyPAMInvalidCredentials, phpypam.api, **connection_kwargs)
+
+
+def test_custom_user_agent():
+    """Test to set custom user-agent header.
+
+    Test to connect to API with a custom user-agent header set.
+    """
+    connection_kwargs = connection_params.copy()
+    connection_kwargs.update({'user_agent': 'my_test_agent'})
+
+    pi = phpypam.api(**connection_kwargs)
+
+    assert isinstance(pi, phpypam.api)
+    assert len(pi.get_token()) == 24

tests/ensure_nameserver.py

@@ -1,12 +1,13 @@
-#!/usr/bin/env python
-
+"""Test controller method."""
 import phpypam
 import yaml
 
 with open('tests/vars/server.yml') as c:
     server = yaml.safe_load(c)
 
-if __name__ == '__main__':
+
+def test_controllers():
+    """Test if controllers method returns correct datatype."""
     pi = phpypam.api(
         url=server['url'],
         app_id=server['app_id'],
@@ -16,4 +17,4 @@
     )
 
     controllers = pi.controllers()
-    print(controllers)
+    assert isinstance(controllers, set)