Add syntax explanation

autotest.sh

@@ -6,6 +6,7 @@ DATABASEHOST=${MYSQL_HOST:-localhost}
 BASEDIR=$PWD
 
 DBCONFIGS="mysql mariadb"
+TESTS="REDIS MEMCACHE MEMCACHED APCU NODB"
 
 export MYSQL_DATABASE="$DATABASENAME"
 export MYSQL_USERNAME="$DATABASEUSER"
@@ -23,6 +24,24 @@ set -e
 _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\"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
+  echo -e "\t\"MYSQL_USDRNAME\" Mysql Username (Default: friendica)" >&2
+  echo -e "\t\"MYSQL_DATABASE\" Mysql Database (Default: test)" >&2
+  echo -e "\nOther environment variables:\n" >&2
+  echo -e "\t\"TEST_SELECTION\" test a specific group of tests, can be one of: $TESTS" >&2
+  echo -e "\t\"NOINSTALL\" If set to true, skip the db and install process" >&2
+  echo -e "\t\"NOCOVERAGE\" If set to true, don't create a coverage output" >&2
+  echo -e "\t\"USEDOCKER\" If set to true, the DB server will be executed inside a docker container" >&2
+  echo -e "\nExample: NOCOVERAGE=true ./autotest.sh mysql src/Core/Cache/MemcacheTest.php" >&2
+  echo "will run the test suite from \"tests/src/Core/Cache/MemcacheTest.php\" without a Coverage" >&2
+  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"
 else
@@ -43,8 +62,8 @@ else
 fi
 
 if ! [ \( -w config -a ! -f config/local.config.php \) -o \( -f config/local.config.php -a -w config/local.config.php \) ]; then
-	echo "Please enable write permissions on config and config/config.php" >&2
-	exit 1
+  echo "Please enable write permissions on config and config/config.php" >&2
+  exit 1
 fi
 
 if [ "$1" ]; then
@@ -57,6 +76,7 @@ if [ "$1" ]; then
   done
   if [ $FOUND = 0 ]; then
     echo -e "Unknown database config name \"$1\"\n" >&2
+    show_syntax
     exit 2
   fi
 fi
