suite-py 1.47.0__py3-none-any.whl → 1.47.2__py3-none-any.whl

suite_py/__version__.py

@@ -1,2 +1,2 @@
 # -*- encoding: utf-8 -*-
-__version__ = "1.47.0"
+__version__ = "1.47.2"

suite_py/lib/handler/pre_commit_handler.py

@@ -16,18 +16,20 @@ class PreCommit:
         self._git = GitHandler(project, config)
 
     def check_and_warn(self):
-        if self.is_enabled() and not self.is_pre_commit_hooks_installed():
-            self.warn_missing_pre_commit_hook()
+        if self._is_enabled() and not self._is_pre_commit_hooks_installed():
+            self._warn_missing_pre_commit_hook()
 
-    def is_pre_commit_hooks_installed(self):
+    def _is_enabled(self):
+        return self._git.get_git_config("suite-py.disable-pre-commit-warning") != "true"
+
+    def _is_pre_commit_hooks_installed(self):
         """
-        Apply some heuteristics to check whether the gitleaks pre-commit hook is installed.
+        Apply some heuristics to check whether the gitleaks pre-commit hook is installed.
         This is extremely imperfect, and only supports direct calls in shell scripts.
-        More hooks, like husky should be added later
         """
-        return self.is_vanilla_hook_setup() or self.is_pre_commit_py_hook_setup()
+        return self._is_shell_script_hook_setup() or self._is_pre_commit_py_hook_setup()
 
-    def warn_missing_pre_commit_hook(self):
+    def _warn_missing_pre_commit_hook(self):
         logger.warning(
             """
 Looks like the current repo is missing the gitleaks pre-commit hook!
@@ -42,28 +44,25 @@ to disable it globally
         """
         )
 
-    def is_vanilla_hook_setup(self):
-        """
-        Check whether the gitleaks hook is setup as a regular bash script
+    def _is_shell_script_hook_setup(self):
         """
-        pre_commit_file = self.read_pre_commit_hook()
+        Check whether the gitleaks hook is setup as a regular bash script:
 
