ocean icon indicating copy to clipboard operation
ocean copied to clipboard

[Integration][JFrog] - Added support for JFrog Integration

Open azeezport opened this issue 1 month ago • 5 comments

User description

Description

What - Add JFrog integration with repository, build, project, and vulnerability tracking

Why -

How -

Type of change

Please leave one option from the following and delete the rest:

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] New Integration (non-breaking change which adds a new integration)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ ] Non-breaking change (fix of existing functionality that will not change current behavior)
  • [ ] Documentation (added/updated documentation)

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
  • [ ] Docs PR link here

Preflight checklist

  • [ ] Handled rate limiting
  • [ ] Handled pagination
  • [ ] Implemented the code in async
  • [ ] Support Multi account

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 JFrog integration supporting repositories, builds, projects, and vulnerabilities

  • Implement async JFrog API client with rate limiting and XRay support

  • Create Port blueprints for container images and vulnerability tracking

  • Configure resync handlers for all JFrog resource types


Diagram Walkthrough

flowchart LR
  JFrogAPI["JFrog API<br/>Artifactory & XRay"]
  Client["JFrogClient<br/>Async HTTP Client"]
  Resync["Resync Handlers<br/>Repository, Build, Project,<br/>Docker Image, Vulnerability"]
  Blueprints["Port Blueprints<br/>5 Resource Types"]
  Config["Integration Config<br/>Credentials & Settings"]
  
  JFrogAPI -->|API Calls| Client
  Client -->|Data| Resync
  Resync -->|Entity Mapping| Blueprints
  Config -->|Initialize| Client

File Walkthrough

Relevant files
Enhancement
3 files
client.py
JFrog async HTTP client with rate limiting                             
+176/-0 
main.py
Resync handlers for all resource types                                     
+72/-0   
debug.py
Debug entry point for local development                                   
+4/-0     
Configuration changes
8 files
blueprints.json
Port blueprints for JFrog resources                                           
+90/-0   
port-app-config.yml
Entity mappings and selectors configuration                           
+80/-0   
spec.yaml
Integration specification and configuration schema             
+55/-0   
.env.example
Environment variables template for setup                                 
+6/-0     
poetry.toml
Poetry virtual environment configuration                                 
+3/-0     
Makefile
Makefile symlink to shared infrastructure                               
+1/-0     
sonar-project.properties
SonarQube project configuration                                                   
+2/-0     
launch.json
VS Code debug configuration for JFrog integration               
+11/-0   
Dependencies
1 files
pyproject.toml
Poetry dependencies and project metadata                                 
+113/-0 
Tests
1 files
test_sample.py
Basic test placeholder for integration                                     
+2/-0     
Documentation
3 files
README.md
Integration documentation and usage guide                               
+7/-0     
CONTRIBUTING.md
Contribution guidelines for local development                       
+7/-0     
CHANGELOG.md
Changelog template for version tracking                                   
+8/-0     
Additional files
1 files
__init__.py [link]   

azeezport avatar Oct 23 '25 12:10 azeezport