Add pytest support and first unit test

Author: rkaplan

conftest.py

@@ -0,0 +1,56 @@
+# grequests must be imported before any module not designed for reentrancy,
+# because it relies on aggressive monkey patching that breaks if done after many
+# other common module imports, e.g. ssl.
+#
+# So we import it before everything else. For details see:
+# https://github.com/gevent/gevent/issues/1016#issuecomment-328530533
+# https://github.com/spyoungtech/grequests/issues/8
+import grequests
+################
+
+import logging
+import os
+
+import requests
+import pytest
+
+import nucleus
+
+
+assert 'PYTEST_API_KEY' in os.environ, \
+    "You must set the 'PYTEST_API_KEY' environment variable to a valid " \
+    "Nucleus API key to run the test suite"
+
+API_KEY = os.environ['PYTEST_API_KEY']
+
+
+@pytest.fixture(scope='session')
+def monkeypatch_session(request):
+    """ This workaround is needed to allow monkeypatching in session-scoped fixtures.
+
+    See https://github.com/pytest-dev/pytest/issues/363
+    """
+    from _pytest.monkeypatch import MonkeyPatch
+    mpatch = MonkeyPatch()
+    yield mpatch
+    mpatch.undo()
+
+
+@pytest.fixture(scope='session')
+def CLIENT(monkeypatch_session):
+    client = nucleus.NucleusClient(API_KEY)
+
+    # Change _make_request to raise AsssertionErrors when the
+    # HTTP status code is not successful, so that tests fail if
+    # the request was unsuccessful.
+    def _make_request_patch(
+        payload: dict, route: str, requests_command=requests.post
+    ) -> dict:
+        response = client._make_request_raw(payload, route, requests_command)
+        assert response.status_code in [200, 201], \
+            f"HTTP response had status code: {response.status_code}. " \
+            f"Full JSON: {response.json()}"
+        return response.json()
+
+    monkeypatch_session.setattr(client, "_make_request", _make_request_patch)
+    return client

nucleus/__init__.py

@@ -878,11 +878,13 @@ def _make_grequest(
             )
         return post
 
-    def _make_request(
+    def _make_request_raw(
         self, payload: dict, route: str, requests_command=requests.post
     ) -> dict:
         """
-        makes a request to Nucleus endpoint
+        Makes a request to Nucleus endpoint. This method returns the raw
+        requests.Response object which is useful for unit testing.
+
         :param payload: given payload
         :param route: route for the request
         :param requests_command: requests.post, requests.get, requests.delete
@@ -899,7 +901,23 @@ def _make_request(
         )
         logger.info("API request has response code %s", response.status_code)
 
-        if response.status_code != 200:
+        return response
+
+    def _make_request(
+        self, payload: dict, route: str, requests_command=requests.post
+    ) -> dict:
+        """
+        Makes a request to Nucleus endpoint and logs a warning if not
+        successful.
+
+        :param payload: given payload
+        :param route: route for the request
+        :param requests_command: requests.post, requests.get, requests.delete
+        :return: response JSON
+        """
+        response = self._make_request_raw(payload, route, requests_command)
+
+        if response.status_code not in [200, 201]:
             logger.warning(response)
 
         return (

tests/test_dataset.py

@@ -0,0 +1,15 @@
+import pytest
+
+import nucleus
+from nucleus import Dataset
+
+
+TEST_DATASET_NAME = '[PyTest] Test Dataset'
+
+def test_dataset_create_and_delete(CLIENT):
+    # Creation
+    ds = CLIENT.create_dataset(TEST_DATASET_NAME)
+    assert isinstance(ds, Dataset)
+
+    # Deletion
+    response = CLIENT.delete_dataset(ds.id)