Resource filtering properly handles pseudolocales
Pseudolocalized resources are generated by aapt in response to their locales
being passed to aapt. However, when filtering in analysis, we attempted to save
time by not passing any filters to aapt. Fix this by passing the filters if
pseudolocales were specified.
RELNOTES: none
PiperOrigin-RevId: 165939670
diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourcesProcessorBuilder.java b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourcesProcessorBuilder.java
index 5605a04..dd28572 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourcesProcessorBuilder.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/android/AndroidResourcesProcessorBuilder.java
@@ -451,7 +451,7 @@
builder.addExecPath("--packagePath", apkOut);
outs.add(apkOut);
}
- if (resourceFilter.hasConfigurationFilters() && !resourceFilter.isPrefiltering()) {
+ if (resourceFilter.shouldPropagateConfigs(ruleContext)) {
builder.add("--resourceConfigs", resourceFilter.getConfigurationFilterString());
}
if (resourceFilter.hasDensities() && !resourceFilter.isPrefiltering()) {
diff --git a/src/main/java/com/google/devtools/build/lib/rules/android/ResourceFilter.java b/src/main/java/com/google/devtools/build/lib/rules/android/ResourceFilter.java
index b8a25b1..3b828a1 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/android/ResourceFilter.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/android/ResourceFilter.java
@@ -15,6 +15,7 @@
import com.android.ide.common.resources.configuration.DensityQualifier;
import com.android.ide.common.resources.configuration.FolderConfiguration;
+import com.android.ide.common.resources.configuration.LocaleQualifier;
import com.android.ide.common.resources.configuration.VersionQualifier;
import com.android.resources.Density;
import com.android.resources.ResourceFolderType;
@@ -60,6 +61,23 @@
public static final String RESOURCE_CONFIGURATION_FILTERS_NAME = "resource_configuration_filters";
public static final String DENSITIES_NAME = "densities";
+ /**
+ * Locales used for pseudolocation.
+ *
+ * <p>These are special resources that can be used to test how apps handles special cases (such as
+ * particularly long text, accents, or left-to-right text). These resources are not provided like
+ * other resources; instead, when the appropriate filters are passed in, aapt generates them based
+ * on the default resources.
+ *
+ * <p>When these locales are specified in the configuration filters, even if we are filtering in
+ * analysis, we need to pass *all* configuration filters to aapt - the pseudolocalization filters
+ * themselves to trigger pseudolocalization, and the other filters to prevent aapt from filtering
+ * matching resources out.
+ */
+ private static final ImmutableSet<LocaleQualifier> PSEUDOLOCATION_LOCALES =
+ ImmutableSet.of(
+ LocaleQualifier.getQualifier("en-rXA"), LocaleQualifier.getQualifier("ar-rXB"));
+
@VisibleForTesting
static enum FilterBehavior {
/**
@@ -699,6 +717,36 @@
return filterBehavior == FilterBehavior.FILTER_IN_ANALYSIS_WITH_DYNAMIC_CONFIGURATION;
}
+ /**
+ * @return whether resource configuration filters should be propagated to the resource processing
+ * action and eventually to aapt.
+ */
+ public boolean shouldPropagateConfigs(RuleErrorConsumer ruleErrorConsumer) {
+ if (!hasConfigurationFilters()) {
+ // There are no filters to propagate
+ return false;
+ }
+
+ if (!isPrefiltering()) {
+ // The filters were not applied in analysis and must be applied in execution
+ return true;
+ }
+
+ for (FolderConfiguration config : getConfigurationFilters((ruleErrorConsumer))) {
+ for (LocaleQualifier pseudoLocale : PSEUDOLOCATION_LOCALES) {
+ if (pseudoLocale.equals(config.getLocaleQualifier())) {
+ // A pseudolocale was used, and needs to be propagated to aapt. Propagate all
+ // configuration values so that aapt does not filter out those that were skipped.
+ return true;
+ }
+ }
+ }
+
+ // Filtering already happened, and there's no reason to have aapt waste its time trying to
+ // filter again. Don't propagate the filters.
+ return false;
+ }
+
/*
* TODO: Stop tracking these once {@link FilterBehavior#FILTER_IN_ANALYSIS} is fully replaced by
* {@link FilterBehavior#FILTER_IN_ANALYSIS_WITH_DYNAMIC_CONFIGURATION}.
diff --git a/src/test/java/com/google/devtools/build/lib/rules/android/AndroidBinaryTest.java b/src/test/java/com/google/devtools/build/lib/rules/android/AndroidBinaryTest.java
index 862111a..9295234 100644
--- a/src/test/java/com/google/devtools/build/lib/rules/android/AndroidBinaryTest.java
+++ b/src/test/java/com/google/devtools/build/lib/rules/android/AndroidBinaryTest.java
@@ -1582,6 +1582,24 @@
}
@Test
+ public void testFilterResourcesPseudolocalesPropagated() throws Exception {
+ String dir = "java/r/android";
+ ConfiguredTarget binary =
+ scratchConfiguredTarget(
+ dir,
+ "bin",
+ "android_binary(name = 'bin',",
+ " resource_files = glob(['res/**']),",
+ " resource_configuration_filters = ['en', 'en-rXA', 'ar-rXB'],",
+ " manifest = 'AndroidManifest.xml')");
+
+ List<String> resourceProcessingArgs =
+ getGeneratingSpawnActionArgs(getResourceContainer(binary).getRTxt());
+
+ assertThat(resourceProcessingArgs).containsAllOf("--resourceConfigs", "ar-rXB,en,en-rXA");
+ }
+
+ @Test
public void testThrowOnResourceConflictFlagGetsPropagated() throws Exception {
scratch.file(
"java/r/android/BUILD",
diff --git a/src/test/java/com/google/devtools/build/lib/rules/android/ResourceFilterTest.java b/src/test/java/com/google/devtools/build/lib/rules/android/ResourceFilterTest.java
index 2fc4e37..0ad6a66 100644
--- a/src/test/java/com/google/devtools/build/lib/rules/android/ResourceFilterTest.java
+++ b/src/test/java/com/google/devtools/build/lib/rules/android/ResourceFilterTest.java
@@ -697,4 +697,26 @@
return androidOptions;
}
+
+ @Test
+ public void testHasPseudolocationFilters() throws Exception {
+ // Basic pseudolocation filters
+ for (String filter : ImmutableList.of("en_XA", "en-rXA", "ar_XB", "ar-rXB")) {
+ assertHasPseudolocationFilters(filter).isTrue();
+ }
+
+ // Additional qualifiers should not mask whether pseudolocation filters are used
+ assertHasPseudolocationFilters("en-rXA-port").isTrue();
+
+ // Without pseudolocation, even though the locale is similar
+ for (String filter : ImmutableList.of("", "en", "ar", "en-rUS")) {
+ assertHasPseudolocationFilters(filter).isFalse();
+ }
+ }
+
+ private BooleanSubject assertHasPseudolocationFilters(String filters) throws Exception {
+ return assertThat(
+ makeResourceFilter(filters, "", FilterBehavior.FILTER_IN_ANALYSIS)
+ .shouldPropagateConfigs(errorConsumer));
+ }
}
