t-bug-catcher 0.4.0__tar.gz → 0.4.2__tar.gz

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.4.0
+Version: 0.4.2
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.0
+current_version = 0.4.2
 commit = True
 tag = False
 

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/setup.py

@@ -26,7 +26,9 @@ setup(
     packages=find_packages(include=["t_bug_catcher", "t_bug_catcher.*"]),
     test_suite="tests",
     url="https://www.thoughtful.ai/",
-    version="0.4.0",
+    version="0.4.2",
     zip_safe=False,
     install_requires=install_requirements,
+    include_package_data=True,
+    package_data={"": ["resources/*.yml"]},
 )

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/t_bug_catcher/__init__.py

@@ -3,7 +3,7 @@
 __author__ = """Thoughtful"""
 __email__ = "support@thoughtful.ai"
 # fmt: off
-__version__ = '0.4.0'
+__version__ = '0.4.2'
 # fmt: on
 
 from .bug_catcher import (

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/t_bug_catcher/config.py

@@ -13,9 +13,12 @@ class Config:
         MAX_ISSUE_ATTACHMENTS: int = 100
         MAX_DESCRIPTION_LENGTH: int = 250
         SUMMARY_LENGTH: int = 120
+        STACK_SCOPE: int = 3
 
     SUPPORT_BOARD = "AB"
 
+    KEYS_TO_REMOVE = ["credential", "password"]
+
     RC_RUN_LINK = (
         f"https://cloud.robocorp.com/organizations/{os.environ.get('RC_ORGANIZATION_ID')}"
         f"/workspaces/{os.environ.get('RC_WORKSPACE_ID')}/processes"

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/t_bug_catcher/jira.py

@@ -1,12 +1,12 @@
 """JiraPoster class for interacting with the Jira API."""
 
-import datetime
 import hashlib
 import json
 import os
 import re
 import sys
 import traceback
+from datetime import datetime
 from importlib.metadata import version
 from pathlib import Path
 from types import TracebackType
@@ -19,7 +19,7 @@ from retry import retry
 from .config import CONFIG
 from .exceptions import BadRequestError
 from .utils import logger
-from .utils.common import get_frames
+from .utils.common import Encoder, get_frames
 from .workitems import variables
 
 
@@ -389,7 +389,7 @@ class Jira:
                     },
                     {
                         "type": "text",
-                        "text": str(datetime.datetime.now().strftime("%B %d, %Y %I:%M:%S %p")),
+                        "text": str(datetime.now().strftime("%B %d, %Y %I:%M:%S %p")),
                     },
                 ],
             }
@@ -521,7 +521,7 @@ class Jira:
                         "content": [
                             {
                                 "type": "text",
-                                "text": json.dumps(metadata, indent=4),
+                                "text": json.dumps(metadata, indent=4, cls=Encoder),
                             }
                         ],
                     },
@@ -735,7 +735,7 @@ class Jira:
         date_markup = [
             {
                 "type": "text",
-                "text": f" at {str(datetime.datetime.now().strftime('%B %d, %Y %I:%M:%S %p'))}",
+                "text": f" at {str(datetime.now().strftime('%B %d, %Y %I:%M:%S %p'))}",
             },
             {"type": "hardBreak"},
         ]

t_bug_catcher-0.4.2/t_bug_catcher/resources/whispers_config.yml

@@ -0,0 +1,44 @@
+include:
+  files:
+    - "**/*"
+  rules:
+    - password
+    - uri
+    - secret
+    - webhook
+    - apikey
+    - apikey-known
+    - apikey-maybe
+    - id: username
+      group: misc
+      description: Variable names refering to user
+      message: Secret
+      severity: Low
+      key:
+        regex: ^\S*(user(name?)|login|id|uid|otp)_?(hash)?[0-9]*$
+        ignorecase: True
+      value:
+        minlen: 1
+  severity:
+    - Critical
+    - High
+    - Medium
+
+exclude:
+  files:
+    - __pycache__|\.eggs|build|dev|\.vscode|\.git
+    - .*/(locale|spec|test|mock)s?/
+    - integration|node_modules
+    - (package(-lock)?|npm-shrinkwrap)\.json
+
+  keys:
+    - .*(public|project).*
+
+  values:
+    - ^(true|false|yes|no|1|0)$
+    - .*_(user|password|token|key|placeholder|name)$
+    - ^aws_(access_key_id|secret_access_key|session_token)$
+    - ^((cn?trl|alt|shift|del|ins|esc|tab|f[\d]+) ?[\+_\-\\/] ?)+[\w]+$
+
+
+

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/t_bug_catcher/stack_saver.py

@@ -4,35 +4,15 @@ import os
 import re
 import sys
 from datetime import datetime
-from json import JSONEncoder
 from pathlib import Path
 from types import FunctionType, ModuleType
 from typing import Optional
 
 import whispers
 
+from .config import CONFIG
 from .utils import logger
-
-
-class _Encoder(JSONEncoder):
-    """Encoder class for encoding the Episode object to json."""
-
-    def default(self, o):
-        """This method is used to encode the Episode object to json.
-
-        Args:
-            o (object): The object to be encoded.
-
-        Returns:
-            str: The json string.
-        """
-        if hasattr(o, "__dict__"):
-            return o.__dict__
-        if isinstance(o, datetime):
-            return o.isoformat()
-        if isinstance(o, Path):
-            return str(o)
-        return JSONEncoder.default(self, o)
+from .utils.common import Encoder, convert_keys_to_primitives
 
 
 class StackSaver:
@@ -54,8 +34,7 @@ class StackSaver:
         """
         return path.replace(os.getcwd(), "").strip(os.sep)
 
-    @staticmethod
-    def serialize_frame_info(frame_info: dict) -> dict:
+    def serialize_frame_info(self, frame_info: dict) -> dict:
         """A static method to serialize the frame info.
 
         Args:
