Improve testing (#54)

* Updating .gitignore with .coverage,build/

* Adding code coverage, more integration of functional tests with pytest
access

Author: lpefferkorn

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+  branch = True
+  omit = */tests/*
+[report]
+  show_missing = True

.gitignore

@@ -7,5 +7,7 @@
 .tox/
 .cache/
 .idea/
+.coverage
 venv/
+build/
 venv-*/

iocage/tests/0002_ioc_check_test.py

@@ -1,16 +1,62 @@
-# Running tests:
-================
-**These tests are written for `pytest`**
+# Code testing
+All the tests are written using the `pytest` unit testing framework. Code coverage is provided by `pytest-cov`
 
-- Make sure you're in the iocage directory
-- Supply --zpool="POOL" to pytest
+Before running tests, test dependencies can be installed by running:
+```
+$ pip install pytest-cov pytest-pep8
+```
+
+## Unit tests
+
+Located in the ``tests/unit_tests`` directory, they can be started as a normal user with the following command:
+
+```
+$ pytest
+```
+
+## Functional tests
+
+Located in the ``tests/functional_tests``, they need a root acces and the name of a ZFS pool
 
-#####Example:
+**/!\ The contents of the specified ZFS pool will be destroyed**
+
+To start the functional tests, run pytest with root privileges and the name of a zpool:
 ```
-git clone https://github.com/iocage/iocage.git
-cd iocage/iocage
-sudo pytest --zpool="TEST" --server="custom_server"
+$ sudo pytest --zpool=mypool
 ```
 
-**To list all supported fixtures to pytest:**
-`pytest --fixtures`
+Other parameters are available, to see them run:
+```
+$ pytest --fixtures
+```
+Extract:
+```
+zpool 
+    Specify a zpool to use.
+release 
+    Specify a RELEASE to use.
+server 
+    FTP server to login to.
+user 
+    The user to use for fetching.
+password 
+    The password to use for fetching.
+root_dir 
+    Root directory containing all the RELEASEs for fetching.
+http 
+    Have --server define a HTTP server instead.
+hardened 
+    Have fetch expect the default HardeneBSD layout instead.
+_file 
+    Use a local file directory for root-dir instead of FTP or HTTP.
+auth 
+    Authentication method for HTTP fetching. Valid values: basic, digest
+```
+
+
+#Example
+```
+$ git clone https://github.com/iocage/iocage.git
+$ cd iocage/iocage
+$ sudo pytest --zpool="TEST" --server="custom_server"
+```

iocage/tests/README.md

@@ -1,4 +1,5 @@
 import pytest
+import os
 
 
 def pytest_addoption(parser):
@@ -31,6 +32,14 @@ def pytest_addoption(parser):
         help="Root directory containing all the RELEASEs for fetching.")
 
 
+def pytest_runtest_setup(item):
+    if 'require_root' in item.keywords and not os.getuid() == 0:
+        pytest.skip("Need to be root to run")
+
+    if 'require_zpool' in item.keywords and not item.config.getvalue("zpool"):
+        pytest.skip("Need --zpool option to run")
+
+
 @pytest.fixture
 def zpool(request):
     """Specify a zpool to use."""

iocage/tests/__init__.py

@@ -1,11 +1,12 @@
-import os
+import pytest
 import subprocess
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+@require_root
+@require_zpool
 def test_activate(zpool):
-    if os.geteuid() != 0:
-        raise RuntimeError(
-            "You need to have root privileges to run any tests.")
     try:
         subprocess.check_call(["zfs", "set", "org.freebsd.ioc:active=yes",
                                zpool], stdout=subprocess.PIPE)

iocage/tests/conftest.py

@@ -0,0 +1,13 @@
+import pytest
+from iocage.lib.ioc_check import IOCCheck
+
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
+
+
+@require_root
+@require_zpool
+def test_check():
+    IOCCheck()
+
+    assert True == True

iocage/tests/0001_ioc_activate_test.py iocage/tests/functional_tests/0001_ioc_activate_test.py

