Merge pull request #52 from Charlesworth/feature/api-tests

API/SDK integration test setup

Author: LouisBrunner

Pipfile

@@ -13,3 +13,6 @@ pytest = "*"
 "pytest-cov" = "*"
 
 [requires]
+
+[scripts]
+test = "python -m pytest tests/"

README.md

@@ -157,11 +157,19 @@ Please raise any bugs or feature requests as a Github issues. We also gratefully
 ## Testing
 
 ```bash
+# to run all test files in tests directory
+$ pipenv run test
+
+# or to run a single test file
 $ pipenv shell
-$ python -m pytest evasdk/<name-of-file-to-test>
+$ python -m pytest tests/<test-name>_test.py
 
 # some test require supplying ip and token via the `--ip` and `--token` arguements
-$ python -m pytest evasdk/<name-of-file-to-test> --ip 172.16.16.2 --token abc-123-def-456
+$ pipenv run test --ip 172.16.16.2 --token abc-123-def-456
+
+# long duration tests and tests requiring a connected Eva are disabled by default,
+# to include them add the `--runslow` or --runrobot flags
+$ pipenv run test --runslow --runrobot
 ```
 
 ## License

tests/eva_auth_test2.py renamed to tests/Eva_auth_test.py

@@ -1,27 +1,11 @@
-from evasdk import Eva, EvaAutoRenewError, EvaError
+from evasdk import EvaAutoRenewError, EvaError
 import time
 import pytest
-import logging
 
 # TODO: this rely on having an actual robot, should be rewritten to be mockable
 
 
-@pytest.fixture(scope="module")
-def eva(ip, token):
-    e = Eva(ip, token, request_timeout=10, renew_period=2 * 60)
-    e._Eva__logger.setLevel(logging.DEBUG)
-    e._Eva__http_client._EvaHTTPClient__logger.setLevel(logging.DEBUG)
-    yield e
-    if e.lock_status()['status'] != 'unlocked':
-        e.unlock()
-
-
-@pytest.fixture
-def locked_eva(eva):
-    with eva.lock():
-        yield eva
-
-
+@pytest.mark.robot_required
 class TestAuth:
     def test_create_new_session(self, eva):
         token = eva.auth_create_session()
@@ -38,7 +22,7 @@ def test_invalidate_session(self, eva):
         eva.users_get()
         assert(token != eva._Eva__http_client.session_token)
 
-
+    @pytest.mark.slow
     def test_auto_renew_error(self, eva):
         api_token = eva._Eva__http_client.api_token
         eva._Eva__http_client.api_token = ''
@@ -69,7 +53,7 @@ def test_lock_with_no_existing_session(self, eva):
         with eva.lock():
             eva.gpio_set('d1', not eva.gpio_get('d1', 'output'))
 
-
+    @pytest.mark.slow
     def test_auto_renew(self, locked_eva):
         for _ in range(7):
             locked_eva.gpio_set('d1', not locked_eva.gpio_get('d1', 'output'))

tests/Eva_data_test.py

@@ -0,0 +1,27 @@
+from evasdk import EvaError
+import pytest
+
+
+@pytest.mark.robot_required
+class TestEva_Data:
+    # TODO: we may want to check the structure of the snapshot JSON object
+    def test_snapshot(self, eva):
+        snapshot = eva.data_snapshot()
+        assert(snapshot)
+        assert(snapshot['control']['loop_count'] >= 0)
+
+
+    def test_snapshot_property(self, eva):
+        control_snapshot = eva.data_snapshot_property('control')
+        assert(control_snapshot)
+        assert(control_snapshot['loop_count'] >= 0)
+
+
+    def test_data_snapshot_property_PropertNotPresent(self, eva):
+        with pytest.raises(EvaError):
+            eva.data_snapshot_property('rubbish_property')
+
+
+    def test_servo_positions(self, eva):
+        servo_positions = eva.data_servo_positions()
+        assert(len(servo_positions) == 6)

tests/conftest.py

@@ -1,9 +1,13 @@
+from evasdk import Eva
 import pytest
+import logging
 
 
 def pytest_addoption(parser):
     parser.addoption("--ip", default='172.16.16.2', help="IP of the test robot, defaults to 172.16.16.2")
     parser.addoption("--token", default='', help="API token of the test robot")
+    parser.addoption("--runslow", action="store_true", default=False, help="run slow tests")
+    parser.addoption("--runrobot", action="store_true", default=False, help="run tests that require a connected Eva")
 
 
 @pytest.fixture(scope="session")
@@ -14,3 +18,44 @@ def ip(request):
 @pytest.fixture(scope="session")
 def token(request):
     return request.config.getoption("--token")
+
+
+def pytest_configure(config):
+    config.addinivalue_line("markers", "slow: mark test as slow to run")
+    config.addinivalue_line("markers", "robot_required: no mocks, needs a connected Eva to run")
+
+
+def pytest_collection_modifyitems(config, items):
+    if config.getoption("--runslow"):
+        # --runslow given in cli: do not skip slow tests
+        return
+    else:
+        skip_slow = pytest.mark.skip(reason="need --runslow option to run")
+        for item in items:
+            if "slow" in item.keywords:
+                item.add_marker(skip_slow)
+
+    if config.getoption("--runrobot"):
+        # --runrobot given in cli: do not skip tests where a connected Eva is required
+        return
+    else:
+        skip_robot_required = pytest.mark.skip(reason="need --runrobot option to run")
+        for item in items:
+            if "robot_required" in item.keywords:
+                item.add_marker(skip_robot_required)
+
+
+@pytest.fixture(scope="module")
+def eva(ip, token):
+    e = Eva(ip, token, request_timeout=10, renew_period=2 * 60)
+    e._Eva__logger.setLevel(logging.DEBUG)
+    e._Eva__http_client._EvaHTTPClient__logger.setLevel(logging.DEBUG)
+    yield e
+    if e.lock_status()['status'] != 'unlocked':
+        e.unlock()
+
+
+@pytest.fixture
+def locked_eva(eva):
+    with eva.lock():
+        yield eva