Use the session pattern for REST communication, rather than raw requests

Problem: 
All current REST communication uses raw request calls, rather than a session object. 

Solution: 
Use the Requests session object for communication

Signed off: 
serhiy: Serhiy1@live.co.uk
Fix inaccurate doc string


Update TEST_AUTHTOKEN to TEST_AUTHTOKEN_FILENAME


Add a check for identical files func tests

Author: serhiy

README.md

@@ -125,7 +125,7 @@ login is 'githubUserHandle'):
 > rights. If using ~/.ssh/config to manage ssh identities then replace all mentions of
 > 'git@github.com' with the clause name in ~/.ssh/config which references the appropriate
 > ssh key::
-> 
+>
 > For example:
 ```
 Host ssh-githubUserHandle
@@ -215,14 +215,14 @@ If you have access to an archivist instance then one can run functional tests. T
 and authtoken are required. The authtoken must be stored in a file in the credentials
 subdirectory credentials/authtoken (say).
 
-These tests will create artefacts on the archivist instance so it is **not** recommended that 
+These tests will create artefacts on the archivist instance so it is **not** recommended that
 they be run in a production environment.
 
 Set 2 environment variables and execute:
 
 ```bash
 export TEST_ARCHIVIST="https://rkvst.poc.jitsuin.io"
-export TEST_AUTHTOKEN=credentials/authtoken
+export TEST_AUTHTOKEN_FILENAME=credentials/authtoken
 task functests
 ```
 
@@ -333,7 +333,7 @@ Push the changes upstream(the set-upstream option is only required the first tim
 git push --set-upstream origin dev/githubUserHandle/some-proposed-fix
 ```
 
-Enter the github ui at https://github.com/jitsuin-inc/archivist-python and 
+Enter the github ui at https://github.com/jitsuin-inc/archivist-python and
 generate a pull request.
 
 Reviewers will be notified when a PR is generated and you will receive feedback.

archivist/archivist.py

