| // Copyright 2018 The Bazel Authors. All rights reserved. |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| package com.google.devtools.build.lib.skyframe; |
| |
| import static com.google.common.truth.Truth.assertThat; |
| import static com.google.devtools.build.lib.testutil.MoreAsserts.assertThrows; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.devtools.build.lib.actions.ActionInput; |
| import com.google.devtools.build.lib.actions.ActionInputHelper; |
| import com.google.devtools.build.lib.actions.ActionInputMap; |
| import com.google.devtools.build.lib.actions.Artifact; |
| import com.google.devtools.build.lib.actions.Artifact.SpecialArtifact; |
| import com.google.devtools.build.lib.actions.Artifact.SpecialArtifactType; |
| import com.google.devtools.build.lib.actions.Artifact.TreeFileArtifact; |
| import com.google.devtools.build.lib.actions.ArtifactPathResolver; |
| import com.google.devtools.build.lib.actions.ArtifactRoot; |
| import com.google.devtools.build.lib.actions.FileArtifactValue; |
| import com.google.devtools.build.lib.actions.FileArtifactValue.RemoteFileArtifactValue; |
| import com.google.devtools.build.lib.actions.FilesetOutputSymlink; |
| import com.google.devtools.build.lib.actions.HasDigest; |
| import com.google.devtools.build.lib.actions.HasDigest.ByteStringDigest; |
| import com.google.devtools.build.lib.actions.util.ActionsTestUtil; |
| import com.google.devtools.build.lib.testutil.Scratch; |
| import com.google.devtools.build.lib.vfs.PathFragment; |
| import com.google.devtools.build.lib.vfs.Root; |
| import java.io.FileNotFoundException; |
| import java.util.ArrayList; |
| import java.util.List; |
| import java.util.Map; |
| import org.junit.Before; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.junit.runners.JUnit4; |
| |
| /** Tests for {@link ActionMetadataHandler}. */ |
| @RunWith(JUnit4.class) |
| public class ActionMetadataHandlerTest { |
| private Scratch scratch; |
| private ArtifactRoot sourceRoot; |
| private ArtifactRoot outputRoot; |
| |
| @Before |
| public final void setRootDir() throws Exception { |
| scratch = new Scratch(); |
| sourceRoot = ArtifactRoot.asSourceRoot(Root.fromPath(scratch.dir("/workspace"))); |
| outputRoot = ArtifactRoot.asDerivedRoot(scratch.dir("/output"), scratch.dir("/output/bin")); |
| } |
| |
| @Test |
| public void withNonArtifactInput() throws Exception { |
| ActionInput input = ActionInputHelper.fromPath("foo/bar"); |
| FileArtifactValue metadata = |
| FileArtifactValue.createForNormalFile( |
| new byte[] {1, 2, 3}, /*proxy=*/ null, 10L, /*isShareable=*/ true); |
| ActionInputMap map = new ActionInputMap(1); |
| map.putWithNoDepOwner(input, metadata); |
| assertThat(map.getMetadata(input)).isEqualTo(metadata); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThat(handler.getMetadata(input)).isNull(); |
| } |
| |
| @Test |
| public void withArtifactInput() throws Exception { |
| PathFragment path = PathFragment.create("src/a"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(sourceRoot, path); |
| FileArtifactValue metadata = |
| FileArtifactValue.createForNormalFile( |
| new byte[] {1, 2, 3}, /*proxy=*/ null, 10L, /*isShareable=*/ true); |
| ActionInputMap map = new ActionInputMap(1); |
| map.putWithNoDepOwner(artifact, metadata); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThat(handler.getMetadata(artifact)).isEqualTo(metadata); |
| } |
| |
| @Test |
| public void withUnknownSourceArtifactAndNoMissingArtifactsAllowed() throws Exception { |
| PathFragment path = PathFragment.create("src/a"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(sourceRoot, path); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| IllegalStateException expected = |
| assertThrows(IllegalStateException.class, () -> handler.getMetadata(artifact)); |
| assertThat(expected).hasMessageThat().contains("null for "); |
| } |
| |
| @Test |
| public void withUnknownSourceArtifact() throws Exception { |
| PathFragment path = PathFragment.create("src/a"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(sourceRoot, path); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ true, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThat(handler.getMetadata(artifact)).isNull(); |
| } |
| |
| @Test |
| public void withUnknownOutputArtifactMissingAllowed() throws Exception { |
| PathFragment path = PathFragment.create("foo/bar"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(outputRoot, path); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ true, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThat(handler.getMetadata(artifact)).isNull(); |
| } |
| |
| @Test |
| public void withUnknownOutputArtifactStatsFile() throws Exception { |
| scratch.file("/output/bin/foo/bar", "not empty"); |
| Artifact artifact = ActionsTestUtil.createArtifact(outputRoot, "foo/bar"); |
| assertThat(artifact.getPath().exists()).isTrue(); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(artifact), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThat(handler.getMetadata(artifact)).isNotNull(); |
| } |
| |
| @Test |
| public void withUnknownOutputArtifactStatsFileFailsWithException() throws Exception { |
| Artifact artifact = ActionsTestUtil.createArtifact(outputRoot, "foo/bar"); |
| assertThat(artifact.getPath().exists()).isFalse(); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(artifact), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThrows(FileNotFoundException.class, () -> handler.getMetadata(artifact)); |
| } |
| |
| @Test |
| public void withUnknownOutputArtifactMissingDisallowed() throws Exception { |
| PathFragment path = PathFragment.create("foo/bar"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(outputRoot, path); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThrows(IllegalStateException.class, () -> handler.getMetadata(artifact)); |
| } |
| |
| @Test |
| public void withUnknownOutputArtifactMissingAllowedTreeArtifact() throws Exception { |
| PathFragment path = PathFragment.create("bin/foo/bar"); |
| SpecialArtifact treeArtifact = |
| new SpecialArtifact( |
| outputRoot, path, ActionsTestUtil.NULL_ARTIFACT_OWNER, SpecialArtifactType.TREE); |
| Artifact artifact = new TreeFileArtifact(treeArtifact, PathFragment.create("baz")); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ true, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThat(handler.getMetadata(artifact)).isNull(); |
| } |
| |
| @Test |
| public void withUnknownOutputArtifactStatsFileTreeArtifact() throws Exception { |
| scratch.file("/output/bin/foo/bar/baz", "not empty"); |
| PathFragment path = PathFragment.create("bin/foo/bar"); |
| SpecialArtifact treeArtifact = |
| new SpecialArtifact( |
| outputRoot, path, ActionsTestUtil.NULL_ARTIFACT_OWNER, SpecialArtifactType.TREE); |
| Artifact artifact = new TreeFileArtifact(treeArtifact, PathFragment.create("baz")); |
| assertThat(artifact.getPath().exists()).isTrue(); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(treeArtifact), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThat(handler.getMetadata(artifact)).isNotNull(); |
| } |
| |
| @Test |
| public void withUnknownOutputArtifactMissingDisallowedTreeArtifact() throws Exception { |
| PathFragment path = PathFragment.create("bin/foo/bar"); |
| SpecialArtifact treeArtifact = |
| new SpecialArtifact( |
| outputRoot, path, ActionsTestUtil.NULL_ARTIFACT_OWNER, SpecialArtifactType.TREE); |
| Artifact artifact = new TreeFileArtifact(treeArtifact, PathFragment.create("baz")); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| assertThrows(IllegalStateException.class, () -> handler.getMetadata(artifact)); |
| } |
| |
| @Test |
| public void withFilesetInput() throws Exception { |
| // This value should be mapped |
| FileArtifactValue directoryFav = FileArtifactValue.createForDirectoryWithMtime(10L); |
| // This value should not be mapped |
| FileArtifactValue regularFav = |
| FileArtifactValue.createForVirtualActionInput(new byte[] {1, 2, 3, 4}, 10L); |
| // This value should not be mapped |
| HasDigest.ByteStringDigest byteStringDigest = new ByteStringDigest(new byte[] {2, 3, 4}); |
| |
| ImmutableMap<Artifact, ImmutableList<FilesetOutputSymlink>> filesetMap = |
| createFilesetOutputSymlinkMap(directoryFav, regularFav, byteStringDigest); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| new ActionInputMap(0), |
| filesetMap, |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.forExecRoot(outputRoot.getRoot().asPath()), |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| |
| ImmutableMap<PathFragment, FileArtifactValue> filesetMapping = handler.getFilesetMapping(); |
| assertThat(filesetMapping).hasSize(1); |
| PathFragment filesetPathFragment = filesetMapping.keySet().iterator().next(); |
| assertThat(filesetPathFragment.getPathString()).isEqualTo("target/bytestring2"); |
| assertThat(filesetMapping.get(filesetPathFragment)).isEqualTo(regularFav); |
| } |
| |
| @Test |
| public void resettingOutputs() throws Exception { |
| scratch.file("/output/bin/foo/bar", "not empty"); |
| PathFragment path = PathFragment.create("foo/bar"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(outputRoot, path); |
| ActionInputMap map = new ActionInputMap(1); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| map, |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ true, |
| /* outputs= */ ImmutableList.of(artifact), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| handler.discardOutputMetadata(); |
| |
| // The handler doesn't have any info. It'll stat the file and discover that it's 10 bytes long. |
| assertThat(handler.getMetadata(artifact).getSize()).isEqualTo(10); |
| |
| // Inject a remote file of size 42. |
| handler.injectRemoteFile(artifact, new byte[] {1, 2, 3}, 42, 0); |
| assertThat(handler.getMetadata(artifact).getSize()).isEqualTo(42); |
| |
| // Reset this output, which will make the handler stat the file again. |
| handler.resetOutputs(ImmutableList.of(artifact)); |
| assertThat(handler.getMetadata(artifact).getSize()).isEqualTo(10); |
| } |
| |
| @Test |
| public void injectRemoteArtifactMetadata() throws Exception { |
| PathFragment path = PathFragment.create("foo/bar"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(outputRoot, path); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| /* inputArtifactData= */ new ActionInputMap(0), |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(artifact), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| new OutputStore(), |
| outputRoot.getRoot().asPath()); |
| handler.discardOutputMetadata(); |
| |
| byte[] digest = new byte[] {1, 2, 3}; |
| int size = 10; |
| handler.injectRemoteFile(artifact, digest, size, /* locationIndex= */ 1); |
| |
| FileArtifactValue v = handler.getMetadata(artifact); |
| assertThat(v).isNotNull(); |
| assertThat(v.getDigest()).isEqualTo(digest); |
| assertThat(v.getSize()).isEqualTo(size); |
| } |
| |
| @Test |
| public void injectRemoteTreeArtifactMetadata() throws Exception { |
| PathFragment path = PathFragment.create("bin/dir"); |
| SpecialArtifact treeArtifact = |
| new SpecialArtifact( |
| outputRoot, path, ActionsTestUtil.NULL_ARTIFACT_OWNER, SpecialArtifactType.TREE); |
| treeArtifact.setGeneratingActionKey(ActionsTestUtil.NULL_ACTION_LOOKUP_DATA); |
| OutputStore store = new OutputStore(); |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| /* inputArtifactData= */ new ActionInputMap(0), |
| ImmutableMap.of(), |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(treeArtifact), |
| /* tsgm= */ null, |
| ArtifactPathResolver.IDENTITY, |
| store, |
| outputRoot.getRoot().asPath()); |
| handler.discardOutputMetadata(); |
| |
| RemoteFileArtifactValue fooValue = new RemoteFileArtifactValue(new byte[] {1, 2, 3}, 5, 1); |
| RemoteFileArtifactValue barValue = new RemoteFileArtifactValue(new byte[] {4, 5, 6}, 10, 1); |
| Map<PathFragment, RemoteFileArtifactValue> children = |
| ImmutableMap.<PathFragment, RemoteFileArtifactValue>builder() |
| .put(PathFragment.create("foo"), fooValue) |
| .put(PathFragment.create("bar"), barValue) |
| .build(); |
| |
| handler.injectRemoteDirectory(treeArtifact, children); |
| |
| FileArtifactValue value = handler.getMetadata(treeArtifact); |
| assertThat(value).isNotNull(); |
| TreeArtifactValue treeValue = store.getTreeArtifactData(treeArtifact); |
| assertThat(treeValue).isNotNull(); |
| assertThat(treeValue.getDigest()).isEqualTo(value.getDigest()); |
| |
| assertThat(treeValue.getChildPaths()) |
| .containsExactly(PathFragment.create("foo"), PathFragment.create("bar")); |
| assertThat(treeValue.getChildValues().values()).containsExactly(fooValue, barValue); |
| } |
| |
| @Test |
| public void getMetadataFromFilesetMapping() throws Exception { |
| FileArtifactValue directoryFav = FileArtifactValue.createForDirectoryWithMtime(10L); |
| FileArtifactValue regularFav = |
| FileArtifactValue.createForVirtualActionInput(new byte[] {1, 2, 3, 4}, 10L); |
| HasDigest.ByteStringDigest byteStringDigest = new ByteStringDigest(new byte[] {2, 3, 4}); |
| |
| ImmutableMap<Artifact, ImmutableList<FilesetOutputSymlink>> filesetMap = |
| createFilesetOutputSymlinkMap(directoryFav, regularFav, byteStringDigest); |
| |
| ActionMetadataHandler handler = |
| new ActionMetadataHandler( |
| new ActionInputMap(0), |
| filesetMap, |
| /* missingArtifactsAllowed= */ false, |
| /* outputs= */ ImmutableList.of(), |
| /* tsgm= */ null, |
| ArtifactPathResolver.forExecRoot(outputRoot.getRoot().asPath()), |
| new MinimalOutputStore(), |
| outputRoot.getRoot().asPath()); |
| |
| assertThat(handler.getMetadata(ActionInputHelper.fromPath("/output/bin/target/bytestring1"))) |
| .isNull(); |
| assertThat(handler.getMetadata(ActionInputHelper.fromPath("/output/bin/target/bytestring2"))) |
| .isEqualTo(regularFav); |
| assertThat(handler.getMetadata(ActionInputHelper.fromPath("/output/bin/target/bytestring3"))) |
| .isNull(); |
| assertThat(handler.getMetadata(ActionInputHelper.fromPath("/does/not/exist"))).isNull(); |
| } |
| |
| private ImmutableMap<Artifact, ImmutableList<FilesetOutputSymlink>> createFilesetOutputSymlinkMap( |
| HasDigest... digests) { |
| int index = 1; |
| PathFragment execRoot = outputRoot.getExecPath(); |
| List<FilesetOutputSymlink> symlinks = new ArrayList<>(); |
| for (HasDigest digest : digests) { |
| symlinks.add( |
| FilesetOutputSymlink.create( |
| PathFragment.create("test/bytestring" + index), |
| PathFragment.create("target/bytestring" + index++), |
| digest, |
| true, |
| execRoot)); |
| } |
| |
| PathFragment path = PathFragment.create("foo/bar"); |
| Artifact artifact = ActionsTestUtil.createArtifactWithRootRelativePath(outputRoot, path); |
| return ImmutableMap.of(artifact, ImmutableList.copyOf(symlinks)); |
| } |
| } |