Update runner to use the new performancetool plugin

This commit also tidy up and fixes some minor issues.

Author: lameze

runner/main/jobtypes/performance/normalise_site.php

@@ -64,6 +64,7 @@ function performance_modules() {
     local modules=(
         env
         summary
+        moodle-branch
         docker
         docker-logs
         git
@@ -94,8 +95,11 @@ function performance_config() {
     EXITCODE=0
 
     export MOODLE_WWWROOT="http://${WEBSERVER}"
-    export SITESIZE="${SITESIZE:-S}"
+    export SITESIZE="${SITESIZE:-XS}"
     export COURSENAME="performance_course"
+
+    # Default target file (relative to WORKSPACE) where rundata.json will be stored.
+    export TARGET_FILE="${TARGET_FILE:-storage/performance/${MOODLE_BRANCH}/rundata.json}"
 }
 
 # Performance job type setup.
@@ -116,15 +120,43 @@ function performance_setup_normal() {
     local initcmd
     performance_initcmd initcmd # By nameref.
     echo "Running: ${initcmd[*]}"
+
+    plugin_repo="https://github.com/moodlehq/moodle-local_performancetool"
+    dest="/var/www/html/local/performancetool"
+
+    echo "Installing moodle-local_performancetool plugin into ${dest}"
+
+    # Ensure host shared directories exist and are writable so plugin can save files.
+    mkdir -p "${SHAREDDIR}/planfiles" "${SHAREDDIR}/output/logs" "${SHAREDDIR}/output/runs"
+    chmod -R 2777 "${SHAREDDIR}" || true
+
+    # Clone the performance data generator plugin inside the container.
+    docker exec "${WEBSERVER}" sh -c "git clone --depth 1 ${plugin_repo} ${dest}"
+
     docker exec -t -u www-data "${WEBSERVER}" "${initcmd[@]}"
 
-    # Copy the site normalisation script and execute it.
-    echo "Copying and executing the site normalisation script"
-    docker cp "${BASEDIR}/jobtypes/performance/normalise_site.php" "${WEBSERVER}:/var/www/html/normalise_site.php"
-    docker exec -t -u www-data "${WEBSERVER}" php /var/www/html/normalise_site.php
+    # Execute the script inside the container as www-data
+    docker exec -t -u www-data "${WEBSERVER}" php "${dest}"
+    exec_status=$?
 
-    echo "Creating test data"
-    performance_generate_test_data
+    if [[ $exec_status -ne 0 ]]; then
+      echo "Error: php returned exit ${exec_status} when executing ${dest}"
+      exit $exec_status
+    fi
+    performance_perftoolcmd perftoolcmd
+    docker exec -t -u www-data "${WEBSERVER}" "${perftoolcmd[@]}"
+
+    # Copy generated plan files (jmx, csv) from container to host-shared dir.
+    echo "Copying generated plan files from container to ${SHAREDDIR}/planfiles"
+
+    docker exec -u root "${WEBSERVER}" bash -lc "\
+      mkdir -p /shared/planfiles && \
+      cp -a /var/www/html/local/performancetool/planfiles/. /shared/planfiles/ || true && \
+      chown -R www-data:www-data /shared/planfiles || true"
+
+    chmod -R 2777 "${SHAREDDIR}/planfiles" || true
+    echo "Files in ${SHAREDDIR}/planfiles:"
+    ls -la "${SHAREDDIR}/planfiles" || true
 
     echo "============================================================================"
     echo ">>> stopsection <<<"
@@ -148,71 +180,49 @@ function performance_initcmd() {
     )
 }
 
-function performance_generate_test_data() {
-    local phpcmd="php"
-
-    # Generate Test Site.
-    local testsitecmd
-    perfomance_testsite_generator_command testsitecmd # By nameref.
-    echo "Running: ${testsitecmd[*]}"
-    docker exec -t -u www-data "${WEBSERVER}" "${testsitecmd[@]}"
-
-    # Generate the test plan files and capture the output
-    local testplancmd
-    performance_testplan_generator_command testplancmd # By nameref.
-    echo "Running: docker exec -t -u www-data "${WEBSERVER}" "${testplancmd[@]}""
-    testplanfiles=$(docker exec -t -u www-data "${WEBSERVER}" "${testplancmd[@]}")
-
-    # Display the captured output
-    echo "Captured Output:"
-    echo "${testplanfiles}"
-    echo "${SHAREDDIR}"
-
-    # Ensure the directory exists and is writable
-    mkdir -p "${SHAREDDIR}/planfiles"
-    mkdir -p "${SHAREDDIR}/output/logs"
-    mkdir -p "${SHAREDDIR}/output/runs"
-
-    chmod -R 2777 "${SHAREDDIR}"
-
-    # Extract URLs and download files to ${SHAREDDIR}
-    urls=$(echo "${testplanfiles}" | grep -oP 'http://[^ ]+')
-    for url in ${urls}; do
-        # Trim any whitespace or newline characters from the URL
-        url=$(echo "${url}" | tr -d '\r\n')
-        # Extract the filename from the URL
-        filename=$(basename "${url}")
-        echo "Downloading: ${url} to ${SHAREDDIR}/${filename}"
-        docker exec -t -u www-data "${WEBSERVER}" curl -o "/shared/planfiles/${filename}" "${url}"
-    done
+# Returns (by nameref) an array with the command needed to init the Performance site.
+function performance_perftoolcmd() {
+    local -n cmd=$1
+    # We need to determine the init suite to use.
+    local initsuite=""
+
+    # Build the complete init command.
+    cmd=(
+        php local/performancetool/generate_test_data.php \
+            --size="${SITESIZE}" \
+            --planfilespath="/shared" \
+            --quiet="false"
+    )
 }
 
 # Performance job type run.
 function performance_run() {
-    echo
-    if [[ RUNCOUNT -gt 1 ]]; then
-        echo ">>> startsection Starting ${RUNCOUNT} Performance main runs at $(date) <<<"
-    else
-        echo ">>> startsection Starting Performance main run at $(date) <<<"
-    fi
+
+    echo ">>> startsection Starting Performance main run at $(date) <<<"
     echo "============================================================================"
 
     datestring=`date '+%Y%m%d%H%M'`
     # Get the plan file name.
-    testplanfile=`ls "${SHAREDDIR}"/planfiles/*.jmx | head -1 | sed "s@${SHAREDDIR}@/shared@"`
-    testusersfile=`ls "${SHAREDDIR}"/planfiles/*.csv | head -1 | sed "s@${SHAREDDIR}@/shared@"`
+    testplanfile=`ls "${SHAREDDIR}"/*.jmx | head -1 | sed "s@${SHAREDDIR}@/shared@"`
+    echo "Using test plan file: ${testplanfile}"
+    testusersfile=`ls "${SHAREDDIR}"/*.csv | head -1 | sed "s@${SHAREDDIR}@/shared@"`
+    echo "Using test users file: ${testusersfile}"
     group="${MOODLE_BRANCH}"
     description="${GIT_COMMIT}"
     siteversion=""
     sitebranch="${MOODLE_BRANCH}"
     sitecommit="${GIT_COMMIT}"
     runoutput="${SHAREDDIR}/output/logs/run.log"
 
+    # Ensure run log directory exists and is writable so 'tee' can create the file.
+    mkdir -p "$(dirname "${runoutput}")"
+    chmod -R 2777 "${SHAREDDIR}/output/logs" || true
+
     # Calculate the command to run. The function will return the command in the passed array.
     local jmeterruncmd=
     performance_main_command jmeterruncmd # By nameref.
 
-    echo "Running: ${jmeterruncmd[*]}"
+    echo "Running performance command: ${jmeterruncmd[*]}"
     echo ">>> Performance run at $(date) <<<"
     local dockerrunargs=
     docker-jmeter_run_args dockerrunargs # By nameref
@@ -241,21 +251,39 @@ function performance_run() {
 # Performance job type teardown.
 function performance_teardown() {
     DATADIR="${SHAREDDIR}/output/runs"
+
+    # Ensure DATADIR exists before copying format_rundata.php.
+    mkdir -p "${DATADIR}"
+
     cp "${BASEDIR}/jobtypes/performance/format_rundata.php" "${DATADIR}/format_rundata.php"
+
+    # Check if rundata.php exists (generated by JMeter run).
+    if [[ ! -f "${DATADIR}/rundata.php" ]]; then
+        echo "Error: rundata.php not found in ${DATADIR}"
+        return 1
+    fi
+
     docker run \
         -v "${DATADIR}:/shared" \
         -w /shared \
         php:8.3-cli \
-        php /shared/format_rundata.php rundata.php
+        php "/shared/format_rundata.php" "rundata.php"
 
     echo "Storing data with a git commit of '${GIT_COMMIT}'"
 
-    # We use the storage directory to store data for long term comparison.
-    TARGETDIR=`dirname "${TARGET_FILE}"`
-    mkdir -p "${WORKSPACE}/${TARGETDIR}"
-    cp -rf "${DATADIR}/rundata.json" "${TARGET_FILE}"
+    # Resolve absolute target path (use WORKSPACE for relative TARGET_FILE)
+    if [[ "${TARGET_FILE}" = /* ]]; then
+        targetpath="${TARGET_FILE}"
+    else
+        targetpath="${WORKSPACE}/${TARGET_FILE}"
+    fi
+
+    targetdir="$(dirname "${targetpath}")"
+    mkdir -p "${targetdir}"
+    cp -f "${DATADIR}/rundata.json" "${targetpath}"
 }
 
+
 # Calculate the command to run for Performance main execution,
 # returning it in the passed array parameter.
 # Parameters:
@@ -299,38 +327,3 @@ function perfomance_testsite_generator_command() {
             --filesizelimit="1000"
     )
 }
-
-function performance_testplan_generator_command() {
-    local -n _cmd=$1 # Return by nameref.
-
-    case "${SITESIZE}" in
-    'XS')
-        targetcourse='testcourse_3'
-        ;;
-     'S')
-        targetcourse='testcourse_12'
-        ;;
-     'M')
-        targetcourse='testcourse_73'
-        ;;
-     'L')
-        targetcourse='testcourse_277'
-        ;;
-    'XL')
-        targetcourse='testcourse_1065'
-        ;;
-   'XXL')
-        targetcourse='testcourse_4177'
-        ;;
-       *)
-	;;
-    esac
-
-    # Build the complete perf command for the run.
-    _cmd=(
-        php admin/tool/generator/cli/maketestplan.php \
-            --size="${SITESIZE}" \
-            --shortname="${targetcourse}" \
-            --bypasscheck
-    )
-}

runner/main/jobtypes/performance/performance.sh

@@ -51,9 +51,6 @@ function env_setup() {
     # Always make BUILD_NUMBER available, some old scripts use it.
     echo "BUILD_NUMBER=${BUILD_NUMBER}" >> "${ENVIROPATH}"
 
-    # Always add the job type.
-    echo "JOBTYPE=${JOBTYPE}" >> "${ENVIROPATH}"
-
     # Add all the variables that the job type requires.
     for var in $(get_job_to_env_file "${JOBTYPE}"); do
         # Docker does not support multiline env variables via --env-file, so we need to