Skip to content

Improve test coverage of remote worker files #2

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve test coverage of remote worker files #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86fd20a
Update BUILD
visz11 Apr 15, 2025
cdf6784
Make runfiles handling more realistic and Improve test coverage of re…
visz11 Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/test/java/com/google/devtools/build/lib/remote/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ java_library(
"//src/test/java/com/google/devtools/build/lib/exec/util",
"//src/test/java/com/google/devtools/build/lib/remote/util",
"//src/test/java/com/google/devtools/build/lib/testutil",
"//src/test/java/com/google/devtools/build/lib/testutil:TestConstants",
"//src/test/java/com/google/devtools/build/lib/testutil:TestUtils",
"//third_party:auth",
"//third_party:caffeine",
Expand Down
88 changes: 80 additions & 8 deletions src/test/java/com/google/devtools/build/lib/remote/RemoteExecutionServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@
import com.google.devtools.build.lib.remote.util.TracingMetadataUtils;
import com.google.devtools.build.lib.remote.util.Utils.InMemoryOutput;
import com.google.devtools.build.lib.skyframe.TreeArtifactValue;
import com.google.devtools.build.lib.testutil.TestConstants;
import com.google.devtools.build.lib.util.Fingerprint;
import com.google.devtools.build.lib.util.OS;
import com.google.devtools.build.lib.util.TempPathGenerator;
Expand Down Expand Up @@ -2327,16 +2328,28 @@ public void buildMerkleTree_withMemoization_works() throws Exception {
}
Copy link

Choose a reason for hiding this comment

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

Test Design: This test method has grown quite large (over 100 lines) and now handles multiple test scenarios with the new enablePathMapping parameter. Consider breaking it down into smaller, more focused test methods for better readability and maintainability. This would make failures more specific and easier to debug.

Copy link

Choose a reason for hiding this comment

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

Test Naming: Now that this test method accepts a parameter to test different scenarios (with and without path mapping), consider renaming it to better reflect its parameterized nature. A name like buildRemoteActionForRemotePersistentWorkersWithPathMapping would more clearly communicate the test's purpose.


@Test
public void buildRemoteActionForRemotePersistentWorkers() throws Exception {
public void buildRemoteActionForRemotePersistentWorkers(@TestParameter boolean enablePathMapping)
throws Exception {
var input = ActionsTestUtil.createArtifact(artifactRoot, "input");
fakeFileCache.createScratchInput(input, "value");
var toolInput = ActionsTestUtil.createArtifact(artifactRoot, "worker_input");
fakeFileCache.createScratchInput(toolInput, "worker value");

Artifact toolDat = ActionsTestUtil.createArtifact(artifactRoot, "tool.dat");
fakeFileCache.createScratchInput(toolDat, "tool.dat");
RunfilesTree runfilesTree =
createRunfilesTree("outputs/worker_input.runfiles", ImmutableList.of(toolDat));
ActionInput runfilesArtifact =
ActionsTestUtil.createRunfilesArtifact(artifactRoot, "outputs/worker_input.runfiles");
fakeFileCache.addRunfilesTree(runfilesArtifact, runfilesTree);

Spawn spawn =
new SpawnBuilder("@flagfile")
.withExecutionInfo(ExecutionRequirements.SUPPORTS_WORKERS, "1")
.withInputs(input, toolInput)
.withTool(toolInput)
.withInputs(input, toolInput, runfilesArtifact)
.withTools(toolInput, runfilesArtifact)
.setPathMapper(
enablePathMapping ? path -> PathFragment.create("mapped_" + path) : PathMapper.NOOP)
.build();
FakeSpawnExecutionContext context = newSpawnExecutionContext(spawn);
remoteOptions.markToolInputs = true;
Expand All @@ -2352,7 +2365,9 @@ public void buildRemoteActionForRemotePersistentWorkers() throws Exception {
Platform.Property.newBuilder()
.setName("persistentWorkerKey")
.setValue(
"628637504c26bb74fb6bb3f60fb7132b3aa574b866db4181770774882a8853e5"))
enablePathMapping
? "85e3ad12f36ccb7b5eddbfe8f6bc28f57004634c537faac32d33a30b8d456bb8"
: "5b1f31685d47bab5267d65bf671a682a486240ae351d74130a12d452190bd5f3"))
.build());
var merkleTree = remoteAction.getMerkleTree();
var outputDirectory =
Expand All @@ -2376,8 +2391,55 @@ public void buildRemoteActionForRemotePersistentWorkers() throws Exception {
.setNodeProperties(
NodeProperties.newBuilder()
.addProperties(NodeProperty.newBuilder().setName("bazel_tool_input")));
var toolRunfilesDirectoryDigest =
Digest.newBuilder()
.setHash("d5cf7403c6b6c97f7b404c829a3d70c618412411c4554ed29b0f59815c53d952")
.setSizeBytes(79)
.build();
var toolRunfilesDirectory =
DirectoryNode.newBuilder()
.setName("worker_input.runfiles")
.setDigest(toolRunfilesDirectoryDigest);
assertThat(outputDirectory)
.isEqualTo(Directory.newBuilder().addFiles(inputFile).addFiles(toolFile).build());
.isEqualTo(
Directory.newBuilder()
.addFiles(inputFile)
.addFiles(toolFile)
.addDirectories(toolRunfilesDirectory)
.build());
var runfilesDirectory = merkleTree.getDirectoryByDigest(toolRunfilesDirectoryDigest);
var runfilesSubdirectoryDigest =
Digest.newBuilder()
.setHash("2773ed2d89aed9db55b83230eb8c66f56a02884e151009a3b070164bb6800cc8")
.setSizeBytes(106)
.build();
assertThat(runfilesDirectory)
.isEqualTo(
Directory.newBuilder()
.addDirectories(
DirectoryNode.newBuilder()
.setName(TestConstants.WORKSPACE_NAME)
.setDigest(runfilesSubdirectoryDigest))
.build());
var runfilesSubdirectory = merkleTree.getDirectoryByDigest(runfilesSubdirectoryDigest);
assertThat(runfilesSubdirectory)
.isEqualTo(
Directory.newBuilder()
.addFiles(
FileNode.newBuilder()
.setName("tool.dat")
.setDigest(
Digest.newBuilder()
.setHash(
"968b7e2e112917824f4ea807dbc3adeebc00de2836f98c68418f525295f9a0c1")
.setSizeBytes(8))
.setIsExecutable(true)
.setNodeProperties(
NodeProperties.newBuilder()
.addProperties(
NodeProperty.newBuilder().setName("bazel_tool_input")))
.build())
.build());

// Check that if an non-tool input changes, the persistent worker key does not change.
fakeFileCache.createScratchInput(input, "value2");
Expand All @@ -2388,7 +2450,9 @@ public void buildRemoteActionForRemotePersistentWorkers() throws Exception {
Platform.Property.newBuilder()
.setName("persistentWorkerKey")
.setValue(
"628637504c26bb74fb6bb3f60fb7132b3aa574b866db4181770774882a8853e5"))
enablePathMapping
? "85e3ad12f36ccb7b5eddbfe8f6bc28f57004634c537faac32d33a30b8d456bb8"
: "5b1f31685d47bab5267d65bf671a682a486240ae351d74130a12d452190bd5f3"))
.build());