-        # Assume everything is a shell script.
-        # Technically you could use a binary, or even python code,
-        # But those are out of scope for us, and the user should just disable the warning themselves
-        lines = pre_commit_file.splitlines()
-
-        # Filter out lines that start with '#' since those are probably just comments.
-        without_comments = filter(lambda l: not l.strip().startswith("#"), lines)
+        * is there a `.git/hooks/pre-commit` shell script that contains keyword "gitleaks"
+        * is there a `.husky/pre-commit` shell script that contains keyword "security-hooks" (primait/security-hooks repo)
+        """
+        path = os.path.join(self._git.hooks_path(), "pre-commit")
+        keywords = ["gitleaks", "security-hooks"]
 
-        return any("gitleaks" in line for line in without_comments)
+        return any(self._script_contains_keyword(path, keyword) for keyword in keywords)
 
-    def is_pre_commit_py_hook_setup(self):
+    def _is_pre_commit_py_hook_setup(self):
         """
         Check whether the gitleaks hook is setup with the pre-commit python framework
         """
-        # If the framework is not setup skip
-        if "pre-commit" not in self.read_pre_commit_hook():
+        # is there a `.git/hooks/pre-commit` shell script that contains keyword "pre-commit"
+        pre_commit_file_path = os.path.join(self._git.hooks_path(), "pre-commit")
+        if not self._script_contains_keyword(pre_commit_file_path, "pre-commit"):
             logger.debug("pre-commit.com not installed, skipping config check")
             return False
 
@@ -83,14 +82,21 @@ to disable it globally
             for repo in config.get("repos", [])
         )
 
-    def read_pre_commit_hook(self):
-        pre_commit_file_path = os.path.join(self._git.hooks_path(), "pre-commit")
-        logger.debug("Reading pre-commit script from %s", pre_commit_file_path)
+    def _script_contains_keyword(self, file_path, keyword):
+        """
+        Check if a keyword appears in a shell script, ignoring comment lines
+        (binaries and python code are out of scope for us).
+        """
         try:
-            with open(pre_commit_file_path, encoding="utf-8") as f:
-                return f.read()
+            logger.debug("checking pre-commit script(%s)", file_path)
+            with open(file_path, encoding="utf-8") as f:
+                content = f.read()
         except FileNotFoundError:
-            return ""
+            logger.debug("pre-commit script(%s) not found", file_path)
+            return False
 
-    def is_enabled(self):
-        return self._git.get_git_config("suite-py.disable-pre-commit-warning") != "true"
+        # Filter out comments (lines starting with '#').
+        lines_without_comments = (
+            line for line in content.splitlines() if not line.strip().startswith("#")
+        )
+        return any(keyword in line for line in lines_without_comments)

suite_py/lib/logger.py

@@ -17,7 +17,15 @@ def setup(verbose):
         level=level,
         format=LOG_FORMAT,
         datefmt="[%X]",
-        handlers=[RichHandler(rich_tracebacks=True, markup=False, show_path=False)],
+        handlers=[
+            RichHandler(
+                rich_tracebacks=True,
+                markup=False,
+                show_path=False,
+                show_level=False,
+                show_time=False,
+            )
+        ],
     )
 
     logger = logging.getLogger(LOGGER_NAME)

{suite_py-1.47.0.dist-info → suite_py-1.47.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: suite-py
-Version: 1.47.0
+Version: 1.47.2
 Summary: 
 Author: larrywax, EugenioLaghi, michelangelomo
 Author-email: devops@prima.it

{suite_py-1.47.0.dist-info → suite_py-1.47.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 suite_py/__init__.py,sha256=REmi3D0X2G1ZWnYpKs8Ffm3NIj-Hw6dMuvz2b9NW344,142
-suite_py/__version__.py,sha256=MAUpG5q0Rn7dwAd-YiBXREx3zP4X9kP0bBH9hPHdk74,49
+suite_py/__version__.py,sha256=kvsaCaiN9_S0SML3PK6KymI83Qay7-_HSBXG0J1EN00,49
 suite_py/cli.py,sha256=hBbNXb9vVk8lSJXRrb1GctTp3EUjMYFWS9mn_HaNG9I,11155
 suite_py/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 suite_py/commands/ask_review.py,sha256=yN__Ac-fiZBPShjRDhyCCQZGfVlQE16KozoJk4UtiNw,3788
@@ -27,11 +27,11 @@ suite_py/lib/handler/git_handler.py,sha256=8UVttqo65CTg5LCvOBTDXb_sNxLKUrpevCGio
 suite_py/lib/handler/github_handler.py,sha256=xnBATLOTnOLpiYE29WwUrtDr7hxusfId9a1KbfK1OyA,2952
 suite_py/lib/handler/metrics_handler.py,sha256=-Tp62pFIiYsBkDga0nQG3lWU-gxH68wEjIIIJeU1jHk,3159
 suite_py/lib/handler/okta_handler.py,sha256=UiRcBDmFkMFi9H7Me1QaruC8yPI5fFbnLGzOf3kfxG0,2805
-suite_py/lib/handler/pre_commit_handler.py,sha256=nwqVgC-KnUjn7NVIHZ0VmDdUfp6Q1ieFIth-1_U76Gw,3740
+suite_py/lib/handler/pre_commit_handler.py,sha256=NLqwIkggh0FRoiKFVCMdRIkaafKrfnNXgaDHGlfpQMA,4144
 suite_py/lib/handler/prompt_utils.py,sha256=vgk1O7h-iYEAZv1sXtMh8xIgH1djI398rzxRIgZWZcg,2474
 suite_py/lib/handler/version_handler.py,sha256=DXTx4yCAbFVC6CdMqPJ-LiN5YM-dT2zklG8POyKTP5A,6774
 suite_py/lib/handler/youtrack_handler.py,sha256=_CwzeFhj7kMYb61CN8IYF0IE55Zrj6vZT38SUZLA5B8,10192
-suite_py/lib/logger.py,sha256=aL870R69enNL9K8mQrMFgSAVUPXXgkvaVp6xTprCBWA,1029
+suite_py/lib/logger.py,sha256=SsJ1MpA3Kkt_4VTscfmsnlYZRZdzWwkxfWfVWVgsADI,1181
 suite_py/lib/metrics.py,sha256=urTBVzIc1Ys6OHPOO32fLPPRcQU45tzM3XMJ7mUl5dc,1629
 suite_py/lib/oauth.py,sha256=tE3MgCnYhW6ZIbkyeUohFTOUvnBsrJXfHN8XsAVQNXk,5077
 suite_py/lib/requests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -40,7 +40,7 @@ suite_py/lib/requests/session.py,sha256=P32H3cWnCWunu91WIj2iDM5U3HzaBglg60VN_C9J
 suite_py/lib/symbol.py,sha256=z3QYBuNIwD3qQ3zF-cLOomIr_-C3bO_u5UIDAHMiyTo,60
 suite_py/lib/tokens.py,sha256=4DbsHDFLIxs40t3mRw_ZyhmejZQ0Bht7iAL8dTCTQd4,5458
 suite_py/templates/login.html,sha256=fJLls2SB84oZTSrxTdA5q1PqfvIHcCD4fhVWfyco7Ig,861
-suite_py-1.47.0.dist-info/METADATA,sha256=BQ89I8Mw0ramSkm1bIPTIteQJpi4huQCRWwAuh4L6NU,1250
-suite_py-1.47.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-suite_py-1.47.0.dist-info/entry_points.txt,sha256=dVKLC-9Infy-dHJT_MkK6LcDjOgBCJ8lfPkURJhBjxE,46
-suite_py-1.47.0.dist-info/RECORD,,
+suite_py-1.47.2.dist-info/METADATA,sha256=Im2wlMuvnyUlrS78imSKRRMLFhWQsk7XoH2Ij8thbCI,1250
+suite_py-1.47.2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+suite_py-1.47.2.dist-info/entry_points.txt,sha256=dVKLC-9Infy-dHJT_MkK6LcDjOgBCJ8lfPkURJhBjxE,46
+suite_py-1.47.2.dist-info/RECORD,,