You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
What - Updated Integration Blueprint defaults and mapping and add ui base url to exported data
Why - To refine and enrich data returned from integration
How -
Updated default blueprints and mapping
Added checkmarx one ui base url to exported data
Type of change
Please leave one option from the following and delete the rest:
Non-breaking change (fix of existing functionality that will not change current behavior)
All tests should be run against the port production environment(using a testing org).
Core testing checklist
Integration able to create all default resources from scratch
Resync finishes successfully
Resync able to create entities
Resync able to update entities
Resync able to detect and delete entities
Scheduled resync able to abort existing resync and start a new one
Tested with at least 2 integrations from scratch
Tested with Kafka and Polling event listeners
Tested deletion of entities that don't pass the selector
Integration testing checklist
Integration able to create all default resources from scratch
Completed a full resync from a freshly installed integration and it completed successfully
Resync able to create entities
Resync able to update entities
Resync able to detect and delete entities
Resync finishes successfully
If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the examples folder in the integration directory.
If resource kind is updated, run the integration with the example data and check if the expected result is achieved
If new resource kind is added or updated, validate that live-events for that resource are working as expected
Include screenshots from your environment showing how the resources of the integration will look.
API Documentation
Provide links to the API documentation used for this integration.
PR Type
Enhancement
Description
Add UI base URL metadata to all exported entities
Refactor metadata enrichment with centralized utility function
Update blueprint schemas with enhanced enum colors and properties
Add deep link generation for better user navigation
Diagram Walkthrough
flowchart LR
A["Client"] --> B["UI Base URL Property"]
B --> C["Centralized Utils"]
C --> D["All Exporters"]
D --> E["Enhanced Metadata"]
E --> F["Updated Blueprints"]
F --> G["Deep Links"]
ui_base_url is derived by blindly replacing "/api" in base_url; if "/api" is not present or appears earlier in the hostname/path, the result may be incorrect. Consider a more robust approach (e.g., parse URL and strip known API path suffix).
defui_base_url(self) ->str:
""" Get the Checkmarx One UI base URL (without /api suffix). Returns: UI base URL for constructing deeplinks """returnself.base_url.replace("/api", "")
New deep link mappings rely on "__ui_base_url" and various IDs (e.g., similarityID vs similarityId). Ensure all exporters consistently add "__ui_base_url" and that field names match upstream payloads to avoid empty/invalid links.
enrich_result_with_metadata mutates the input dict in place. If callers reuse original payloads elsewhere, consider returning a shallow copy to avoid unintended side effects.
defenrich_result_with_metadata(
result: Dict[str, Any], ui_base_url: str, scan_id: Optional[str] =None
) ->dict[str, Any]:
"""Enrich result with UI base URL and optionally scan ID metadata. Args: result: The result dictionary to enrich ui_base_url: The UI base URL to add as metadata scan_id: Optional scan ID to add as metadata Returns: The enriched result dictionary with __ui_base_url and optionally __scan_id fields """result["__ui_base_url"] =ui_base_urlifscan_id:
result["__scan_id"] =scan_idreturnresult
The PR hardcodes URL paths for deep-links in port-app-config.yaml, which is fragile. It would be more robust to use deep-links provided directly by the Checkmarx One API, if available.
# integrations/checkmarx-one/.port/resources/port-app-config.yaml# This assumes the Checkmarx API can return a 'uiLink' field in its response.
- kind: projectport:
entity:
mappings:
# ...link: .uiLink
- kind: scanport:
entity:
mappings:
# ...link: .uiLink
Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies a significant design weakness, as hardcoding URL structures makes the integration brittle and susceptible to breaking from external UI changes.
Medium
Possible issue
✅ Fix incorrect deep link URLSuggestion Impact:The commit removed the generic links for SCA, Containers, KICS, SAST (and others), aligning with the suggestion to address incorrect generic deep links. However, it did not add the proposed specific URLs; it simply deleted the generic link fields.
Update the generic deep link for SCA, Containers, KICS, and SAST findings to a specific link that navigates to the individual finding. This can be done by constructing a URL with the project ID, scan ID, and similarity ID.
Why: The suggestion correctly identifies that the deep links for findings are generic and provides a correct and much more useful specific link format, significantly improving the functionality introduced in the PR.
Medium
Use removesuffix for robust URL manipulation
Replace replace("/api", "") with removesuffix("/api") in the ui_base_url property to robustly remove the suffix from the URL and avoid accidentally altering other parts of the URL string.
@property
def ui_base_url(self) -> str:
"""
Get the Checkmarx One UI base URL (without /api suffix).
Returns:
UI base URL for constructing deeplinks
"""
- return self.base_url.replace("/api", "")+ return self.base_url.removesuffix("/api")
Apply / Chat
Suggestion importance[1-10]: 6
__
Why: The suggestion correctly points out a potential edge case with replace() and suggests using removesuffix() for a more robust implementation, which improves code correctness and prevents potential bugs.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Description
What - Updated Integration Blueprint defaults and mapping and add ui base url to exported data
Why - To refine and enrich data returned from integration
How -
Type of change
Please leave one option from the following and delete the rest:
All tests should be run against the port production environment(using a testing org).
Core testing checklist
Integration testing checklist
examplesfolder in the integration directory.Preflight checklist
Screenshots
Include screenshots from your environment showing how the resources of the integration will look.
API Documentation
Provide links to the API documentation used for this integration.
PR Type
Enhancement
Description
Add UI base URL metadata to all exported entities
Refactor metadata enrichment with centralized utility function
Update blueprint schemas with enhanced enum colors and properties
Add deep link generation for better user navigation
Diagram Walkthrough
File Walkthrough
9 files
Add UI base URL property to clientCreate centralized metadata enrichment utilityRefactor to use centralized metadata enrichmentRefactor to use centralized metadata enrichmentAdd UI base URL metadata to projectsAdd UI base URL metadata to SAST resultsAdd UI base URL metadata to scansAdd UI base URL metadata to scan resultsAdd link properties and enhanced enum colors2 files
Update tests for centralized metadata enrichmentUpdate tests to verify UI base URL metadata2 files
Add deep link mappings using UI base URLBump version to 0.3.5-dev1 files
Document version 0.3.5-dev improvements