CheckmarxPythonSDK 0.9.2__tar.gz → 0.9.3__tar.gz

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.3}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -103,6 +103,10 @@ from .repoStoreServiceAPI import (
     get_the_list_of_branches_inside_a_git_repository,
 )
 
+from .resultsSummaryAPI import (
+    get_summary_for_many_scans,
+)
+
 from .sastBestFixLocationAPI import (
     get_bfl_graph_by_scan_id,
 )
@@ -145,11 +149,11 @@ from .sastResultsAPI import (
     get_sast_results_by_scan_id,
 )
 
-from .resultsSummaryAPI import (
-    get_summary_for_many_scans,
+from .sastResultsSummaryAPI import (
     get_sast_aggregate_results,
 )
 
+
 from .sastScanMetadataServiceAPI import (
     get_metadata_of_scans,
     get_metadata_of_scan,
@@ -186,6 +190,7 @@ from .scansAPI import (
     get_the_list_of_available_config_as_code_template_files,
     get_the_config_as_code_template_file,
     get_scan_by_id,
+    get_a_scan_by_id,
     cancel_scan,
     delete_scan,
     get_a_detailed_workflow_of_a_scan,

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.3}/CheckmarxPythonSDK/CxOne/httpRequests.py

@@ -30,9 +30,9 @@ def get_data_from_config():
 get, post, put, patch, delete, head = build_request_funcs(get_data_from_config)
 
 headers = {
-    "user-agent":
-        "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) "
-        "Chrome/106.0.0.0 Safari/537.36"
+    # "user-agent":
+    #     "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) "
+    #     "Chrome/106.0.0.0 Safari/537.36"
 }
 
 

checkmarxpythonsdk-0.9.3/CheckmarxPythonSDK/CxOne/resultsSummaryAPI.py

@@ -0,0 +1,68 @@
+from .httpRequests import get_request
+from .utilities import get_url_param, type_check, list_member_type_check
+from .dto import (
+    ResultsSummary,
+    KicsCounters,
+    SastCounters,
+    ScaCounters,
+    ScaPackageCounters,
+    ScaContainersCounters,
+    ApiSecCounters,
+)
+
+api_url = "/api/scan-summary"
+
+
+def get_summary_for_many_scans(scan_ids, include_severity_status=True, include_queries=False, include_files=False,
+                               apply_predicates=True, language=None):
+    """
+
+    Args:
+        scan_ids (list of str): Scan IDs to find. Each scan id will have his own object.
+        include_severity_status (bool): if true returns the severityStatus field, otherwise will omit the field.
+                            Default value : true
+        include_queries (bool): if true returns the queries field, otherwise will omit the field.
+                            Default value : false
+        include_files (bool): if true returns the source code file and sink code file fields, otherwise will omit the fields.
+                            Default value : false
+        apply_predicates (bool): if true will apply changes from predicates, otherwise will return the raw results summary.
+                            Default value : true
+        language (str): get scan summary for specific source code language.
+
+    Returns:
+        dict
+    """
+    type_check(scan_ids, (list, tuple))
+    type_check(include_severity_status, bool)
+    type_check(include_queries, bool)
+    type_check(include_files, bool)
+    type_check(apply_predicates, bool)
+    type_check(language, str)
+
+    list_member_type_check(scan_ids, str)
+
+    relative_url = api_url + "?"
+    relative_url += get_url_param("scan-ids", scan_ids)
+    relative_url += get_url_param("include-severity-status", include_severity_status)
+    relative_url += get_url_param("include-queries", include_queries)
+    relative_url += get_url_param("include-files", include_files)
+    relative_url += get_url_param("apply-predicates", apply_predicates)
+    relative_url += get_url_param("language", language)
+
+    response = get_request(relative_url=relative_url)
+    response = response.json()
+    return {
+        "scansSummaries": [
+            ResultsSummary(
+                scan_id=summary.get("scanId"),
+                sast_counters=summary.get("sastCounters"),
+                kics_counters=summary.get("kicsCounters"),
+                sca_counters=summary.get("scaCounters"),
+                sca_packages_counters=summary.get('scaPackagesCounters'),
+                sca_containers_counters=summary.get('scaContainersCounters'),
+                api_sec_counters=summary.get('apiSecCounters')
+            ) for summary in response.get("scansSummaries") or []
+        ],
+        "totalCount": response.get("totalCount")
+    }
+

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/resultsSummaryAPI.py → checkmarxpythonsdk-0.9.3/CheckmarxPythonSDK/CxOne/sastResultsSummaryAPI.py

@@ -10,61 +10,7 @@ from .dto import (
     ApiSecCounters,
 )
 
-api_url = "/api/scan-summary"
-
-
-def get_summary_for_many_scans(scan_ids, include_severity_status=True, include_queries=False, include_files=False,
-                               apply_predicates=True, language=None):
-    """
-
-    Args:
-        scan_ids (list of str): Scan IDs to find. Each scan id will have his own object.
-        include_severity_status (bool): if true returns the severityStatus field, otherwise will omit the field.
-                            Default value : true
-        include_queries (bool): if true returns the queries field, otherwise will omit the field.
-                            Default value : false
-        include_files (bool): if true returns the source code file and sink code file fields, otherwise will omit the fields.
-                            Default value : false
-        apply_predicates (bool): if true will apply changes from predicates, otherwise will return the raw results summary.
-                            Default value : true
-        language (str): get scan summary for specific source code language.
-
-    Returns:
-        dict
-    """
-    type_check(scan_ids, (list, tuple))
-    type_check(include_severity_status, bool)
-    type_check(include_queries, bool)
-    type_check(include_files, bool)
-    type_check(apply_predicates, bool)
-    type_check(language, str)
-
-    list_member_type_check(scan_ids, str)
-
-    relative_url = api_url + "?"
-    relative_url += get_url_param("scan-ids", scan_ids)
-    relative_url += get_url_param("include-severity-status", include_severity_status)
-    relative_url += get_url_param("include-queries", include_queries)
-    relative_url += get_url_param("include-files", include_files)
-    relative_url += get_url_param("apply-predicates", apply_predicates)
-    relative_url += get_url_param("language", language)
-
-    response = get_request(relative_url=relative_url)
-    response = response.json()
-    return {
-        "scansSummaries": [
-            ResultsSummary(
-                scan_id=summary.get("scanId"),
-                sast_counters=summary.get("sastCounters"),
-                kics_counters=summary.get("kicsCounters"),
-                sca_counters=summary.get("scaCounters"),
-                sca_packages_counters=summary.get('scaPackagesCounters'),
-                sca_containers_counters=summary.get('scaContainersCounters'),
-                api_sec_counters=summary.get('apiSecCounters')
-            ) for summary in response.get("scansSummaries") or []
-        ],
-        "totalCount": response.get("totalCount")
-    }
+api_url = "/api/sast-scan-summary"
 
 
 def get_sast_aggregate_results(scan_id, group_by_field, language=None, status=None, severity=None, source_file=None,
@@ -127,7 +73,7 @@ def get_sast_aggregate_results(scan_id, group_by_field, language=None, status=No
     list_member_type_check(severity, str)
     list_member_type_check(query_ids, int)
 
-    relative_url = api_url + "?scan-id={scan_id}"
+    relative_url = api_url + "/aggregate?scan-id={scan_id}"
     relative_url += get_url_param("group-by-field", group_by_field)
     relative_url += get_url_param("language", language)
     relative_url += get_url_param("status", status)

checkmarxpythonsdk-0.9.3/CheckmarxPythonSDK/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.9.3'

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.3}/CheckmarxPythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CheckmarxPythonSDK
-Version: 0.9.2
+Version: 0.9.3
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.3}/CheckmarxPythonSDK.egg-info/SOURCES.txt

@@ -64,6 +64,7 @@ CheckmarxPythonSDK/CxOne/sastQueriesAuditAPI.py
 CheckmarxPythonSDK/CxOne/sastQueriesAuditPresetsAPI.py
 CheckmarxPythonSDK/CxOne/sastResourceManagementServiceAPI.py
 CheckmarxPythonSDK/CxOne/sastResultsAPI.py
+CheckmarxPythonSDK/CxOne/sastResultsSummaryAPI.py
 CheckmarxPythonSDK/CxOne/sastScanMetadataServiceAPI.py
 CheckmarxPythonSDK/CxOne/scanConfigurationAPI.py
 CheckmarxPythonSDK/CxOne/scannersResultsAPI.py

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CheckmarxPythonSDK
-Version: 0.9.2
+Version: 0.9.3
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/__version__.py

@@ -1 +0,0 @@
-__version__ = '0.9.2'