Skip to content

Commit

Permalink
Make it possible to retrieve a TreeArtifactValue from an ActionInputMap.
Browse files Browse the repository at this point in the history 
This will be needed by bazelbuild#16283.

PiperOrigin-RevId: 481921235
Change-Id: I619bdbee25b7465ce2e6ad3e384e1ce414d2e770
  • Loading branch information
@tjgq @copybara-github
tjgq authored and copybara-github committed Oct 18, 2022
1 parent 4eb0cc8 commit 8d76ef1
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 32 deletions.
17 changes: 17 additions & 0 deletions src/main/java/com/google/devtools/build/lib/actions/ActionInputMap.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,23 @@ private FileArtifactValue getMetadataFromTreeArtifacts(PathFragment execPath) {
return entry != null ? entry.getValue() : null;
}

/**
* Returns the {@link TreeArtifactValue} for the given path, or {@code null} if no such tree
* artifact exists.
*/
@Nullable
public TreeArtifactValue getTreeMetadata(PathFragment execPath) {
int index = getIndex(execPath.getPathString());
if (index < 0) {
return null;
}
Object value = values[index];
if (!(value instanceof TrieArtifact)) {
return null;
}
return ((TrieArtifact) value).treeArtifactValue;
}

@Nullable
@Override
public ActionInput getInput(String execPathString) {
Expand Down
74 changes: 42 additions & 32 deletions src/test/java/com/google/devtools/build/lib/actions/ActionInputMapTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// limitations under the License.
package com.google.devtools.build.lib.actions;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.US_ASCII;
import static org.junit.Assert.assertThrows;
Expand Down Expand Up @@ -112,7 +113,7 @@ public void putTreeArtifact_addsEmptyTreeArtifact() {
map.putTreeArtifact(tree, TreeArtifactValue.empty(), /*depOwner=*/ null);

assertThat(map.sizeForDebugging()).isEqualTo(1);
assertContainsEqualMetadata(tree, TreeArtifactValue.empty().getMetadata());
assertContainsTree(tree, TreeArtifactValue.empty());
}

@Test
Expand All @@ -131,9 +132,9 @@ public void putTreeArtifact_addsTreeArtifactAndAllChildren() {
map.putTreeArtifact(tree, treeValue, /*depOwner=*/ null);

assertThat(map.sizeForDebugging()).isEqualTo(1);
assertContainsEqualMetadata(tree, treeValue.getMetadata());
assertContainsSameInstance(child1, child1Metadata);
assertContainsSameInstance(child2, child2Metadata);
assertContainsTree(tree, treeValue);
assertContainsFile(child1, child1Metadata);
assertContainsFile(child2, child2Metadata);
}

@Test
Expand All @@ -149,9 +150,9 @@ public void putTreeArtifact_mixedTreeAndFiles_addsTreeAndChildren() {

map.putTreeArtifact(tree, treeValue, /*depOwner=*/ null);

assertContainsEqualMetadata(tree, treeValue.getMetadata());
assertContainsSameInstance(child, childMetadata);
assertContainsSameInstance(file, fileMetadata);
assertContainsTree(tree, treeValue);
assertContainsFile(child, childMetadata);
assertContainsFile(file, fileMetadata);
}

@Test
Expand All @@ -170,10 +171,10 @@ public void putTreeArtifact_multipleTrees_addsAllTreesAndChildren() {
map.putTreeArtifact(tree1, tree1Value, /*depOwner=*/ null);
map.putTreeArtifact(tree2, tree2Value, /*depOwner=*/ null);

assertContainsEqualMetadata(tree1, tree1Value.getMetadata());
assertContainsSameInstance(tree1Child, tree1ChildMetadata);
assertContainsEqualMetadata(tree2, tree2Value.getMetadata());
assertContainsSameInstance(tree2Child, tree2ChildMetadata);
assertContainsTree(tree1, tree1Value);
assertContainsFile(tree1Child, tree1ChildMetadata);
assertContainsTree(tree2, tree2Value);
assertContainsFile(tree2Child, tree2ChildMetadata);
}

@Test
Expand All @@ -186,24 +187,28 @@ public void putTreeArtifact_multipleTreesUnderSameDirectory_addsAllTrees() {
map.putTreeArtifact(tree2, TreeArtifactValue.empty(), /*depOwner=*/ null);
map.putTreeArtifact(tree3, TreeArtifactValue.empty(), /*depOwner=*/ null);

assertThat(map.getInput(tree1.getExecPathString())).isEqualTo(tree1);
assertThat(map.getInput(tree2.getExecPathString())).isEqualTo(tree2);
assertThat(map.getInput(tree3.getExecPathString())).isEqualTo(tree3);
assertContainsTree(tree1, TreeArtifactValue.empty());
assertContainsTree(tree2, TreeArtifactValue.empty());
assertContainsTree(tree3, TreeArtifactValue.empty());
}

@Test
public void putTreeArtifact_afterPutTreeArtifactWithSameExecPath_doesNothing() {
SpecialArtifact tree1 = createTreeArtifact("tree");
SpecialArtifact tree2 = createTreeArtifact("tree");
TreeFileArtifact tree2File = TreeFileArtifact.createTreeOutput(tree2, "file");
TreeArtifactValue tree1Value = TreeArtifactValue.empty();
TreeArtifactValue tree2Value =
TreeArtifactValue.newBuilder(tree2).putChild(tree2File, TestMetadata.create(1)).build();
map.putTreeArtifact(tree1, TreeArtifactValue.empty(), /*depOwner=*/ null);
map.putTreeArtifact(tree1, tree1Value, /*depOwner=*/ null);

map.putTreeArtifact(tree2, tree2Value, /*depOwner=*/ null);

assertContainsEqualMetadata(tree1, TreeArtifactValue.empty().getMetadata());
assertThat(map.getMetadata(tree2)).isEqualTo(TreeArtifactValue.empty().getMetadata());
assertContainsTree(tree1, tree1Value);
// Cannot assertContainsTree since the execpath will point to tree1 instead.
assertThat(map.getMetadata(tree2)).isEqualTo(tree1Value.getMetadata());
assertThat(map.getTreeMetadata(tree2.getExecPath())).isSameInstanceAs(tree1Value);
assertThat(map.getInput(tree2.getExecPathString())).isSameInstanceAs(tree1);
assertDoesNotContain(tree2File);
}

Expand Down Expand Up @@ -279,13 +284,10 @@ public void putTreeArtifact_nestedTree_returnsOuterEntriesForOverlappingFiles(
() -> map.putTreeArtifact(tree, treeValue, /*depOwner=*/ null),
() -> map.putTreeArtifact(nestedTree, nestedTreeValue, /*depOwner=*/ null));

assertContainsEqualMetadata(tree, treeValue.getMetadata());
assertContainsEqualMetadata(nestedTree, nestedTreeValue.getMetadata());
assertThat(map.getMetadata(treeFile)).isSameInstanceAs(treeFileMetadata);
assertThat(map.getMetadata(nestedTreeFile)).isSameInstanceAs(nestedTreeFileMetadata);
assertThat(map.getMetadata(treeFile.getExecPath())).isSameInstanceAs(treeFileMetadata);
assertThat(map.getInput(treeFile.getExecPathString())).isSameInstanceAs(treeFile);
assertContainsSameInstance(onlyOuterTreeFile, onlyOuterTreeFileMetadata);
assertContainsTree(tree, treeValue);
assertContainsTree(nestedTree, nestedTreeValue);
assertContainsFile(treeFile, treeFileMetadata);
assertContainsFile(onlyOuterTreeFile, onlyOuterTreeFileMetadata);
}

