1#
2# Copyright (C) 2011 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8#      http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16
17ifndef ART_ANDROID_COMMON_TEST_MK
18ART_ANDROID_COMMON_TEST_MK = true
19
20include art/build/Android.common_path.mk
21
22# Directory used for temporary test files on the host.
23# TMPDIR is always provided by the build system as $OUT_DIR-unique temporary directory.
24ART_HOST_TEST_DIR := $(TMPDIR)/test-art
25
26# List of known broken tests that we won't attempt to execute. The test name must be the full
27# rule name such as test-art-host-oat-optimizing-HelloWorld64.
28ART_TEST_KNOWN_BROKEN :=
29
30# List of known failing tests that when executed won't cause test execution to not finish.
31# The test name must be the full rule name such as test-art-host-oat-optimizing-HelloWorld64.
32ART_TEST_KNOWN_FAILING :=
33
34# Keep going after encountering a test failure?
35ART_TEST_KEEP_GOING ?= true
36
37# Do you want run-test to be quieter? run-tests will only show output if they fail.
38ART_TEST_QUIET ?= true
39
40# Define the command run on test failure. $(1) is the name of the test. Executed by the shell.
41# If the test was a top-level make target (e.g. `test-art-host-gtest-codegen_test64`), the command
42# fails with exit status 1 (returned by the last `grep` statement below).
43# Otherwise (e.g., if the test was run as a prerequisite of a compound test command, such as
44# `test-art-host-gtest-codegen_test`), the command does not fail, as this would break rules running
45# ART_TEST_PREREQ_FINISHED as one of their actions, which expects *all* prerequisites *not* to fail.
46define ART_TEST_FAILED
47  ( [ -f $(ART_HOST_TEST_DIR)/skipped/$(1) ] || \
48    (mkdir -p $(ART_HOST_TEST_DIR)/failed/ && touch $(ART_HOST_TEST_DIR)/failed/$(1) && \
49      echo $(ART_TEST_KNOWN_FAILING) | grep -q $(1) \
50        && (echo -e "$(1) \e[91mKNOWN FAILURE\e[0m") \
51        || (echo -e "$(1) \e[91mFAILED\e[0m" >&2; echo $(MAKECMDGOALS) | grep -q -v $(1))))
52endef
53
54ifeq ($(ART_TEST_QUIET),true)
55  ART_TEST_ANNOUNCE_PASS := ( true )
56  ART_TEST_ANNOUNCE_RUN := ( true )
57  ART_TEST_ANNOUNCE_SKIP_FAILURE := ( true )
58  ART_TEST_ANNOUNCE_SKIP_BROKEN := ( true )
59else
60  # Note the use of '=' and not ':=' is intentional since these are actually functions.
61  ART_TEST_ANNOUNCE_PASS = ( echo -e "$(1) \e[92mPASSED\e[0m" )
62  ART_TEST_ANNOUNCE_RUN = ( echo -e "$(1) \e[95mRUNNING\e[0m")
63  ART_TEST_ANNOUNCE_SKIP_FAILURE = ( echo -e "$(1) \e[93mSKIPPING DUE TO EARLIER FAILURE\e[0m" )
64  ART_TEST_ANNOUNCE_SKIP_BROKEN = ( echo -e "$(1) \e[93mSKIPPING BROKEN TEST\e[0m" )
65endif
66
67# Define the command run on test success. $(1) is the name of the test. Executed by the shell.
68# The command checks prints "PASSED" then checks to see if this was a top-level make target (e.g.
69# "mm test-art-host-oat-HelloWorld32"), if it was then it does nothing, otherwise it creates a file
70# to be printed in the passing test summary.
71define ART_TEST_PASSED
72  ( $(call ART_TEST_ANNOUNCE_PASS,$(1)) && \
73    (echo $(MAKECMDGOALS) | grep -q $(1) || \
74      (mkdir -p $(ART_HOST_TEST_DIR)/passed/ && touch $(ART_HOST_TEST_DIR)/passed/$(1))))
75endef
76
77# Define the command run on test success of multiple prerequisites. $(1) is the name of the test.
78# When the test is a top-level make target then a summary of the ran tests is produced. Executed by
79# the shell.
80define ART_TEST_PREREQ_FINISHED
81  (echo -e "$(1) \e[32mCOMPLETE\e[0m" && \
82    (echo $(MAKECMDGOALS) | grep -q -v $(1) || \
83      (([ -d $(ART_HOST_TEST_DIR)/passed/ ] \
84        && (echo -e "\e[92mPASSING TESTS\e[0m" && ls -1 $(ART_HOST_TEST_DIR)/passed/) \
85        || (echo -e "\e[91mNO TESTS PASSED\e[0m")) && \
86      ([ -d $(ART_HOST_TEST_DIR)/skipped/ ] \
87        && (echo -e "\e[93mSKIPPED TESTS\e[0m" && ls -1 $(ART_HOST_TEST_DIR)/skipped/) \
88        || (echo -e "\e[92mNO TESTS SKIPPED\e[0m")) && \
89      ([ -d $(ART_HOST_TEST_DIR)/failed/ ] \
90        && (echo -e "\e[91mFAILING TESTS\e[0m" >&2 && ls -1 $(ART_HOST_TEST_DIR)/failed/ >&2) \
91        || (echo -e "\e[92mNO TESTS FAILED\e[0m")) \
92      && ([ ! -d $(ART_HOST_TEST_DIR)/failed/ ] && rm -r $(ART_HOST_TEST_DIR) \
93          || (rm -r $(ART_HOST_TEST_DIR) && false)))))
94endef
95
96# Define the command executed by the shell ahead of running an art test. $(1) is the name of the
97# test.
98define ART_TEST_SKIP
99  ((echo $(ART_TEST_KNOWN_BROKEN) | grep -q -v $(1) \
100     && ([ ! -d $(ART_HOST_TEST_DIR)/failed/ ] || [ $(ART_TEST_KEEP_GOING) = true ])\
101     && $(call ART_TEST_ANNOUNCE_RUN,$(1)) ) \
102   || ((mkdir -p $(ART_HOST_TEST_DIR)/skipped/ && touch $(ART_HOST_TEST_DIR)/skipped/$(1) \
103     && ([ -d $(ART_HOST_TEST_DIR)/failed/ ] \
104       && $(call ART_TEST_ANNOUNCE_SKIP_FAILURE,$(1)) ) \
105     || $(call ART_TEST_ANNOUNCE_SKIP_BROKEN,$(1)) ) && false))
106endef
107
108# Create a build rule to create the dex file for a test.
109# $(1): module prefix, e.g. art-test-dex
110# $(2): input test directory in art/test, e.g. HelloWorld
111# $(3): target output module path (default module path is used on host)
112# $(4): additional dependencies
113# $(5): a make variable used to collate target dependencies, e.g ART_TEST_TARGET_OAT_HelloWorld_DEX
114# $(6): a make variable used to collate host dependencies, e.g ART_TEST_HOST_OAT_HelloWorld_DEX
115#
116# If the input test directory contains a file called main.list,
117# then a multi-dex file is created passing main.list as the --main-dex-list
118# argument to dx.
119define build-art-test-dex
120  ifeq ($(ART_BUILD_TARGET),true)
121    include $(CLEAR_VARS)
122    LOCAL_MODULE := $(1)-$(2)
123    LOCAL_SRC_FILES := $(call all-java-files-under, $(2))
124    LOCAL_NO_STANDARD_LIBRARIES := true
125    LOCAL_DEX_PREOPT := false
126    LOCAL_ADDITIONAL_DEPENDENCIES := art/build/Android.common_test.mk $(4)
127    LOCAL_MODULE_TAGS := tests
128    LOCAL_JAVA_LIBRARIES := $(TARGET_TEST_CORE_JARS)
129    LOCAL_MODULE_PATH := $(3)
130    ifneq ($(wildcard $(LOCAL_PATH)/$(2)/main.list),)
131      LOCAL_MIN_SDK_VERSION := 19
132      LOCAL_DX_FLAGS := --multi-dex --main-dex-list=$(LOCAL_PATH)/$(2)/main.list --minimal-main-dex
133    endif
134    include $(BUILD_JAVA_LIBRARY)
135    $(5) := $$(LOCAL_INSTALLED_MODULE)
136  endif
137  ifeq ($(ART_BUILD_HOST),true)
138    include $(CLEAR_VARS)
139    LOCAL_MODULE := $(1)-$(2)
140    LOCAL_SRC_FILES := $(call all-java-files-under, $(2))
141    LOCAL_NO_STANDARD_LIBRARIES := true
142    LOCAL_DEX_PREOPT := false
143    LOCAL_ADDITIONAL_DEPENDENCIES := art/build/Android.common_test.mk $(4)
144    LOCAL_JAVA_LIBRARIES := $(HOST_TEST_CORE_JARS)
145    ifneq ($(wildcard $(LOCAL_PATH)/$(2)/main.list),)
146      LOCAL_MIN_SDK_VERSION := 19
147      LOCAL_DX_FLAGS := --multi-dex --main-dex-list=$(LOCAL_PATH)/$(2)/main.list --minimal-main-dex
148    endif
149    include $(BUILD_HOST_DALVIK_JAVA_LIBRARY)
150    $(6) := $$(LOCAL_INSTALLED_MODULE)
151  endif
152endef
153
154endif # ART_ANDROID_COMMON_TEST_MK
155