test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

test(integ-test): gate optional integration environments - #5731

Open
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates
Open

test(integ-test): gate optional integration environments#5731
mengweieric wants to merge 3 commits into
opensearch-project:mainfrom
mengweieric:menwe/optional-it-environment-gates

Conversation

@mengweieric

Copy link
Copy Markdown
Collaborator

Summary

Plain external-cluster integration runs do not always include the Security, geospatial, telemetry, or remote-cluster environments required by their dedicated test suites. Those suites currently fail during setup instead of reporting that the dependency is unavailable.

This change detects optional plugins through _cat/plugins and skips only when the required component is absent. Cross-cluster tests similarly skip when no remote cluster is configured. Dedicated environments continue to run the tests unchanged.

No production behavior is modified.

Validation

  • On a plain five-shard cluster, all optional-environment suites skipped cleanly and the task passed
  • Plugin-present paths remain enabled by runtime detection
  • spotlessCheck, compileTestJava, and git diff --check pass

Detect Security, geospatial, telemetry, and remote-cluster capabilities at runtime so plain external-cluster runs skip unavailable environments while dedicated test tasks continue to execute them.
Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

(Review updated until commit 0179dc6)

Here are some key observations to aid the review process:

🧪 PR contains tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Resource Leak

The isPluginInstalled method opens an InputStream from response.getEntity().getContent() but does not close it if readAllBytes() throws an exception. While the try-with-resources closes the stream on normal completion, an exception during readAllBytes() (e.g., network interruption, malformed encoding) leaves the stream open, leaking the HTTP connection resource.

try (InputStreamcontent = response.getEntity().getContent()) {
body = newString(content.readAllBytes(), StandardCharsets.UTF_8);
}

@mengweiericmengweieric added the testing Related to improving software testing label Aug 29, 2026
@github-actions

github-actionsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

Latest suggestions up to 0179dc6

Explore these optional code suggestions:

CategorySuggestion Impact
Possible issue
Handle cross-platform line endings

The current implementation may fail to match plugin names on Windows systems where
line endings are \r\n instead of \n. After splitting by \n, lines may still contain
trailing \r characters, causing the exact equality check to fail even when the
plugin is installed.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [122-126]

-for (String line : body.split("\n")) {+for (String line : body.split("\\r?\\n")) {
if (line.trim().equals(pluginComponentName)) {
return true;
}
}
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a potential cross-platform compatibility issue where Windows line endings (\r\n) could cause the plugin detection to fail. The improved_code properly handles both Unix and Windows line endings by using the regex pattern \\r?\\n.

Medium
General
Add exception handling in static setup

The @BeforeClass method requireRemoteCluster() is static but calls requireOrAssume
which may throw exceptions. If a subclass overrides instance initialization methods,
the static check runs before any instance setup, which could lead to confusing error
messages or test framework issues.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [34-48]

-ClusterPlugins.requireOrAssume(- HAS_REMOTE_CLUSTER,- Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster); skipping",- "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"- + " 'remote*' cluster) but none was found, and this task marks it required via -D"- + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+@BeforeClass+public static void requireRemoteCluster() {+ try {+ ClusterPlugins.requireOrAssume(+ HAS_REMOTE_CLUSTER,+ Boolean.getBoolean(ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY),+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster); skipping",+ "Cross-cluster search requires a configured remote cluster (-Dcluster.names must include a"+ + " 'remote*' cluster) but none was found, and this task marks it required via -D"+ + ClusterPlugins.REQUIRE_REMOTE_CLUSTER_PROPERTY);+ } catch (Exception e) {+ throw new RuntimeException("Failed to verify remote cluster configuration", e);+ }+}
Suggestion importance[1-10]: 2

__

Why: The suggestion is incorrect. The requireOrAssume method is designed to throw AssumptionViolatedException or AssertionError by design, which are the standard JUnit mechanisms for skipping tests or failing them. Wrapping these in a RuntimeException would break the intended test framework behavior and make the error messages less clear.

Low

Previous suggestions

Suggestions up to commit 4192322
CategorySuggestion Impact
General
Trim whitespace from cluster names

The code doesn't trim whitespace from cluster names after splitting, which could
cause startsWith("remote") to fail if there are spaces around commas in the property
value. Add trim() to each cluster name token.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [25-28]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ String trimmed = cluster.trim();+ if (trimmed.startsWith("remote")) {+ remote = trimmed;
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: This is a valid bug fix. The code splits on commas but doesn't trim whitespace from individual tokens, which could cause startsWith("remote") to fail if the property value contains spaces like "cluster1, remote2". The suggested fix correctly trims each token and updates the remote variable assignment accordingly.

Medium
Security
Add response size limit check

The readAllBytes() method can throw OutOfMemoryError if the response is unexpectedly
large. Consider adding a size limit check or using a bounded read to prevent
potential memory exhaustion from malicious or malformed responses.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [82-84]

 try (InputStream content = response.getEntity().getContent()) {
- body = new String(content.readAllBytes(), StandardCharsets.UTF_8);+ byte[] bytes = content.readNBytes(1024 * 1024); // 1MB limit+ if (content.read() != -1) {+ throw new IOException("Response exceeds maximum allowed size");+ }+ body = new String(bytes, StandardCharsets.UTF_8);
}
Suggestion importance[1-10]: 6

__

Why: The suggestion addresses a potential memory exhaustion issue when reading unbounded response content. While _cat/plugins responses are typically small, adding a size limit is a reasonable defensive measure. However, the suggested implementation has issues: it uses readNBytes() which may read less than requested, and the follow-up read() check is unreliable. A better approach would use Content-Length header validation or a proper bounded stream wrapper.

Low
Suggestions up to commit 5b565cf
CategorySuggestion Impact
Possible issue
Use exact line matching for plugin detection

The contains() check may produce false positives if pluginComponentName is a
substring of another plugin name. Use line-by-line matching to ensure exact
component name matches.

integ-test/src/test/java/org/opensearch/sql/util/ClusterPlugins.java [45-47]

 Response response = client.performRequest(new Request("GET", "/_cat/plugins?h=component"));
String body = new String(response.getEntity().getContent().readAllBytes());
-return body.contains(pluginComponentName);+return body.lines().anyMatch(line -> line.trim().equals(pluginComponentName));
Suggestion importance[1-10]: 8

__

Why: The suggestion correctly identifies a potential false positive issue where contains() could match partial plugin names. Using exact line matching with lines().anyMatch() ensures accurate plugin detection and prevents bugs.

Medium
General
Trim cluster names after splitting

The code doesn't trim cluster names after splitting, which could cause
startsWith("remote") to fail if there are spaces around commas in the property
value. Apply trim() to each cluster name.

integ-test/src/test/java/org/opensearch/sql/security/CrossClusterTestBase.java [22-30]

 String clusterNamesProp = System.getProperty("cluster.names");
String remote = null;
if (clusterNamesProp != null && !clusterNamesProp.isBlank()) {
for (var cluster : clusterNamesProp.split(",")) {
- if (cluster.startsWith("remote")) {- remote = cluster;+ if (cluster.trim().startsWith("remote")) {+ remote = cluster.trim();
break;
}
}
}
Suggestion importance[1-10]: 7

__

Why: Valid suggestion that addresses a potential issue where whitespace in the cluster.names property could cause the startsWith("remote") check to fail. Trimming ensures robust parsing of cluster names.

Medium

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 4192322

Signed-off-by: Eric Wei <menwe@amazon.com>
@github-actions

Copy link
Copy Markdown
Contributor

Persistent review updated to latest commit 0179dc6

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testingRelated to improving software testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mengweieric