// Check that if a tool input changes, the persistent worker key changes.
Expand All @@ -2400,7 +2464,9 @@ public void buildRemoteActionForRemotePersistentWorkers() throws Exception {
Platform.Property.newBuilder()
.setName("persistentWorkerKey")
.setValue(
"98e07ff5afc8f4d127e93d326c87c132f89cfd009517422671e6abec2fe05e2b"))
enablePathMapping
? "6667700b8ff75e77f50c0d6b471e9052c856a21648c8204f0772fc455df6d6dc"
: "63335231cbbf2ff838acdd19da768ce6524e929c4dcedcdce77c822a480fa49b"))
.build());
}

Expand Down Expand Up @@ -2685,7 +2751,13 @@ public PathFragment getExecPath() {
@Override
Copy link

Choose a reason for hiding this comment

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

Code Complexity: This lambda expression contains nested method calls spanning multiple lines, making it difficult to understand at a glance. Consider extracting this mapping logic to a named helper method to improve readability and make the intent clearer.

public SortedMap<PathFragment, Artifact> getMapping() {
return artifacts.stream()
.collect(toImmutableSortedMap(naturalOrder(), Artifact::getExecPath, identity()));
.collect(
toImmutableSortedMap(
naturalOrder(),
artifact ->
PathFragment.create(TestConstants.WORKSPACE_NAME)
.getRelative(artifact.getRunfilesPath()),
identity()));
}

@Override
Expand Down