1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
// 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.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException;
import com.google.devtools.build.lib.packages.RuleErrorConsumer;
import com.google.devtools.build.lib.rules.android.AndroidConfiguration.AndroidAaptVersion;
import com.google.devtools.build.lib.skylarkbuildapi.android.ValidatedAndroidDataApi;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
/** Wraps validated and packaged Android resource information */
public class ValidatedAndroidResources extends MergedAndroidResources implements
ValidatedAndroidDataApi {
private final Artifact rTxt;
private final Artifact sourceJar;
private final Artifact apk;
// aapt2 outputs. Will be null if and only if aapt2 is not used for validation.
@Nullable private final Artifact aapt2RTxt;
@Nullable private final Artifact aapt2SourceJar;
@Nullable private final Artifact staticLibrary;
/**
* Validates and packages merged resources.
*
* <p>Specifically, validates that:
*
* <ul>
* <li>there are no conflicts between resources (though currently we just warn)
* <li>each reference to a resource in resources and manifest are satisfied
* </ul>
*
* <p>And packs resources into:
*
* <ul>
* <li>R.java and R.txt files
* <li>A resource-only APK (deprecated)
* <li>When building with aapt2, aapt2 equivalents of the above
* <li>When building with aapt2, a compiled symbols zip
* </ul>
*/
public static ValidatedAndroidResources validateFrom(
AndroidDataContext dataContext, MergedAndroidResources merged, AndroidAaptVersion aaptVersion)
throws InterruptedException {
AndroidResourceValidatorActionBuilder builder =
new AndroidResourceValidatorActionBuilder()
.setJavaPackage(merged.getJavaPackage())
.setDebug(dataContext.useDebug())
.setMergedResources(merged.getMergedResources())
.setRTxtOut(dataContext.createOutputArtifact(AndroidRuleClasses.ANDROID_R_TXT))
.setSourceJarOut(
dataContext.createOutputArtifact(AndroidRuleClasses.ANDROID_JAVA_SOURCE_JAR))
// Request an APK so it can be inherited when a library is used in a binary's
// resources attr.
// TODO(b/30307842): Remove this once it is no longer needed for resources migration.
.setApkOut(dataContext.createOutputArtifact(AndroidRuleClasses.ANDROID_LIBRARY_APK))
.withDependencies(merged.getResourceDependencies());
if (aaptVersion == AndroidAaptVersion.AAPT2) {
builder
.setCompiledSymbols(merged.getCompiledSymbols())
.setAapt2RTxtOut(
dataContext.createOutputArtifact(AndroidRuleClasses.ANDROID_RESOURCES_AAPT2_R_TXT))
.setAapt2SourceJarOut(
dataContext.createOutputArtifact(
AndroidRuleClasses.ANDROID_RESOURCES_AAPT2_SOURCE_JAR))
.setStaticLibraryOut(
dataContext.createOutputArtifact(
AndroidRuleClasses.ANDROID_RESOURCES_AAPT2_LIBRARY_APK));
}
return builder.build(dataContext, merged);
}
static ValidatedAndroidResources of(
MergedAndroidResources merged,
Artifact rTxt,
Artifact sourceJar,
Artifact apk,
@Nullable Artifact aapt2RTxt,
@Nullable Artifact aapt2SourceJar,
@Nullable Artifact staticLibrary) {
return new ValidatedAndroidResources(
merged, rTxt, sourceJar, apk, aapt2RTxt, aapt2SourceJar, staticLibrary);
}
private ValidatedAndroidResources(
MergedAndroidResources merged,
Artifact rTxt,
Artifact sourceJar,
Artifact apk,
@Nullable Artifact aapt2RTxt,
@Nullable Artifact aapt2SourceJar,
@Nullable Artifact staticLibrary) {
super(merged);
this.rTxt = rTxt;
this.sourceJar = sourceJar;
this.apk = apk;
this.aapt2RTxt = aapt2RTxt;
this.aapt2SourceJar = aapt2SourceJar;
this.staticLibrary = staticLibrary;
}
public AndroidResourcesInfo toProvider() {
return getResourceDependencies().toInfo(this);
}
public Artifact getRTxt() {
return rTxt;
}
public Artifact getJavaSourceJar() {
return sourceJar;
}
public Artifact getApk() {
return apk;
}
@Nullable
public Artifact getAapt2RTxt() {
return aapt2RTxt;
}
@Nullable
public Artifact getAapt2SourceJar() {
return aapt2SourceJar;
}
@Nullable
public Artifact getStaticLibrary() {
return staticLibrary;
}
public ValidatedAndroidResources filter(
RuleErrorConsumer errorConsumer, ResourceFilter resourceFilter, boolean isDependency)
throws RuleErrorException {
return maybeFilter(errorConsumer, resourceFilter, isDependency).orElse(this);
}
@Override
public Optional<ValidatedAndroidResources> maybeFilter(
RuleErrorConsumer errorConsumer, ResourceFilter resourceFilter, boolean isDependency)
throws RuleErrorException {
return super.maybeFilter(errorConsumer, resourceFilter, isDependency)
.map(
merged ->
ValidatedAndroidResources.of(
merged, rTxt, sourceJar, apk, aapt2RTxt, aapt2SourceJar, staticLibrary));
}
@Override
public boolean equals(Object object) {
if (!super.equals(object) || !(object instanceof ValidatedAndroidResources)) {
return false;
}
ValidatedAndroidResources other = (ValidatedAndroidResources) object;
return rTxt.equals(other.rTxt)
&& sourceJar.equals(other.sourceJar)
&& apk.equals(other.apk)
&& Objects.equals(aapt2RTxt, other.aapt2RTxt)
&& Objects.equals(aapt2SourceJar, other.aapt2SourceJar)
&& Objects.equals(staticLibrary, other.staticLibrary);
}
@Override
public int hashCode() {
return Objects.hash(
super.hashCode(), rTxt, sourceJar, apk, aapt2RTxt, aapt2SourceJar, staticLibrary);
}
public ValidatedAndroidResources export() {
return new ValidatedAndroidResources(
new MergedAndroidResources(
new ParsedAndroidResources(
new AndroidResources(getResources(), getResourceRoots()),
getSymbols(),
getCompiledSymbols(),
getLabel(),
getStampedManifest(),
// Null out databinding to avoid accidentally propagating ActionCreationContext
null),
getMergedResources(),
getClassJar(),
getDataBindingInfoZip(),
getResourceDependencies(),
getProcessedManifest()),
getRTxt(),
getJavaSourceJar(),
getApk(),
getAapt2RTxt(),
getAapt2SourceJar(),
getStaticLibrary());
}
}
|
