Update verify parameter

- Instead of passing in a verify parameter for every request, set it on startup - update unit tests to reflect this - black formatting
datatrails · May 21, 2024 · 2bfaf97 · 2bfaf97
1 parent f7f3af9
commit 2bfaf97
Show file tree

Hide file tree

Showing 35 changed files with 34 additions and 169 deletions.
diff --git a/archivist/archivist.py b/archivist/archivist.py
@@ -1,34 +1,35 @@
 # -*- coding: utf-8 -*-
 """Archivist connection interface
 
-   This module contains the base Archivist class which manages
-   the connection parameters to a DataTrails instance and
-   the basic REST verbs to GET, POST, PATCH and DELETE entities..
+This module contains the base Archivist class which manages
+the connection parameters to a DataTrails instance and
+the basic REST verbs to GET, POST, PATCH and DELETE entities..
 
-   The REST methods in this class should only be used directly when
-   a CRUD endpoint for the specific type of entity is unavailable.
-   Current CRUD endpoints are assets, events, locations, attachments.
-   IAM subjects and IAM access policies.
+The REST methods in this class should only be used directly when
+a CRUD endpoint for the specific type of entity is unavailable.
+Current CRUD endpoints are assets, events, locations, attachments.
+IAM subjects and IAM access policies.
 
-   Instantiation of this class encapsulates the URL and authentication
-   parameters (the max_time parameter is optional):
+Instantiation of this class encapsulates the URL and authentication
+parameters (the max_time parameter is optional):
 
-   .. code-block:: python
+.. code-block:: python
 
-      with open(".auth_token", mode="r", encoding="utf-8") as tokenfile:
-          authtoken = tokenfile.read().strip()
+   with open(".auth_token", mode="r", encoding="utf-8") as tokenfile:
+       authtoken = tokenfile.read().strip()
 
-      # Initialize connection to Archivist
-      arch = Archivist(
-          "https://app.datatrails.ai",
-          authtoken,
-          max_time=300.0,
-      )
+   # Initialize connection to Archivist
+   arch = Archivist(
+       "https://app.datatrails.ai",
+       authtoken,
+       max_time=300.0,
+   )
 
-    The arch variable now has additional endpoints assets,events,locations,
-    attachments, IAM subjects and IAM access policies documented elsewhere.
+ The arch variable now has additional endpoints assets,events,locations,
+ attachments, IAM subjects and IAM access policies documented elsewhere.
 
 """
+
 from copy import deepcopy
 from logging import getLogger
 from time import time
