mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-09 01:13:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

all.sh: document new file structure

Browse Source 
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard 2024-10-09 11:18:43 +02:00
parent 1cb8ee81f6
commit 7b556951f9
3 changed files with 31 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
tests/scripts/all-core.sh
View File

@ -3,8 +3,6 @@
# Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
################################################################
#### Documentation
################################################################
@ -14,6 +12,24 @@
#
# To run all tests possible or available on the platform.
#
# Files structure
# ---------------
#
# The executable entry point for users and the CI is tests/scripts/all.sh.
#
# The actual content is in the following files:
# - all-core.sh contains the core logic for running test components,
# processing command line options, reporting results, etc.
# - all-helpers.sh contains helper functions used by more than 1 component.
# - components-*.sh contain the definitions of the various components.
#
# The first two parts are shared between repos and branches;
# the component files are repo&branch-specific.
#
# The files all-*.sh and components-*.sh should only define functions and not
# run code when sourced; the only exception being that all-core.sh runs
# 'shopt' because that is necessary for the rest of the file to parse.
#
# Notes for users
# ---------------
#
@ -143,7 +159,7 @@ pre_check_environment () {
pre_load_components () {
# Include the components from components.sh
test_script_dir="${0%/*}"
for file in "$test_script_dir"/components*.sh; do
for file in "$test_script_dir"/components-*.sh; do
source $file
done
}

10
tests/scripts/all-helpers.sh
View File

@ -3,7 +3,15 @@
# Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
# This file contains helpers for test components that are executed by all.sh
# This file contains helpers for test components that are executed by all.sh.
# See "Files structure" in all-core.sh for other files used by all.sh.
#
# This file is the right place for helpers:
# - that are used by more than one component living in more than one file;
# - or (inclusive) that we want to share accross repos or branches.
#
# Helpers that are used in a single component file that is
# repo&branch-specific can be defined in the file where they are used.
################################################################
#### Helpers for components using libtestdriver1

3
tests/scripts/all.sh
View File

@ -5,6 +5,9 @@
# Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
# This file is executable; it is the entry point for users and the CI.
# See "Files structure" in all-core.sh for other files used.
# The path is going to change when this is moved to the framework
test_script_dir="${0%/*}"
source "$test_script_dir"/all-core.sh