forked from oppia/oppia-android
-
Notifications
You must be signed in to change notification settings - Fork 0
/
build_flavors.bzl
238 lines (222 loc) · 9 KB
/
build_flavors.bzl
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
"""
Macros & definitions corresponding to Oppia binary build flavors.
"""
load("//:oppia_android_application.bzl", "declare_deployable_application", "oppia_android_application")
load("//:version.bzl", "MAJOR_VERSION", "MINOR_VERSION", "OPPIA_ALPHA_KITKAT_VERSION_CODE", "OPPIA_ALPHA_VERSION_CODE", "OPPIA_DEV_KITKAT_VERSION_CODE", "OPPIA_DEV_VERSION_CODE")
# Defines the list of flavors available to build the Oppia app in. Note to developers: this list
# should be ordered by the development pipeline (i.e. features go through dev first, then other
# flavors as they mature).
AVAILABLE_FLAVORS = [
"dev",
"dev_kitkat",
"alpha",
"alpha_kitkat",
]
# This file contains the list of classes that must be in the main dex list for the legacy multidex
# build used on KitKat devices. Generally, this is the main application class is needed so that it
# can load multidex support, plus any dependencies needed by that pipeline.
_MAIN_DEX_LIST_TARGET_KITKAT = "//:config/kitkat_main_dex_class_list.txt"
# keep sorted
_PRODUCTION_PROGUARD_SPECS = [
"config/proguard/android-proguard-rules.pro",
"config/proguard/androidx-proguard-rules.pro",
"config/proguard/firebase-components-proguard-rules.pro",
"config/proguard/glide-proguard-rules.pro",
"config/proguard/google-play-services-proguard-rules.pro",
"config/proguard/guava-proguard-rules.pro",
"config/proguard/kotlin-proguard-rules.pro",
"config/proguard/kotlinpoet-javapoet-proguard-rules.pro",
"config/proguard/material-proguard-rules.pro",
"config/proguard/moshi-proguard-rules.pro",
"config/proguard/okhttp-proguard-rules.pro",
"config/proguard/oppia-prod-proguard-rules.pro",
"config/proguard/protobuf-proguard-rules.pro",
]
# Note to developers: keys of this dict should follow the order of AVAILABLE_FLAVORS.
_FLAVOR_METADATA = {
"dev": {
"manifest": "//app:src/main/AndroidManifest.xml",
"min_sdk_version": 21,
"target_sdk_version": 29,
"multidex": "native",
"proguard_specs": [], # Developer builds are not optimized.
"production_release": False,
"deps": [
"//app",
],
"version_code": OPPIA_DEV_VERSION_CODE,
},
"dev_kitkat": {
"manifest": "//app:src/main/AndroidManifest.xml",
"min_sdk_version": 19,
"target_sdk_version": 29,
"multidex": "manual_main_dex",
"main_dex_list": _MAIN_DEX_LIST_TARGET_KITKAT,
"proguard_specs": [], # Developer builds are not optimized.
"production_release": False,
"deps": [
"//app",
],
"version_code": OPPIA_DEV_KITKAT_VERSION_CODE,
},
"alpha": {
"manifest": "//app:src/main/AndroidManifest.xml",
"min_sdk_version": 21,
"target_sdk_version": 29,
"multidex": "native",
"proguard_specs": _PRODUCTION_PROGUARD_SPECS,
"production_release": True,
"deps": [
"//app",
],
"version_code": OPPIA_ALPHA_VERSION_CODE,
},
"alpha_kitkat": {
"manifest": "//app:src/main/AndroidManifest.xml",
"min_sdk_version": 19,
"target_sdk_version": 29,
"multidex": "manual_main_dex",
"main_dex_list": _MAIN_DEX_LIST_TARGET_KITKAT,
"proguard_specs": [], # TODO(#3886): Re-add Proguard support to alpha_kitkat.
"production_release": True,
"deps": [
"//app",
],
"version_code": OPPIA_ALPHA_KITKAT_VERSION_CODE,
},
}
def _transform_android_manifest_impl(ctx):
input_file = ctx.attr.input_file.files.to_list()[0]
output_file = ctx.outputs.output_file
git_meta_dir = ctx.attr.git_meta_dir.files.to_list()[0]
build_flavor = ctx.attr.build_flavor
major_version = ctx.attr.major_version
minor_version = ctx.attr.minor_version
version_code = ctx.attr.version_code
# See corresponding transformation script for details on the passed arguments.
arguments = [
".", # Working directory of the Bazel repository.
input_file.path, # Path to the source manifest.
output_file.path, # Path to the output manifest.
build_flavor,
"%s" % major_version,
"%s" % minor_version,
"%s" % version_code,
"origin/develop", # The base branch for computing the version name.
]
# Reference: https://docs.bazel.build/versions/master/skylark/lib/actions.html#run.
ctx.actions.run(
outputs = [output_file],
inputs = ctx.files.input_file + [git_meta_dir],
tools = [ctx.executable._transform_android_manifest_tool],
executable = ctx.executable._transform_android_manifest_tool.path,
arguments = arguments,
mnemonic = "TransformAndroidManifest",
progress_message = "Transforming Android manifest",
)
return DefaultInfo(
files = depset([output_file]),
runfiles = ctx.runfiles(files = [output_file]),
)
_transform_android_manifest = rule(
attrs = {
"input_file": attr.label(
allow_files = True,
mandatory = True,
),
"output_file": attr.output(
mandatory = True,
),
"git_meta_dir": attr.label(
allow_files = True,
mandatory = True,
),
"build_flavor": attr.string(mandatory = True),
"major_version": attr.int(mandatory = True),
"minor_version": attr.int(mandatory = True),
"version_code": attr.int(mandatory = True),
"_transform_android_manifest_tool": attr.label(
executable = True,
cfg = "host",
default = "//scripts:transform_android_manifest",
),
},
implementation = _transform_android_manifest_impl,
)
def transform_android_manifest(
name,
input_file,
output_file,
build_flavor,
major_version,
minor_version,
version_code):
"""
Generates a new transformation of the specified AndroidManifest.xml.
The transformed version of the manifest include an explicitly specified version code and
computed version name based on the specified major/minor version, flavor, and the most recent
develop branch hash.
Args:
name: str. The name of this transformation target.
input_file: target. The file target corresponding to the AndroidManifest.xml file to
transform.
output_file: str. The filename that should be generated as the transformed manifest.
build_flavor: str. The specific release flavor of this build of the app.
major_version: int. The major version of the app.
minor_version: int. The minor version of the app.
version_code: int. The version code of this flavor of the app.
"""
_transform_android_manifest(
name = name,
input_file = input_file,
output_file = output_file,
git_meta_dir = "//:.git",
build_flavor = build_flavor,
major_version = major_version,
minor_version = minor_version,
version_code = version_code,
)
def define_oppia_aab_binary_flavor(flavor):
"""
Defines a new flavor of the Oppia Android app.
Flavors are defined through properties defined within _FLAVOR_METADATA.
This will define two targets:
- //:oppia_<flavor> (the AAB)
- //:install_oppia_<flavor> (the installable binary target--see declare_deployable_application
for details)
Args:
flavor: str. The name of the flavor of the app. Must correspond to an entry in
AVAILABLE_FLAVORS.
"""
transform_android_manifest(
name = "oppia_%s_transformed_manifest" % flavor,
input_file = _FLAVOR_METADATA[flavor]["manifest"],
output_file = "AndroidManifest_transformed_%s.xml" % flavor,
build_flavor = flavor,
major_version = MAJOR_VERSION,
minor_version = MINOR_VERSION,
version_code = _FLAVOR_METADATA[flavor]["version_code"],
)
oppia_android_application(
name = "oppia_%s" % flavor,
custom_package = "org.oppia.android",
testonly = not _FLAVOR_METADATA[flavor]["production_release"],
enable_data_binding = True,
config_file = "//:bundle_config.pb.json",
manifest = ":AndroidManifest_transformed_%s.xml" % flavor,
manifest_values = {
"applicationId": "org.oppia.android",
"minSdkVersion": "%d" % _FLAVOR_METADATA[flavor]["min_sdk_version"],
"targetSdkVersion": "%d" % _FLAVOR_METADATA[flavor]["target_sdk_version"],
},
multidex = _FLAVOR_METADATA[flavor]["multidex"],
main_dex_list = _FLAVOR_METADATA[flavor].get("main_dex_list"),
proguard_generate_mapping = True if len(_FLAVOR_METADATA[flavor]["proguard_specs"]) != 0 else False,
proguard_specs = _FLAVOR_METADATA[flavor]["proguard_specs"],
shrink_resources = True if len(_FLAVOR_METADATA[flavor]["proguard_specs"]) != 0 else False,
deps = _FLAVOR_METADATA[flavor]["deps"],
)
declare_deployable_application(
name = "install_oppia_%s" % flavor,
aab_target = ":oppia_%s" % flavor,
)