Fix OpenSearchNode working directory to avoid executing in immutable Gradle cache directory by dbwiddis · Pull Request #20229 · opensearch-project/OpenSearch

dbwiddis · 2025-12-14T01:02:30Z

Description

Modified OpenSearchNode binary execution directory from getDistroDir() to workingDir.toFile() so that all OpenSearch bin scripts run from the node's working directory instead of the Gradle cache directory.

Changed the Unix executable to use absolute paths since we changed the working directory.

Related Issues

Fixes [BUG] TestClusters plugin corrupts Gradle 9.x transform cache when canUseSharedDistribution() is true #20226
Supercedes [Backport main] [3.4] Prevent use of shared distribution on gradle builds #20228 which should be closed

Check List

Functionality includes testing.
~~[ ] API changes companion pull request created, if applicable.~~
~~[ ] Public documentation issue/PR created, if applicable.~~

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Summary by CodeRabbit

Bug Fixes
- Fixed test cluster startup so tools run from the node working directory and use explicit script paths, preventing failures when executed in immutable or cached build directories.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-14T01:02:50Z

Walkthrough

Changed OpenSearchNode so tools are resolved from the distribution's bin directory and processes are started with the node's working directory instead of the extracted distro/Gradle cache directory, preventing writes into the immutable Gradle transform cache.

Changes

Cohort / File(s)	Summary
Changelog `CHANGELOG.md`	Added entry documenting the fix that avoids executing in the immutable Gradle cache directory.
Script execution logic `buildSrc/src/main/java/org/opensearch/gradle/testclusters/OpenSearchNode.java`	Resolve tool paths from `getDistroDir()/bin`; set process working directory to the node's `workingDir`; on Windows use `cmd` with the resolved absolute `.bat` path passed as an argument (no reliance on current dir).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Inspect getDistroDir().resolve("bin") usage and Windows .bat resolution for correctness.
Verify the process builder's working directory is the node workingDir and that no files are written into the distro/Gradle cache.
Run integ tests on Linux/macOS to confirm Gradle immutable workspace is not modified.

Poem

🐰 I hopped where scripts once roamed the cache,

Now I tuck them safe within my patch.
No more marks upon that guarded ground,
Logs at home, not scattered around.
A small tidy hop — peace all around. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: fixing OpenSearchNode's working directory to prevent execution in the immutable Gradle cache.
Description check	✅ Passed	The description includes all essential template sections: clear description of changes, related issues, and completed checklist items with DCO confirmation.
Linked Issues check	✅ Passed	The code changes address the root cause of issue #20226: preventing OpenSearchNode from executing in the immutable Gradle cache by changing working directory and using absolute paths.
Out of Scope Changes check	✅ Passed	All changes in CHANGELOG.md and OpenSearchNode.java are directly scoped to fixing the working directory issue and preventing cache corruption, with no unrelated modifications.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35c5865 and 149bcdb.

📒 Files selected for processing (1)

CHANGELOG.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

CHANGELOG.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (21)

GitHub Check: gradle-check
GitHub Check: detect-breaking-change
GitHub Check: precommit (25, ubuntu-24.04-arm)
GitHub Check: precommit (21, ubuntu-latest)
GitHub Check: precommit (25, ubuntu-latest)
GitHub Check: precommit (25, windows-latest)
GitHub Check: assemble (21, macos-15)
GitHub Check: precommit (25, macos-15-intel)
GitHub Check: assemble (25, ubuntu-24.04-arm)
GitHub Check: precommit (21, windows-2025, true)
GitHub Check: precommit (21, macos-15)
GitHub Check: precommit (25, macos-15)
GitHub Check: assemble (25, windows-latest)
GitHub Check: assemble (21, ubuntu-latest)
GitHub Check: precommit (21, ubuntu-24.04-arm)
GitHub Check: precommit (21, windows-latest)
GitHub Check: Analyze (java)
GitHub Check: assemble (25, ubuntu-latest)
GitHub Check: assemble (21, ubuntu-24.04-arm)
GitHub Check: assemble (21, windows-latest)
GitHub Check: Mend Security Check

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

…ble Gradle cache directory Signed-off-by: Daniel Widdis <widdis@gmail.com>

github-actions · 2025-12-14T02:26:54Z

✅ Gradle check result for 35c5865: SUCCESS

codecov · 2025-12-14T02:31:08Z

Codecov Report