@@ -253,14 +254,12 @@ def post(
             response = self.session.post(
                 url,
                 data=request,
-                verify=self.verify,
             )
         else:
             response = self.session.post(
                 url,
                 json=request,
                 headers=self._add_headers(headers),
-                verify=self.verify,
             )
 
         error = _parse_response(response)
@@ -305,7 +304,6 @@ def post_file(
             url,
             data=multipart,  # pyright: ignore    https://github.com/requests/toolbelt/issues/312
             headers=self._add_headers(headers),
-            verify=self.verify,
             params=_dotdict(params),
         )
 
@@ -335,7 +333,6 @@ def delete(
         response = self.session.delete(
             url,
             headers=self._add_headers(headers),
-            verify=self.verify,
         )
 
         self._response_ring_buffer.appendleft(response)
@@ -371,7 +368,6 @@ def patch(
             url,
             json=request,
             headers=self._add_headers(headers),
-            verify=self.verify,
         )
 
         self._response_ring_buffer.appendleft(response)

diff --git a/archivist/archivistpublic.py b/archivist/archivistpublic.py
@@ -122,6 +122,7 @@ def session(self) -> requests.Session:
         """creates and returns session"""
         if self._session is None:
             self._session = requests.Session()
+            self._session.verify = self.verify
         return self._session
 
     def close(self):
@@ -197,7 +198,6 @@ def get(
         response = self.session.get(
             url,
             headers=self._add_headers(headers),
-            verify=self.verify,
             params=_dotdict(params),
         )
 
@@ -237,7 +237,6 @@ def get_file(
         response = self.session.get(
             url,
             headers=self._add_headers(headers),
-            verify=self.verify,
             stream=True,
             params=_dotdict(params),
         )
@@ -272,7 +271,6 @@ def __list(
         response = self.session.get(
             url,
             headers=self._add_headers(headers),
-            verify=self.verify,
             params=_dotdict(params),
         )
 

diff --git a/archivist/confirmer.py b/archivist/confirmer.py
@@ -52,32 +52,28 @@ def __on_giveup_confirmation(details: "Details"):
 def _wait_for_confirmation(
     self: "_AssetsRestricted",
     identity: str,
-) -> "Asset":
-    ...  # pragma: no cover
+) -> "Asset": ...  # pragma: no cover
 
 
 @overload
 def _wait_for_confirmation(
     self: "_AssetsPublic",
     identity: str,
-) -> "Asset":
-    ...  # pragma: no cover
+) -> "Asset": ...  # pragma: no cover
 
 
 @overload
 def _wait_for_confirmation(
     self: "_EventsRestricted",
     identity: str,
-) -> "Event":
-    ...  # pragma: no cover
+) -> "Event": ...  # pragma: no cover
 
 
 @overload
 def _wait_for_confirmation(
     self: "_EventsPublic",
     identity: str,
-) -> "Event":
-    ...  # pragma: no cover
+) -> "Event": ...  # pragma: no cover
 
 
 @backoff.on_predicate(

diff --git a/functests/execassets.py b/functests/execassets.py
@@ -129,9 +129,9 @@ def setUp(self):
         self.traffic_light = deepcopy(ATTRS)
         self.traffic_light["arc_display_type"] = "Traffic light with violation camera"
         self.traffic_light_merkle_log = deepcopy(ATTRS)
-        self.traffic_light_merkle_log[
-            "arc_display_type"
-        ] = "Traffic light with violation camera (merkle_log)"
+        self.traffic_light_merkle_log["arc_display_type"] = (
+            "Traffic light with violation camera (merkle_log)"
+        )
 
     def tearDown(self):
         self.arch.close()

diff --git a/unittests/testaccess_policies.py b/unittests/testaccess_policies.py
@@ -127,7 +127,6 @@ def test_access_policies_create(self):
                     "headers": {
                         "authorization": "Bearer authauthauth",
                     },
-                    "verify": True,
                 },
                 msg="CREATE method called incorrectly",
             )
@@ -159,7 +158,6 @@ def test_access_policies_read(self):
                             "authorization": "Bearer authauthauth",
                         },
                         "params": None,
-                        "verify": True,
                     },
                 ),
                 msg="GET method called incorrectly",
@@ -181,7 +179,6 @@ def test_access_policies_delete(self):
                         "headers": {
                             "authorization": "Bearer authauthauth",
                         },
-                        "verify": True,
                     },
                 ),
                 msg="DELETE method called incorrectly",
@@ -211,7 +208,6 @@ def test_access_policies_update(self):
                     "headers": {
                         "authorization": "Bearer authauthauth",
                     },
-                    "verify": True,
                 },
                 msg="PATCH method kwargs called incorrectly",
             )
@@ -249,7 +245,6 @@ def test_access_policies_count(self):
                             HEADERS_REQUEST_TOTAL_COUNT: "true",
                         },
                         "params": {"page_size": 1},
-                        "verify": True,
                     },
                 ),
                 msg="GET method called incorrectly",
@@ -289,7 +284,6 @@ def test_access_policies_count_by_name(self):
                             "page_size": 1,
                             "display_name": "Policy display name",
                         },
-                        "verify": True,
                     },
                 ),
                 msg="GET method called incorrectly",
@@ -330,7 +324,6 @@ def test_access_policies_list(self):
                                 "authorization": "Bearer authauthauth",
                             },
                             "params": None,
-                            "verify": True,
                         },
                     ),
                     msg="GET method called incorrectly",
@@ -375,7 +368,6 @@ def test_access_policies_list_by_name(self):
                                 "authorization": "Bearer authauthauth",
                             },
                             "params": {"display_name": "Policy display name"},
-                            "verify": True,
                         },
                     ),
                     msg="GET method called incorrectly",
@@ -421,7 +413,6 @@ def test_access_policies_list_matching_access_policies(self):
                                 "authorization": "Bearer authauthauth",
                             },
                             "params": None,
-                            "verify": True,
                         },
                     ),
                     msg="GET method called incorrectly",
