Skip to content

Add Telemetry AI event support to Java wrapper with test coverage (AST-127560) #454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
cx-anurag-dalke merged 29 commits into from
Dec 29, 2025
Merged

Add Telemetry AI event support to Java wrapper with test coverage (AST-127560) #454

cx-anurag-dalke merged 29 commits into from
Dec 29, 2025
+135 −8

Conversation

@cx-atish-jadhav
Copy link
Contributor

@cx-atish-jadhav cx-atish-jadhav commented Dec 29, 2025

Description

This PR introduces telemetry AI event support to the Java wrapper:

  • Adds a telemetry AI command in the wrapper to report AI-related events (provider, agent, event type, subtype, engine, severity, scan type, status, totals).
  • Provides unit tests covering different invocation scenarios (AI interaction logging, detection logging, and edge/minimal parameters).
  • Keeps existing behavior intact for all other commands.

Background and motivation

  • Enables clients and IDE plugins to emit standardized telemetry around AI-assisted workflows and detections.
  • Aligns the Java wrapper with newer CLI capabilities, simplifying adoption by downstream integrations.

Impacts

  • Public API: new method in the wrapper to emit telemetry AI events.
  • No change to existing public methods, input contracts, or default flows.
  • No migration required for current users; this is purely additive.
  • Performance and memory impact are negligible (command assembly and execution only).
  • Logging: leverages the existing logger; no new logging frameworks added.

References

AST-127560

Testing

  • Integration tests: Added focused tests for telemetry AI event invocation covering:
    • AI interaction logging with minimal-but-meaningful parameters
    • Detection logging with scan-type/status/totalCount emphasis
    • Edge cases with empty or minimal values
  • Existing tests: All pre-existing test suites complete without errors.

Additional notes

  • Backward compatibility maintained; no existing flags or parsing logic were changed.
  • Error handling follows established wrapper behavior: non-zero CLI exit codes propagate as exceptions.
  • The feature is safe to roll out; it’s disabled unless explicitly called by in plugin code

cx-atish-jadhav and others added 29 commits October 14, 2025 12:42
@cx-atish-jadhav
aimcp server changes
bfaa9d3
@cx-atish-jadhav
oss-realtime scanner changes
994bec4
@cx-atish-jadhav
Create OssRealtimeVulnerability.java
f741fa1
@cx-atish-jadhav
Unify realtime scan wrappers; consolidate Secrets/IaC models; depreca…
1551319 
…te and stub obsolete result classes
@cx-atish-jadhav
Add ContainersRealtimeVulnerability model for containers realtime sca…
decc733 
…n parsing
@cx-atish-jadhav
Add @JsonCreator constructor to OssRealtimeVulnerability for reliable…
1ac5286 
… Jackson deserialization
@cx-atish-jadhav
Refactoring package name and adding test for oss and mcp flag
fa9f1b5
@cx-atish-jadhav
Add integration tests for OSS, Container, and Secrets realtime scanners
ece0319
@cx-atish-jadhav
Replaced Id to CVE in oss vulnerability
a395d91
@cx-anand-nandeshwar
Changed variable from id to CVE as per OSS response
5564f93
@cx-anand-nandeshwar
Merge remote-tracking branch 'origin/feature/agentic_ai' into feature…
95ee628 
…/agentic_ai
@cx-atish-jadhav
aimcp server changes
1810e78
@cx-atish-jadhav
oss-realtime scanner changes
bf95eb7
@cx-atish-jadhav
Create OssRealtimeVulnerability.java
7c72274
@cx-atish-jadhav
Unify realtime scan wrappers; consolidate Secrets/IaC models; depreca…
0677502 
…te and stub obsolete result classes
@cx-atish-jadhav
Add ContainersRealtimeVulnerability model for containers realtime sca…
2f0f55b 
…n parsing
@cx-atish-jadhav
Add @JsonCreator constructor to OssRealtimeVulnerability for reliable…
d1cb41c 
… Jackson deserialization
@cx-atish-jadhav
Refactoring package name and adding test for oss and mcp flag
b2f2588
@cx-atish-jadhav
Add integration tests for OSS, Container, and Secrets realtime scanners
d647f57
@cx-anand-nandeshwar @cx-atish-jadhav
Changed variable from id to CVE as per OSS response
ee4c90c
@cx-atish-jadhav
Add maskedResult for secret remediation and change log level from INF…
97c6c69 
…O to DEBUG
@cx-atish-jadhav
Remove masked secrets functionality from codebase
82d6c66
@cx-atish-jadhav
Implemented mask cmd in java wrapper
23ddb2d
@cx-anjali-deore
Added fix for containerTool for IAC
dbd2b51
@cx-anjali-deore
Merge branch 'feature/agentic_ai' of https://github.com/CheckmarxDev/…
04b7efb 
…ast-cli-java-wrapper into feature/agentic_ai