@Test
Expand All @@ -294,7 +296,10 @@ public void putTreeArtifact_omittedTree_addsEntryWithNoChildren() {

map.putTreeArtifact(tree, TreeArtifactValue.OMITTED_TREE_MARKER, /*depOwner=*/ null);

assertContainsSameInstance(tree, FileArtifactValue.OMITTED_FILE_MARKER);
// Cannot assertContainsTree since TreeArtifactValue#getMetadata throws for OMITTED_TREE_MARKER.
assertThat(map.getMetadata(tree)).isSameInstanceAs(FileArtifactValue.OMITTED_FILE_MARKER);
assertThat(map.getMetadata(tree.getExecPath()))
.isSameInstanceAs(FileArtifactValue.OMITTED_FILE_MARKER);
}

@Test
Expand All @@ -305,7 +310,7 @@ public void put_treeFileArtifact_addsEntry() {

map.put(treeFile, metadata, /*depOwner=*/ null);

assertContainsSameInstance(treeFile, metadata);
assertContainsFile(treeFile, metadata);
}

@Test
Expand Down Expand Up @@ -463,18 +468,23 @@ private void assertContains(String execPath, int value) {
private void assertDoesNotContain(ActionInput input) {
assertThat(map.getMetadata(input)).isNull();
assertThat(map.getMetadata(input.getExecPath())).isNull();
assertThat(map.getTreeMetadata(input.getExecPath())).isNull();
assertThat(map.getInput(input.getExecPathString())).isNull();
}

private void assertContainsEqualMetadata(ActionInput input, FileArtifactValue metadata) {
assertThat(map.getMetadata(input)).isEqualTo(metadata);
assertThat(map.getMetadata(input.getExecPath())).isEqualTo(metadata);
private void assertContainsFile(ActionInput input, FileArtifactValue fileValue) {
checkArgument(!(input instanceof SpecialArtifact), "use assertContainsTree for tree artifacts");
assertThat(map.getMetadata(input)).isSameInstanceAs(fileValue);
assertThat(map.getMetadata(input.getExecPath())).isSameInstanceAs(fileValue);
assertThat(map.getTreeMetadata(input.getExecPath())).isNull();
assertThat(map.getInput(input.getExecPathString())).isSameInstanceAs(input);
}

private void assertContainsSameInstance(ActionInput input, FileArtifactValue metadata) {
assertThat(map.getMetadata(input)).isSameInstanceAs(metadata);
assertThat(map.getMetadata(input.getExecPath())).isSameInstanceAs(metadata);
private void assertContainsTree(SpecialArtifact input, TreeArtifactValue treeValue) {
// TreeArtifactValue#getMetadata returns a freshly allocated instance.
assertThat(map.getMetadata(input)).isEqualTo(treeValue.getMetadata());
assertThat(map.getMetadata(input.getExecPath())).isEqualTo(treeValue.getMetadata());
assertThat(map.getTreeMetadata(input.getExecPath())).isSameInstanceAs(treeValue);
assertThat(map.getInput(input.getExecPathString())).isSameInstanceAs(input);
}

Expand Down

0 comments on commit 8d76ef1

Please sign in to comment.