DATAGO-116001: event-management-agent: Configure JCSMP to use default JDK truststore for Event Portal connections #282

rudraneel-chakraborty · 2025-11-03T19:34:11Z

What is the purpose of this change?

implement asks of https://sol-jira.atlassian.net/browse/DATAGO-116001

How was this change implemented?

Java

How was this change tested?

IT manually

Is there anything the reviewers should focus on/be aware of?

...

rudraneel-chakraborty · 2025-11-03T19:53:29Z

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java

+    boolean isCustomCACertConfigured() {
+        String customCaCertsPresent = System.getenv("CUSTOM_CA_CERTS_PRESENT");
+
+        return ("1".equals(customCaCertsPresent));
+    }


Package private to aid in testing

rudraneel-chakraborty · 2025-11-03T19:53:52Z

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java

+    void setDefaultTrustStore(Properties properties) {
+        String javaHome = System.getProperty("java.home");
+        if (StringUtils.isBlank(javaHome)) {
+            log.warn("java.home system property is not set. Cannot configure default truststore for JCSMP.");
+            return;
+        }
+        Path defaultTrustStorePath = Paths.get(javaHome, "lib", "security", "cacerts");
+        File trustStoreFile = defaultTrustStorePath.toFile();
+
+        if (!trustStoreFile.exists() || !trustStoreFile.canRead()) {
+            log.warn("Default truststore not found or not readable at: {}. JCSMP connection may fail.", defaultTrustStorePath);
+            return;
+        }
+
+        log.debug("Custom CA certificates present. Explicitly configuring EVMR connection to use default truststore: {}", defaultTrustStorePath);
+        properties.setProperty(SolaceProperties.TransportLayerSecurityProperties.TRUST_STORE_PATH, defaultTrustStorePath.toString());
+    }
+


package private to help in testing

Copilot

Pull Request Overview

This PR configures the JCSMP (Java Client Solace Messaging Protocol) to use the default JDK truststore when connecting to Event Portal, specifically when custom CA certificates are present in the environment.

Key Changes:

Added logic to detect custom CA certificates via environment variable and configure JCSMP truststore accordingly
Implemented truststore path validation and file existence checks
Added unit tests to verify the truststore configuration behavior

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
VMRProperties.java	Added methods to check for custom CA certs and configure default JDK truststore path for JCSMP connections
VMRPropertiesTests.java	Added tests verifying truststore configuration is called/skipped based on custom CA cert presence; fixed package declaration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-04T14:11:17Z

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java

        properties.setProperty(SolaceProperties.AuthenticationProperties.SCHEME_BASIC_PASSWORD, password);
        properties.setProperty(SolaceProperties.ClientProperties.NAME, clientName);

+        //We will always use the default jks truststore for connecting to the EVMR


The comment states 'We will always use the default jks truststore' but the implementation only configures it when CUSTOM_CA_CERTS_PRESENT=1. Update the comment to accurately reflect the conditional behavior.

Suggested change

//We will always use the default jks truststore for connecting to the EVMR

// Explicitly configure the default JKS truststore for connecting to the EVMR only when custom CA certificates are present

I agree with this comment 👍

Copilot · 2025-11-04T14:11:18Z

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java

+    boolean isCustomCACertConfigured() {
+        String customCaCertsPresent = System.getenv("CUSTOM_CA_CERTS_PRESENT");
+
+        return ("1".equals(customCaCertsPresent));
+    }


The method name isCustomCACertConfigured is misleading - it checks whether custom CA certs are present, not whether they are configured. Consider renaming to hasCustomCACerts or isCustomCACertPresent to better reflect what it checks.

Copilot · 2025-11-04T14:11:18Z

...rc/test/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRPropertiesTests.java