@@ -64,19 +43,8 @@ class StackSaver:
         Returns:
             dict: The serialized frame info.
         """
-        run_locals = {}
-        run_args = {}
-        if frame_info["locals"]:
-            for key, value in frame_info["locals"].items():
-                if isinstance(value, dict):
-                    run_locals[str(key)] = value
-                else:
-                    run_locals[str(key)] = str(value)
-        for key, value in frame_info["args"].items():
-            if isinstance(value, dict):
-                run_args[str(key)] = value
-            else:
-                run_args[str(key)] = str(value)
+        run_locals = convert_keys_to_primitives(frame_info["locals"]) if frame_info["locals"] else {}
+        run_args = convert_keys_to_primitives(frame_info["args"]) if frame_info["args"] else {}
         serializable_frame_info = {
             "filename": frame_info["filename"],
             "function_name": frame_info["function_name"],
@@ -104,7 +72,7 @@ class StackSaver:
                     continue
                 if isinstance(var, (ModuleType, FunctionType)):
                     continue
-                local_variables[var_name] = var
+                local_variables[str(var_name)] = var
             return local_variables
 
     def mask_credentials(self, file_path: str) -> None:
@@ -122,7 +90,11 @@ class StackSaver:
         with open(file_path, "r") as f:
             filedata = f.readlines()
 
-        secrets = [secret for secret in whispers.secrets(file_path)]
+        config_path = Path(__file__).parent.resolve().as_posix() + "/resources/whispers_config.yml"
+
+        args = f"-c {config_path} {file_path}"
+
+        secrets = [secret for secret in whispers.secrets(args)]
 
         for index, line in enumerate(filedata):
             if not secrets:
@@ -162,7 +134,7 @@ class StackSaver:
                     continue
                 frames.append(frame)
                 tb = tb.tb_next
-            frames = frames[:3]
+            frames = frames[-CONFIG.LIMITS.STACK_SCOPE :]
 
             for frame in frames:
                 frame_info = {
@@ -176,7 +148,7 @@ class StackSaver:
             file_path = f"stack_details_{datetime.now().strftime('%Y%m%d%H%M%S')}.json"
 
             with open(file_path, "w") as f:
-                json.dump(stack_details_json, f, indent=4, cls=_Encoder)
+                json.dump(stack_details_json, f, indent=4, cls=Encoder)
 
             self.mask_credentials(file_path)
 

t_bug_catcher-0.4.2/t_bug_catcher/utils/common.py

@@ -0,0 +1,69 @@
+import traceback
+from datetime import date, datetime
+from json import JSONEncoder
+from pathlib import Path
+from types import TracebackType
+from typing import List
+
+from ..config import CONFIG
+
+
+class Encoder(JSONEncoder):
+    """This class is used to encode the Episode object to json."""
+
+    def default(self, o):
+        """This method is used to encode the Episode object to json.
+
+        Args:
+            o (object): The object to be encoded.
+
+        Returns:
+            str: The json string.
+        """
+        try:
+            if hasattr(o, "__dict__"):
+                keys_to_remove = [
+                    key for key in o.__dict__.keys() if any(s in str(key).lower() for s in CONFIG.KEYS_TO_REMOVE)
+                ]
+                for key in keys_to_remove:
+                    del o.__dict__[key]
+                return {str(key): str(value) for key, value in o.__dict__.items()}
+            if isinstance(o, (datetime, date)):
+                return o.isoformat()
+            if isinstance(o, Path):
+                return str(o)
+            return super().default(self, o)
+        except TypeError:
+            return str(o)
+
+
+def get_frames(exc_traceback: TracebackType) -> List:
+    """Get the frames of the exception.
+
+    Args:
+        exc_traceback (TracebackType): The traceback of the exception.
+
+    Returns:
+        List: The frames of the exception.
+    """
+    return [
+        frame for frame in traceback.extract_tb(exc_traceback) if "site-packages" not in str(frame.filename).lower()
+    ]
+
+
+def convert_keys_to_primitives(data: dict) -> dict:
+    """A function that recursively converts keys in a nested dictionary to primitives.
+
+    Args:
+        data (dict): The input dictionary to convert keys.
+
+    Returns:
+        dict: A new dictionary with keys converted to strings.
+    """
+    new_dict = {}
+    for key, value in data.items():
+        if isinstance(value, dict):
+            new_dict[str(key)] = convert_keys_to_primitives(value)
+        else:
+            new_dict[str(key)] = value
+    return new_dict

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/t_bug_catcher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: t_bug_catcher
-Version: 0.4.0
+Version: 0.4.2
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.2}/t_bug_catcher.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ t_bug_catcher.egg-info/dependency_links.txt
 t_bug_catcher.egg-info/not-zip-safe
 t_bug_catcher.egg-info/requires.txt
 t_bug_catcher.egg-info/top_level.txt
+t_bug_catcher/resources/whispers_config.yml
 t_bug_catcher/utils/__init__.py
 t_bug_catcher/utils/common.py
 t_bug_catcher/utils/logger.py

t_bug_catcher-0.4.0/t_bug_catcher/utils/common.py

@@ -1,17 +0,0 @@
-import traceback
-from types import TracebackType
-from typing import List
-
-
-def get_frames(exc_traceback: TracebackType) -> List:
-    """Get the frames of the exception.
-
-    Args:
-        exc_traceback (TracebackType): The traceback of the exception.
-
-    Returns:
-        List: The frames of the exception.
-    """
-    return [
-        frame for frame in traceback.extract_tb(exc_traceback) if "site-packages" not in str(frame.filename).lower()
-    ]