@@ -1,6 +1,12 @@
+import pytest
 from iocage.lib.ioc_fetch import IOCFetch
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+
+@require_root
+@require_zpool
 def test_fetch(release, server, user, password, auth, root_dir, http, _file,
                hardened):
     IOCFetch(release, server, user, password, auth, root_dir, http=http,

iocage/tests/functional_tests/0002_ioc_check_test.py

@@ -1,6 +1,12 @@
+import pytest
 from iocage.lib.ioc_create import IOCCreate
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+
+@require_root
+@require_zpool
 def test_create(release, hardened):
     prop = ("tag=test",)
     prop_short = ("tag=test_short",)

iocage/tests/0003_ioc_fetch_test.py iocage/tests/functional_tests/0003_ioc_fetch_test.py

@@ -1,8 +1,14 @@
+import pytest
 from iocage.lib.ioc_json import IOCJson
 from iocage.lib.ioc_list import IOCList
 from iocage.lib.ioc_start import IOCStart
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+
+@require_root
+@require_zpool
 def test_start():
     jails, paths = IOCList("uuid").list_datasets()
 

iocage/tests/0004_ioc_create_test.py iocage/tests/functional_tests/0004_ioc_create_test.py

@@ -1,8 +1,14 @@
+import pytest
 from iocage.lib.ioc_json import IOCJson
 from iocage.lib.ioc_list import IOCList
 from iocage.lib.ioc_stop import IOCStop
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+
+@require_root
+@require_zpool
 def test_stop():
     jails, paths = IOCList("uuid").list_datasets()
 

iocage/tests/0005_ioc_start_test.py iocage/tests/functional_tests/0005_ioc_start_test.py

@@ -1,7 +1,13 @@
+import pytest
 from iocage.lib.ioc_json import IOCJson
 from iocage.lib.ioc_list import IOCList
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+
+@require_root
+@require_zpool
 def test_set():
     _, paths = IOCList("uuid").list_datasets()
 

iocage/tests/0006_ioc_stop_test.py iocage/tests/functional_tests/0006_ioc_stop_test.py

@@ -1,7 +1,13 @@
+import pytest
 from iocage.lib.ioc_json import IOCJson
 from iocage.lib.ioc_list import IOCList
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+
+@require_root
+@require_zpool
 def test_get():
     _, paths = IOCList("uuid").list_datasets()
 

iocage/tests/0007_ioc_set_test.py iocage/tests/functional_tests/0007_ioc_set_test.py

@@ -1,7 +1,13 @@
+import pytest
 from iocage.lib.ioc_destroy import IOCDestroy
 from iocage.lib.ioc_list import IOCList
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
 
+
+@require_root
+@require_zpool
 def test_destroy():
     jails, paths = IOCList("uuid").list_datasets()
 

iocage/tests/0008_ioc_get_test.py iocage/tests/functional_tests/0008_ioc_get_test.py

@@ -1,8 +1,13 @@
 import os
-
+import pytest
 from iocage.lib.ioc_clean import IOCClean
 
+require_root = pytest.mark.require_root
+require_zpool = pytest.mark.require_zpool
+
 
+@require_root
+@require_zpool
 def test_clean():
     # Unless we change directory (not sure why) this will crash pytest.
     os.chdir("/")

iocage/tests/0009_ioc_destroy_test.py iocage/tests/functional_tests/0009_ioc_destroy_test.py

@@ -0,0 +1,4 @@
+[tool:pytest]
+addopts = -v -x -rs --ignore=setup.py --pep8 --cov-report term-missing --cov=iocage iocage iocage/tests
+pep8maxlinelength = 80
+pep8ignore = * ALL

iocage/tests/9999_ioc_clean_test.py iocage/tests/functional_tests/9999_ioc_clean_test.py

@@ -30,5 +30,6 @@
               'iocage = iocage.main:main'
           ]
       },
-      data_files=_data
+      data_files=_data,
+      tests_require=['pytest', 'pytest-cov', 'pytest-pep8']
       )