insightconnect-plugin-runtime 6.2.1__py3-none-any.whl → 6.2.2__py3-none-any.whl

insightconnect_plugin_runtime/helper.py

@@ -10,7 +10,7 @@ import subprocess
 import time
 from datetime import datetime, timedelta
 from io import IOBase
-from typing import Any, Callable, Dict, List, Union, Tuple
+from typing import Any, Callable, Dict, List, Union, Tuple, Optional
 from urllib import request
 from hashlib import sha1
 from json import JSONDecodeError
@@ -33,17 +33,45 @@ DEFAULTS_HOURS_AGO = 24
 logger = logging.getLogger()
 
 
-def hash_sha1(log: Dict) -> str:
+def hash_sha1(log: Dict[str, Any], keys: Optional[List[str]] = None) -> str:
     """
     Iterate through a dictionary and hash each value.
+    Optionally only hash certain keys in the dictionary.
+
     :param log: Dictionary to be hashed.
-    :type Dict:
+    :param keys: Optional list of keys to hash on if provided
+
     :return: Hex digest of hash.
-    :rtype: str
     """
+
     hash_ = sha1()  # nosec B303
-    for key, value in log.items():
+
+    # Leaving no room for developer error and ensuring they know exactly where it went wrong
+    # if they provide a key not in list format
+    if keys is not None and not isinstance(keys, list):
+        raise TypeError(
+            f"The 'keys' parameter must be a list or None in the 'hash_sha1' function, not {type(keys).__name__}"
+        )
+
+    # Hash all key-value pairs if no keys provided
+    if keys is None:
+        items_to_hash = log.items()
+
+    # Otherwise, only include specified keys
+    else:
+        items_to_hash = []
+        for key in keys:
+            if key in log:
+                items_to_hash.append((key, log[key]))
+
+            # Alert if the key is not found in the log
+            else:
+                raise KeyError(f"Key '{key}' not found in the provided log.")
+
+    # Iterate through items to hash and hash
+    for key, value in items_to_hash:
         hash_.update(f"{key}{value}".encode(ENCODE_TYPE))
+
     return hash_.hexdigest()
 
 
