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

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

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

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

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

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.1}/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.1",
     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.1}/t_bug_catcher/__init__.py

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

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

@@ -13,6 +13,7 @@ class Config:
         MAX_ISSUE_ATTACHMENTS: int = 100
         MAX_DESCRIPTION_LENGTH: int = 250
         SUMMARY_LENGTH: int = 120
+        STACK_SCOPE: int = 3
 
     SUPPORT_BOARD = "AB"
 

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.1}/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.1/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.1}/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
 
 
 class StackSaver:
@@ -68,11 +48,15 @@ class StackSaver:
         run_args = {}
         if frame_info["locals"]:
             for key, value in frame_info["locals"].items():
+                if str(key).lower() == "credentials":
+                    continue
                 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 str(key).lower() == "credentials":
+                continue
             if isinstance(value, dict):
                 run_args[str(key)] = value
             else:
@@ -122,19 +106,30 @@ 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)]
+        unique_secrets = []
+        seen = set()
+        for secret in secrets:
+            item = (secret.key, secret.value, secret.line)
+            if item not in seen:
+                seen.add(item)
+                unique_secrets.append(secret)
 
         for index, line in enumerate(filedata):
-            if not secrets:
+            if not unique_secrets:
                 break
 
-            for secret in secrets:
+            for secret in unique_secrets:
                 if secret.key in line and secret.value in line:
                     filedata[index] = line.replace(secret.value, secret.value[:1] + "***")
-                    secrets.pop(secrets.index(secret))
+                    unique_secrets.pop(unique_secrets.index(secret))
                     break
 
-        if secrets:
+        if unique_secrets:
             logger.warning("Failed to mask credentials")
             os.remove(file_path)
             raise Exception("Failed to mask credentials")
@@ -162,7 +157,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 +171,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.1/t_bug_catcher/utils/common.py

@@ -0,0 +1,41 @@
+import traceback
+from datetime import date, datetime
+from json import JSONEncoder
+from pathlib import Path
+from types import TracebackType
+from typing import List
+
+
+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.
+        """
+        if hasattr(o, "__dict__"):
+            return o.__dict__
+        if isinstance(o, (datetime, date)):
+            return o.isoformat()
+        if isinstance(o, Path):
+            return str(o)
+        return JSONEncoder.default(self, 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()
+    ]

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.1}/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.1
 Summary: Bug catcher
 Home-page: https://www.thoughtful.ai/
 Author: Thoughtful

{t_bug_catcher-0.4.0 → t_bug_catcher-0.4.1}/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()
-    ]