Merge pull request #154 from andrewnicols/MDL-83424-take2

Attempt to support restructured directories

Author: andrewnicols

runner/main/jobtypes/behat/behat.sh

@@ -45,6 +45,8 @@ function behat_to_env_file() {
         SELENIUMURL_10
 
         WEBSERVER
+        APACHE_DOCUMENT_ROOT
+        PUBLICROOT
 
         IONICURL
 
@@ -151,6 +153,7 @@ function behat_check() {
 # Behat job type init.
 function behat_config() {
     # Apply some defaults.
+    PUBLICROOT="${PUBLICROOT:-}"
     RUNCOUNT="${RUNCOUNT:-1}"
     BEHAT_SUITE="${BEHAT_SUITE:-}"
     BEHAT_TAGS="${BEHAT_TAGS:-}"
@@ -237,7 +240,7 @@ function behat_initcmd() {
 
     # Build the complete init command.
     cmd=(
-        php admin/tool/behat/cli/init.php
+        php ${PUBLICROOT}admin/tool/behat/cli/init.php
         "${initsuite}"
         -j="${BEHAT_PARALLEL}"
         --axe
@@ -462,7 +465,7 @@ function behat_main_command() {
 
     # Let's build the complete behat command for the 1st (parallel) run.
     _cmd=(
-        php admin/tool/behat/cli/run.php
+        php ${PUBLICROOT}admin/tool/behat/cli/run.php
     )
 
     # Add the options and profile.
@@ -538,7 +541,7 @@ function behat_rerun_command() {
     # and, also, it automatically handles the file system links for the web server.
     # (output is a little bit uglier, but consistent with the main run).
     _reruncmd=(
-        php admin/tool/behat/cli/run.php --rerun
+        php ${PUBLICROOT}admin/tool/behat/cli/run.php --rerun
     )
 
     # Add the config, options and profile.

runner/main/jobtypes/phpunit/phpunit.sh

@@ -20,6 +20,8 @@
 # PHPUnit needed variables to go to the env file.
 function phpunit_to_env_file() {
     local env=(
+        PUBLICROOT
+
         DBTYPE
         DBTAG
         DBHOST
@@ -157,7 +159,7 @@ function phpunit_initcmd() {
     local -n cmd=$1
     cmd=(
         php
-        admin/tool/phpunit/cli/init.php
+        ${PUBLICROOT}admin/tool/phpunit/cli/init.php
     )
 }
 

runner/main/modules/docker-php/docker-php.sh

@@ -54,8 +54,10 @@ function docker-php_setup() {
       --name "${WEBSERVER}" \
       --detach \
       --env-file "${ENVIROPATH}" \
+      -e "APACHE_DOCUMENT_ROOT=${APACHE_DOCUMENT_ROOT}" \
       -v "${COMPOSERCACHE}:/var/www/.composer:rw" \
       -v "${SHAREDDIR}":/shared \
+      -v "${BASEDIR}/modules/docker-php/entrypoint":/docker-entrypoint.d \
       "${DOCKER_PHP}"
 
     # Ensure that the whole .composer directory is writable to all (www-data needs to write there).

runner/main/modules/docker-php/entrypoint/documentroot.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+# Replace the default document root in Apache configuration files with the one set in the environment variable.
+# This is needed to make the webserver work with the Moodle codebase for Moodle 5.1 onwards with MDL-83424.
+
+sed -ri -e 's@/var/www/html@${APACHE_DOCUMENT_ROOT}@g' /etc/apache2/sites-available/*.conf
+sed -ri -e 's@/var/www/@${APACHE_DOCUMENT_ROOT}@g' /etc/apache2/apache2.conf /etc/apache2/conf-available/*.conf

runner/main/modules/moodle-core-copy/moodle-core-copy.sh

@@ -37,7 +37,11 @@ function moodle-core-copy_check() {
 # Moodle core copy module config.
 function moodle-core-copy_config() {
     # Get the Moodle branch from code, so we can make decisions based on it.
-    MOODLE_BRANCH=$(grep "\$branch" "${CODEDIR}"/version.php | sed "s/';.*//" | sed "s/^\$.*'//")
+    if [[ -d "${CODEDIR}/public" ]]; then
+        MOODLE_BRANCH=$(grep "\$branch" "${CODEDIR}"/public/version.php | sed "s/';.*//" | sed "s/^\$.*'//")
+    else
+        MOODLE_BRANCH=$(grep "\$branch" "${CODEDIR}"/version.php | sed "s/';.*//" | sed "s/^\$.*'//")
+    fi
 }
 
 # Moodle core copy module setup.

runner/main/modules/summary/summary.sh

@@ -52,12 +52,14 @@ function summary_setup() {
     echo "== Build Id: ${BUILD_ID}"
     echo "== Workspace: ${WORKSPACE}"
     echo "== Code directory: ${CODEDIR}"
+    echo "== Public directory: ${PUBLICROOT}"
     echo "== Shared directory: ${SHAREDDIR}"
+    echo "== APACHE_DOCUMENT_ROOT: ${APACHE_DOCUMENT_ROOT}"
     echo "== UUID / Container suffix: ${UUID}"
     echo "== Environment: ${ENVIROPATH}"
     echo "== GIT commit: ${GIT_COMMIT}"
 
     # Add all the summary information that the job type wants to add.
     get_job_to_summary "${JOBTYPE}"
     echo "============================================================================"
-}
+}

runner/main/run.sh

@@ -48,6 +48,12 @@ fi
 
 # Base directory where the code is located.
 CODEDIR="${CODEDIR:-${WORKSPACE}/moodle}"
+APACHE_DOCUMENT_ROOT="${APACHE_DOCUMENT_ROOT:-/var/www/html}"
+PUBLICROOT="${PUBLICROOT:-}"
+if [[ -d "${CODEDIR}/public" ]]; then
+    PUBLICROOT="public/"
+    APACHE_DOCUMENT_ROOT="/var/www/html/public"
+fi
 
 # Fail if CODEDIR does not exist.
 if [[ ! -d ${CODEDIR} ]]; then

test/helpers/common.bash

@@ -37,6 +37,7 @@ function git_moodle_checkout() {
     # Checkout a branch, tag or commit in the moodle.git repository.
     # $1: Branch, tag or commit to checkout.
     local branch="$1"
+    local remote="$2"
 
     if [[ -z ${branch} ]]; then
         echo "Please, specify a branch, tag or commit to checkout."
@@ -48,8 +49,18 @@ function git_moodle_checkout() {
         exit 1
     fi
 
-    # Checkout the branch or tag.
-    git -C "${MOODLE_CI_RUNNER_GITDIR}" --git-dir .git checkout -f --quiet "${branch}" || exit 1
+
+    if [[ -n ${remote} ]]; then
+        # Check if the remote is valid.
+        git -C "${MOODLE_CI_RUNNER_GITDIR}" fetch "${remote}" "${branch}" || {
+            echo "Unable to fetch ${remote} {$branch}."
+            exit 1
+        }
+        git -C "${MOODLE_CI_RUNNER_GITDIR}" --git-dir .git checkout -f --quiet FETCH_HEAD || exit 1
+    else
+        # Checkout the branch or tag.
+        git -C "${MOODLE_CI_RUNNER_GITDIR}" --git-dir .git checkout -f --quiet "${branch}" || exit 1
+    fi
 }
 
 function launch_runner() {

test/phpunit_test.bats

@@ -83,3 +83,34 @@ teardown() {
     assert_output --partial "Running: php vendor/bin/phpunit"
     assert_output --partial "== Exit code: 0"
 }
+
+@test "PHPUnit tests: run the job for MDL-83424 with filter applied" {
+    # Set all the required variables.
+    JOBTYPE="phpunit"
+    PHP_VERSION="8.4"
+    DBTYPE="pgsql"
+    CODEDIR="${MOODLE_CI_RUNNER_GITDIR}"
+    PHPUNIT_TESTSUITE="mod_label_testsuite"
+
+    # Checkout main
+    run git_moodle_checkout MDL-83424-main https://github.com/andrewnicols/moodle.git
+    assert_success
+
+    # Run the job
+    run launch_runner
+    assert_success
+    assert_output --partial "== JOBTYPE: phpunit"
+    assert_output --partial "== Moodle branch (version.php): 501"
+    assert_output --partial "== PHP version: 8.4"
+    assert_output --partial "== DBTYPE: pgsql"
+    assert_output --partial "== PHPUNIT_TESTSUITE: mod_label_testsuite"
+    assert_output --partial "== DBREPLICAS: 0"
+    assert_output --partial "Setting up docker-caches module..."
+    assert_output --partial "Initialising Moodle PHPUnit test environment..."
+    assert_output --partial "Running: php vendor/bin/phpunit"
+    assert_output --partial "OK"
+    assert_output --regexp "Tests: [0-9]+"
+    assert_output --partial "Exporting all docker logs for UUID"
+    assert_output --partial "Stopping and removing all docker containers"
+    assert_output --partial "== Exit code: 0"
+}