Added: Add termux-core-tests

agnostic-apollo · agnostic-apollo · commit 4834bb0c5716 · 2025-03-05T08:38:13.000+05:00
diff --git a/Makefile b/Makefile
@@ -238,6 +238,19 @@ all: | pre-build
 	"$(TERMUX_CORE__TERMUX_REPLACE_TERMUX_CORE_SRC_SCRIPTS_FILE)" $(BIN_BUILD_OUTPUT_DIR)/*
 
 
+	@printf "\ntermux-core-package: %s\n" "Building tests/*"
+	@mkdir -p $(TESTS_BUILD_OUTPUT_DIR)
+	find tests -maxdepth 1 -type f -name "*.in" -print0 | xargs -0 -n1 sh -c \
+		'output_file="$(TESTS_BUILD_OUTPUT_DIR)/$$(printf "%s" "$$0" | sed -e "s|^tests/||" -e "s/\.in$$//")" && mkdir -p "$$(dirname "$$output_file")" && sed $(TERMUX__CONSTANTS__SED_ARGS) "$$0" > "$$output_file"'
+	find $(TESTS_BUILD_OUTPUT_DIR) -maxdepth 1 -type f -exec chmod 700 "{}" \;
+
+	@printf "\ntermux-core-package: %s\n" "Building tests/scripts/*"
+	@mkdir -p $(TESTS_BUILD_OUTPUT_DIR)/scripts
+	find tests/scripts -type f -name "*.in" -print0 | xargs -0 -n1 sh -c \
+		'output_file="$(TESTS_BUILD_OUTPUT_DIR)/scripts/$$(printf "%s" "$$0" | sed -e "s|^tests/scripts/||" -e "s/\.in$$//")" && mkdir -p "$$(dirname "$$output_file")" && sed $(TERMUX__CONSTANTS__SED_ARGS) "$$0" > "$$output_file"'
+	find $(TESTS_BUILD_OUTPUT_DIR)/scripts -type f -exec chmod 700 "{}" \;
+
+
 	@printf "\ntermux-core-package: %s\n" "Building packaging/debian/*"
 	@mkdir -p $(DEBIAN_PACKAGING_BUILD_OUTPUT_DIR)
 	find packaging/debian -mindepth 1 -maxdepth 1 -type f -name "*.in" -exec sh -c \
@@ -265,10 +278,17 @@ clean:
 install:
 	@printf "termux-core-package: %s\n" "Installing termux-core-package in $(TERMUX_CORE_PKG__INSTALL_PREFIX)"
 	install -d $(TERMUX_CORE_PKG__INSTALL_PREFIX)/bin
+	install -d $(TERMUX_CORE_PKG__INSTALL_PREFIX)/libexec
 
 
 	find $(BIN_BUILD_OUTPUT_DIR) -maxdepth 1 \( -type f -o -type l \) -exec cp -a "{}" $(TERMUX_CORE_PKG__INSTALL_PREFIX)/bin/ \;
 
+
+
+	rm -rf $(TERMUX_CORE_PKG__INSTALL_PREFIX)/libexec/installed-tests/termux-core
+	install -d $(TERMUX_CORE_PKG__INSTALL_PREFIX)/libexec/installed-tests
+	cp -a $(TESTS_BUILD_OUTPUT_DIR) $(TERMUX_CORE_PKG__INSTALL_PREFIX)/libexec/installed-tests/termux-core
+
 	@printf "\ntermux-core-package: %s\n\n" "Install termux-core-package successful"
 
 uninstall:
@@ -277,6 +297,10 @@ uninstall:
 	find scripts \( -type f -o -type l \) -exec sh -c \
 		'rm -f "$(TERMUX_CORE_PKG__INSTALL_PREFIX)/bin/$$(basename "$$1" | sed "s/\.in$$//")"' sh "{}" \;
 
+
+
+	rm -rf $(TERMUX_CORE_PKG__INSTALL_PREFIX)/libexec/installed-tests/termux-core
+
 	@printf "\ntermux-core-package: %s\n\n" "Uninstall termux-core-package successful"
 
 
@@ -286,4 +310,33 @@ packaging-debian-build: all
 
 
 
-.PHONY: all pre-build clean install uninstall packaging-debian-build
+test: all
+	$(MAKE) TERMUX_CORE_PKG__INSTALL_PREFIX=$(PREFIX_BUILD_INSTALL_DIR) install
+
+	@printf "\ntermux-core-package: %s\n" "Executing termux-core-package tests"
+	bash $(PREFIX_BUILD_INSTALL_DIR)/libexec/installed-tests/termux-core/termux-core-tests \
+		--tests-path="$(PREFIX_BUILD_INSTALL_DIR)/libexec/installed-tests/termux-core" \
+		--only-termux-core-tests \
+		-vvv all
+
+test-unit: all
+	$(MAKE) TERMUX_CORE_PKG__INSTALL_PREFIX=$(PREFIX_BUILD_INSTALL_DIR) install
+
+	@printf "\ntermux-core-package: %s\n" "Executing termux-core-package unit tests"
+	bash $(PREFIX_BUILD_INSTALL_DIR)/libexec/installed-tests/termux-core/termux-core-tests \
+		--tests-path="$(PREFIX_BUILD_INSTALL_DIR)/libexec/installed-tests/termux-core" \
+		--only-termux-core-tests \
+		-vvv unit
+
+test-runtime: all
+	$(MAKE) TERMUX_CORE_PKG__INSTALL_PREFIX=$(PREFIX_BUILD_INSTALL_DIR) install
+
+	@printf "\ntermux-core-package: %s\n" "Executing termux-core-package runtime tests"
+	bash $(PREFIX_BUILD_INSTALL_DIR)/libexec/installed-tests/termux-core/termux-core-tests \
+		--tests-path="$(PREFIX_BUILD_INSTALL_DIR)/libexec/installed-tests/termux-core" \
+		--only-termux-core-tests \
+		-vvv runtime
+
+
+
+.PHONY: all pre-build clean install uninstall packaging-debian-build test test-unit test-runtime
diff --git a/site/pages/en/projects/docs/developer/test/index.md b/site/pages/en/projects/docs/developer/test/index.md
@@ -0,0 +1,88 @@
+---
+page_ref: "@ARK_PROJECT__VARIANT@/termux/termux-core-package/docs/@ARK_DOC__VERSION@/developer/test/index.md"
+---
+
+# termux-core-package Test Docs
+
+<!-- @ARK_DOCS__HEADER_PLACEHOLDER@ -->
+
+[`termux-core-tests`](https://github.com/termux/termux-core-package/blob/master/tests/termux-core-tests.in) can be used to run tests for [`termux-core`](https://github.com/termux/termux-core-package) can be tested with and other external Termux packages.
+
+To show help, run `"${TERMUX__PREFIX:-$PREFIX}/libexec/installed-tests/termux-core/termux-core-tests" --help`.
+
+&nbsp;
+
+To run all tests, run `"${TERMUX__PREFIX:-$PREFIX}/libexec/installed-tests/termux-core/termux-core-tests" -vv all`. You can optionally run only `unit` or `runtime` tests as well.
+- The `unit` tests test different units/components of libraries and executables.
+- The `runtime` tests test the runtime execution of libraries and executables.
+
+&nbsp;
+
+Two variants of each test binary is compiled.
+- With `fsanitize` enabled with the `-fsanitize=address -fsanitize-recover=address -fno-omit-frame-pointer` flags that contain `-fsanitize` in filename
+- Without `fsanitize` enabled that contain `-nofsanitize` in filename.
+
+This is requires because `fsanitize` does not work on all Android versions/architectures properly and may crash with false positives with the `AddressSantizier: SEGV on unknown address` error, like Android `7` (always crashes) and `x86_64` (requires loop to trigger as occasional crash), even for a source file compiled with an empty `main()` function.
+
+To enable `AddressSantizier` while running `termux-core-tests`, pass `-f`. To also enable `LeakSanitizer`, pass `-l` as well, but if it is not supported on current device, the `termux-core-tests` will error out with `AddressSantizier: detect_leaks is not supported on this platform`.
+
+If you get `CANNOT LINK EXECUTABLE *: library "libclang_rt.asan-aarch64.so" not found`, like on Android `7`, you will need to install the `libcompiler-rt` package to get the `libclang_rt.asan-aarch64.so` dynamic library required for `AddressSantizier` if passing `-f`. Export library file path with `export LD_LIBRARY_PATH="${TERMUX__PREFIX:-$PREFIX}/lib/clang/17/lib/linux"` before running tests.
+
+&nbsp;
+
+By default, `termux-core-tests` also runs tests other external Termux packages/commands to ensure proper functioning of the Termux execution environment. To only run `termux-core` package specific tests, pass `--only-termux-core-tests`. To run tests for specific packages only, pass a regex with `--test-packages-filter=<filter>` option.
+
+&nbsp;
+
+Make sure to grant Termux app `Draw over apps` permission as otherwise `termux-am` tests will fail.
+
+---
+
+&nbsp;
+
+
+
+
+
+## Help
+
+```
+termux-core-tests can be used to run tests for 'termux-core' and
+other external Termux packages.
+
+
+Usage:
+    termux-core-tests [command_options] <command>
+
+Available commands:
+    unit                      Run unit tests.
+    runtime                   Run runtime on-device tests.
+    all                       Run all tests.
+
+Available command_options:
+    [ -h | --help ]           Display this help screen.
+    [ --version ]             Display version.
+    [ -q | --quiet ]          Set log level to 'OFF'.
+    [ -v | -vv | -vvv | -vvvvv ]
+                              Set log level to 'DEBUG', 'VERBOSE',
+                              'VVERBOSE' and 'VVVERBOSE'.
+    [ -f ]                    Use fsanitize binaries for AddressSanitizer.
+    [ -l ]                    Detect memory leaks with LeakSanitizer.
+                              Requires '-f' to be passed.
+    [ --no-clean ]            Do not clean test files on failure.
+    [ --only-termux-core-tests ]
+                              Only run 'termux-core' package tests.
+    [ --test-names-filter=<filter> ]
+                              Regex to filter which tests to run by
+                              test name.
+    [ --test-packages-filter=<filter> ]
+                              Regex to filter which tests to run by
+                              package names. By default tests for
+                              both 'termux-core' and external Termux
+                              packages are run.
+    [ --tests-path=<path> ]   The path to installed-tests directory.
+```
+
+---
+
+&nbsp;
diff --git a/tests/scripts/termux-core-project_runtime-script-tests.in b/tests/scripts/termux-core-project_runtime-script-tests.in
@@ -0,0 +1,36 @@
+#!@TERMUX__PREFIX@/bin/bash
+# shellcheck shell=bash
+
+
+##
+# `termux_core_project__runtime_script_tests__main`
+##
+termux_core_project__runtime_script_tests__main() {
+
+    TERMUX_CORE__TESTS__LOG_TAG="@TERMUX__LNAME@-core-prj.rs-tests"
+
+    termux_core__tests__log 4 "main()"
+
+
+    # Run tests.
+    termux_core_project__runtime_script_tests__run_tests || return $?
+
+    return 0
+}
+
+##
+# `termux_core_project__runtime_script_tests__run_tests`
+##
+termux_core_project__runtime_script_tests__run_tests() {
+
+    termux_core__tests__log 2 "runTests(start)"
+
+    TERMUX_CORE__TESTS__TESTS_COUNT="0"
+    TERMUX_CORE__TESTS__LOG_EMPTY_LINE_AFTER_SCRIPT_TEST="true"
+
+
+
+    termux_core__tests__log 2 "runTests(end): $TERMUX_CORE__TESTS__TESTS_COUNT tests completed"
+
+    return 0
+}
diff --git a/tests/termux-core-project_tests.in b/tests/termux-core-project_tests.in
@@ -0,0 +1,75 @@
+#!@TERMUX__PREFIX@/bin/bash
+# shellcheck shell=bash
+
+##
+# `termux_core_project__tests__main`
+##
+termux_core_project__tests__main() {
+
+    TERMUX_CORE__TESTS__LOG_TAG="@TERMUX__LNAME@-core-prj.tests"
+
+    termux_core__tests__log 4 "main()"
+
+    # Set `TERMUX_CORE__TESTS__TESTS_PATH` used by compiled c tests.
+    if [[ ! "$TERMUX_CORE__TESTS__TESTS_PATH" =~ $TERMUX_CORE__TESTS__REGEX__ROOTFS_OR_ABSOLUTE_PATH ]]; then
+        termux_core__tests__log_error "The TERMUX_CORE__TESTS__TESTS_PATH '$TERMUX_CORE__TESTS__TESTS_PATH' is either not set or is not an absolute path"
+        return 1
+    fi
+
+
+    # Run runtime tests.
+    if [[ "$TERMUX_CORE__TESTS__RUN_RUNTIME_TESTS" == "true" ]]; then
+        termux_core_project__runtime_tests__run_command || return $?
+    fi
+
+    return 0
+
+}
+
+
+
+##
+# `termux_core_project__runtime_tests__run_command`
+##
+termux_core_project__runtime_tests__run_command() {
+
+    termux_core__tests__log 4 "Running 'runtime' tests"
+
+    (
+        termux_core_project__runtime_script_tests__run_command || exit $?
+    ) || return $?
+
+    return 0
+
+}
+
+##
+# `termux_core_project__runtime_script_tests__run_command`
+##
+termux_core_project__runtime_script_tests__run_command() {
+
+    local return_value
+
+    local tests_start_time; tests_start_time="$(date "+%s")" || return $?
+
+    termux_core__tests__log 1 "Running 'termux-core-project_runtime-script-tests'"
+
+    (
+        # shellcheck source=tests/scripts/termux-core-project_runtime-script-tests.in
+        termux_core__tests__source_file_from_path \
+            "$TERMUX_CORE__TESTS__TESTS_PATH/scripts/termux-core-project_runtime-script-tests" || exit $?
+
+        termux_core_project__runtime_script_tests__main
+    )
+    return_value=$?
+    if [ $return_value -ne 0 ]; then
+        termux_core__tests__log_error "'termux-core-project_runtime-script-tests' failed"
+        return $return_value
+    fi
+
+    termux_core__tests__log 2 "'termux-core-project_runtime-script-tests' completed in \
+$(termux_core__tests__print_elapsed_time "$tests_start_time")"
+
+    return 0
+
+}
diff --git a/tests/termux-core-tests.in b/tests/termux-core-tests.in
