diff options
8 files changed, 262 insertions, 72 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidAssets.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidAssets.java index ffed91b2ae..f7e0273694 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidAssets.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidAssets.java @@ -13,6 +13,7 @@ // limitations under the License. package com.google.devtools.build.lib.rules.android; +import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Preconditions; import com.google.common.collect.ImmutableList; import com.google.devtools.build.lib.actions.Artifact; @@ -24,9 +25,10 @@ import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTa import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException; import com.google.devtools.build.lib.syntax.Type; import com.google.devtools.build.lib.vfs.PathFragment; +import java.util.Objects; /** Wraps this target's Android assets */ -public final class AndroidAssets { +public class AndroidAssets { private static final String ASSETS_ATTR = "assets"; private static final String ASSETS_DIR_ATTR = "assets_dir"; @@ -64,7 +66,8 @@ public final class AndroidAssets { PathFragment path = file.getExecPath(); assetRoots.add(path.subFragment(0, path.segmentCount() - relativePath.segmentCount())); } else { - ruleContext.attributeError(ASSETS_ATTR, + ruleContext.attributeError( + ASSETS_ATTR, String.format( "'%s' (generated by '%s') is not beneath '%s'", file.getRootRelativePath(), target.getLabel(), assetsDir)); @@ -103,7 +106,12 @@ public final class AndroidAssets { private final ImmutableList<Artifact> assets; private final ImmutableList<PathFragment> assetRoots; - private AndroidAssets(ImmutableList<Artifact> assets, ImmutableList<PathFragment> assetRoots) { + AndroidAssets(AndroidAssets other) { + this(other.assets, other.assetRoots); + } + + @VisibleForTesting + AndroidAssets(ImmutableList<Artifact> assets, ImmutableList<PathFragment> assetRoots) { this.assets = assets; this.assetRoots = assetRoots; } @@ -115,4 +123,23 @@ public final class AndroidAssets { public ImmutableList<PathFragment> getAssetRoots() { return assetRoots; } + + public ParsedAndroidAssets parse(RuleContext ruleContext) throws InterruptedException { + return ParsedAndroidAssets.parseFrom(ruleContext, this); + } + + @Override + public boolean equals(Object object) { + if (object == null || getClass() != object.getClass()) { + return false; + } + + AndroidAssets other = (AndroidAssets) object; + return assets.equals(other.assets) && assetRoots.equals(other.assetRoots); + } + + @Override + public int hashCode() { + return Objects.hash(assets, assetRoots); + } } diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourceParsingActionBuilder.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourceParsingActionBuilder.java index 3a6c71f1ee..a3bd4773d6 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourceParsingActionBuilder.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourceParsingActionBuilder.java @@ -205,6 +205,13 @@ public class AndroidResourceParsingActionBuilder { androidResources, output, compiledSymbols, ruleContext.getLabel(), manifest); } + public ParsedAndroidAssets build(AndroidAssets assets) { + setAssets(assets); + build(ruleContext); + + return ParsedAndroidAssets.of(assets, output, ruleContext.getLabel()); + } + /** * Builds and registers the action, and updates the given resourceContainer with the output * symbols. diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java index 72395e1d81..433fc7f562 100644 --- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java +++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidRuleClasses.java @@ -136,6 +136,8 @@ public final class AndroidRuleClasses { fromTemplates("%{name}_symbols/local.bin"); public static final SafeImplicitOutputsFunction ANDROID_MERGED_SYMBOLS = fromTemplates("%{name}_symbols/merged.bin"); + public static final SafeImplicitOutputsFunction ANDROID_ASSET_SYMBOLS = + fromTemplates("%{name}_symbols/assets.bin"); public static final SafeImplicitOutputsFunction ANDROID_COMPILED_SYMBOLS = fromTemplates("%{name}_symbols/symbols.zip"); public static final SafeImplicitOutputsFunction ANDROID_SYMLINKED_MANIFEST = diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/ParsedAndroidAssets.java b/src/main/java/com/google/devtools/build/lib/rules/android/ParsedAndroidAssets.java new file mode 100644 index 0000000000..6a83642483 --- /dev/null +++ b/src/main/java/com/google/devtools/build/lib/rules/android/ParsedAndroidAssets.java @@ -0,0 +1,67 @@ +// 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.rules.android; + +import com.google.devtools.build.lib.actions.Artifact; +import com.google.devtools.build.lib.analysis.RuleContext; +import com.google.devtools.build.lib.cmdline.Label; +import java.util.Objects; + +/** Parsed Android assets which can be merged together with assets from dependencies. */ +public class ParsedAndroidAssets extends AndroidAssets implements MergableAndroidData { + private final Artifact symbols; + private final Label label; + + public static ParsedAndroidAssets parseFrom(RuleContext ruleContext, AndroidAssets assets) + throws InterruptedException { + return new AndroidResourceParsingActionBuilder(ruleContext) + .setOutput(ruleContext.getImplicitOutputArtifact(AndroidRuleClasses.ANDROID_ASSET_SYMBOLS)) + .build(assets); + } + + public static ParsedAndroidAssets of(AndroidAssets assets, Artifact symbols, Label label) { + return new ParsedAndroidAssets(assets, symbols, label); + } + + private ParsedAndroidAssets(AndroidAssets other, Artifact symbols, Label label) { + super(other); + this.symbols = symbols; + this.label = label; + } + + @Override + public Label getLabel() { + return label; + } + + @Override + public Artifact getSymbols() { + return symbols; + } + + @Override + public boolean equals(Object object) { + if (!super.equals(object)) { + return false; + } + + ParsedAndroidAssets other = (ParsedAndroidAssets) object; + return symbols.equals(other.symbols) && label.equals(other.label); + } + + @Override + public int hashCode() { + return Objects.hash(super.hashCode(), symbols, label); + } +} diff --git a/src/test/java/com/google/devtools/build/lib/rules/android/AndroidAssetsTest.java b/src/test/java/com/google/devtools/build/lib/rules/android/AndroidAssetsTest.java new file mode 100644 index 0000000000..401443d3b5 --- /dev/null +++ b/src/test/java/com/google/devtools/build/lib/rules/android/AndroidAssetsTest.java @@ -0,0 +1,56 @@ +// 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.rules.android; + +import static com.google.common.truth.Truth.assertThat; + +import com.google.common.collect.ImmutableList; +import com.google.devtools.build.lib.analysis.RuleContext; +import com.google.devtools.build.lib.vfs.PathFragment; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +/** Tests {@link AndroidAssets} */ +@RunWith(JUnit4.class) +public class AndroidAssetsTest extends ResourceTestBase { + @Test + public void testParse() throws Exception { + RuleContext ruleContext = getRuleContext(); + AndroidAssets assets = + new AndroidAssets( + ImmutableList.of(getResource("asset_1"), getResource("asset_2")), + ImmutableList.of(PathFragment.create("asset_dir"))); + ParsedAndroidAssets parsed = assets.parse(ruleContext); + + // Assets should be unchanged + assertThat(parsed.getAssets()).isEqualTo(assets.getAssets()); + assertThat(parsed.getAssetRoots()).isEqualTo(assets.getAssetRoots()); + + // Label should be correct + assertThat(parsed.getLabel()).isEqualTo(ruleContext.getLabel()); + + // Symbols file should be created from raw assets + assertActionArtifacts( + ruleContext, + /* inputs = */ assets.getAssets(), + /* outputs = */ ImmutableList.of(parsed.getSymbols())); + } + + private RuleContext getRuleContext() throws Exception { + return getRuleContextForActionTesting( + scratchConfiguredTarget("pkg", "r", "android_library(name='r')")); + } +} diff --git a/src/test/java/com/google/devtools/build/lib/rules/android/AndroidResourcesTest.java b/src/test/java/com/google/devtools/build/lib/rules/android/AndroidResourcesTest.java index 113847fb60..5a008e4a70 100644 --- a/src/test/java/com/google/devtools/build/lib/rules/android/AndroidResourcesTest.java +++ b/src/test/java/com/google/devtools/build/lib/rules/android/AndroidResourcesTest.java @@ -19,42 +19,24 @@ import static com.google.common.truth.Truth.assertWithMessage; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Iterables; -import com.google.common.collect.Streams; -import com.google.devtools.build.lib.actions.ActionAnalysisMetadata; import com.google.devtools.build.lib.actions.Artifact; -import com.google.devtools.build.lib.analysis.CachingAnalysisEnvironment; import com.google.devtools.build.lib.analysis.ConfiguredTarget; import com.google.devtools.build.lib.analysis.RuleContext; -import com.google.devtools.build.lib.analysis.config.BuildConfigurationCollection; -import com.google.devtools.build.lib.events.ExtendedEventHandler; -import com.google.devtools.build.lib.events.StoredEventHandler; import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException; -import com.google.devtools.build.lib.skyframe.ConfiguredTargetKey; import com.google.devtools.build.lib.vfs.PathFragment; import java.util.Optional; -import java.util.stream.Collectors; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; -/** Tests {@link AndroidResourcesTest} */ +/** Tests {@link AndroidResources} */ @RunWith(JUnit4.class) public class AndroidResourcesTest extends ResourceTestBase { private static final PathFragment DEFAULT_RESOURCE_ROOT = PathFragment.create(RESOURCE_ROOT); private static final ImmutableList<PathFragment> RESOURCES_ROOTS = ImmutableList.of(DEFAULT_RESOURCE_ROOT); - private static final ImmutableSet<String> TOOL_FILENAMES = - ImmutableSet.of( - "static_aapt_tool", - "aapt.static", - "aapt", - "aapt2", - "empty.sh", - "android_blaze.jar", - "android.jar"); - @Before @Test public void testGetResourceRootsNoResources() throws Exception { @@ -434,38 +416,6 @@ public class AndroidResourcesTest extends ResourceTestBase { } /** - * Assets that the action used to generate the given outputs has the expected inputs and outputs. - */ - private void assertActionArtifacts( - RuleContext ruleContext, ImmutableList<Artifact> inputs, ImmutableList<Artifact> outputs) { - // Actions must have at least one output - assertThat(outputs).isNotEmpty(); - - // Get the action from one of the outputs - ActionAnalysisMetadata action = - ruleContext.getAnalysisEnvironment().getLocalGeneratingAction(outputs.get(0)); - assertThat(action).isNotNull(); - - assertThat(removeToolingArtifacts(action.getInputs())).containsExactlyElementsIn(inputs); - - assertThat(action.getOutputs()).containsExactlyElementsIn(outputs); - } - - /** Remove busybox and aapt2 tooling artifacts from a list of action inputs */ - private Iterable<Artifact> removeToolingArtifacts(Iterable<Artifact> inputArtifacts) { - return Streams.stream(inputArtifacts) - .filter( - artifact -> - // Not a known tool - !TOOL_FILENAMES.contains(artifact.getFilename()) - // Not one of the various busybox tools (we get different ones on different OSs) - && !artifact.getFilename().contains("busybox") - // Not a params file - && !artifact.getFilename().endsWith(".params")) - .collect(Collectors.toList()); - } - - /** * Validates that a parse action was invoked correctly. Returns the {@link ParsedAndroidResources} * for further validation. */ @@ -510,23 +460,6 @@ public class AndroidResourcesTest extends ResourceTestBase { "android_library(name = 'target',", useDataBinding ? " enable_data_binding = True" : "", ")"); - RuleContext dummy = getRuleContext(target); - - ExtendedEventHandler eventHandler = new StoredEventHandler(); - assertThat(targetConfig.isActionsEnabled()).isTrue(); - return view.getRuleContextForTesting( - eventHandler, - target, - new CachingAnalysisEnvironment( - view.getArtifactFactory(), - skyframeExecutor.getActionKeyContext(), - ConfiguredTargetKey.of(target.getLabel(), targetConfig), - /*isSystemEnv=*/ false, - targetConfig.extendedSanityChecks(), - eventHandler, - /*env=*/ null, - targetConfig.isActionsEnabled()), - new BuildConfigurationCollection( - ImmutableList.of(dummy.getConfiguration()), dummy.getHostConfiguration())); + return getRuleContextForActionTesting(target); } } diff --git a/src/test/java/com/google/devtools/build/lib/rules/android/BUILD b/src/test/java/com/google/devtools/build/lib/rules/android/BUILD index f00d1e9941..f023920c7d 100644 --- a/src/test/java/com/google/devtools/build/lib/rules/android/BUILD +++ b/src/test/java/com/google/devtools/build/lib/rules/android/BUILD @@ -120,11 +120,27 @@ java_test( ], ) +java_test( + name = "AndroidAssetsTest", + srcs = ["AndroidAssetsTest.java"], + deps = [ + ":ResourceTestBase", + "//src/main/java/com/google/devtools/build/lib:android-rules", + "//src/main/java/com/google/devtools/build/lib:build-base", + "//src/main/java/com/google/devtools/build/lib/vfs", + "//third_party:guava", + "//third_party:junit4", + "//third_party:truth", + ], +) + java_library( name = "ResourceTestBase", srcs = ["ResourceTestBase.java"], deps = [ ":AndroidBuildViewTestCase", + "//src/main/java/com/google/devtools/build/lib:build-base", + "//src/main/java/com/google/devtools/build/lib:events", "//src/main/java/com/google/devtools/build/lib:packages-internal", "//src/main/java/com/google/devtools/build/lib/actions", "//src/main/java/com/google/devtools/build/lib/vfs", diff --git a/src/test/java/com/google/devtools/build/lib/rules/android/ResourceTestBase.java b/src/test/java/com/google/devtools/build/lib/rules/android/ResourceTestBase.java index e7fd7d4ad3..50d92b0fa7 100644 --- a/src/test/java/com/google/devtools/build/lib/rules/android/ResourceTestBase.java +++ b/src/test/java/com/google/devtools/build/lib/rules/android/ResourceTestBase.java @@ -18,14 +18,24 @@ import static com.google.common.truth.Truth.assertWithMessage; import com.google.common.collect.ArrayListMultimap; import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableSet; import com.google.common.collect.Multimap; +import com.google.common.collect.Streams; +import com.google.devtools.build.lib.actions.ActionAnalysisMetadata; import com.google.devtools.build.lib.actions.Artifact; import com.google.devtools.build.lib.actions.ArtifactOwner; import com.google.devtools.build.lib.actions.ArtifactRoot; +import com.google.devtools.build.lib.analysis.CachingAnalysisEnvironment; +import com.google.devtools.build.lib.analysis.ConfiguredTarget; +import com.google.devtools.build.lib.analysis.RuleContext; +import com.google.devtools.build.lib.analysis.config.BuildConfigurationCollection; import com.google.devtools.build.lib.cmdline.Label; import com.google.devtools.build.lib.cmdline.LabelSyntaxException; +import com.google.devtools.build.lib.events.ExtendedEventHandler; +import com.google.devtools.build.lib.events.StoredEventHandler; import com.google.devtools.build.lib.packages.AbstractRuleErrorConsumer; import com.google.devtools.build.lib.packages.RuleErrorConsumer; +import com.google.devtools.build.lib.skyframe.ConfiguredTargetKey; import com.google.devtools.build.lib.vfs.FileSystem; import com.google.devtools.build.lib.vfs.Path; import com.google.devtools.build.lib.vfs.Root; @@ -33,6 +43,7 @@ import com.google.devtools.build.lib.vfs.inmemoryfs.InMemoryFileSystem; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.stream.Collectors; import org.junit.After; import org.junit.Before; @@ -40,6 +51,16 @@ import org.junit.Before; public abstract class ResourceTestBase extends AndroidBuildViewTestCase { public static final String RESOURCE_ROOT = "java/android/res"; + private static final ImmutableSet<String> TOOL_FILENAMES = + ImmutableSet.of( + "static_aapt_tool", + "aapt.static", + "aapt", + "aapt2", + "empty.sh", + "android_blaze.jar", + "android.jar"); + private static final ArtifactOwner OWNER = () -> { try { return Label.create("java", "all"); @@ -185,4 +206,65 @@ public abstract class ResourceTestBase extends AndroidBuildViewTestCase { return new Artifact( root, root.getExecPath().getRelative(root.getRoot().relativize(path)), OWNER); } + + /** + * Gets a RuleContext that can be used to register actions and test that they are created + * correctly. + * + * <p>Takes in a dummy target which will be used to configure the RuleContext's {@link + * AndroidConfiguration}. + */ + public RuleContext getRuleContextForActionTesting(ConfiguredTarget dummyTarget) throws Exception { + + RuleContext dummy = getRuleContext(dummyTarget); + + ExtendedEventHandler eventHandler = new StoredEventHandler(); + assertThat(targetConfig.isActionsEnabled()).isTrue(); + return view.getRuleContextForTesting( + eventHandler, + dummyTarget, + new CachingAnalysisEnvironment( + view.getArtifactFactory(), + skyframeExecutor.getActionKeyContext(), + ConfiguredTargetKey.of(dummyTarget.getLabel(), targetConfig), + /*isSystemEnv=*/ false, + targetConfig.extendedSanityChecks(), + eventHandler, + /*env=*/ null, + targetConfig.isActionsEnabled()), + new BuildConfigurationCollection( + ImmutableList.of(dummy.getConfiguration()), dummy.getHostConfiguration())); + } + + /** + * Assets that the action used to generate the given outputs has the expected inputs and outputs. + */ + void assertActionArtifacts( + RuleContext ruleContext, ImmutableList<Artifact> inputs, ImmutableList<Artifact> outputs) { + // Actions must have at least one output + assertThat(outputs).isNotEmpty(); + + // Get the action from one of the outputs + ActionAnalysisMetadata action = + ruleContext.getAnalysisEnvironment().getLocalGeneratingAction(outputs.get(0)); + assertThat(action).isNotNull(); + + assertThat(removeToolingArtifacts(action.getInputs())).containsExactlyElementsIn(inputs); + + assertThat(action.getOutputs()).containsExactlyElementsIn(outputs); + } + + /** Remove busybox and aapt2 tooling artifacts from a list of action inputs */ + private Iterable<Artifact> removeToolingArtifacts(Iterable<Artifact> inputArtifacts) { + return Streams.stream(inputArtifacts) + .filter( + artifact -> + // Not a known tool + !TOOL_FILENAMES.contains(artifact.getFilename()) + // Not one of the various busybox tools (we get different ones on different OSs) + && !artifact.getFilename().contains("busybox") + // Not a params file + && !artifact.getFilename().endsWith(".params")) + .collect(Collectors.toList()); + } } |