# Conflicts:
#	src/main/java/com/checkmarx/ast/wrapper/CxConstants.java
#	src/main/java/com/checkmarx/ast/wrapper/CxWrapper.java
#	src/test/java/com/checkmarx/ast/SecretsRealtimeResultsTest.java
@cx-atish-jadhav
Add telemetry AI command with full parameter support and tests
13c6f10
@cx-atish-jadhav
Add ignoredFilePath parameter to ScanAsca method
36872e6
@cx-atish-jadhav
Removing ASCA ignore file path changes
65d7e2a
@cx-atish-jadhav
Squashed commit of the following:
00ab820 
commit d95cdea
Merge: 09bebed bfcd160
Author: AST Sypher <astsypher@checkmarx.com>
Date:   Mon Dec 15 15:41:37 2025 +0530

    Merge pull request #452 from Checkmarx/feature/update_cli_2.3.41

    Update checkmarx-ast-cli binaries with 2.3.41

commit bfcd160
Author: cx-anurag-dalke <120229307+cx-anurag-dalke@users.noreply.github.com>
Date:   Mon Dec 15 09:54:20 2025 +0000

    Update checkmarx-ast-cli to 2.3.41

commit 87bb7ad
Author: github-actions <github-actions@github.com>
Date:   Mon Dec 15 09:54:19 2025 +0000

    Track Checkmarx CLI binaries with Git LFS

commit 09bebed
Author: Atish Jadhav <141334503+cx-atish-jadhav@users.noreply.github.com>
Date:   Mon Dec 15 13:26:35 2025 +0530

    Devassist: Realtime scanners (OSS, Secrets, Containers, IaC) with unified wrapper and enhanced parsing(AST-115438) (#451)

    * aimcp server changes

    * oss-realtime scanner changes

    * Create OssRealtimeVulnerability.java

    * Unify realtime scan wrappers; consolidate Secrets/IaC models; deprecate and stub obsolete result classes

    * Add ContainersRealtimeVulnerability model for containers realtime scan parsing

    * Add @JsonCreator constructor to OssRealtimeVulnerability for reliable Jackson deserialization

    * Refactoring package name and adding test for oss and mcp flag

    * Add integration tests for OSS, Container, and Secrets realtime scanners

    * Changed variable from id to CVE as per OSS response

    * Add maskedResult for secret remediation and change log level from INFO to DEBUG

    * Remove masked secrets functionality from codebase

    * Implemented mask cmd in java wrapper

    ---------

    Co-authored-by: cx-anand-nandeshwar <73646287+cx-anand-nandeshwar@users.noreply.github.com>
Merge branch 'main' into feature/agentic_ai
@cx-ben-alvo
Copy link
Collaborator

cx-ben-alvo commented Dec 29, 2025

Logo
Checkmarx One – Scan Summary & Details – fa6b9fb8-67ea-46f6-ac4a-671e7af50bab

Great job! No new security vulnerabilities introduced in this pull request

Use @Checkmarx to reach out to us for assistance.

Just send a PR comment with @Checkmarx followed by a natural language request.

Examples: @Checkmarx how are you able to help me? @Checkmarx rescan this PR

cx-anurag-dalke
cx-anurag-dalke approved these changes Dec 29, 2025
View reviewed changes
Copy link
Collaborator

@cx-anurag-dalke cx-anurag-dalke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@cx-anurag-dalke cx-anurag-dalke merged commit f27370c into main Dec 29, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cx-anurag-dalke cx-anurag-dalke cx-anurag-dalke approved these changes

Assignees

No one assigned

Labels

feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@cx-atish-jadhav @cx-ben-alvo @cx-anurag-dalke @cx-anand-nandeshwar @cx-anjali-deore