@@ -137,7 +165,12 @@ def make_request(
             raise PluginException(
                 preset=PluginException.Preset.UNKNOWN, data=str(exception)
             )
-    response_handler(response, exception_custom_configs, exception_data_location, allowed_status_codes)
+    response_handler(
+        response,
+        exception_custom_configs,
+        exception_data_location,
+        allowed_status_codes,
+    )
     return response
 
 
@@ -192,7 +225,7 @@ def request_error_handling(
                         exception.response,
                         data_location=exception_data_location,
                         custom_configs=custom_configs,
-                        allowed_status_codes=allowed_status_codes
+                        allowed_status_codes=allowed_status_codes,
                     )
                 else:
                     raise PluginException(
@@ -443,15 +476,19 @@ def convert_dict_to_snake_case(
 
     if isinstance(input_dict, list):
         return [
-            convert_dict_to_snake_case(element)
-            if isinstance(element, (dict, list))
-            else element
+            (
+                convert_dict_to_snake_case(element)
+                if isinstance(element, (dict, list))
+                else element
+            )
             for element in input_dict
         ]
     return {
-        convert_to_snake_case(key): convert_dict_to_snake_case(value)
-        if isinstance(value, (dict, list))
-        else value
+        convert_to_snake_case(key): (
+            convert_dict_to_snake_case(value)
+            if isinstance(value, (dict, list))
+            else value
+        )
         for key, value in input_dict.items()
     }
 
@@ -665,7 +702,7 @@ def open_cachefile(cache_file, append=False):
             logger.info("OpenCacheFile: %s created", cache_file)
             f = open(cache_file, "a+" if append else "r+")
         return f
-    logging.error("OpenCacheFile: %s directory or does not exist", cache_dir)
+    logger.error("OpenCacheFile: %s directory or does not exist", cache_dir)
 
 
 def remove_cachefile(cache_file):
@@ -748,11 +785,11 @@ def open_url(url, timeout=None, verify=True, **kwargs):
             urlobj = request.urlopen(req, timeout=timeout, context=ctx)
         return urlobj
     except request.HTTPError as e:
-        logging.error("HTTPError: %s for %s", str(e.code), url)
+        logger.error("HTTPError: %s for %s", str(e.code), url)
         if e.code == 304:
             return None
     except request.URLError as e:
-        logging.error("URLError: %s for %s", str(e.reason), url)
+        logger.error("URLError: %s for %s", str(e.reason), url)
     raise Exception("GetURL Failed")
 
 
@@ -780,17 +817,17 @@ def check_url(url):
             return True
 
     except requests.exceptions.HTTPError:
-        logging.error(
+        logger.error(
             "Requests: HTTPError: status code %s for %s",
             str(resp.status_code) if resp else None,
             url,
         )
     except requests.exceptions.Timeout:
-        logging.error("Requests: Timeout for %s", url)
+        logger.error("Requests: Timeout for %s", url)
     except requests.exceptions.TooManyRedirects:
-        logging.error("Requests: TooManyRedirects for %s", url)
+        logger.error("Requests: TooManyRedirects for %s", url)
     except requests.ConnectionError:
-        logging.error("Requests: ConnectionError for %s", url)
+        logger.error("Requests: ConnectionError for %s", url)
     return False
 
 
@@ -810,7 +847,7 @@ def exec_command(command):
         rcode = p.poll()
         return {"stdout": stdout, "stderr": stderr, "rcode": rcode}
     except OSError as e:
-        logging.error(
+        logger.error(
             "SubprocessError: %s %s: %s", str(e.filename), str(e.strerror), str(e.errno)
         )
     raise Exception("ExecCommand")
@@ -836,7 +873,7 @@ def encode_file(file_path):
             return efile
         return None
     except (IOError, OSError) as e:
-        logging.error("EncodeFile: Failed to open file: %s", e.strerror)
+        logger.error("EncodeFile: Failed to open file: %s", e.strerror)
         raise Exception("EncodeFile")
     finally:
         if isinstance(f, IOBase):
@@ -859,17 +896,17 @@ def check_url_modified(url):
         if resp.status_code == 200:
             return True
     except requests.exceptions.HTTPError:
-        logging.error(
+        logger.error(
             "Requests: HTTPError: status code %s for %s",
             str(resp.status_code) if resp else None,
             url,
         )
     except requests.exceptions.Timeout:
-        logging.error("Requests: Timeout for %s", url)
+        logger.error("Requests: Timeout for %s", url)
     except requests.exceptions.TooManyRedirects:
-        logging.error("Requests: TooManyRedirects for %s", url)
+        logger.error("Requests: TooManyRedirects for %s", url)
     except requests.ConnectionError:
-        logging.error("Requests: ConnectionError for %s", url)
+        logger.error("Requests: ConnectionError for %s", url)
     return False
 
 
@@ -895,7 +932,7 @@ def get_url_path_filename(url):
             if name[n].endswith("."):
                 return name
     except IndexError:
-        logging.error("Range: IndexError: URL basename is short: %s of %s", name, url)
+        logger.error("Range: IndexError: URL basename is short: %s of %s", name, url)
         return None
     return None
 
@@ -915,16 +952,16 @@ def get_url_filename(url):
             return name
         return None
     except requests.exceptions.MissingSchema:
-        logging.error("Requests: MissingSchema: Requires ftp|http(s):// for %s", url)
+        logger.error("Requests: MissingSchema: Requires ftp|http(s):// for %s", url)
     except requests.exceptions.HTTPError:
-        logging.error(
+        logger.error(
             "Requests: HTTPError: status code %s for %s",
             str(resp.status_code) if resp else None,
             url,
         )
     except requests.exceptions.Timeout:
-        logging.error("Requests: Timeout for %s", url)
+        logger.error("Requests: Timeout for %s", url)
     except requests.exceptions.TooManyRedirects:
-        logging.error("Requests: TooManyRedirects for %s", url)
+        logger.error("Requests: TooManyRedirects for %s", url)
     except requests.ConnectionError:
-        logging.error("Requests: ConnectionError for %s", url)
+        logger.error("Requests: ConnectionError for %s", url)

{insightconnect_plugin_runtime-6.2.1.dist-info → insightconnect_plugin_runtime-6.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: insightconnect-plugin-runtime
-Version: 6.2.1
+Version: 6.2.2
 Summary: InsightConnect Plugin Runtime
 Home-page: https://github.com/rapid7/komand-plugin-sdk-python
 Author: Rapid7 Integrations Alliance
@@ -211,6 +211,7 @@ contributed. Black is installed as a test dependency and the hook can be initial
 after cloning this repository.
 
 ## Changelog
+* 6.2.2 - Fix instances where logging errors would lead to duplicate entries being output | Add option to hash only on provided keys for `hash_sha1` function
 * 6.2.1 - Fix instances where logging would lead to duplicate entries being output
 * 6.2.0 - Update base images to pull Python 3.11.10 | changed the pep-8 check in tox to `pycodestyle`
 * 6.1.4 - Address vulnerabilities within local development requirements.txt and vulnerabilities in slim image.

{insightconnect_plugin_runtime-6.2.1.dist-info → insightconnect_plugin_runtime-6.2.2.dist-info}/RECORD

@@ -4,7 +4,7 @@ insightconnect_plugin_runtime/cli.py,sha256=Pb-Janu-XfRlSXxPHh30OIquljWptrhhS51C
 insightconnect_plugin_runtime/connection.py,sha256=4bHHV2B0UFGsAtvLu1fiYQRwx7fissUakHPUyjLQO0E,2340
 insightconnect_plugin_runtime/dispatcher.py,sha256=ru7njnyyWE1-oD-VbZJ-Z8tELwvDf69rM7Iezs4rbnw,1774
 insightconnect_plugin_runtime/exceptions.py,sha256=Pvcdkx81o6qC2qU661x-DzNjuIMP82x52nPMSEqEo4s,8491
-insightconnect_plugin_runtime/helper.py,sha256=IY4-ntZbiXWFx7jAQ_n1vBjQBd_tt4Zr4INtXzQmiGg,31564
+insightconnect_plugin_runtime/helper.py,sha256=WiCFu4S33BL8wugBmyFH-06inkcXPmdC5cv0UGlSHfA,32646
 insightconnect_plugin_runtime/metrics.py,sha256=hf_Aoufip_s4k4o8Gtzz90ymZthkaT2e5sXh5B4LcF0,3186
 insightconnect_plugin_runtime/plugin.py,sha256=Yf4LNczykDVc31F9G8uuJ9gxEsgmxmAr0n4pcZzichM,26393
 insightconnect_plugin_runtime/schema.py,sha256=jTNc6KAMqFpaDVWrAYhkVC6e8I63P3X7uVlJkAr1hiY,583
@@ -68,7 +68,7 @@ tests/unit/test_aws_action.py,sha256=pBE23Qn4aXKJqPmwiHMcEU5zPdyvbKO-eK-6jUlrsQw
 tests/unit/test_custom_encoder.py,sha256=KLYyVOTq9MEkZXyhVHqjm5LVSW6uJS4Davgghsw9DGk,2207
 tests/unit/test_endpoints.py,sha256=LuXOfLBu47rDjGa5YEsOwTZBEdvQdl_C6-r46oxWZA8,6401
 tests/unit/test_exceptions.py,sha256=Y4F-ij8WkEJkUU3mPvxlEchqE9NCdxDvR8bJzPVVNao,5328
-tests/unit/test_helpers.py,sha256=_1jlU-h-GNY9MLQ8nV_or4zkTI911AmHKtvFyamKjfU,16297
+tests/unit/test_helpers.py,sha256=9Y5N5cUBtesfr289oOZFekMJb84VYuFjucqQ9VEk3WQ,17431
 tests/unit/test_metrics.py,sha256=PjjTrB9w7uQ2Q5UN-893-SsH3EGJuBseOMHSD1I004s,7979
 tests/unit/test_oauth.py,sha256=nbFG0JH1x04ExXqSe-b5BGdt_hJs7DP17eUa6bQzcYI,2093
 tests/unit/test_plugin.py,sha256=ZTNAZWwZhDIAbxkVuWhnz9FzmojbijgMmsLWM2mXQI0,4160
@@ -78,7 +78,7 @@ tests/unit/test_server_spec.py,sha256=je97BaktgK0Fiz3AwFPkcmHzYtOJJNqJV_Fw5hrvqX
 tests/unit/test_trigger.py,sha256=E53mAUoVyponWu_4IQZ0IC1gQ9lakBnTn_9vKN2IZfg,1692
 tests/unit/test_variables.py,sha256=OUEOqGYZA3Nd5oKk5GVY3hcrWKHpZpxysBJcO_v5gzs,291
 tests/unit/utils.py,sha256=VooVmfpIgxmglNdtmT32AkEDFxHxyRHLK8RsCWjjYRY,2153
-insightconnect_plugin_runtime-6.2.1.dist-info/METADATA,sha256=7VvNCT7PV0qyLXPRcZcp6tUulmRLyEHix_Qf53iwn3M,15117
-insightconnect_plugin_runtime-6.2.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-insightconnect_plugin_runtime-6.2.1.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
-insightconnect_plugin_runtime-6.2.1.dist-info/RECORD,,
+insightconnect_plugin_runtime-6.2.2.dist-info/METADATA,sha256=aQsntlkFksgMSHJvZyCnixCTdVSbzypDrq81UQVzBFU,15275
+insightconnect_plugin_runtime-6.2.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+insightconnect_plugin_runtime-6.2.2.dist-info/top_level.txt,sha256=AJtyJOpiFzHxsbHUICTcUKXyrGQ3tZxhrEHsPjJBvEA,36
+insightconnect_plugin_runtime-6.2.2.dist-info/RECORD,,

tests/unit/test_helpers.py

@@ -510,20 +510,46 @@ class TestRequestsHelpers(TestCase):
         )
 
 
-def test_hash_sha1():
-    log = {"example": "value", "sample": "value"}
-    assert "2e1ccc1a95e9b2044f13546c25fe380bbd039293" == helper.hash_sha1(log)
-
-
-def test_compare_and_dedupe_hashes():
-    hashes = ["2e1ccc1a95e9b2044f13546c25fe380bbd039293"]
-    logs = [
-        {
-            "example": "value",
-            "sample": "value",
-        },
-        {"specimen": "new_value"},
-    ]
-    assert [{"specimen": "new_value"}], [
-        "ad6ae80c0356e02b1561cb58408ee678eb1070bb"
-    ] == helper.compare_and_dedupe_hashes(hashes, logs)
+class TestHashing(TestCase):
+    def setUp(self) -> None:
+        self.log = {"example": "value", "sample": "value"}
+
+    def test_hash_sha1_no_keys(self):
+        # Test hash with no keys provided
+        expected_hash = "2e1ccc1a95e9b2044f13546c25fe380bbd039293"
+        self.assertEqual(helper.hash_sha1(self.log), expected_hash)
+
+    def test_hash_sha1_keys(self):
+        # Test hash with valid key provided
+        expected_hash = "61c908e52d66a763ceed0798b8e5f4b7f0328a21"
+        self.assertEqual(helper.hash_sha1(self.log, keys=["example"]), expected_hash)
+
+    def test_hash_sha1_keys_wrong_type(self):
+        # Test hash with wrong type for keys
+        with self.assertRaises(TypeError) as context:
+            helper.hash_sha1(self.log, keys="test")
+
+        self.assertEqual(
+            str(context.exception),
+            "The 'keys' parameter must be a list or None in the 'hash_sha1' function, not str"
+        )
+
+    def test_hash_sha1_keys_not_found(self):
+        # Test hash with key not found
+        with self.assertRaises(KeyError) as context:
+            helper.hash_sha1(self.log, keys=["example", "test"])
+
+        self.assertEqual(str(context.exception), "\"Key 'test' not found in the provided log.\"")
+
+    def test_compare_and_dedupe_hashes(self):
+        hashes = ["2e1ccc1a95e9b2044f13546c25fe380bbd039293"]
+        logs = [
+            {
+                "example": "value",
+                "sample": "value",
+            },
+            {"specimen": "new_value"},
+        ]
+        assert [{"specimen": "new_value"}], [
+            "ad6ae80c0356e02b1561cb58408ee678eb1070bb"
+        ] == helper.compare_and_dedupe_hashes(hashes, logs)