From 3aeeac5d987b9636b82f00013bbb644d3e4df9ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roland=20H=C3=A4der?= Date: Tue, 21 Jun 2022 19:38:56 +0200 Subject: [PATCH] Rewrite: - rewrote autotest.sh and moved it to bin/dev/ as this is clearly a developer script - the rewrite's goal is towards Shell/POSIX-compliance (e.g. ${VAR} and not $VAR) --- .gitignore | 8 ++ autotest.sh => bin/dev/autotest.sh | 159 +++++++++++++++-------------- 2 files changed, 88 insertions(+), 79 deletions(-) rename autotest.sh => bin/dev/autotest.sh (55%) diff --git a/.gitignore b/.gitignore index 56b90b0e8e..c094f6a246 100644 --- a/.gitignore +++ b/.gitignore @@ -90,3 +90,11 @@ venv/ #ignore avatar picture cache path /avatar +#Ignore autotest results +autotest-results.xml + +#ignore phpunit result cache +tests/.phpunit.result.cache + +#ignore .php_cs (local copy) +.php_cs diff --git a/autotest.sh b/bin/dev/autotest.sh similarity index 55% rename from autotest.sh rename to bin/dev/autotest.sh index 15067bf9d5..a3367db1e5 100755 --- a/autotest.sh +++ b/bin/dev/autotest.sh @@ -15,33 +15,34 @@ # - TEST_SELECTION= ... Specify which tests are used to run (based on the test-labeling) # - XDEBUG_CONFIG= ... Set some XDEBUG specific environment settings for development -DATABASENAME=${MYSQL_DATABASE:-test} -DATABASEUSER=${MYSQL_USERNAME:-friendica} -DATABASEHOST=${MYSQL_HOST:-localhost} -BASEDIR=$PWD +DATABASE_NAME=${FRIENDICA_MYSQL_DATABASE:-test} +DATABASE_USER=${FRIENDICA_MYSQL_USERNAME:-friendica} +DATABASE_HOST=${FRIENDICA_MYSQL_HOST:-localhost} +DATABASE_PASSWORD=${FRIENDICA_MYSQL_PASSWORD:-friendica} +BASEDIR=${PWD} DBCONFIGS="mysql mariadb" TESTS="REDIS MEMCACHE MEMCACHED APCU NODB" -export MYSQL_DATABASE="$DATABASENAME" -export MYSQL_USERNAME="$DATABASEUSER" -export MYSQL_PASSWORD="friendica" +export MYSQL_DATABASE="${DATABASE_NAME}" +export MYSQL_USERNAME="${DATABASE_USER}" +export MYSQL_PASSWORD="${DATABASE_PASSWORD}" -if [ -z "$PHP_EXE" ]; then +if [ -z "${PHP_EXE}" ]; then PHP_EXE=php fi -PHP=$(which "$PHP_EXE") +PHP=$(which "${PHP_EXE}") # Use the Friendica internal composer -COMPOSER="$BASEDIR/bin/composer.phar" +COMPOSER="${BASEDIR}/bin/composer.phar" set -e -_XDEBUG_CONFIG=$XDEBUG_CONFIG +_XDEBUG_CONFIG=${XDEBUG_CONFIG} unset XDEBUG_CONFIG function show_syntax() { echo -e "Syntax: ./autotest.sh [dbconfigname] [testfile]\n" >&2 - echo -e "\t\"dbconfigname\" can be one of: $DBCONFIGS" >&2 + echo -e "\t\"dbconfigname\" can be one of: ${DBCONFIGS}" >&2 echo -e "\t\"testfile\" is the name of a test file, for example lib/template.php" >&2 echo -e "\nDatabase environment variables:\n" >&2 echo -e "\t\"MYSQL_HOST\" Mysql Hostname (Default: localhost)" >&2 @@ -57,22 +58,22 @@ function show_syntax() { echo -e "\nIf no arguments are specified, all tests will be run with all database configs" >&2 } -if [ -x "$PHP" ]; then - echo "Using PHP executable $PHP" +if [ -x "${PHP}" ]; then + echo "Using PHP executable ${PHP}" else - echo "Could not find PHP executable $PHP_EXE" >&2 + echo "Could not find PHP executable ${PHP_EXE}" >&2 exit 3 fi echo "Installing depdendencies" -$PHP "$COMPOSER" install +${PHP} "$COMPOSER" install -PHPUNIT="$BASEDIR/vendor/bin/phpunit" +PHPUNIT="${BASEDIR}/vendor/bin/phpunit" -if [ -x "$PHPUNIT" ]; then - echo "Using PHPUnit executable $PHPUNIT" +if [ -x "${PHPUNIT}" ]; then + echo "Using PHPUnit executable ${PHPUNIT}" else - echo "Could not find PHPUnit executable after composer $PHPUNIT" >&2 + echo "Could not find PHPUnit executable after composer ${PHPUNIT}" >&2 exit 3 fi @@ -83,8 +84,8 @@ fi if [ "$1" ]; then FOUND=0 - for DBCONFIG in $DBCONFIGS; do - if [ "$1" = "$DBCONFIG" ]; then + for DBCONFIG in ${DBCONFIGS}; do + if [ "$1" = "${DBCONFIG}" ]; then FOUND=1 break fi @@ -103,13 +104,13 @@ fi function cleanup_config() { - if [ -n "$DOCKER_CONTAINER_ID" ]; then - echo "Kill the docker $DOCKER_CONTAINER_ID" - docker stop "$DOCKER_CONTAINER_ID" - docker rm -f "$DOCKER_CONTAINER_ID" + if [ -n "${DOCKER_CONTAINER_ID}" ]; then + echo "Kill the docker ${DOCKER_CONTAINER_ID}" + docker stop "${DOCKER_CONTAINER_ID}" + docker rm -f "${DOCKER_CONTAINER_ID}" fi - cd "$BASEDIR" + cd "${BASEDIR}" # Restore existing config if [ -f config/local.config-autotest-backup.php ]; then @@ -122,77 +123,77 @@ trap cleanup_config EXIT function execute_tests() { DB=$1 - echo "Setup environment for $DB testing ..." + echo "Setup environment for ${DB} testing ..." # back to root folder - cd "$BASEDIR" + cd "${BASEDIR}" # backup current config if [ -f config/local.config.php ]; then mv config/local.config.php config/local.config-autotest-backup.php fi - if [ -z "$NOINSTALL" ]; then + if [ -z "${NOINSTALL}" ]; then #drop database - if [ "$DB" == "mysql" ]; then - if [ -n "$USEDOCKER" ]; then + if [ "${DB}" == "mysql" ]; then + if [ -n "${USEDOCKER}" ]; then echo "Fire up the mysql docker" DOCKER_CONTAINER_ID=$(docker run \ -e MYSQL_ROOT_PASSWORD=friendica \ - -e MYSQL_USER="$DATABASEUSER" \ + -e MYSQL_USER="${DATABASE_USER}" \ -e MYSQL_PASSWORD=friendica \ - -e MYSQL_DATABASE="$DATABASENAME" \ + -e MYSQL_DATABASE="${DATABASE_NAME}" \ -d mysql) - DATABASEHOST=$(docker inspect --format="{{.NetworkSettings.IPAddress}}" "$DOCKER_CONTAINER_ID") + DATABASE_HOST=$(docker inspect --format="{{.NetworkSettings.IPAddress}}" "${DOCKER_CONTAINER_ID}") else - if [ -z "$DRONE" ]; then # no need to drop the DB when we are on CI + if [ -z "${DRONE}" ]; then # no need to drop the DB when we are on CI if [ "mysql" != "$(mysql --version | grep -o mysql)" ]; then echo "Your mysql binary is not provided by mysql" echo "To use the docker container set the USEDOCKER environment variable" exit 3 fi - mysql -u "$DATABASEUSER" -pfriendica -e "DROP DATABASE IF EXISTS $DATABASENAME" -h $DATABASEHOST || true - mysql -u "$DATABASEUSER" -pfriendica -e "CREATE DATABASE $DATABASENAME DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci" -h $DATABASEHOST + mysql -u "${DATABASE_USER}" -pfriendica -e "DROP DATABASE IF EXISTS ${DATABASE_NAME}" -h ${DATABASE_HOST} || true + mysql -u "${DATABASE_USER}" -pfriendica -e "CREATE DATABASE ${DATABASE_NAME} DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci" -h ${DATABASE_HOST} else - DATABASEHOST=mysql + DATABASE_HOST=mysql fi fi - echo "Waiting for MySQL $DATABASEHOST initialization..." - if ! bin/wait-for-connection $DATABASEHOST 3306 300; then + echo "Waiting for MySQL ${DATABASE_HOST} initialization..." + if ! bin/wait-for-connection ${DATABASE_HOST} 3306 300; then echo "[ERROR] Waited 300 seconds, no response" >&2 exit 1 fi echo "MySQL is up." fi - if [ "$DB" == "mariadb" ]; then - if [ -n "$USEDOCKER" ]; then + if [ "${DB}" == "mariadb" ]; then + if [ -n "${USEDOCKER}" ]; then echo "Fire up the mariadb docker" DOCKER_CONTAINER_ID=$(docker run \ -e MYSQL_ROOT_PASSWORD=friendica \ - -e MYSQL_USER="$DATABASEUSER" \ + -e MYSQL_USER="${DATABASE_USER}" \ -e MYSQL_PASSWORD=friendica \ - -e MYSQL_DATABASE="$DATABASENAME" \ + -e MYSQL_DATABASE="${DATABASE_NAME}" \ -d mariadb) - DATABASEHOST=$(docker inspect --format="{{.NetworkSettings.IPAddress}}" "$DOCKER_CONTAINER_ID") + DATABASE_HOST=$(docker inspect --format="{{.NetworkSettings.IPAddress}}" "${DOCKER_CONTAINER_ID}") else - if [ -z "$DRONE" ]; then # no need to drop the DB when we are on CI + if [ -z "${DRONE}" ]; then # no need to drop the DB when we are on CI if [ "MariaDB" != "$(mysql --version | grep -o MariaDB)" ]; then echo "Your mysql binary is not provided by mysql" echo "To use the docker container set the USEDOCKER environment variable" exit 3 fi - mysql -u "$DATABASEUSER" -pfriendica -e "DROP DATABASE IF EXISTS $DATABASENAME" -h $DATABASEHOST || true - mysql -u "$DATABASEUSER" -pfriendica -e "CREATE DATABASE $DATABASENAME DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci" -h $DATABASEHOST + mysql -u "${DATABASE_USER}" -pfriendica -e "DROP DATABASE IF EXISTS ${DATABASE_NAME}" -h ${DATABASE_HOST} || true + mysql -u "${DATABASE_USER}" -pfriendica -e "CREATE DATABASE ${DATABASE_NAME} DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci" -h ${DATABASE_HOST} else - DATABASEHOST=mariadb + DATABASE_HOST=mariadb fi fi - echo "Waiting for MariaDB $DATABASEHOST initialization..." - if ! bin/wait-for-connection $DATABASEHOST 3306 300; then + echo "Waiting for MariaDB ${DATABASE_HOST} initialization..." + if ! bin/wait-for-connection ${DATABASE_HOST} 3306 300; then echo "[ERROR] Waited 300 seconds, no response" >&2 exit 1 fi @@ -200,28 +201,28 @@ function execute_tests() { echo "MariaDB is up." fi - if [ -n "$USEDOCKER" ]; then + if [ -n "${USEDOCKER}" ]; then echo "Initialize database..." - docker exec $DOCKER_CONTAINER_ID mysql -u root -pfriendica -e 'CREATE DATABASE IF NOT EXISTS $DATABASENAME;' + docker exec ${DOCKER_CONTAINER_ID} mysql -u root -pfriendica -e "CREATE DATABASE IF NOT EXISTS ${DATABASE_NAME};" fi - export MYSQL_HOST="$DATABASEHOST" + export MYSQL_HOST="${DATABASE_HOST}" #call installer echo "Installing Friendica..." - "$PHP" ./bin/console.php autoinstall --dbuser="$DATABASEUSER" --dbpass=friendica --dbdata="$DATABASENAME" --dbhost="$DATABASEHOST" --url=https://friendica.local --admin=admin@friendica.local + "${PHP}" ./bin/console.php autoinstall --dbuser="${DATABASE_USER}" --dbpass=friendica --dbdata="${DATABASE_NAME}" --dbhost="${DATABASE_HOST}" --url=https://friendica.local --admin=admin@friendica.local fi #test execution echo "Testing..." rm -fr "coverage-html" mkdir "coverage-html" - if [[ "$_XDEBUG_CONFIG" ]]; then - export XDEBUG_CONFIG=$_XDEBUG_CONFIG + if [[ "${_XDEBUG_CONFIG}" ]]; then + export XDEBUG_CONFIG=${_XDEBUG_CONFIG} fi COVER='' - if [ -z "$NOCOVERAGE" ]; then + if [ -z "${NOCOVERAGE}" ]; then COVER="--coverage-clover tests/autotest-clover.xml" else echo "No coverage" @@ -229,51 +230,51 @@ function execute_tests() { # per default, there is no cache installed GROUP='--exclude-group REDIS,MEMCACHE,MEMCACHED,APCU' - if [ "$TEST_SELECTION" == "REDIS" ]; then + if [ "${TEST_SELECTION}" == "REDIS" ]; then GROUP="--group REDIS" fi - if [ "$TEST_SELECTION" == "MEMCACHE" ]; then + if [ "${TEST_SELECTION}" == "MEMCACHE" ]; then GROUP="--group MEMCACHE" fi - if [ "$TEST_SELECTION" == "MEMCACHED" ]; then + if [ "${TEST_SELECTION}" == "MEMCACHED" ]; then GROUP="--group MEMCACHED" fi - if [ "$TEST_SELECTION" == "APCU" ]; then + if [ "${TEST_SELECTION}" == "APCU" ]; then GROUP="--group APCU" fi - if [ "$TEST_SELECTION" == "NODB" ]; then + if [ "${TEST_SELECTION}" == "NODB" ]; then GROUP="--exclude-group DB,SLOWDB" fi - INPUT="$BASEDIR/tests" + INPUT="${BASEDIR}/tests" if [ -n "$2" ]; then - INPUT="$INPUT/$2" + INPUT="${INPUT}/$2" fi - echo "${PHPUNIT[@]}" --configuration tests/phpunit.xml $GROUP $COVER --log-junit "autotest-results.xml" "$INPUT" "$3" - "${PHPUNIT[@]}" --configuration tests/phpunit.xml $GROUP $COVER --log-junit "autotest-results.xml" "$INPUT" "$3" + echo "${PHPUNIT[@]}" --configuration tests/phpunit.xml ${GROUP} ${COVER} --log-junit "autotest-results.xml" "${INPUT}" "$3" + "${PHPUNIT[@]}" --configuration tests/phpunit.xml ${GROUP} ${COVER} --log-junit "autotest-results.xml" "${INPUT}" "$3" RESULT=$? - if [ -n "$DOCKER_CONTAINER_ID" ]; then - echo "Kill the docker $DOCKER_CONTAINER_ID" - docker stop $DOCKER_CONTAINER_ID - docker rm -f $DOCKER_CONTAINER_ID - unset $DOCKER_CONTAINER_ID + if [ -n "${DOCKER_CONTAINER_ID}" ]; then + echo "Kill the docker ${DOCKER_CONTAINER_ID}" + docker stop ${DOCKER_CONTAINER_ID} + docker rm -f ${DOCKER_CONTAINER_ID} + unset ${DOCKER_CONTAINER_ID} fi } # # Start the test execution # -if [ -z "$1" ] && [ -n "$TEST_SELECTION" ]; then +if [ -z "$1" ] && [ -n "${TEST_SELECTION}" ]; then # run all known database configs - for DBCONFIG in $DBCONFIGS; do - execute_tests "$DBCONFIG" + for DBCONFIG in ${DBCONFIGS}; do + execute_tests "${DBCONFIG}" done else FILENAME="$2" - if [ -n "$2" ] && [ ! -f "tests/$FILENAME" ] && [ "${FILENAME:0:2}" != "--" ]; then - FILENAME="../$FILENAME" + if [ -n "$2" ] && [ ! -f "tests/${FILENAME}" ] && [ "${FILENAME:0:2}" != "--" ]; then + FILENAME="../${FILENAME}" fi - execute_tests "$1" "$FILENAME" "$3" + execute_tests "$1" "${FILENAME}" "$3" fi