review comments

MAAP-Project · Sep 4, 2024 · b001b4e · b001b4e
1 parent b5d833d
commit b001b4e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 13 deletions.
diff --git a/maap/Secrets.py b/maap/Secrets.py
@@ -21,21 +21,20 @@ def get_secrets(self):
         Returns a list of secrets for a given user.
 
         Returns:
-            list: Secret names for a given user.
+            list: Returns a list of dicts containing secret names e.g. [{'secret_name': 'secret1'}, {'secret_name': 'secret2'}].
         """
         try:
             response = requests.get(
                 url = self._members_endpoint,
                 headers=self._api_header
             )
-            logger.debug(response.text)
+            logger.debug(f"Response from get_secrets request: {response.text}")
             return json.loads(response.text)
-
         except Exception as e:
             raise(f"Error retrieving secrets: {e}")
 
 
-    def get_secret(self, secret_name=None):
+    def get_secret(self, secret_name):
         """
         Returns secret value for provided secret name.
 
@@ -49,21 +48,21 @@ def get_secret(self, secret_name=None):
             ValueError: If secret name is not provided.
         """
         if secret_name is None:
-            raise ValueError("Failed to get secret value. Please provide secret name.")
+            raise ValueError("Secret name parameter cannot be None.")
 
         try:
             response = requests.get(
                 url = f"{self._members_endpoint}/{secret_name}",
                 headers=self._api_header
             )
 
+            # Return secret value directly for user ease-of-use
             if response.ok:
                 response = response.json()
                 return response["secret_value"]
 
-            logger.debug(response.text)
+            logger.debug(f"Response from get_secret request: {response.text}")
             return json.loads(response.text)
-
         except Exception as e:
             raise(f"Error retrieving secret: {e}")
 
@@ -92,9 +91,8 @@ def add_secret(self, secret_name=None, secret_value=None):
                 data=json.dumps({"secret_name": secret_name, "secret_value": secret_value})
             )
 
-            logger.debug(response.text)
+            logger.debug(f"Response from add_secret: {response.text}")
             return json.loads(response.text)
-
         except Exception as e:
             raise(f"Error adding secret: {e}")
 
@@ -121,9 +119,8 @@ def delete_secret(self, secret_name=None):
                 headers=self._api_header
             )
 
-            logger.debug(response.text)
+            logger.debug(f"Response from delete_secret: {response.text}")
             return json.loads(response.text)
-
         except Exception as e:
             raise(f"Error deleting secret: {e}")
 

diff --git a/test/functional_test.py b/test/functional_test.py
@@ -121,10 +121,11 @@ def get_secrets(maap: MAAP):
     assert resp is not None
 
 @log_decorator
-def get_secret(maap: MAAP, secret_name=None):
+def get_secret(maap: MAAP, secret_name=None, secret_value=None):
     resp = maap.secrets.get_secret(secret_name)
     print(resp)
     assert resp is not None
+    assert resp == secret_value
 
 @log_decorator
 def delete_secret(maap: MAAP, secret_name=None):
@@ -148,7 +149,7 @@ def main():
     secret_value = "test_value"
     get_secrets(maap)
     add_secret(maap, secret_name, secret_value)
-    get_secret(maap, secret_name)
+    get_secret(maap, secret_name, secret_value)
     delete_secret(maap, secret_name)
 
     # submit_job(maap, wait_for_completion=True)