socketsecurity 0.0.89__tar.gz → 0.0.92__tar.gz

{socketsecurity-0.0.89/socketsecurity.egg-info → socketsecurity-0.0.92}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: socketsecurity
-Version: 0.0.89
+Version: 0.0.92
 Summary: Socket Security CLI for CI/CD
 Author-email: Douglas Coburn <douglas@socket.dev>
 Maintainer-email: Douglas Coburn <douglas@socket.dev>

{socketsecurity-0.0.89 → socketsecurity-0.0.92}/socketsecurity/__init__.py

@@ -1,2 +1,2 @@
 __author__ = 'socket.dev'
-__version__ = '0.0.89'
+__version__ = '0.0.92'

{socketsecurity-0.0.89 → socketsecurity-0.0.92}/socketsecurity/core/__init__.py

@@ -28,7 +28,8 @@ import time
 __all__ = [
     "Core",
     "log",
-    "__version__"
+    "__version__",
+    "do_request"
 ]
 
 
@@ -128,8 +129,10 @@ def do_request(
     else:
         msg = {
             "status_code": response.status_code,
+            "UnexpectedError": "There was an unexpected error using the API",
             "error": response.text,
-            "UnexpectedError": "There was an unexpected error using the API"
+            "payload": payload,
+            "url": url
         }
         raise APIFailure(msg)
 

{socketsecurity-0.0.89 → socketsecurity-0.0.92}/socketsecurity/core/github.py

@@ -1,8 +1,7 @@
 import json
 import os
-from socketsecurity.core import log
+from socketsecurity.core import log, do_request
 import requests
-from socketsecurity.core.exceptions import *
 from socketsecurity.core.classes import Comment
 from socketsecurity.core.scm_comments import Comments
 import sys
@@ -54,59 +53,12 @@ for env in github_variables:
         else:
             is_default_branch = True
 
-
-def do_request(
-        path: str,
-        headers: dict = None,
-        payload: [dict, str] = None,
-        files: list = None,
-        method: str = "GET",
-) -> dict:
-    """
-    do_requests is the shared function for making HTTP calls
-
-    :param path: Required path for the request
-    :param headers: Optional dictionary of headers. If not set will use a default set
-    :param payload: Optional dictionary or string of the payload to pass
-    :param files: Optional list of files to upload
-    :param method: Optional method to use, defaults to GET
-    :return:
-    """
-    if gh_api_token is None or gh_api_token == "":
-        raise APIKeyMissing
-
-    if headers is None:
-        headers = {
-            'Authorization': f"Bearer {gh_api_token}",
-            'User-Agent': 'SocketPythonScript/0.0.1',
-            "accept": "application/json"
-        }
-    url = f"{github_api_url}/{path}"
-    response = requests.request(
-        method.upper(),
-        url,
-        headers=headers,
-        data=payload,
-        files=files
-    )
-    if response.status_code <= 399:
-        try:
-            return response.json()
-        except Exception as error:
-            response = {
-                "error": error,
-                "response": response.text,
-                "payload": payload
-            }
-            return response
-    else:
-        msg = {
-            "status_code": response.status_code,
-            "UnexpectedError": "There was an unexpected error using the API",
-            "error": response.text,
-            "payload": payload
-        }
-        raise APIFailure(msg)
+headers = {
+    'Authorization': f"Bearer {gh_api_token}",
+    'User-Agent': 'SocketPythonScript/0.0.1',
+    "accept": "application/json"
+}
+base_url = f"{github_api_url}/"
 
 
 class Github:
@@ -176,37 +128,43 @@ class Github:
         existing_overview_comment = comments.get("overview")
         existing_security_comment = comments.get("security")
         if new_overview_comment:
+            log.debug("New Dependency Overview comment")
             if existing_overview_comment is not None:
+                log.debug("Previous version of Dependency Overview, updating")
                 existing_overview_comment: Comment
                 Github.update_comment(overview_comment, str(existing_overview_comment.id))
             else:
+                log.debug("No previous version of Dependency Overview, posting")
                 Github.post_comment(overview_comment)
         if new_security_comment:
+            log.debug("New Security Issue Comment")
             if existing_security_comment is not None:
+                log.debug("Previous version of Security Issue comment, updating")
                 existing_security_comment: Comment
                 Github.update_comment(security_comment, str(existing_security_comment.id))
             else:
+                log.debug("No Previous version of Security Issue comment, posting")
                 Github.post_comment(security_comment)
 
     @staticmethod
     def post_comment(body: str) -> None:
         repo = github_repository.rsplit("/", 1)[1]
-        path = f"repos/{github_repository_owner}/{repo}/issues/{pr_number}/comments"
+        path = f"{base_url}repos/{github_repository_owner}/{repo}/issues/{pr_number}/comments"
         payload = {
             "body": body
         }
         payload = json.dumps(payload)
-        do_request(path, payload=payload, method="POST")
+        do_request(path, payload=payload, method="POST", headers=headers)
 
     @staticmethod
     def update_comment(body: str, comment_id: str) -> None:
         repo = github_repository.rsplit("/", 1)[1]
-        path = f"repos/{github_repository_owner}/{repo}/issues/comments/{comment_id}"
+        path = f"{base_url}repos/{github_repository_owner}/{repo}/issues/comments/{comment_id}"
         payload = {
             "body": body
         }
         payload = json.dumps(payload)
-        do_request(path, payload=payload, method="PATCH")
+        do_request(path, payload=payload, method="PATCH", headers=headers)
 
     @staticmethod
     def write_new_env(name: str, content: str) -> None:
@@ -217,8 +175,8 @@ class Github:
 
     @staticmethod
     def get_comments_for_pr(repo: str, pr: str) -> dict:
-        path = f"repos/{github_repository_owner}/{repo}/issues/{pr}/comments"
-        raw_comments = do_request(path)
+        path = f"{base_url}repos/{github_repository_owner}/{repo}/issues/{pr}/comments"
+        raw_comments = do_request(path, headers=headers)
         comments = {}
         if "error" not in raw_comments:
             for item in raw_comments:

{socketsecurity-0.0.89 → socketsecurity-0.0.92}/socketsecurity/core/gitlab.py

@@ -1,7 +1,5 @@
 import os
-from socketsecurity.core import log
-import requests
-from socketsecurity.core.exceptions import *
+from socketsecurity.core import log, do_request
 from socketsecurity.core.scm_comments import Comments
 import sys
 from socketsecurity.core.classes import Comment, Issue
@@ -41,62 +39,19 @@ gitlab_variables = [
     "GITLAB_TOKEN",
 ]
 
-
 for env in gitlab_variables:
     var_name = env.lower()
     globals()[var_name] = os.getenv(env) or None
+    if var_name != 'gitlab_token':
+        value = globals()[var_name]
+        log.debug(f"{env}={value}")
 
-
-def do_request(
-        path: str,
-        headers: dict = None,
-        payload: [dict, str] = None,
-        files: list = None,
-        method: str = "GET",
-) -> dict:
-    """
-    do_requests is the shared function for making HTTP calls
-
-    :param path: Required path for the request
-    :param headers: Optional dictionary of headers. If not set will use a default set
-    :param payload: Optional dictionary or string of the payload to pass
-    :param files: Optional list of files to upload
-    :param method: Optional method to use, defaults to GET
-    :return:
-    """
-    if gitlab_token is None or gitlab_token == "":
-        raise APIKeyMissing
-
-    if headers is None:
-        headers = {
-            'Authorization': f"Bearer {gitlab_token}",
-            'User-Agent': 'SocketPythonScript/0.0.1',
-            "accept": "application/json"
-        }
-    url = f"{ci_api_v4_url}/{path}"
-    response = requests.request(
-        method.upper(),
-        url,
-        headers=headers,
-        data=payload,
-        files=files
-    )
-    if response.status_code <= 399:
-        try:
-            return response.json()
-        except Exception as error:
-            response = {
-                "error": error,
-                "response": response.text
-            }
-            return response
-    else:
-        msg = {
-            "status_code": response.status_code,
-            "UnexpectedError": "There was an unexpected error using the API",
-            "error": response.text
-        }
-        raise APIFailure(msg)
+base_url = f"{ci_api_v4_url}/"
+headers = {
+    'Authorization': f"Bearer {gitlab_token}",
+    'User-Agent': 'SocketPythonScript/0.0.1',
+    "accept": "application/json"
+}
 
 
 class Gitlab:
@@ -166,40 +121,44 @@ class Gitlab:
         existing_overview_comment = comments.get("overview")
         existing_security_comment = comments.get("security")
         if new_overview_comment:
+            log.debug("New Dependency Overview comment")
             if existing_overview_comment is not None:
+                log.debug("Previous version of Dependency Overview, updating")
                 existing_overview_comment: Comment
                 Gitlab.update_comment(overview_comment, str(existing_overview_comment.id))
             else:
+                log.debug("No previous version of Dependency Overview, posting")
                 Gitlab.post_comment(overview_comment)
         if new_security_comment:
+            log.debug("New Security Issue Comment")
             if existing_security_comment is not None:
+                log.debug("Previous version of Security Issue comment, updating")
                 existing_security_comment: Comment
                 Gitlab.update_comment(security_comment, str(existing_security_comment.id))
             else:
+                log.debug("No Previous version of Security Issue comment, posting")
                 Gitlab.post_comment(security_comment)
 
     @staticmethod
     def post_comment(body: str) -> None:
-        path = f"projects/{ci_merge_request_project_id}/merge_requests/{ci_merge_request_iid}/notes"
+        path = f"{base_url}projects/{ci_merge_request_project_id}/merge_requests/{ci_merge_request_iid}/notes"
         payload = {
             "body": body
         }
-        # payload = json.dumps(payload)
-        do_request(path, payload=payload, method="POST")
+        do_request(path, payload=payload, method="POST", headers=headers)
 
     @staticmethod
     def update_comment(body: str, comment_id: str) -> None:
-        path = f"projects/{ci_merge_request_project_id}/merge_requests/{ci_merge_request_iid}/notes/{comment_id}"
+        path = f"{base_url}projects/{ci_merge_request_project_id}/merge_requests/{ci_merge_request_iid}/notes/{comment_id}"
         payload = {
             "body": body
         }
-        # payload = json.dumps(payload)
-        do_request(path, payload=payload, method="PUT")
+        do_request(path, payload=payload, method="PUT", headers=headers)
 
     @staticmethod
     def get_comments_for_pr(repo: str, pr: str) -> dict:
-        path = f"projects/{ci_merge_request_project_id}/merge_requests/{ci_merge_request_iid}/notes"
-        raw_comments = do_request(path)
+        path = f"{base_url}projects/{ci_merge_request_project_id}/merge_requests/{ci_merge_request_iid}/notes"
+        raw_comments = do_request(path, headers=headers)
         comments = {}
         if "message" not in raw_comments:
             for item in raw_comments:
@@ -212,34 +171,6 @@ class Gitlab:
         socket_comments = Comments.check_for_socket_comments(comments)
         return socket_comments
 
-    @staticmethod
-    def get_ignore_options(comments: dict) -> [bool, list]:
-        ignore_commands = []
-        ignore_all = False
-
-        for comment in comments["ignore"]:
-            comment: Comment
-            first_line = comment.body_list[0]
-            if not ignore_all and "SocketSecurity ignore" in first_line:
-                first_line = first_line.lstrip("@")
-                _, command = first_line.split("SocketSecurity ")
-                command = command.strip()
-                if command == "ignore-all":
-                    ignore_all = True
-                else:
-                    command = command.lstrip("ignore").strip()
-                    name, version = command.split("@")
-                    data = f"{name}, {version}"
-                    ignore_commands.append(data)
-        return ignore_all, ignore_commands
-
-    @staticmethod
-    def is_ignore(pkg_name: str, pkg_version: str, name: str, version: str) -> bool:
-        result = False
-        if pkg_name == name and (pkg_version == version or version == "*"):
-            result = True
-        return result
-
     @staticmethod
     def remove_comment_alerts(comments: dict):
         security_alert = comments.get("security")

{socketsecurity-0.0.89 → socketsecurity-0.0.92}/socketsecurity/socketcli.py

@@ -248,23 +248,34 @@ def main_code():
     diff = None
     if scm is not None and scm.check_event_type() == "comment":
         log.info("Comment initiated flow")
+        log.debug(f"Getting comments for Repo {scm.repository} for PR {scm.pr_number}")
         comments = scm.get_comments_for_pr(scm.repository, str(scm.pr_number))
+        log.debug("Removing comment alerts")
         scm.remove_comment_alerts(comments)
     elif scm is not None and scm.check_event_type() != "comment":
         log.info("Push initiated flow")
         diff: Diff
         diff = core.create_new_diff(target_path, params, workspace=target_path, new_files=files)
         if scm.check_event_type() == "diff":
+            log.info("Starting comment logic for PR/MR event")
+            log.debug(f"Getting comments for Repo {scm.repository} for PR {scm.pr_number}")
             comments = scm.get_comments_for_pr(repo, str(pr_number))
+            log.debug("Removing comment alerts")
+            log.debug("")
             diff.new_alerts = Comments.remove_alerts(comments, diff.new_alerts)
+            log.debug("Creating Dependency Overview Comment")
             overview_comment = Messages.dependency_overview_template(diff)
+            log.debug("Creating Security Issues Comment")
             security_comment = Messages.security_comment_template(diff)
             new_security_comment = True
             new_overview_comment = True
             if len(diff.new_alerts) == 0 or disable_security_issue:
                 new_security_comment = False
+                log.debug("No new alerts or security issue comment disabled")
             if (len(diff.new_packages) == 0 and diff.removed_packages == 0) or disable_overview:
                 new_overview_comment = False
+                log.debug("No new/removed packages or Dependency Overview comment disabled")
+            log.debug(f"Adding comments for {scm_type}")
             scm.add_socket_comments(
                 security_comment,
                 overview_comment,
@@ -272,7 +283,10 @@ def main_code():
                 new_security_comment,
                 new_overview_comment
             )
+        else:
+            log.info("Not a PR/MR event no comment needed")
         if enable_json:
+            log.debug("Outputting JSON Results")
             output_console_json(diff)
         else:
             output_console_comments(diff)

{socketsecurity-0.0.89 → socketsecurity-0.0.92/socketsecurity.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: socketsecurity
-Version: 0.0.89
+Version: 0.0.92
 Summary: Socket Security CLI for CI/CD
 Author-email: Douglas Coburn <douglas@socket.dev>
 Maintainer-email: Douglas Coburn <douglas@socket.dev>