@@ -125,6 +125,7 @@ def __init__(
 
         self._cert = cert
         self._response_ring_buffer = deque(maxlen=self.RING_BUFFER_MAX_LEN)
+        self._session = requests.Session()
 
         # keep these in sync with CLIENTS map above
         self.assets: _AssetsClient
@@ -188,7 +189,7 @@ def get(
             dict representing the response body (entity).
 
         """
-        response = requests.get(
+        response = self._session.get(
             SEP.join((self.url, ROOT, subpath, identity)),
             headers=self.__add_headers(headers),
             verify=self.verify,
@@ -226,7 +227,7 @@ def get_file(
             REST response (not the response body)
 
         """
-        response = requests.get(
+        response = self._session.get(
             SEP.join((self.url, ROOT, subpath, identity)),
             headers=self.__add_headers(headers),
             verify=self.verify,
@@ -261,7 +262,7 @@ def post(self, path: str, request: Dict, *, headers: Optional[Dict] = None) -> D
 
         """
 
-        response = requests.post(
+        response = self._session.post(
             SEP.join((self.url, ROOT, path)),
             data=json.dumps(request),
             headers=self.__add_headers(headers),
@@ -298,7 +299,7 @@ def post_file(self, path: str, fd: BinaryIO, mtype: str) -> Dict:
         headers = {
             "content-type": multipart.content_type,
         }
-        response = requests.post(
+        response = self._session.post(
             SEP.join((self.url, ROOT, path)),
             data=multipart,  # type: ignore      https://github.com/requests/toolbelt/issues/312
             headers=self.__add_headers(headers),
@@ -330,7 +331,7 @@ def delete(
             dict representing the response body (entity).
 
         """
-        response = requests.delete(
+        response = self._session.delete(
             SEP.join((self.url, ROOT, subpath, identity)),
             headers=self.__add_headers(headers),
             verify=self.verify,
@@ -368,7 +369,7 @@ def patch(
 
         """
 
-        response = requests.patch(
+        response = self._session.patch(
             SEP.join((self.url, ROOT, subpath, identity)),
             data=json.dumps(request),
             headers=self.__add_headers(headers),
@@ -388,7 +389,7 @@ def __list(self, path, args, *, headers=None) -> Response:
         if args:
             path = "?".join((path, args))
 
-        response = requests.get(
+        response = self._session.get(
             SEP.join((self.url, ROOT, path)),
             headers=self.__add_headers(headers),
             verify=self.verify,

functests/execaccess_policies.py

@@ -64,7 +64,7 @@ class TestAccessPolicies(TestCase):
 
     @classmethod
     def setUpClass(cls):
-        with open(environ["TEST_AUTHTOKEN"]) as fd:
+        with open(environ["TEST_AUTHTOKEN_FILENAME"]) as fd:
             auth = fd.read().strip()
         cls.arch = Archivist(environ["TEST_ARCHIVIST"], auth=auth, verify=False)
         cls.props = deepcopy(PROPS)

functests/execassets.py

@@ -34,8 +34,9 @@ class TestAssetCreate(TestCase):
 
     maxDiff = None
 
+    @classmethod
     def setUp(cls):
-        with open(environ["TEST_AUTHTOKEN"]) as fd:
+        with open(environ["TEST_AUTHTOKEN_FILENAME"]) as fd:
             auth = fd.read().strip()
         cls.arch = Archivist(environ["TEST_ARCHIVIST"], auth=auth, verify=False)
         cls.attrs = deepcopy(ATTRS)

functests/execattachments.py

@@ -0,0 +1,57 @@
+"""
+Tests the upload and download functionality of the SDK
+"""
+import os
+from os import environ
+from unittest import TestCase
+from contextlib import suppress
+from filecmp import cmp
+
+from archivist.archivist import Archivist
+
+
+# pylint: disable=fixme
+# pylint: disable=missing-docstring
+# pylint: disable=unused-variable
+
+
+class TestAssetCreate(TestCase):
+    """
+    Test Archivist Asset Create method
+    """
+
+    TEST_IMAGE_PATH = "functests/test_resources/Jitsuin_Logo_RGB.jpg"
+    TEST_IMAGE_DOWNLOAD_PATH = "functests/test_resources/downloaded_image.jpg"
+
+    @classmethod
+    def setUp(cls):
+        with open(environ["TEST_AUTHTOKEN_FILENAME"]) as fd:
+            auth = fd.read().strip()
+        cls.arch = Archivist(environ["TEST_ARCHIVIST"], auth=auth, verify=False)
+        cls.file_uuid: str = ""
+
+        with suppress(FileNotFoundError):
+            os.remove(cls.TEST_IMAGE_DOWNLOAD_PATH)
+
+    @classmethod
+    def tearDown(cls) -> None:
+        """Remove the downloaded image for subsequent test runs"""
+        with suppress(FileNotFoundError):
+            os.remove(cls.TEST_IMAGE_DOWNLOAD_PATH)
+
+    def testfile_upload_and_download(self):
+        """
+        Test file upload through the SDK
+        Test file download through the SDK
+        """
+        with open(self.TEST_IMAGE_PATH, "rb") as image:
+            attachment = self.arch.attachments.upload(image)
+            file_uuid = attachment["identity"]
+
+        with open(self.TEST_IMAGE_DOWNLOAD_PATH, "wb") as image:
+            attachment = self.arch.attachments.download(file_uuid, image)
+
+        # Check the downloaded file is identical to the one that was uploaded
+        self.assertTrue(
+            cmp(self.TEST_IMAGE_PATH, self.TEST_IMAGE_DOWNLOAD_PATH, shallow=False)
+        )

functests/execsubjects.py

@@ -31,7 +31,7 @@ class TestSubjects(TestCase):
 
     @classmethod
     def setUpClass(cls):
-        with open(environ["TEST_AUTHTOKEN"]) as fd:
+        with open(environ["TEST_AUTHTOKEN_FILENAME"]) as fd:
             auth = fd.read().strip()
         cls.arch = Archivist(environ["TEST_ARCHIVIST"], auth=auth, verify=False)
         cls.display_name = f"{DISPLAY_NAME} {uuid4()}"

functests/test_resources/Jitsuin_Logo_RGB.jpg

@@ -12,6 +12,6 @@ docker run \
     -v $(pwd):/home/builder \
     -u $(id -u):$(id -g) \
     -e TEST_ARCHIVIST \
-    -e TEST_AUTHTOKEN \
+    -e TEST_AUTHTOKEN_FILENAME \
     jitsuin-archivist-python-builder \
     "$@"

scripts/builder.sh

@@ -7,14 +7,14 @@ then
     echo "TEST_ARCHIVIST is undefined"
     exit 1
 fi
-if [ -z "${TEST_AUTHTOKEN}" ]
+if [ -z "${TEST_AUTHTOKEN_FILENAME}" ]
 then
-    echo "TEST_AUTHTOKEN is undefined"
+    echo "TEST_AUTHTOKEN_FILENAME is undefined"
     exit 1
 fi
-if [ ! -s "${TEST_AUTHTOKEN}" ]
+if [ ! -s "${TEST_AUTHTOKEN_FILENAME}" ]
 then
-    echo "${TEST_AUTHTOKEN} does not exist"
+    echo "${TEST_AUTHTOKEN_FILENAME} does not exist"
     exit 1
 fi
 

scripts/functests.sh

@@ -93,7 +93,7 @@ class TestAccessPolicies(TestCase):
     def setUp(self):
         self.arch = Archivist("url", auth="authauthauth")
 
-    @mock.patch("requests.post")
+    @mock.patch("requests.Session.post")
     def test_access_policies_create(self, mock_post):
         """
         Test access_policy creation
@@ -125,7 +125,7 @@ def test_access_policies_create(self, mock_post):
             msg="CREATE method called incorrectly",
         )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_read(self, mock_get):
         """
         Test access_policy reading
@@ -149,7 +149,7 @@ def test_access_policies_read(self, mock_get):
             msg="GET method called incorrectly",
         )
 
-    @mock.patch("requests.delete")
+    @mock.patch("requests.Session.delete")
     def test_access_policies_delete(self, mock_delete):
         """
         Test access_policy deleting
@@ -173,7 +173,7 @@ def test_access_policies_delete(self, mock_delete):
             msg="DELETE method called incorrectly",
         )
 
-    @mock.patch("requests.patch")
+    @mock.patch("requests.Session.patch")
     def test_access_policies_update(self, mock_patch):
         """
         Test access_policy deleting
@@ -201,7 +201,7 @@ def test_access_policies_update(self, mock_patch):
             msg="PATCH method called incorrectly",
         )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_read_with_error(self, mock_get):
         """
         Test read method with error
@@ -210,7 +210,7 @@ def test_access_policies_read_with_error(self, mock_get):
         with self.assertRaises(ArchivistBadRequestError):
             resp = self.arch.access_policies.read(IDENTITY)
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_count(self, mock_get):
         """
         Test access_policy counting
@@ -246,7 +246,7 @@ def test_access_policies_count(self, mock_get):
             msg="Incorrect count",
         )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_count_by_name(self, mock_get):
         """
         Test access_policy counting
@@ -285,7 +285,7 @@ def test_access_policies_count_by_name(self, mock_get):
             msg="GET method called incorrectly",
         )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_list(self, mock_get):
         """
         Test access_policy listing
@@ -327,7 +327,7 @@ def test_access_policies_list(self, mock_get):
                 msg="GET method called incorrectly",
             )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_list_by_name(self, mock_get):
         """
         Test access_policy listing
@@ -379,7 +379,7 @@ def test_access_policies_list_by_name(self, mock_get):
                 msg="GET method called incorrectly",
             )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_count_matching_access_policies(self, mock_get):
         """
         Test access_policy counting
@@ -420,7 +420,7 @@ def test_access_policies_count_matching_access_policies(self, mock_get):
             msg="Incorrect count",
         )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_list_matching_access_policies(self, mock_get):
         """
         Test access_policy counting
@@ -467,7 +467,7 @@ def test_access_policies_list_matching_access_policies(self, mock_get):
                 msg="GET method called incorrectly",
             )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_count_matching_assets(self, mock_get):
         """
         Test access_policy counting
@@ -508,7 +508,7 @@ def test_access_policies_count_matching_assets(self, mock_get):
             msg="Incorrect count",
         )
 
-    @mock.patch("requests.get")
+    @mock.patch("requests.Session.get")
     def test_access_policies_list_matching_assets(self, mock_get):
         """
         Test access_policy counting