blob: bd2c90c28136d6fc540daf05c886211e39ccf839 [file] [log] [blame]
# Copyright (c) 2021 Project CHIP Authors
#
# 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.
import os
import shlex
from enum import Enum, auto
from .builder import Builder
class AndroidBoard(Enum):
ARM = auto()
ARM64 = auto()
X64 = auto()
X86 = auto()
AndroidStudio_ARM = auto()
AndroidStudio_ARM64 = auto()
AndroidStudio_X64 = auto()
AndroidStudio_X86 = auto()
def TargetCpuName(self):
if self == AndroidBoard.ARM or self == AndroidBoard.AndroidStudio_ARM:
return "arm"
elif self == AndroidBoard.ARM64 or self == AndroidBoard.AndroidStudio_ARM64:
return "arm64"
elif self == AndroidBoard.X64 or self == AndroidBoard.AndroidStudio_X64:
return "x64"
elif self == AndroidBoard.X86 or self == AndroidBoard.AndroidStudio_X86:
return "x86"
else:
raise Exception("Unknown board type: %r" % self)
def AbiName(self):
if self.TargetCpuName() == "arm":
return "armeabi-v7a"
elif self.TargetCpuName() == "arm64":
return "arm64-v8a"
elif self.TargetCpuName() == "x64":
return "x86_64"
elif self.TargetCpuName() == "x86":
return "x86"
else:
raise Exception("Unknown board type: %r" % self)
def IsIde(self):
if (
self == AndroidBoard.AndroidStudio_ARM
or self == AndroidBoard.AndroidStudio_ARM64
or self == AndroidBoard.AndroidStudio_X64
or self == AndroidBoard.AndroidStudio_X86
):
return True
else:
return False
class AndroidApp(Enum):
CHIP_TOOL = auto()
CHIP_TEST = auto()
TV_SERVER = auto()
TV_CASTING_APP = auto()
JAVA_MATTER_CONTROLLER = auto()
KOTLIN_MATTER_CONTROLLER = auto()
VIRTUAL_DEVICE_APP = auto()
def AppName(self):
if self == AndroidApp.CHIP_TOOL:
return "CHIPTool"
elif self == AndroidApp.CHIP_TEST:
return "CHIPTest"
elif self == AndroidApp.TV_SERVER:
return "tv-server"
elif self == AndroidApp.TV_CASTING_APP:
return "tv-casting"
elif self == AndroidApp.VIRTUAL_DEVICE_APP:
return "virtual-device-app"
else:
raise Exception("Unknown app type: %r" % self)
def AppGnArgs(self):
gn_args = {}
if self == AndroidApp.TV_SERVER:
gn_args["chip_config_network_layer_ble"] = False
elif self == AndroidApp.TV_CASTING_APP:
gn_args["chip_config_network_layer_ble"] = False
elif self == AndroidApp.VIRTUAL_DEVICE_APP:
gn_args["chip_config_network_layer_ble"] = True
elif self == AndroidApp.CHIP_TOOL:
gn_args["chip_build_controller_dynamic_server"] = True
return gn_args
def ExampleName(self):
if self == AndroidApp.TV_SERVER:
return "tv-app"
elif self == AndroidApp.TV_CASTING_APP:
return "tv-casting-app"
elif self == AndroidApp.VIRTUAL_DEVICE_APP:
return "virtual-device-app"
elif self == AndroidApp.CHIP_TEST:
return "chip-test"
else:
return None
def Modules(self):
if self == AndroidApp.TV_SERVER:
return ["platform-app", "content-app"]
else:
return None
def BuildRoot(self, root):
if self == AndroidApp.CHIP_TEST:
return os.path.join(root, 'examples/android/CHIPTest')
else:
return None
class AndroidProfile(Enum):
RELEASE = auto()
DEBUG = auto()
@property
def ProfileName(self):
if self == AndroidProfile.RELEASE:
return 'release'
elif self == AndroidProfile.DEBUG:
return 'debug'
else:
raise Exception('Unknown profile type: %r' % self)
class AndroidBuilder(Builder):
def __init__(self,
root,
runner,
board: AndroidBoard,
app: AndroidApp,
profile: AndroidProfile = AndroidProfile.DEBUG):
super(AndroidBuilder, self).__init__(root, runner)
self.board = board
self.app = app
self.profile = profile
def validate_build_environment(self):
for k in ["ANDROID_NDK_HOME", "ANDROID_HOME"]:
if k not in os.environ:
raise Exception(
"Environment %s missing, cannot build android libraries" % k
)
# SDK manager must be runnable to 'accept licenses'
sdk_manager = os.path.join(
os.environ["ANDROID_HOME"], "tools", "bin", "sdkmanager"
)
# New SDK manager at cmdline-tools/latest/bin/
new_sdk_manager = os.path.join(
os.environ["ANDROID_HOME"], "cmdline-tools", "latest", "bin", "sdkmanager"
)
if not (
os.path.isfile(sdk_manager) and os.access(sdk_manager, os.X_OK)
) and not (
os.path.isfile(new_sdk_manager) and os.access(
new_sdk_manager, os.X_OK)
):
raise Exception(
"'%s' and '%s' is not executable by the current user"
% (sdk_manager, new_sdk_manager)
)
# In order to accept a license, the licenses folder is updated with the hash of the
# accepted license
android_home = os.environ["ANDROID_HOME"]
licenses = os.path.join(android_home, "licenses")
if not os.path.exists(licenses):
# Initial install may not have licenses at all
if not os.access(android_home, os.W_OK):
raise Exception(
"'%s' is NOT writable by the current user (needed to create licenses folder for accept)"
% android_home
)
elif not os.access(licenses, os.W_OK):
raise Exception(
"'%s' is NOT writable by the current user (needed to accept licenses)"
% licenses
)
def copyToSrcAndroid(self):
# JNILibs will be copied as long as they reside in src/main/jniLibs/ABI:
# https://developer.android.com/studio/projects/gradle-external-native-builds#jniLibs
# to avoid redefined in IDE mode, copy to another place and add that path in build.gradle
# We do NOT use python builtins for copy, so that the 'execution commands' are available
# when using dry run.
jnilibs_dir = os.path.join(
self.root,
"examples/android/",
self.app.AppName(),
"app/libs/jniLibs",
self.board.AbiName(),
)
libs_dir = os.path.join(
self.root, "examples/android/", self.app.AppName(), "app/libs"
)
self._Execute(
["mkdir", "-p", jnilibs_dir], title="Prepare Native libs " + self.identifier
)
# TODO: Runtime dependencies should be computed by the build system rather than hardcoded
# GN supports getting these dependencies like:
# gn desc out/android-x64-chip_tool/ //src/controller/java runtime_deps
# gn desc out/android-x64-chip_tool/ //src/setup_payload/java runtime_deps
# However this assumes that the output folder has been populated, which will not be
# the case for `dry-run` executions. Hence this harcoding here.
#
# If we unify the JNI libraries, libc++_shared.so may not be needed anymore, which could
# be another path of resolving this inconsistency.
for libName in [
"libCHIPController.so",
"libc++_shared.so",
]:
self._Execute(
[
"cp",
os.path.join(
self.output_dir, "lib", "jni", self.board.AbiName(), libName
),
os.path.join(jnilibs_dir, libName),
]
)
jars = {
"CHIPController.jar": "src/controller/java/CHIPController.jar",
"CHIPInteractionModel.jar": "src/controller/java/CHIPInteractionModel.jar",
"OnboardingPayload.jar": "src/controller/java/OnboardingPayload.jar",
"AndroidPlatform.jar": "src/platform/android/AndroidPlatform.jar",
"libMatterJson.jar": "src/controller/java/libMatterJson.jar",
"libMatterTlv.jar": "src/controller/java/libMatterTlv.jar",
"CHIPClusters.jar": "src/controller/java/CHIPClusters.jar",
"CHIPClusterID.jar": "src/controller/java/CHIPClusterID.jar",
}
for jarName in jars.keys():
self._Execute(
[
"cp",
os.path.join(self.output_dir, "lib", jars[jarName]),
os.path.join(libs_dir, jarName),
]
)
def copyToExampleApp(self, jnilibs_dir, libs_dir, libs, jars):
self._Execute(
["mkdir", "-p", jnilibs_dir], title="Prepare Native libs " + self.identifier
)
for libName in libs:
self._Execute(
[
"cp",
os.path.join(
self.output_dir, "lib", "jni", self.board.AbiName(), libName
),
os.path.join(jnilibs_dir, libName),
]
)
for jarName in jars.keys():
self._Execute(
[
"cp",
os.path.join(self.output_dir, "lib", jars[jarName]),
os.path.join(libs_dir, jarName),
]
)
def gradlewBuildSrcAndroid(self):
# App compilation
self._Execute(
[
"%s/examples/android/%s/gradlew" % (
self.root, self.app.AppName()),
"-p",
"%s/examples/android/%s" % (self.root, self.app.AppName()),
"-PmatterBuildSrcDir=%s" % self.output_dir,
"-PmatterSdkSourceBuild=false",
"-PbuildDir=%s" % self.output_dir,
"assembleDebug",
],
title="Building APP " + self.identifier,
)
def gradlewBuildExampleAndroid(self):
# Example compilation
if self.app.Modules():
for module in self.app.Modules():
self._Execute(
[
"%s/examples/%s/android/App/gradlew"
% (self.root, self.app.ExampleName()),
"-p",
"%s/examples/%s/android/App/"
% (self.root, self.app.ExampleName()),
"-PmatterBuildSrcDir=%s" % self.output_dir,
"-PmatterSdkSourceBuild=false",
"-PbuildDir=%s/%s" % (self.output_dir, module),
":%s:assembleDebug" % module,
],
title="Building Example %s, module %s" % (
self.identifier, module),
)
else:
self._Execute(
[
"%s/examples/%s/android/App/gradlew"
% (self.root, self.app.ExampleName()),
"-p",
"%s/examples/%s/android/App/" % (self.root,
self.app.ExampleName()),
"-PmatterBuildSrcDir=%s" % self.output_dir,
"-PmatterSdkSourceBuild=false",
"-PbuildDir=%s" % self.output_dir,
"assembleDebug",
],
title="Building Example " + self.identifier,
)
def generate(self):
self._Execute(
["python3", "third_party/android_deps/set_up_android_deps.py"],
title="Setting up Android deps through Gradle",
)
self._Execute(
["third_party/java_deps/set_up_java_deps.sh"],
title="Setting up Java deps",
)
if not os.path.exists(self.output_dir):
# NRF does a in-place update of SDK tools
if not self._runner.dry_run:
self.validate_build_environment()
exampleName = self.app.ExampleName()
gn_args = {}
gn_args["target_os"] = "android"
gn_args["target_cpu"] = self.board.TargetCpuName()
gn_args["android_ndk_root"] = os.environ["ANDROID_NDK_HOME"]
gn_args["android_sdk_root"] = os.environ["ANDROID_HOME"]
if exampleName == "chip-test":
gn_args["chip_build_test_static_libraries"] = False
if self.options.pw_command_launcher:
gn_args["pw_command_launcher"] = self.options.pw_command_launcher
if exampleName == "chip-test":
gn_args["chip_build_tests"] = True
if self.profile != AndroidProfile.DEBUG:
gn_args["is_debug"] = False
gn_args.update(self.app.AppGnArgs())
args_str = ""
for key, value in gn_args.items():
if type(value) is bool:
if value:
args_str += "%s=true " % (key)
else:
args_str += "%s=false " % (key)
else:
args_str += '%s="%s" ' % (key, shlex.quote(value))
args = "--args=%s" % (args_str)
gn_gen = [
"gn",
"gen",
"--check",
"--fail-on-unused-args",
self.output_dir,
args,
]
rootName = self.app.BuildRoot(self.root)
if rootName is not None:
gn_gen += ["--root=%s" % rootName]
elif exampleName is not None:
gn_gen += ["--root=%s/examples/%s/android/" %
(self.root, exampleName)]
if self.board.IsIde():
gn_gen += [
"--ide=json",
"--json-ide-script=//scripts/examples/gn_to_cmakelists.py",
]
self._Execute(gn_gen, title="Generating " + self.identifier)
new_sdk_manager = os.path.join(
os.environ["ANDROID_HOME"],
"cmdline-tools",
"latest",
"bin",
"sdkmanager",
)
if os.path.isfile(new_sdk_manager) and os.access(new_sdk_manager, os.X_OK):
self._Execute(
["bash", "-c", "yes | %s --licenses >/dev/null" %
new_sdk_manager],
title="Accepting NDK licenses @ cmdline-tools",
)
else:
sdk_manager = os.path.join(
os.environ["ANDROID_HOME"], "tools", "bin", "sdkmanager"
)
self._Execute(
["bash", "-c", "yes | %s --licenses >/dev/null" % sdk_manager],
title="Accepting NDK licenses @ tools",
)
def stripSymbols(self):
output_libs_dir = os.path.join(
self.output_dir,
"lib",
"jni",
self.board.AbiName())
for lib in os.listdir(output_libs_dir):
if (lib.endswith(".so")):
self._Execute(
["llvm-strip",
"-s",
os.path.join(output_libs_dir, lib)
],
"Stripping symbols from " + lib
)
def _build(self):
if self.board.IsIde():
# App compilation IDE
# TODO: Android Gradle with module and -PbuildDir= will caused issue, remove -PbuildDir=
self._Execute(
[
"%s/examples/android/%s/gradlew" % (
self.root, self.app.AppName()),
"-p",
"%s/examples/android/%s" % (self.root, self.app.AppName()),
"-PmatterBuildSrcDir=%s" % self.output_dir,
"-PmatterSdkSourceBuild=true",
"-PmatterSourceBuildAbiFilters=%s" % self.board.AbiName(),
"assembleDebug",
],
title="Building APP " + self.identifier,
)
else:
self._Execute(
["ninja", "-C", self.output_dir],
title="Building JNI " + self.identifier,
)
exampleName = self.app.ExampleName()
if exampleName is None:
self.copyToSrcAndroid()
self.gradlewBuildSrcAndroid()
elif exampleName == "tv-casting-app":
jnilibs_dir = os.path.join(
self.root,
"examples/",
self.app.ExampleName(),
"android/App/app/libs/jniLibs",
self.board.AbiName(),
)
libs_dir = os.path.join(
self.root, "examples/", self.app.ExampleName(), "android/App/app/libs"
)
libs = ["libc++_shared.so", "libTvCastingApp.so"]
jars = {
"AndroidPlatform.jar": "third_party/connectedhomeip/src/platform/android/AndroidPlatform.jar",
"CHIPAppServer.jar": "third_party/connectedhomeip/src/app/server/java/CHIPAppServer.jar",
"CHIPInteractionModel.jar": "third_party/connectedhomeip/src/controller/java/CHIPInteractionModel.jar",
"TvCastingApp.jar": "TvCastingApp.jar",
}
self.copyToExampleApp(jnilibs_dir, libs_dir, libs, jars)
self.gradlewBuildExampleAndroid()
elif exampleName == "tv-app":
jnilibs_dir = os.path.join(
self.root,
"examples/",
self.app.ExampleName(),
"android/App/app/libs/jniLibs",
self.board.AbiName(),
)
libs_dir = os.path.join(
self.root, "examples/", self.app.ExampleName(), "android/App/app/libs"
)
libs = ["libc++_shared.so", "libTvApp.so"]
jars = {
"OnboardingPayload.jar": "third_party/connectedhomeip/src/controller/java/OnboardingPayload.jar",
"AndroidPlatform.jar": "third_party/connectedhomeip/src/platform/android/AndroidPlatform.jar",
"CHIPAppServer.jar": "third_party/connectedhomeip/src/app/server/java/CHIPAppServer.jar",
"TvApp.jar": "TvApp.jar",
}
self.copyToExampleApp(jnilibs_dir, libs_dir, libs, jars)
self.gradlewBuildExampleAndroid()
elif exampleName == "chip-test":
jnilibs_dir = os.path.join(
self.root,
"examples/android/CHIPTest/app/libs/jniLibs",
self.board.AbiName(),
)
libs_dir = os.path.join(
self.root, "examples/android/CHIPTest/app/libs"
)
libs = ["libc++_shared.so", "libCHIPTest.so"]
jars = {
"AndroidPlatform.jar": "third_party/connectedhomeip/src/platform/android/AndroidPlatform.jar",
"CHIPTest.jar": "CHIPTest.jar",
}
self.copyToExampleApp(jnilibs_dir, libs_dir, libs, jars)
self.gradlewBuildSrcAndroid()
elif exampleName == "virtual-device-app":
jnilibs_dir = os.path.join(
self.root,
"examples/",
self.app.ExampleName(),
"android/App/app/libs/jniLibs",
self.board.AbiName(),
)
libs_dir = os.path.join(
self.root, "examples/", self.app.ExampleName(), "android/App/app/libs"
)
libs = ["libc++_shared.so", "libDeviceApp.so"]
jars = {
"OnboardingPayload.jar": "third_party/connectedhomeip/src/controller/java/OnboardingPayload.jar",
"AndroidPlatform.jar": "third_party/connectedhomeip/src/platform/android/AndroidPlatform.jar",
"CHIPAppServer.jar": "third_party/connectedhomeip/src/app/server/java/CHIPAppServer.jar",
"DeviceApp.jar": "DeviceApp.jar",
}
self.copyToExampleApp(jnilibs_dir, libs_dir, libs, jars)
self.gradlewBuildExampleAndroid()
if (self.profile != AndroidProfile.DEBUG):
self.stripSymbols()
def build_outputs(self):
if self.board.IsIde():
outputs = {
self.app.AppName()
+ "-debug.apk": os.path.join(
self.root,
"examples/android",
self.app.AppName(),
"app/build/outputs/apk/debug/app-debug.apk",
)
}
elif self.app.ExampleName() is not None:
if self.app == AndroidApp.TV_SERVER:
outputs = {
"tv-sever-platform-app-debug.apk": os.path.join(
self.output_dir, "platform-app", "outputs", "apk", "debug", "platform-app-debug.apk"
),
"tv-sever-content-app-debug.apk": os.path.join(
self.output_dir, "content-app", "outputs", "apk", "debug", "content-app-debug.apk"
)
}
elif self.app == AndroidApp.VIRTUAL_DEVICE_APP:
outputs = {
self.app.AppName() + "app-debug.apk": os.path.join(
self.output_dir, "VirtualDeviceApp", "app", "outputs", "apk", "debug", "app-debug.apk"
)
}
else:
outputs = {
self.app.AppName() + "app-debug.apk": os.path.join(
self.output_dir, "outputs", "apk", "debug", "app-debug.apk"
)
}
else:
outputs = {
self.app.AppName() + "app-debug.apk": os.path.join(
self.output_dir, "outputs", "apk", "debug", "app-debug.apk"
),
"CHIPController.jar": os.path.join(
self.output_dir, "lib", "src/controller/java/CHIPController.jar"
),
"CHIPInteractionModel.jar": os.path.join(
self.output_dir, "lib", "src/controller/java/CHIPInteractionModel.jar"
),
"libMatterTlv.jar": os.path.join(
self.output_dir, "lib", "src/controller/java/libMatterTlv.jar"
),
"AndroidPlatform.jar": os.path.join(
self.output_dir, "lib", "src/platform/android/AndroidPlatform.jar"
),
"OnboardingPayload.jar": os.path.join(
self.output_dir,
"lib",
"src/controller/java/OnboardingPayload.jar",
),
"CHIPClusters.jar": os.path.join(
self.output_dir,
"lib",
"src/controller/java/CHIPClusters.jar",
),
"CHIPClusterID.jar": os.path.join(
self.output_dir,
"lib",
"src/controller/java/CHIPClusterID.jar",
),
"jni/%s/libCHIPController.so"
% self.board.AbiName(): os.path.join(
self.output_dir,
"lib",
"jni",
self.board.AbiName(),
"libCHIPController.so",
),
"jni/%s/libc++_shared.so"
% self.board.AbiName(): os.path.join(
self.output_dir,
"lib",
"jni",
self.board.AbiName(),
"libc++_shared.so",
),
}
return outputs