+    @Test
+    @SneakyThrows
+    void testSetDefaultTrustStoreCalledWhenCustomCaCertsPresent() {
+        // Spy on vmrProperties to mock getCustomCaCertsPresentEnv and verify setDefaultTrustStore is called


The comment references a non-existent method getCustomCaCertsPresentEnv. It should reference isCustomCACertConfigured instead to match the actual method being mocked.

Copilot · 2025-11-04T14:11:18Z

...rc/test/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRPropertiesTests.java

+    @Test
+    @SneakyThrows
+    void testSetDefaultTrustStoreNotCalledWhenCustomCaCertsNotPresent() {
+        // Spy on vmrProperties to mock getCustomCaCertsPresentEnv and verify setDefaultTrustStore is NOT called


The comment references a non-existent method getCustomCaCertsPresentEnv. It should reference isCustomCACertConfigured instead to match the actual method being mocked.

Suggested change

// Spy on vmrProperties to mock getCustomCaCertsPresentEnv and verify setDefaultTrustStore is NOT called

// Spy on vmrProperties to mock isCustomCACertConfigured and verify setDefaultTrustStore is NOT called

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java

moodiRealist

PR looks good, but we shouldn't merge it until changes to applicatoin.yml file are reverted.

service/application/src/main/resources/application.yml

moodiRealist · 2025-11-05T15:57:27Z

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java

        properties.setProperty(SolaceProperties.AuthenticationProperties.SCHEME_BASIC_PASSWORD, password);
        properties.setProperty(SolaceProperties.ClientProperties.NAME, clientName);

+        //We will always use the default jks truststore for connecting to the EVMR


I agree with this comment 👍

moodiRealist · 2025-11-05T16:20:28Z

...t/java/com/solace/maas/ep/event/management/agent/scanManager/ScanManagerHandleErrorTest.java

    @Mock
    private ScanStatusPublisher scanStatusPublisher;

+    @Mock


Can we use @MockitoBean in here as well?

sonarqube-solacecloud · 2025-11-05T16:25:38Z

Quality Gate failed

Failed conditions
2 New issues
25.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

rudraneel-chakraborty added 3 commits October 22, 2025 10:24

DATAGO-114866 poc

513803d

DATAGO-114866 poc

7db131c

DATAGO-116001 code complete

5ce4699

rudraneel-chakraborty temporarily deployed to build_pr November 3, 2025 19:34 — with GitHub Actions Inactive

DATAGO-116001 code complete

0a337d0

rudraneel-chakraborty temporarily deployed to build_pr November 3, 2025 19:52 — with GitHub Actions Inactive

rudraneel-chakraborty commented Nov 3, 2025

View reviewed changes

rudraneel-chakraborty requested a review from Copilot November 4, 2025 14:09

Copilot AI reviewed Nov 4, 2025

View reviewed changes

DATAGO-116001 code complete

4bd47ce

rudraneel-chakraborty had a problem deploying to build_pr November 4, 2025 19:13 — with GitHub Actions Failure

moodiRealist reviewed Nov 5, 2025

View reviewed changes

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java Outdated Show resolved Hide resolved

moodiRealist reviewed Nov 5, 2025

View reviewed changes

...gin/src/main/java/com/solace/maas/ep/event/management/agent/plugin/config/VMRProperties.java Outdated Show resolved Hide resolved

DATAGO-116001 code complete

6bb8041

rudraneel-chakraborty temporarily deployed to build_pr November 5, 2025 15:29 — with GitHub Actions Inactive

DATAGO-116001 code complete

01b42a3

rudraneel-chakraborty temporarily deployed to build_pr November 5, 2025 15:40 — with GitHub Actions Inactive

moodiRealist changed the title ~~DATAGO-116002: event-management-agent: Configure JCSMP to use default JDK truststore for Event Portal connections~~ DATAGO-116001: event-management-agent: Configure JCSMP to use default JDK truststore for Event Portal connections Nov 5, 2025

moodiRealist requested changes Nov 5, 2025

View reviewed changes

rudraneel-chakraborty marked this pull request as ready for review November 5, 2025 16:13

DATAGO-116001 code complete

8559ebe

rudraneel-chakraborty temporarily deployed to build_pr November 5, 2025 16:15 — with GitHub Actions Inactive

moodiRealist reviewed Nov 5, 2025

View reviewed changes

SolaceProducts deleted a comment from moodiRealist Nov 5, 2025

moodiRealist approved these changes Nov 5, 2025

View reviewed changes

bol444 approved these changes Nov 6, 2025

View reviewed changes

rudraneel-chakraborty merged commit 95a8d10 into main Nov 6, 2025
5 of 6 checks passed

rudraneel-chakraborty deleted the DATAGO-116001-custom-cert-ema-work branch November 6, 2025 18:51

	//We will always use the default jks truststore for connecting to the EVMR
	// Explicitly configure the default JKS truststore for connecting to the EVMR only when custom CA certificates are present

	// Spy on vmrProperties to mock getCustomCaCertsPresentEnv and verify setDefaultTrustStore is NOT called
	// Spy on vmrProperties to mock isCustomCACertConfigured and verify setDefaultTrustStore is NOT called

DATAGO-116001: event-management-agent: Configure JCSMP to use default JDK truststore for Event Portal connections #282

DATAGO-116001: event-management-agent: Configure JCSMP to use default JDK truststore for Event Portal connections #282

Uh oh!

Conversation

rudraneel-chakraborty commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is the purpose of this change?

How was this change implemented?

How was this change tested?

Is there anything the reviewers should focus on/be aware of?

Uh oh!

rudraneel-chakraborty Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

rudraneel-chakraborty Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

moodiRealist Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

moodiRealist left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

moodiRealist Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

moodiRealist Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqube-solacecloud bot commented Nov 5, 2025

Quality Gate failed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rudraneel-chakraborty commented Nov 3, 2025 •

edited

Loading