test: change testing strategy (#339)

Author: e0ipso

.env

@@ -1,75 +1,53 @@
-dist: trusty
-group: edge
 language: php
-
-addons:
-  chrome: stable
-
-php:
-  - 7.1
-  - 7.2
-
+php: 7.2
 cache:
   directories:
     - "$HOME/.composer/cache/files"
-
 env:
   global:
     - PROJECT_NAME=contentacms
     - PROJECT_BASE_PATH=$HOME/$PROJECT_NAME
     - PROJECT_RELEASE_BRANCH=${PROJECT_RELEASE_BRANCH:-8.x-3.x}
-    - WEB_HOST=127.0.0.1
-    - WEB_PORT=8888
+    - SIMPLETEST_BASE_URL=http://127.0.0.1:8888
+    - SIMPLETEST_DB=sqlite://tmp/site.sqlite
 
 branches:
   only:
     - /^8\.x\-[0-9]+\.x$/
 
-before_install:
-  # Fixes Composer exhausting the memory when using PHP 5.6.
-  - echo "memory_limit=-1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
-  # Fix failing tests due to email sending.
-  - echo 'sendmail_path = /bin/true' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
-  - mkdir $PROJECT_BASE_PATH
-  # Load .env and .local.env
-  - source ./scripts/ci/travis/load_env.sh
-
-install:
-  - composer run-script install-contenta $PROJECT_BASE_PATH --timeout=0
-  - composer run-script ci:helper setup_anonymous_user "$PROJECT_BASE_PATH" --timeout=0
-
-before_script:
-  # Start Contenta Local Server
-  - composer run-script start-contenta $PROJECT_BASE_PATH --timeout=0 &
-  - until curl -s $WEB_HOST:$WEB_PORT; do sleep 1; done > /dev/null
-
-script:
-  - composer run-script ci:helper run_functional_tests "$PROJECT_BASE_PATH" --timeout=0
-
-after_script:
-  - killall php
-
-# This stanza creates Travis Stages that are sequentially dependent.
 jobs:
   include:
-    # Deployment Stage
-    # This stage promotes a successful artifact from the deployment branch to GitHub
-    - stage: Release
-      php: 7.2
-      install: skip
+    -
+      stage: test
+      before_install:
+        # Fixes Composer exhausting the memory when using PHP 5.6.
+        - echo "memory_limit=-1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
+        # Fix failing tests due to email sending.
+        - echo 'sendmail_path = /bin/true' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
+        - mkdir $PROJECT_BASE_PATH
+      install: composer run-script install-contenta $PROJECT_BASE_PATH --timeout=0
+      before_script:
+        # Start Contenta CMS Local Server
+        - composer run-script start-contenta $PROJECT_BASE_PATH --timeout=0 &
+        - until curl -sS $SIMPLETEST_BASE_URL; do sleep 1; done > /dev/null
+        - echo "Connected to the test server at ${SIMPLETEST_BASE_URL}"
+      script: composer run-script ci:helper run_functional_tests "$PROJECT_BASE_PATH" --timeout=0
+      after_script: killall php
+
+    -
+      stage: release
+      install: composer run-script install-contenta $PROJECT_BASE_PATH --timeout=0
       before_script: skip
       script: skip
       before_deploy:
-        # Install Contenta
-        - composer run-script install-contenta $PROJECT_BASE_PATH --timeout=0
         # Set Deployment Variable
         - RELEASE_DATE=$( date +%Y-%m-%d)
-        - TRAVIS_TAG="v3.0.${TRAVIS_BUILD_NUMBER}"
-        # Clean the Contenta Profile Folder
+        # Clean the Contenta CMS Profile Folder
         - composer run-script ci:before-deploy contentacms_profile_cleanup "$PROJECT_BASE_PATH/web" --timeout=0
         # Remove Site files
         - composer run-script ci:before-deploy rm_site "$PROJECT_BASE_PATH/web" --timeout=0
         # Zip Folder
+        - TRAVIS_TAG="v3.0.${TRAVIS_BUILD_NUMBER}"
         - composer run-script ci:before-deploy zip_folder "$HOME" "$PROJECT_NAME" "$TRAVIS_TAG" --timeout=0
       deploy:
         provider: releases

.travis.yml

@@ -1,25 +1,56 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<phpunit
-    convertErrorsToExceptions="true"
-    colors="true"
-    convertWarningsToExceptions="true"
-    forceCoversAnnotation="false"
-    stopOnFailure="true"
->
-    <php>
-        <ini name="memory_limit" value="-1" />
-        <env name="WEB_HOST" value="127.0.0.1" />
-        <env name="WEB_HOST" value="8888" />
+<?xml version="1.0" encoding="UTF-8"?>
 
+<!-- TODO set checkForUnintentionallyCoveredCode="true" once https://www.drupal.org/node/2626832 is resolved. -->
+<!-- PHPUnit expects functional tests to be run with either a privileged user
+ or your current system user. See core/tests/README.md and
+ https://www.drupal.org/node/2116263 for details.
+-->
+<phpunit bootstrap="../../../core/tests/bootstrap.php"
+         colors="true"
+         verbose="true"
+         beStrictAboutTestsThatDoNotTestAnything="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutChangesToGlobalState="true">
+    <!-- TODO set printerClass="\Drupal\Tests\Listeners\HtmlOutputPrinter" once
+     https://youtrack.jetbrains.com/issue/WI-24808 is resolved. Drupal provides a
+     result printer that links to the html output results for functional tests.
+     Unfortunately, this breaks the output of PHPStorm's PHPUnit runner. However, if
+     using the command line you can add
+     - -printer="\Drupal\Tests\Listeners\HtmlOutputPrinter" to use it (note there
+     should be no spaces between the hyphens).
+    -->
+    <php>
+        <!-- Set error reporting to E_ALL. -->
+        <ini name="error_reporting" value="32767"/>
+        <!-- Do not limit the amount of memory tests take to run. -->
+        <ini name="memory_limit" value="-1"/>
+        <!-- Example SIMPLETEST_BASE_URL value: http://localhost -->
+        <!-- Example SIMPLETEST_DB value: mysql://username:password@localhost/databasename#table_prefix -->
+        <!-- Example BROWSERTEST_OUTPUT_DIRECTORY value: ../../../sites/simpletest/browser_output -->
+        <ini name="BROWSERTEST_OUTPUT_DIRECTORY" value="../../../sites/simpletest/browser_output"/>
+        <!-- To disable deprecation testing completely uncomment the next line. -->
+        <!-- <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled"/> -->
+        <!-- Example for changing the driver class for mink tests MINK_DRIVER_CLASS value: 'Drupal\FunctionalJavascriptTests\DrupalSelenium2Driver' -->
+        <!-- Example for changing the driver args to mink tests MINK_DRIVER_ARGS value: '["http://127.0.0.1:8510"]' -->
+        <!-- Example for changing the driver args to phantomjs tests MINK_DRIVER_ARGS_PHANTOMJS value: '["http://127.0.0.1:8510"]' -->
+        <!-- Example for changing the driver args to webdriver tests MINK_DRIVER_ARGS_WEBDRIVER value: '["firefox", null, "http://localhost:4444/wd/hub"]' -->
     </php>
     <testsuites>
         <testsuite name="ContentaFunctional">
             <directory suffix="Test.php">tests/src/Functional/</directory>
         </testsuite>
     </testsuites>
+    <listeners>
+        <listener class="\Drupal\Tests\Listeners\DrupalListener">
+        </listener>
+        <!-- The Symfony deprecation listener has to come after the Drupal listener -->
+        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener">
+        </listener>
+    </listeners>
+    <!-- Filter for coverage reports. -->
     <filter>
         <whitelist>
-            <directory>tests/src/</directory>
+            <directory>./tests/src/</directory>
         </whitelist>
     </filter>
 </phpunit>

phpunit.xml

@@ -3,29 +3,6 @@
 COMPOSER_BIN_DIR="$(composer config bin-dir)"
 DOCROOT="web"
 
-# Setup Anonymous User Function
-# Gives access to anonymous user to access protected resources.
-# This function receives one argument:
-#   $1 -> The Drupal Base Path
-setup_anonymous_user() {
-     if [ -z $1 ] ; then
-        echo "Please pass the Contenta Project Base Path to the install_test_dependencies function " 1>&2
-        exit 1
-    fi
-
-    # Setup local variables
-    current_path=`pwd`
-    DRUSH=$1/$COMPOSER_BIN_DIR/drush
-    DRUPAL_BASE=$1/$DOCROOT
-
-    cd $DRUPAL_BASE
-    # Add Permission to anonymous user
-    $DRUSH updatedb -y
-    $DRUSH cr -y
-
-    cd $current_path
-}
-
 # Run Functional Tests Function
 # Run Contenta CMS Functional Tests
 # This function receives one argument:
@@ -36,18 +13,25 @@ run_functional_tests() {
         exit 1
     fi
 
-    if [[ -z $WEB_HOST ]] || [[ -z $WEB_PORT ]] ; then
-        echo "Please ensure that WEB_HOST and WEB_PORT environment variables are set." 1>&2
+    if [[ -z $SIMPLETEST_BASE_URL ]] ; then
+        echo "Please ensure that SIMPLETEST_BASE_URL environment variable is set. Ex: http://localhost" 1>&2
+        exit 1
+    fi
+    if [[ -z $SIMPLETEST_DB ]] ; then
+        echo "Please ensure that SIMPLETEST_DB environment variable is set. Ex: mysql://username:password@localhost/databasename#table_prefix" 1>&2
         exit 1
     fi
 
-    current_path=`pwd`
-    CONTENTA_PATH=$1/$DOCROOT/profiles/contrib/contenta_jsonapi/
-    PHPUNIT=$1/$COMPOSER_BIN_DIR/phpunit
-
-    cd $CONTENTA_PATH
+    # remove xdebug to make php execute faster
+    phpenv config-rm xdebug.ini
 
-    WEB_HOST=$WEB_HOST WEB_PORT=$WEB_PORT $PHPUNIT --testsuite ContentaFunctional
+    CONTENTA_PATH=$1/$DOCROOT/profiles/contrib/contenta_jsonapi/
+    DRUSH=$1/$COMPOSER_BIN_DIR/drush
+    cd $1/$DOCROOT
+    $DRUSH pm-enable --yes simpletest
+    cd $1/$DOCROOT
+    echo "php $1/$DOCROOT/core/scripts/run-tests.sh --php `which php` --url $SIMPLETEST_BASE_URL --suppress-deprecations --verbose --color Contenta"
+    php $1/$DOCROOT/core/scripts/run-tests.sh --php `which php` --url $SIMPLETEST_BASE_URL --suppress-deprecations --verbose --color Contenta
     exit $?
 }
 

scripts/ci/travis/load_env.sh

@@ -40,6 +40,10 @@ if [ -d "$DEST_DIR" ]; then
     sudo rm -Rf $DEST_DIR
   fi
 fi
+
+# update composer
+$COMPOSER self-update
+
 echo "-----------------------------------------------"
 echo " Downloading Contenta CMS using composer "
 echo "-----------------------------------------------"
@@ -52,29 +56,27 @@ if [ $? -ne 0 ]; then
 fi
 
 cd ${DEST_DIR}
-
 $COMPOSER config repositories.contenta_jsonapi path ${BASE_DIR}
-
 $COMPOSER require "contentacms/contenta_jsonapi:*" "phpunit/phpunit:^6" --no-progress
 
 cd $DOCROOT
 echo "-----------------------------------------------"
 echo " Installing Contenta CMS for local usage "
 echo "-----------------------------------------------"
-echo -e "${FG_C}${BG_C} EXECUTING ${NO_C} $DRUSH site-install --verbose --yes --db-url=sqlite://tmp/site.sqlite --site-mail=admin@localhost --account-mail=admin@localhost --site-name='Contenta CMS Demo' --account-name=admin --account-pass=admin\n\n"
+echo -e "${FG_C}${BG_C} EXECUTING ${NO_C} $DRUSH site-install --verbose --yes --db-url=$SIMPLETEST_DB --site-mail=admin@localhost --account-mail=admin@localhost --site-name='Contenta CMS Demo' --account-name=admin --account-pass=admin\n\n"
 # There is a problem installing from CLI. Drush can't locate some required services. Reinstalling a
 # second time usually does the trick.
 # TODO: We need to fix this.
-$DRUSH site-install --verbose --yes --db-url=sqlite://tmp/site.sqlite --site-mail=admin@localhost --account-mail=admin@localhost --site-name='Contenta CMS Demo' --account-name=admin --account-pass=admin;
-$DRUSH site-install --verbose --yes --db-url=sqlite://tmp/site.sqlite --site-mail=admin@localhost --account-mail=admin@localhost --site-name='Contenta CMS Demo' --account-name=admin --account-pass=admin;
+$DRUSH site-install --verbose --yes --db-url=$SIMPLETEST_DB --site-mail=admin@localhost --account-mail=admin@localhost --site-name='Contenta CMS Demo' --account-name=admin --account-pass=admin;
+$DRUSH site-install --verbose --yes --db-url=$SIMPLETEST_DB --site-mail=admin@localhost --account-mail=admin@localhost --site-name='Contenta CMS Demo' --account-name=admin --account-pass=admin;
 
 if [ $? -ne 0 ]; then
   echo -e "${FG_C}${EBG_C} ERROR ${NO_C} The Drupal installer failed to install Contenta CMS."
   exit 3
 fi
 
 echo -e "${FG_C}${BG_C} EXECUTING ${NO_C} $DRUSH en -y recipes_magazin contentajs\n\n"
-$DRUSH en -y recipes_magazin contentajs contenta_graphql
+$DRUSH en -y recipes_magazin contentajs
 
 echo -e "\n\n\n"
 echo -e "\t********************************"

scripts/ci/travis/tests/contenta_ci_tests_helper.sh

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 
-export $(cat .env | xargs)
+if [ -e .env ]; then
+    export $(cat .env | xargs)
+fi
 
 if [ -e .env.local ]; then
     export $(cat .env.local | xargs)
@@ -34,11 +36,11 @@ echo "-------------------------------------"
 echo " Initializing local PHP server "
 echo "-------------------------------------"
 echo -e "${FG_C}${WBG_C} INFO ${NO_C} Server started. Use Ctrl+C to stop it."
-$DRUSH runserver --default-server=builtin ${WEB_HOST}:${WEB_PORT}
+$DRUSH runserver --no-browser $SIMPLETEST_BASE_URL
 
 echo "---------------------------------"
 echo " One time admin login link "
 echo "---------------------------------"
-echo -e "${FG_C}${BG_C} EXECUTING ${NO_C} $DRUSH user-login --no-browser --uri=\"http://${WEB_HOST}:${WEB_PORT}\""
+echo -e "${FG_C}${BG_C} EXECUTING ${NO_C} $DRUSH user-login --no-browser --uri=\"$SIMPLETEST_BASE_URL\""
 echo -e "${FG_C}${WBG_C} INFO ${NO_C} Use this link to login as an administrator in your new site:"
-$DRUSH user-login --no-browser --uri="http://$WEB_HOST:$WEB_PORT"
+$DRUSH user-login --no-browser --uri="$SIMPLETEST_BASE_URL"