@@ -66,165 +86,165 @@ if [ -f config/local.config.php ] && [ ! -f config/local.config-autotest-backup.
   mv config/local.config.php config/local.config-autotest-backup.php
 fi
 
-function cleanup_config {
+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"
-    fi
+  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
-      mv config/local.config-autotest-backup.php config/local.config.php
-    fi
+  # Restore existing config
+  if [ -f config/local.config-autotest-backup.php ]; then
+    mv config/local.config-autotest-backup.php config/local.config.php
+  fi
 }
 
 # restore config on exit
 trap cleanup_config EXIT
 
-function execute_tests {
-    DB=$1
-    echo "Setup environment for $DB testing ..."
-    # back to root folder
-    cd "$BASEDIR"
-
-    # backup current config
-    if [ -f config/local.config.php ]; then
-      mv config/local.config.php config/local.config-autotest-backup.php
-    fi
+function execute_tests() {
+  DB=$1
+  echo "Setup environment for $DB testing ..."
+  # back to root folder
+  cd "$BASEDIR"
 
-    if [ -z "$NOINSTALL" ]; then
-      #drop database
-      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_PASSWORD=friendica \
-                    -e MYSQL_DATABASE="$DATABASENAME" \
-                    -d mysql)
-            DATABASEHOST=$(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 [ "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
-            else
-              DATABASEHOST=mysql
-            fi
-          fi
+  # backup current config
+  if [ -f config/local.config.php ]; then
+    mv config/local.config.php config/local.config-autotest-backup.php
+  fi
 
-          echo "Waiting for MySQL $DATABASEHOST initialization..."
-          if ! bin/wait-for-connection $DATABASEHOST 3306 300; then
-            echo "[ERROR] Waited 300 seconds, no response" >&2
-            exit 1
+  if [ -z "$NOINSTALL" ]; then
+    #drop database
+    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_PASSWORD=friendica \
+          -e MYSQL_DATABASE="$DATABASENAME" \
+          -d mysql)
+        DATABASEHOST=$(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 [ "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
-
-          echo "MySQL is up."
+          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
+        else
+          DATABASEHOST=mysql
+        fi
       fi
-      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_PASSWORD=friendica \
-                    -e MYSQL_DATABASE="$DATABASENAME" \
-                    -d mariadb)
-            DATABASEHOST=$(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 [ "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
-            else
-              DATABASEHOST=mariadb
-            fi
-          fi
 
-           echo "Waiting for MariaDB $DATABASEHOST initialization..."
-            if ! bin/wait-for-connection $DATABASEHOST 3306 300; then
-                echo "[ERROR] Waited 300 seconds, no response" >&2
-                exit 1
-            fi
-
-            echo "MariaDB is up."
+      echo "Waiting for MySQL $DATABASEHOST initialization..."
+      if ! bin/wait-for-connection $DATABASEHOST 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
-        echo "Initialize database..."
-        docker exec $DOCKER_CONTAINER_ID mysql -u root -pfriendica -e 'CREATE DATABASE IF NOT EXISTS $DATABASENAME;'
+        echo "Fire up the mariadb docker"
+        DOCKER_CONTAINER_ID=$(docker run \
+          -e MYSQL_ROOT_PASSWORD=friendica \
+          -e MYSQL_USER="$DATABASEUSER" \
+          -e MYSQL_PASSWORD=friendica \
+          -e MYSQL_DATABASE="$DATABASENAME" \
+          -d mariadb)
+        DATABASEHOST=$(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 [ "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
+        else
+          DATABASEHOST=mariadb
+        fi
       fi
 
-      export MYSQL_HOST="$DATABASEHOST"
+      echo "Waiting for MariaDB $DATABASEHOST initialization..."
+      if ! bin/wait-for-connection $DATABASEHOST 3306 300; then
+        echo "[ERROR] Waited 300 seconds, no response" >&2
+        exit 1
+      fi
 
-      #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
+      echo "MariaDB is up."
     fi
 
-    #test execution
-    echo "Testing..."
-    rm -fr "coverage-html"
-    mkdir "coverage-html"
-    if [[ "$_XDEBUG_CONFIG" ]]; then
-      export XDEBUG_CONFIG=$_XDEBUG_CONFIG
+    if [ -n "$USEDOCKER" ]; then
+      echo "Initialize database..."
+      docker exec $DOCKER_CONTAINER_ID mysql -u root -pfriendica -e 'CREATE DATABASE IF NOT EXISTS $DATABASENAME;'
     fi
 
-    COVER=''
-    if [ -z "$NOCOVERAGE" ]; then
-      COVER="--coverage-clover tests/autotest-clover.xml"
-    else
-      echo "No coverage"
-    fi
+    export MYSQL_HOST="$DATABASEHOST"
 
-    # per default, there is no cache installed
-    GROUP='--exclude-group REDIS,MEMCACHE,MEMCACHED,APCU'
-    if [ "$TEST_SELECTION" == "REDIS" ]; then
-      GROUP="--group REDIS"
-    fi
-    if [ "$TEST_SELECTION" == "MEMCACHE" ]; then
-      GROUP="--group MEMCACHE"
-    fi
-    if [ "$TEST_SELECTION" == "MEMCACHED" ]; then
-      GROUP="--group MEMCACHED"
-    fi
-    if [ "$TEST_SELECTION" == "APCU" ]; then
-      GROUP="--group APCU"
-    fi
-    if [ "$TEST_SELECTION" == "NODB" ]; then
-      GROUP="--exclude-group DB,SLOWDB"
-    fi
+    #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
+  fi
 
-    INPUT="$BASEDIR/tests"
-    if [ -n "$2" ]; then
-      INPUT="$INPUT/$2"
-    fi
+  #test execution
+  echo "Testing..."
+  rm -fr "coverage-html"
+  mkdir "coverage-html"
+  if [[ "$_XDEBUG_CONFIG" ]]; then
+    export XDEBUG_CONFIG=$_XDEBUG_CONFIG
+  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"
-    RESULT=$?
+  COVER=''
+  if [ -z "$NOCOVERAGE" ]; then
+    COVER="--coverage-clover tests/autotest-clover.xml"
+  else
+    echo "No coverage"
+  fi
 
-    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
+  # per default, there is no cache installed
+  GROUP='--exclude-group REDIS,MEMCACHE,MEMCACHED,APCU'
+  if [ "$TEST_SELECTION" == "REDIS" ]; then
+    GROUP="--group REDIS"
+  fi
+  if [ "$TEST_SELECTION" == "MEMCACHE" ]; then
+    GROUP="--group MEMCACHE"
+  fi
+  if [ "$TEST_SELECTION" == "MEMCACHED" ]; then
+    GROUP="--group MEMCACHED"
+  fi
+  if [ "$TEST_SELECTION" == "APCU" ]; then
+    GROUP="--group APCU"
+  fi
+  if [ "$TEST_SELECTION" == "NODB" ]; then
+    GROUP="--exclude-group DB,SLOWDB"
+  fi
+
+  INPUT="$BASEDIR/tests"
+  if [ -n "$2" ]; then
+    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"
+  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
+  fi
 }
 
 #