@@ -464,7 +455,6 @@ def test_access_policies_list_matching_assets(self):
                                 "authorization": "Bearer authauthauth",
                             },
                             "params": None,
-                            "verify": True,
                         },
                     ),
                     msg="GET method called incorrectly",

diff --git a/unittests/testappidp.py b/unittests/testappidp.py
@@ -79,7 +79,6 @@ def test_appidp_token_create(self):
                 kwargs,
                 {
                     "data": REQUEST,
-                    "verify": True,
                 },
                 msg="CREATE method kwargs called incorrectly",
             )

diff --git a/unittests/testapplications.py b/unittests/testapplications.py
@@ -95,7 +95,6 @@ def test_applications_create(self):
                     "headers": {
                         "authorization": "Bearer authauthauth",
                     },
-                    "verify": True,
                 },
                 msg="CREATE method kwargs called incorrectly",
             )
@@ -122,7 +121,6 @@ def test_applications_read(self):
                             "authorization": "Bearer authauthauth",
                         },
                         "params": None,
-                        "verify": True,
                     },
                 ),
                 msg="GET method called incorrectly",
@@ -144,7 +142,6 @@ def test_applications_delete(self):
                         "headers": {
                             "authorization": "Bearer authauthauth",
                         },
-                        "verify": True,
                     },
                 ),
                 msg="DELETE method called incorrectly",
@@ -170,7 +167,6 @@ def test_applications_update(self):
                         "headers": {
                             "authorization": "Bearer authauthauth",
                         },
-                        "verify": True,
                     },
                 ),
                 msg="PATCH method called incorrectly",
@@ -220,7 +216,6 @@ def test_applications_list(self):
                                 "authorization": "Bearer authauthauth",
                             },
                             "params": {},
-                            "verify": True,
                         },
                     ),
                     msg="GET method called incorrectly",
@@ -267,7 +262,6 @@ def test_applications_list_by_name(self):
                             "params": {
                                 "display_name": "Application display name",
                             },
-                            "verify": True,
                         },
                     ),
                     msg="GET method called incorrectly",
@@ -295,7 +289,6 @@ def test_applications_regenerate(self):
                             "authorization": "Bearer authauthauth",
                         },
                         "json": None,
-                        "verify": True,
                     },
                 ),
                 msg="POST method called incorrectly",

diff --git a/unittests/testarchivist.py b/unittests/testarchivist.py
@@ -269,7 +269,6 @@ def test_patch(self):
                     "headers": {
                         "authorization": "Bearer authauthauth",
                     },
-                    "verify": True,
                 },
                 msg="POST method kwargs called incorrectly",
             )
@@ -312,7 +311,6 @@ def test_patch_with_headers(self):
                         "authorization": "Bearer authauthauth",
                         "headerfield1": "headervalue1",
                     },
-                    "verify": True,
                 },
                 msg="PATCH method kwargs called incorrectly",
             )
@@ -389,7 +387,6 @@ def test_patch_with_429_retry_and_success(self):
                     "headers": {
                         "authorization": "Bearer authauthauth",
                     },
-                    "verify": True,
                 },
                 msg="PATCH method kwargs called incorrectly",
             )

diff --git a/unittests/testarchivistdelete.py b/unittests/testarchivistdelete.py
@@ -50,7 +50,6 @@ def test_delete(self):
                         "headers": {
                             "authorization": "Bearer authauthauth",
                         },
-                        "verify": True,
                     },
                 ),
                 msg="DELETE method called incorrectly",
@@ -84,7 +83,6 @@ def test_delete_with_headers(self):
                             "authorization": "Bearer authauthauth",
                             "headerfield1": "headervalue1",
                         },
-                        "verify": True,
                     },
                 ),
                 msg="DELETE method called incorrectly",
@@ -147,7 +145,6 @@ def test_delete_with_429_retry_and_success(self):
                         "headers": {
                             "authorization": "Bearer authauthauth",
                         },
-                        "verify": True,
                     },
                 ),
                 msg="DELETE method called incorrectly",
-Original file line number
+Diff line change
@@ Expand Up / @@ -79,7 +79,6 @@ def test_appidp_token_create(self): @@
                     kwargs,
                     {
                         "data": REQUEST,
-                        "verify": True,
                     },
                     msg="CREATE method kwargs called incorrectly",
                 )
@@ Expand Down @@