Improve test coverage of remote worker files

[visz11]

Adds a runfiles tree to the input and also runs the test with path mapping enabled.

Summary by CodeRabbit

• Tests
  • Enhanced test coverage for remote persistent worker actions, including parameterized path mapping scenarios and additional assertions on runfiles trees and tool input handling.

[visz11]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

Walkthrough

The changes introduce a new dependency to the test build configuration, specifically adding TestConstants to the RemoteTests_lib target. In the test code, the method buildRemoteActionForRemotePersistentWorkers is updated to accept a boolean parameter for enabling path mapping, and the test logic is extended to handle an additional tool artifact and runfiles tree. The test now conditionally applies path mapping, updates assertions to reflect different expected values based on path mapping, and refines how runfiles paths are constructed by incorporating the workspace name.

Changes

File(s)	Change Summary
src/test/java/com/google/devtools/build/lib/remote/BUILD	Added //src/test/java/com/google/devtools/build/lib/testutil:TestConstants as a dependency to the RemoteTests_lib target.
src/test/java/com/google/devtools/build/lib/remote/RemoteExecutionServiceTest.java	Modified the test method buildRemoteActionForRemotePersistentWorkers to accept a boolean parameter for path mapping. Added logic for an extra tool artifact and runfiles tree. Updated assertions and Merkle tree checks to reflect changes in tool inputs and path mapping. The runfiles path mapping now includes the workspace name using TestConstants.WORKSPACE_NAME.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant RemoteExecutionServiceTest
    participant Spawn
    participant PathMapper
    participant MerkleTree

    TestRunner->>RemoteExecutionServiceTest: buildRemoteActionForRemotePersistentWorkers(enablePathMapping)
    RemoteExecutionServiceTest->>Spawn: Create spawn with inputs, tools, runfiles tree
    alt enablePathMapping is true
        RemoteExecutionServiceTest->>PathMapper: Apply prefix mapping to paths
    else enablePathMapping is false
        RemoteExecutionServiceTest->>PathMapper: No-op mapping
    end
    RemoteExecutionServiceTest->>MerkleTree: Build Merkle tree including runfiles and tool
    RemoteExecutionServiceTest->>RemoteExecutionServiceTest: Assert persistent worker key and Merkle structure

Loading

Poem

In the warren of tests, a new path appears,
With tools and runfiles, the logic now steers.
A workspace name hops into runfiles with glee,
While mapping or not, the assertions agree.
With dependencies fresh and mappings anew,
This bunny’s delighted with all that you do!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ast-grep (0.31.1)

src/test/java/com/google/devtools/build/lib/remote/RemoteExecutionServiceTest.java

---

📜 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 c0c98a2 and cdf6784.

📒 Files selected for processing (2)

• src/test/java/com/google/devtools/build/lib/remote/BUILD (1 hunks)
• src/test/java/com/google/devtools/build/lib/remote/RemoteExecutionServiceTest.java (7 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/test/java/com/google/devtools/build/lib/remote/RemoteExecutionServiceTest.java (2)

src/test/java/com/google/devtools/build/lib/testutil/TestConstants.java (1)

• TestConstants (24-174)

src/test/java/com/google/devtools/build/lib/actions/util/ActionsTestUtil.java (1)

• ActionsTestUtil (118-1015)

🔇 Additional comments (9)

src/test/java/com/google/devtools/build/lib/remote/BUILD (1)

152-152: Appropriate addition of TestConstants dependency.

This dependency is needed to access TestConstants.WORKSPACE_NAME in the RemoteExecutionServiceTest for constructing proper runfiles paths.

src/test/java/com/google/devtools/build/lib/remote/RemoteExecutionServiceTest.java (8)

122-122: Appropriate import for TestConstants.

This import is necessary to access the WORKSPACE_NAME constant used in the modified test.

---

2331-2332: Good test enhancement with parameterization.

Adding the boolean parameter enablePathMapping is a good approach to test both with and without path mapping enabled, increasing test coverage.

---

2338-2344: Good addition of runfiles tree to test inputs.

Adding the tool.dat artifact and corresponding runfiles tree correctly simulates the environment for remote worker files, improving test fidelity.

---

2349-2352: Well-implemented conditional path mapping.

The updated test now properly includes runfiles artifacts as inputs and tools and conditionally applies path mapping based on the test parameter.

---

2367-2370: Appropriate hash value updates for path mapping.

The hash values differ appropriately when path mapping is enabled vs. disabled, correctly reflecting how the persistent worker key would change.

---

2394-2442: Thorough Merkle tree structure verification.

The added assertions thoroughly verify the structure of the Merkle tree, including checking for the presence of the runfiles directory, nested directories, and proper file properties.

---

2454-2455: Consistent hash values for path mapping in verification.

The hash values for verification are consistently updated to match the values when path mapping is enabled or disabled.

Also applies to: 2468-2469

---

2754-2760: Improved runfiles path construction with workspace name.

The modification to prepend the workspace name to the runfiles path more accurately reflects how runfiles paths are constructed in the actual system, improving test accuracy.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.