diff --git a/CHANGELOG.md b/CHANGELOG.md index fd6ce0b0..45cd4d2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ Unreleased * [Add] ReportAPI.create_scan_report_v2 optional severities/states/status/sections/report_type/emails/report_filename/timezone params, matching the documented request body — previously these were all hardcoded with no way for callers to override them. report_filename, when omitted, now lets the server apply its own "Cx_ScanReport_{Scan_Date}" default instead of forcing an empty string. * [Fix] ScansAPI.sca_recalculate (POST /scans/recalculate) — was returning the raw httpx Response instead of a parsed object, and wasn't exported from CxOne/__init__.py. Now returns a Scan (the live response is the same Scan schema as create_scan's), matching the documented response body, and is exported like every other endpoint. * [Breaking] ScansAPI.sca_recalculate — removed the hardcoded, undocumented `config: [{"type": "sca", "value": {"enableContainersScan": True}}]` that was silently sent on every call; it isn't part of the documented request body. Replaced with an optional `config` param (raw list of dicts, left untyped since it's undocumented) that defaults to not being sent at all. +* [Fix] CxOne.ScaAPI (and anything else passing url_prefix to ApiClient) — Sca.__init__ built base_url straight from configuration.server_base_url, never applying api_client.url_prefix. The combining logic was removed in 63bc292 ([refactor] eliminate is_iam, relative_url, and create_url) back in May 2026 when Sca switched from relative URLs through create_url (which did honor url_prefix) to building absolute f-string URLs itself; url_prefix was left on ApiClient but nothing read it again. CxOne/scaAPI.py's url_prefix="/api/sca" has been silently ineffective ever since, so every CxOne SCA call (including gql_url) hit `https:///...` instead of `https:///api/sca/...`. Reproduced live: get_all_projects() via CxOne.ScaAPI failed with "400 Request Header Or Cookie Too Large" (misrouted by the tenant's gateway) before the fix, succeeded (18 real projects) after. CxScaApiSDK's own direct usage is unaffected since it never passes url_prefix. **Affected versions: 1.8.2 through 1.9.2** (every release containing 63bc292, confirmed via `git merge-base --is-ancestor` against each version tag) — 1.8.1 and earlier are not affected, since url_prefix was still honored by create_url there. Every CxOne.ScaAPI call in every one of those releases has been silently hitting the wrong URL. +* [Fix] tests/CxOne/test_sca_api.py — all 24 tests were `@pytest.mark.skip`'d with the misdiagnosed reason "400 Request Header Too Large - SCA API nginx header buffer limitation"; that 400 was actually the url_prefix bug above. Removed the skip markers now that it's fixed: 23 pass live. The 24th (test_get_one_vulnerability) uncovered a real, separate, pre-existing bug -- get_one_vulnerability's GraphQL query requests a `vulnerabilityFixResolutionText` field that the live schema 400s on ("does not exist on the type `VulnerabilityModel`") -- documented with an accurate skip reason instead of fixed, since it's unrelated to url_prefix. 1.9.2 - 2026-11-03 * [Fix] api_client retry decorator — 500/502/503/504 responses are now actually retried (check_response used to raise before the retry logic could see them), with a backoff before each retry: honors Retry-After when present, otherwise exponential backoff (30s, 60s, 120s, ... capped at 180s / 3 minutes). 429 handling now works the same way. Improves recovery from gateway timeouts such as SCA scan report export 504s. diff --git a/CheckmarxPythonSDK/CxScaApiSDK/api.py b/CheckmarxPythonSDK/CxScaApiSDK/api.py index 1828fef3..ea703c6c 100644 --- a/CheckmarxPythonSDK/CxScaApiSDK/api.py +++ b/CheckmarxPythonSDK/CxScaApiSDK/api.py @@ -18,7 +18,8 @@ def __init__(self, api_client: ApiClient = None): configuration = construct_configuration() api_client = ApiClient(configuration=configuration) self.api_client = api_client - self.base_url = api_client.configuration.server_base_url.rstrip("/") + url_prefix = (getattr(api_client, "url_prefix", "") or "").rstrip("/") + self.base_url = api_client.configuration.server_base_url.rstrip("/") + url_prefix self.gql_url = f"{self.base_url}/graphql/graphql" def get_all_projects(self, project_name: str = None) -> Union[dict, List[dict]]: diff --git a/tests/CxOne/test_sca_api.py b/tests/CxOne/test_sca_api.py index 92a59859..000f095c 100644 --- a/tests/CxOne/test_sca_api.py +++ b/tests/CxOne/test_sca_api.py @@ -2,38 +2,32 @@ from CheckmarxPythonSDK.CxOne.scaAPI import ScaAPI -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_projects(): projects = ScaAPI().get_all_projects() assert projects is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_vulnerabilities_risks_by_scan_id(): result = ScaAPI().get_number_of_vulnerabilities_risks_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", is_exploitable_path_enabled=False) assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_supply_chain_risks_by_scan_id(): result = ScaAPI().get_number_of_supply_chain_risks_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_outdated_packages_by_scan_id(): result = ScaAPI().get_number_of_outdated_packages_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_legal_risks_by_scan_id(): result = ScaAPI().get_number_of_legal_risks_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_vulnerabilities_risks_by_scan_id(): result = ScaAPI().get_vulnerabilities_risks_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", take=10, skip=0) @@ -43,7 +37,11 @@ def test_get_vulnerabilities_risks_by_scan_id(): assert second_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") +@pytest.mark.skip(reason="get_one_vulnerability's GraphQL query requests " + "vulnerabilityFixResolutionText, which the live schema 400s on: " + "'The field `vulnerabilityFixResolutionText` does not exist on the " + "type `VulnerabilityModel`.' Unrelated to url_prefix -- a separate, " + "pre-existing bug in the query itself.") def test_get_one_vulnerability(): result = ScaAPI().get_one_vulnerability(scan_id="fd129816-5ef0-4111-959b-11f118e286fa", vulnerability_id="CVE-2019-19919", @@ -51,7 +49,6 @@ def test_get_one_vulnerability(): assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_supply_chain_risks_by_scan_id(): result = ScaAPI().get_supply_chain_risks_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", take=10, skip=0) @@ -61,7 +58,6 @@ def test_get_supply_chain_risks_by_scan_id(): assert second_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_legal_risks_by_scan_id(): result = ScaAPI().get_legal_risks_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", take=10, skip=0) @@ -71,7 +67,6 @@ def test_get_legal_risks_by_scan_id(): assert second_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_direct_third_party_packages_by_scan_id(): # result = ScaAPI().get_direct_third_party_packages_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", # take=10, skip=0) @@ -84,7 +79,6 @@ def test_get_direct_third_party_packages_by_scan_id(): assert private_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_transitive_third_party_packages_by_scan_id(): # result = ScaAPI().get_transitive_third_party_packages_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", # take=10, skip=0) @@ -99,7 +93,6 @@ def test_get_transitive_third_party_packages_by_scan_id(): assert private_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_package_details_by_scan_id_and_package_id(): result = ScaAPI().get_package_details_by_scan_id_and_package_id( package_id="Maven-mysql:mysql-connector-java-5.1.26", @@ -109,13 +102,11 @@ def test_get_package_details_by_scan_id_and_package_id(): assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_packages_by_scan_id(): result = ScaAPI().get_number_of_packages_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_direct_third_party_packages_by_scan_id(): # result = ScaAPI().get_number_of_direct_third_party_packages_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") # assert result is not None @@ -124,7 +115,6 @@ def test_get_number_of_direct_third_party_packages_by_scan_id(): assert private_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_transitive_third_party_packages_by_scan_id(): # result = ScaAPI().get_number_of_transitive_third_party_packages_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") # assert result is not None @@ -133,13 +123,11 @@ def test_get_number_of_transitive_third_party_packages_by_scan_id(): assert private_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_number_of_packages_used_for_accessing_saas_services(): result = ScaAPI().get_number_of_packages_used_for_accessing_saas_services(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_container_packages_by_scan_id(): result = ScaAPI().get_container_packages_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", take=10, skip=0) @@ -149,7 +137,6 @@ def test_get_container_packages_by_scan_id(): assert second_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_container_vulnerabilities_by_scan_id(): result = ScaAPI().get_container_vulnerabilities_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", take=10, skip=0) @@ -159,7 +146,6 @@ def test_get_container_vulnerabilities_by_scan_id(): assert second_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_package_licenses_by_scan_id(): result = ScaAPI().get_package_licenses_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", take=10, skip=0) @@ -169,7 +155,6 @@ def test_get_package_licenses_by_scan_id(): assert second_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_down_stream_remediation_by_scan_id(): result = ScaAPI().get_down_stream_remediation_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7", take=10, skip=0) @@ -179,25 +164,21 @@ def test_get_down_stream_remediation_by_scan_id(): assert second_result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_scan_info_by_scan_id(): result = ScaAPI().get_scan_info_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_scan_progress_by_scan_id(): result = ScaAPI().get_scan_progress_by_scan_id(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_packages_of_a_scan(): result = ScaAPI().get_packages_of_a_scan(scan_id="d201a795-e2f0-44bf-8f5a-d6a5eb1c28b7") assert result is not None -@pytest.mark.skip(reason="400 Request Header Too Large - SCA API nginx header buffer limitation") def test_get_packages_from_inventory_by_name_and_version(): package_name = "pillow" package_version = "2.9.0"