❌ Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.18%. Comparing base (66ed5cb) to head (35c5865).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...opensearch/gradle/testclusters/OpenSearchNode.java	0.00%	7 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #20229      +/-   ##
============================================
+ Coverage     72.82%   73.18%   +0.35%     
- Complexity    71315    71771     +456     
============================================
  Files          5795     5795              
  Lines        328297   328306       +9     
  Branches      47282    47283       +1     
============================================
+ Hits         239089   240276    +1187     
+ Misses        69893    68787    -1106     
+ Partials      19315    19243      -72

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

cwperks · 2025-12-15T03:30:13Z

        try (InputStream byteArrayInputStream = new ByteArrayInputStream(input.getBytes(StandardCharsets.UTF_8))) {
            LoggedExec.exec(project, spec -> {
                spec.setEnvironment(getOpenSearchEnvironment());
-                spec.workingDir(getDistroDir());


When is getDistroDir resolved to the gradle cache? Is that in instances when running integTest against a testcluster that is using the ARCHIVE distribution?

I'm wondering if we should start to remove the restrictions on copying only the transport modules in the INTEG_TEST distribution and then start a campaign across the plugins to use INTEG_TEST which always pulls the latest commit from core without pulling a min distribution though I'm not sure how that would impact test speed.

Let me try to dig up the comment about the distinction of ARCHIVE vs INTEG_TEST.

Here was the comment: opensearch-project/query-insights#441 (comment)

When is getDistroDir resolved to the gradle cache? Is that in instances when running integTest against a testcluster that is using the ARCHIVE distribution?

It's reproducible on main using ccr repo, so perhaps you can see if this change fixes it?

In any case, I'm not sure we want to execute in the distro dir and not the working dir...

Signed-off-by: Daniel Widdis <widdis@gmail.com>

github-actions · 2025-12-16T00:32:15Z

❌ Gradle check result for 149bcdb: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

opensearch-trigger-bot · 2026-02-08T15:23:59Z

This PR is stalled because it has been open for 30 days with no activity.

dbwiddis · 2026-02-15T16:52:21Z

Closing as this has been addressed by a different approach.

dbwiddis requested a review from a team as a code owner December 14, 2025 01:02

dbwiddis added the Build Build Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement. label Dec 14, 2025

github-actions bot added the bug Something isn't working label Dec 14, 2025

Fix working directory for OpenSearchNode to avoid executing in immuta…

35c5865

…ble Gradle cache directory Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis force-pushed the fix-working-dir branch from 0c0e7db to 35c5865 Compare December 14, 2025 01:12

dbwiddis mentioned this pull request Dec 14, 2025

[Backport main] [3.4] Prevent use of shared distribution on gradle builds #20228

Closed

cwperks reviewed Dec 15, 2025

View reviewed changes

This was referenced Dec 15, 2025

Ensure all modules are included in INTEG_TEST testcluster distribution #20241

Merged

[3.4] Ensure all modules are included in INTEG_TEST testcluster distribution #20243

Closed

Merge branch 'main' into fix-working-dir

149bcdb

Signed-off-by: Daniel Widdis <widdis@gmail.com>

dbwiddis added the v3.5.0 Issues and PRs related to version 3.5.0 label Dec 26, 2025

opensearch-trigger-bot bot added the stalled Issues that have stalled label Feb 8, 2026

dbwiddis closed this Feb 15, 2026

opensearch-ci-bot mentioned this pull request Mar 18, 2026

[AUTOCUT] Gradle Check Flaky Test Report for TransferManagerBlobContainerReaderTests #18872

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix OpenSearchNode working directory to avoid executing in immutable Gradle cache directory#20229

Fix OpenSearchNode working directory to avoid executing in immutable Gradle cache directory#20229
dbwiddis wants to merge 2 commits intoopensearch-project:mainfrom
dbwiddis:fix-working-dir

dbwiddis commented Dec 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 14, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Dec 14, 2025

Uh oh!

codecov bot commented Dec 14, 2025

Uh oh!

cwperks Dec 15, 2025

Uh oh!

cwperks Dec 15, 2025

Uh oh!

dbwiddis Dec 15, 2025

Uh oh!

github-actions bot commented Dec 16, 2025

Uh oh!

opensearch-trigger-bot bot commented Feb 8, 2026

Uh oh!

dbwiddis commented Feb 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

dbwiddis commented Dec 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

github-actions bot commented Dec 14, 2025

Uh oh!

codecov bot commented Dec 14, 2025

Codecov Report

Uh oh!

cwperks Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

cwperks Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

dbwiddis Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 16, 2025

Uh oh!

opensearch-trigger-bot bot commented Feb 8, 2026

Uh oh!

dbwiddis commented Feb 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dbwiddis commented Dec 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 14, 2025 •

edited

Loading