xref: /aosp_15_r20/build/make/core/tasks/tools/compatibility.mk (revision 9e94795a3d4ef5c1d47486f9a02bb378756cea8a)
1# Copyright (C) 2015 The Android Open Source Project
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#      http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15# Package up a compatibility test suite in a zip file.
16#
17# Input variables:
18#   test_suite_name: the name of this test suite eg. cts
19#   test_suite_tradefed: the name of this test suite's tradefed wrapper
20#   test_suite_dynamic_config: the path to this test suite's dynamic configuration file
21#   test_suite_readme: the path to a README file for this test suite
22#   test_suite_prebuilt_tools: the set of prebuilt tools to be included directly
23#                         in the 'tools' subdirectory of the test suite.
24#   test_suite_tools: the set of tools for this test suite
25#
26# Output variables:
27#   compatibility_zip: the path to the output zip file.
28
29special_mts_test_suites :=
30special_mts_test_suites += $(mts_modules)
31ifneq ($(filter $(special_mts_test_suites),$(patsubst mcts-%,%,$(test_suite_name))),)
32	test_suite_subdir := android-mts
33else ifneq ($(filter $(special_mts_test_suites),$(patsubst mts-%,%,$(test_suite_name))),)
34	test_suite_subdir := android-mts
35else
36	test_suite_subdir := android-$(test_suite_name)
37endif
38
39out_dir := $(HOST_OUT)/$(test_suite_name)/$(test_suite_subdir)
40test_artifacts := $(COMPATIBILITY.$(test_suite_name).FILES)
41test_tools := $(HOST_OUT_JAVA_LIBRARIES)/tradefed.jar \
42  $(HOST_OUT_JAVA_LIBRARIES)/loganalysis.jar \
43  $(HOST_OUT_JAVA_LIBRARIES)/compatibility-host-util.jar \
44  $(HOST_OUT_JAVA_LIBRARIES)/compatibility-tradefed.jar \
45  $(HOST_OUT_JAVA_LIBRARIES)/$(test_suite_tradefed).jar \
46  $(HOST_OUT_JAVA_LIBRARIES)/$(test_suite_tradefed)-tests.jar \
47  $(HOST_OUT_EXECUTABLES)/$(test_suite_tradefed) \
48  $(HOST_OUT_EXECUTABLES)/test-utils-script \
49  $(test_suite_readme)
50
51$(foreach f,$(test_suite_readme),$(if $(strip $(ALL_TARGETS.$(f).META_LIC)),,$(eval ALL_TARGETS.$(f).META_LIC := $(module_license_metadata))))
52
53test_tools += $(test_suite_tools)
54
55# The JDK to package into the test suite zip file.  Always package the linux JDK.
56test_suite_jdk_dir := $(ANDROID_JAVA_HOME)/../linux-x86
57ifndef test_suite_jdk_files
58  # This file gets included many times, so make sure we only run the $(shell) once.
59  # Otherwise it will slow down every build due to all copies of it being rerun when kati
60  # checks the stamp file.
61  test_suite_jdk_files :=$= $(shell find $(test_suite_jdk_dir) -type f | sort)
62endif
63test_suite_jdk := $(call intermediates-dir-for,PACKAGING,$(test_suite_name)_jdk,HOST)/jdk.zip
64$(test_suite_jdk): PRIVATE_JDK_DIR := $(test_suite_jdk_dir)
65$(test_suite_jdk): PRIVATE_SUBDIR := $(test_suite_subdir)
66$(test_suite_jdk): $(test_suite_jdk_files)
67$(test_suite_jdk): $(SOONG_ZIP)
68	$(SOONG_ZIP) -o $@ -P $(PRIVATE_SUBDIR)/jdk -C $(PRIVATE_JDK_DIR) -D $(PRIVATE_JDK_DIR) -sha256
69
70$(call declare-license-metadata,$(test_suite_jdk),SPDX-license-identifier-GPL-2.0-with-classpath-exception,permissive,\
71  $(test_suite_jdk_dir)/legal/java.base/LICENSE,JDK,prebuilts/jdk/$(notdir $(patsubst %/,%,$(dir $(test_suite_jdk_dir)))))
72
73# Copy license metadata
74$(call declare-copy-target-license-metadata,$(out_dir)/$(notdir $(test_suite_jdk)),$(test_suite_jdk))
75$(foreach t,$(test_tools) $(test_suite_prebuilt_tools),\
76  $(eval _dst := $(out_dir)/tools/$(notdir $(t)))\
77  $(if $(strip $(ALL_TARGETS.$(t).META_LIC)),\
78    $(call declare-copy-target-license-metadata,$(_dst),$(t)),\
79    $(warning $(t) has no license metadata)\
80  )\
81)
82test_copied_tools := $(foreach t,$(test_tools) $(test_suite_prebuilt_tools), $(out_dir)/tools/$(notdir $(t))) $(out_dir)/$(notdir $(test_suite_jdk))
83
84
85# Include host shared libraries
86host_shared_libs := $(call copy-many-files, $(COMPATIBILITY.$(test_suite_name).HOST_SHARED_LIBRARY.FILES))
87
88$(if $(strip $(host_shared_libs)),\
89  $(foreach p,$(COMPATIBILITY.$(test_suite_name).HOST_SHARED_LIBRARY.FILES),\
90    $(eval _src := $(call word-colon,1,$(p)))\
91    $(eval _dst := $(call word-colon,2,$(p)))\
92    $(if $(strip $(ALL_TARGETS.$(_src).META_LIC)),\
93      $(call declare-copy-target-license-metadata,$(_dst),$(_src)),\
94      $(warning $(_src) has no license metadata for $(_dst))\
95    )\
96  )\
97)
98
99compatibility_zip_deps := \
100  $(test_artifacts) \
101  $(test_tools) \
102  $(test_suite_prebuilt_tools) \
103  $(test_suite_dynamic_config) \
104  $(test_suite_jdk) \
105  $(MERGE_ZIPS) \
106  $(SOONG_ZIP) \
107  $(host_shared_libs) \
108  $(test_suite_extra_deps) \
109
110compatibility_zip_resources := $(out_dir)/tools $(out_dir)/testcases $(out_dir)/lib $(out_dir)/lib64
111
112# Test Suite NOTICE files
113test_suite_notice_txt := $(out_dir)/NOTICE.txt
114test_suite_notice_html := $(out_dir)/NOTICE.html
115
116compatibility_zip_deps += $(test_suite_notice_txt)
117compatibility_zip_resources += $(test_suite_notice_txt)
118
119compatibility_tests_list_zip := $(HOST_OUT)/$(test_suite_name)/android-$(test_suite_name)-tests_list.zip
120
121compatibility_zip := $(HOST_OUT)/$(test_suite_name)/android-$(test_suite_name).zip
122$(compatibility_zip) : .KATI_IMPLICIT_OUTPUTS := $(compatibility_tests_list_zip)
123$(compatibility_zip): PRIVATE_OUT_DIR := $(out_dir)
124$(compatibility_zip): PRIVATE_TOOLS := $(test_tools) $(test_suite_prebuilt_tools)
125$(compatibility_zip): PRIVATE_SUITE_NAME := $(test_suite_name)
126$(compatibility_zip): PRIVATE_DYNAMIC_CONFIG := $(test_suite_dynamic_config)
127$(compatibility_zip): PRIVATE_RESOURCES := $(compatibility_zip_resources)
128$(compatibility_zip): PRIVATE_JDK := $(test_suite_jdk)
129$(compatibility_zip): PRIVATE_tests_list := $(out_dir)-tests_list
130$(compatibility_zip): PRIVATE_tests_list_zip := $(compatibility_tests_list_zip)
131ifeq ($(strip $(HAS_BUILD_NUMBER)),true)
132$(compatibility_zip): $(BUILD_NUMBER_FILE)
133endif
134$(compatibility_zip): $(compatibility_zip_deps) | $(ADB) $(ACP)
135# Make dir structure
136	mkdir -p $(PRIVATE_OUT_DIR)/tools $(PRIVATE_OUT_DIR)/testcases
137	rm -f $@ $@.tmp $@.jdk
138	echo $(BUILD_NUMBER_FROM_FILE) > $(PRIVATE_OUT_DIR)/tools/version.txt
139# Copy tools
140	cp $(PRIVATE_TOOLS) $(PRIVATE_OUT_DIR)/tools
141	$(if $(PRIVATE_DYNAMIC_CONFIG),$(hide) cp $(PRIVATE_DYNAMIC_CONFIG) $(PRIVATE_OUT_DIR)/testcases/$(PRIVATE_SUITE_NAME).dynamic)
142	find $(PRIVATE_RESOURCES) | sort >$@.list
143	$(SOONG_ZIP) -d -o $@.tmp -C $(dir $@) -l $@.list -sha256
144	$(MERGE_ZIPS) $@ $@.tmp $(PRIVATE_JDK)
145	rm -f $@.tmp
146# Build a list of tests
147	rm -f $(PRIVATE_tests_list)
148	$(hide) grep -e .*\\.config$$ $@.list | sed s%$(PRIVATE_OUT_DIR)/testcases/%%g > $(PRIVATE_tests_list)
149	$(SOONG_ZIP) -d -o $(PRIVATE_tests_list_zip) -j -f $(PRIVATE_tests_list)
150	rm -f $(PRIVATE_tests_list)
151
152$(call declare-0p-target,$(compatibility_tests_list_zip),)
153
154$(call declare-1p-container,$(compatibility_zip),)
155$(call declare-container-license-deps,$(compatibility_zip),$(compatibility_zip_deps) $(test_copied_tools), $(out_dir)/:/)
156
157$(eval $(call html-notice-rule,$(test_suite_notice_html),"Test suites","Notices for files contained in the test suites filesystem image:",$(compatibility_zip),$(compatibility_zip)))
158$(eval $(call text-notice-rule,$(test_suite_notice_txt),"Test suites","Notices for files contained in the test suites filesystem image:",$(compatibility_zip),$(compatibility_zip)))
159
160$(call declare-0p-target,$(test_suite_notice_html))
161$(call declare-0p-target,$(test_suite_notice_txt))
162
163$(call declare-1p-copy-files,$(test_suite_dynamic_config),)
164$(call declare-1p-copy-files,$(test_suite_prebuilt_tools),)
165
166# Reset all input variables
167test_suite_name :=
168test_suite_tradefed :=
169test_suite_dynamic_config :=
170test_suite_readme :=
171test_suite_prebuilt_tools :=
172test_suite_tools :=
173test_suite_jdk :=
174test_suite_jdk_dir :=
175host_shared_libs :=
176test_suite_extra_deps :=
177