#!/bin/bash # # --------------------------------------------------------------------- # # GLPI - Gestionnaire Libre de Parc Informatique # # http://glpi-project.org # # @copyright 2015-2025 Teclib' and contributors. # @copyright 2003-2014 by the INDEPNET Development Team. # @licence https://www.gnu.org/licenses/gpl-3.0.html # # --------------------------------------------------------------------- # # LICENSE # # This file is part of GLPI. # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # --------------------------------------------------------------------- # set -e -u -o pipefail WORKING_DIR=$(readlink -f "$(dirname $0)") # Declaration order in $TESTS_SUITES corresponds to the execution order TESTS_SUITES=( "lint" "lint_php" "lint_js" "lint_scss" "lint_twig" "security_scan" "install" "update" "functional" "cache" "ldap" "imap" "web" "javascript" "e2e" ) # Extract named options ALL=false HELP=false BUILD=false INTERACTIVE=false while [[ $# -gt 0 ]]; do if [[ $1 == "--"* ]]; then ## Remove -- prefix, replace - by _ and uppercase all declare $(echo $1 | sed -e 's/^--//g' | sed -e 's/-/_/g' -e 's/\(.*\)/\U\1/')=true shift else break fi done # Flag to indicate whether services containers are useful USE_SERVICES_CONTAINERS=0 SELECTED_SCOPE="default" SELECTED_METHODS="all" # Extract list of tests suites to run SELECTED_TESTS_TO_RUN=() # Flag to indicate the DB needs to be reinstalled. Required after e2e tests are run before functional or unit tests can be run. NEED_DB_REINSTALL=true if [[ $# -gt 0 ]]; then ARGS=("$@") for KEY in "${ARGS[@]}"; do INDEX=0 for VALID_KEY in "${TESTS_SUITES[@]}"; do if [[ "$VALID_KEY" == "$KEY" ]]; then SELECTED_TESTS_TO_RUN[$INDEX]=$KEY continue 2 # Go to next arg fi INDEX+=1 done echo -e "\e[1;30;43m/!\ Invalid \"$KEY\" test suite \e[0m" done # Ensure install test is executed if something else than "lint" or "javascript" is executed. # This is mandatory as database is initialized by this test suite. # Also, check whether services containers are useful. for TEST_SUITE in "${SELECTED_TESTS_TO_RUN[@]}"; do if [[ ! " lint javascript " =~ " ${TEST_SUITE} " ]]; then USE_SERVICES_CONTAINERS=1 break fi done elif [[ "$ALL" = true ]]; then SELECTED_TESTS_TO_RUN=("${TESTS_SUITES[@]}") # Remove specific lint test, because of global "lint" test suite for TEST in "${!SELECTED_TESTS_TO_RUN[@]}"; do if [[ "${SELECTED_TESTS_TO_RUN[TEST]}" =~ ^lint_.+ ]]; then unset 'SELECTED_TESTS_TO_RUN[TEST]' fi done USE_SERVICES_CONTAINERS=1 fi # If running in interactive mode, always use services containers if [[ "$INTERACTIVE" = true ]]; then USE_SERVICES_CONTAINERS=1 fi # Display help if user asks for it, or if it does not provide which test suite has to be executed if [[ "$HELP" = true || ( ${#SELECTED_TESTS_TO_RUN[@]} -eq 0 && "$INTERACTIVE" = false ) ]]; then cat << EOF This command runs the tests in an environment similar to what is done by CI. Usage: run_tests.sh [options] [tests-suites] Examples: - run_tests.sh --all - run_tests.sh --build ldap imap - run_tests.sh lint - run_tests.sh --interactive Available options: --all run all tests suites --build build dependencies and translation files before running test suites --interactive run tests in interactive mode Available tests suites: - lint - lint_php - lint_js - lint_scss - lint_twig - security_scan - install - update - functional - cache - ldap - imap - web - javascript - e2e EOF exit 0 fi # Check for system dependencies if [[ ! -x "$(command -v docker)" ]]; then echo "This scripts requires the \"docker\" utility to be installed" exit 1 fi LAST_EXIT_CODE=0 # Import variables from .env file this file exists APP_CONTAINER_HOME="" DB_IMAGE="" PHP_IMAGE="" UPDATE_FILES_ACL=false if [[ -f "$WORKING_DIR/.env" ]]; then source $WORKING_DIR/.env fi # Define variables (some may be defined in .env file) APPLICATION_ROOT=$(readlink -f "$WORKING_DIR/..") [[ ! -z "$APP_CONTAINER_HOME" ]] || APP_CONTAINER_HOME=$(mktemp -d -t glpi-tests-home-XXXXXXXXXX) [[ ! -z "$DB_IMAGE" ]] || DB_IMAGE=githubactions-mariadb:10.11 [[ ! -z "$PHP_IMAGE" ]] || PHP_IMAGE=githubactions-php-apache:8.3 # Backup configuration files BACKUP_DIR=$(mktemp -d -t glpi-tests-backup-XXXXXXXXXX) find "$APPLICATION_ROOT/tests/config" -mindepth 1 ! -iname ".gitignore" -exec mv {} $BACKUP_DIR \; # Export variables to env (required for docker compose) and start containers export COMPOSE_FILE="$APPLICATION_ROOT/.github/actions/docker-compose-app.yml" if [[ "$USE_SERVICES_CONTAINERS" ]]; then export COMPOSE_FILE="$COMPOSE_FILE:$APPLICATION_ROOT/.github/actions/docker-compose-services.yml" fi export APPLICATION_ROOT export APP_CONTAINER_HOME export DB_IMAGE export PHP_IMAGE export UPDATE_FILES_ACL $APPLICATION_ROOT/.github/actions/init_containers-start.sh $APPLICATION_ROOT/.github/actions/init_show-versions.sh # Install dependencies if required [[ "$BUILD" = false ]] || docker compose exec -T app .github/actions/init_build.sh INSTALL_TESTS_RUN=false run_single_test () { local TEST_TO_RUN=$1 local TESTS_WITHOUT_INSTALL=("install", "lint" "lint_php" "lint_js" "lint_scss" "lint_twig" "security_scan" "javascript") #Need reinstall if current test is not e2e and $NEED_DB_REINSTALL is true #e2e tests are written to not care about extra data in the database local REINSTALL_NOW=false if [[ $NEED_DB_REINSTALL == true && $TEST_TO_RUN != "e2e" ]]; then REINSTALL_NOW=true fi if [[ ($INSTALL_TESTS_RUN == false || $REINSTALL_NOW == true) && ! " ${TESTS_WITHOUT_INSTALL[@]} " =~ $TEST_TO_RUN ]]; then echo "The requested test suite \"$TEST_TO_RUN\" requires the \"install\" test suite to be run first." echo "Install tests run status: $INSTALL_TESTS_RUN" echo "Reinstall now status: $REINSTALL_NOW" # Run install test suite before any other test suite run_single_test "install" fi local TEST_ARGS="" if ! [[ "$SCOPE" == "" || "$SCOPE" == "default" ]]; then if [[ -f "${APPLICATION_ROOT}/${SCOPE}" ]]; then TEST_ARGS="-f ${SCOPE}" else TEST_ARGS="-d ${SCOPE}" fi fi if ! [[ "$METHODS" = "" || "$METHODS" == "all" ]]; then TEST_ARGS="${TEST_ARGS} -m ${METHODS}" fi echo -e "\n\e[1;30;43m Running \"$TEST_TO_RUN\" test suite \e[0m" case $TEST_TO_RUN in "lint") # Misc lint (licence headers and locales) is not executed here as their output is not configurable yet # and it would be a pain to handle rolling back of their changes. # TODO Add ability to simulate locales extact without actually modifying locale files. docker compose exec -T app .github/actions/lint_php-lint.sh \ && docker compose exec -T app .github/actions/lint_js-lint.sh \ && docker compose exec -T app .github/actions/lint_scss-lint.sh \ && docker compose exec -T app .github/actions/lint_twig-lint.sh \ || LAST_EXIT_CODE=$? ;; "lint_php") docker compose exec -T app .github/actions/lint_php-lint.sh \ || LAST_EXIT_CODE=$? ;; "lint_js") docker compose exec -T app .github/actions/lint_js-lint.sh \ || LAST_EXIT_CODE=$? ;; "lint_scss") docker compose exec -T app .github/actions/lint_scss-lint.sh \ || LAST_EXIT_CODE=$? ;; "lint_twig") docker compose exec -T app .github/actions/lint_twig-lint.sh \ || LAST_EXIT_CODE=$? ;; "security_scan") docker compose exec -T app vendor/bin/psalm \ || LAST_EXIT_CODE=$? ;; "install") docker compose exec -T app .github/actions/test_install.sh \ || LAST_EXIT_CODE=$? ;; "update") $APPLICATION_ROOT/.github/actions/init_initialize-0.85.5-db.sh \ && $APPLICATION_ROOT/.github/actions/init_initialize-9.5-db.sh \ && docker compose exec -T app .github/actions/test_update-from-older-version.sh \ && docker compose exec -T app .github/actions/test_update-from-9.5.sh \ || LAST_EXIT_CODE=$? ;; "functional") docker compose exec -T app .github/actions/test_tests-functional.sh $TEST_ARGS \ || LAST_EXIT_CODE=$? ;; "cache") docker compose exec -T app .github/actions/test_tests-cache.sh \ || LAST_EXIT_CODE=$? ;; "ldap") $APPLICATION_ROOT/.github/actions/init_initialize-ldap-fixtures.sh \ && docker compose exec -T app .github/actions/test_tests-ldap.sh \ || LAST_EXIT_CODE=$? ;; "imap") $APPLICATION_ROOT/.github/actions/init_initialize-imap-fixtures.sh \ && docker compose exec -T app .github/actions/test_tests-imap.sh \ || LAST_EXIT_CODE=$? ;; "web") docker compose exec -T app .github/actions/test_tests-web.sh \ || LAST_EXIT_CODE=$? ;; "javascript") docker compose exec -T app .github/actions/test_javascript.sh \ || LAST_EXIT_CODE=$? ;; "e2e") $APPLICATION_ROOT/.github/actions/init_initialize-ldap-fixtures.sh \ && docker compose exec -T app .github/actions/test_tests-e2e.sh \ || LAST_EXIT_CODE=$? ;; esac if [[ $TEST_TO_RUN == "e2e" ]]; then NEED_DB_REINSTALL=true fi if [[ $LAST_EXIT_CODE -ne 0 ]]; then echo -e "\e[1;39;41m Tests \"$TEST_TO_RUN\" failed \e[0m\n" else echo -e "\e[1;30;42m Tests \"$TEST_TO_RUN\" passed \e[0m\n" if [[ $TEST_TO_RUN == "install" ]]; then INSTALL_TESTS_RUN=true NEED_DB_REINSTALL=false fi fi } run_tests () { LAST_EXIT_CODE=0 # If no tests are selected, display the info if [[ ${#TESTS_TO_RUN[@]} -eq 0 ]]; then show_info else for TEST_SUITE in "${TESTS_TO_RUN[@]}"; do run_single_test $TEST_SUITE done fi } show_info () { # If no tests are selected, display a message with information about how to select tests if [[ ${#SELECTED_TESTS_TO_RUN[@]} -eq 0 ]]; then echo "Selected actions: none" echo "No actions selected. You can select actions by using the 'set action' command." else echo "Selected actions: ${SELECTED_TESTS_TO_RUN[@]}" fi echo "Selected scope: ${SELECTED_SCOPE}" echo "Selected methods: ${SELECTED_METHODS}" echo "" #empty line } cleanup_and_exit () { # Restore configuration files rm -f $APPLICATION_ROOT/tests/config/* find "$BACKUP_DIR" -mindepth 1 -exec mv -f {} $APPLICATION_ROOT/tests/config \; # Stop containers docker compose down --volumes exit $LAST_EXIT_CODE } # Add ctrl+c handler to cleanup and exit gracefully trap cleanup_and_exit INT if [[ "$INTERACTIVE" = false ]]; then # Do not automatically run tests if in interactive mode TESTS_TO_RUN=("${SELECTED_TESTS_TO_RUN[@]}") SCOPE=$SELECTED_SCOPE METHODS=$SELECTED_METHODS run_tests else echo "GLPI Tests (Interactive mode)" echo "" #empty line fi if [[ "$INTERACTIVE" = true ]]; then CHOICE="" while [[ "$CHOICE" != "exit" ]]; do TESTS_TO_RUN=("${SELECTED_TESTS_TO_RUN[@]}") SCOPE=$SELECTED_SCOPE METHODS=$SELECTED_METHODS show_info read -e -r -p "GLPI Tests > " CHOICE if [[ "$CHOICE" = run* ]]; then # If actions were specified after the run choice, use them instead of the ones selected if [[ "$CHOICE" != "run" ]]; then RUN_OPTS=(${CHOICE#run }) # TESTS_TO_RUN is the first argument. It should be a single word without spaces. # The second argument, if it exists, is the scope. If it doesn't exist, the scope is the selected one. TESTS_TO_RUN=(${RUN_OPTS[0]}) if [[ ${#RUN_OPTS[@]} -gt 1 ]]; then SCOPE=${RUN_OPTS[1]} else SCOPE="default" fi # The third argument, if it exists, is the methods pattern. If it doesn't exist, the methods pattern is the selected one. if [[ ${#RUN_OPTS[@]} -gt 2 ]]; then METHODS=${RUN_OPTS[2]} else METHODS="all" fi fi run_tests elif [[ "$CHOICE" = "help" ]]; then cat << EOF Available commands: - run [action] [scope]: Run the currently selected actions or run the single specified action with the specified scope (defaults to the selected scope). - set action [actions]: Change the currently selected actions. - set scope [scope]: Change the currently selected scope. The scope affects which file or directory the tests are run on (if supported by the test). - set methods [methods]: Change the currently selected methods pattern. This affects which tests methods are run (if supported by the test). - info: Display information about the currently selected actions, scope and methods pattern. - exit: Stop the containers and exit. - help: See this list of commands. EOF elif [[ "$CHOICE" = set[[:space:]]action* ]]; then SELECTED_TESTS_TO_RUN=(${CHOICE#set[[:space:]]action }) elif [[ "$CHOICE" = set[[:space:]]scope* ]]; then SELECTED_SCOPE=${CHOICE#set[[:space:]]scope } if [[ ! "$SELECTED_SCOPE" =~ ^tests/ && "$SELECTED_SCOPE" != "default" && "$SELECTED_SCOPE" != "" ]]; then SELECTED_SCOPE="tests/$SELECTED_SCOPE" fi elif [[ "$CHOICE" = set[[:space:]]methods* ]]; then SELECTED_METHODS=${CHOICE#set[[:space:]]methods } elif [[ "$CHOICE" = "info" ]]; then show_info elif [[ "$CHOICE" = "exit" ]]; then cleanup_and_exit else echo -e "\e[1;39;41m Invalid command \e[0m" fi CHOICE="" done fi cleanup_and_exit