Merge branch 'master' of github.com:mhughes2k/moodle

.github/workflows/onebyone.yml

@@ -0,0 +1,143 @@
+name: One by One Testing
+# Run all the individual unit tests one by one, with
+# fully independent PHPUnit executions. Useful to
+# detect issues with some tests that are using stuff
+# that has been made available by others, but is not
+# available when running individually.
+#
+# Note that we aren't using PHPUnit's own isolation
+# here but completely separated runs, one for each
+# test.
+#
+# The workflow will fail reporting all the tests
+# that have failed (and will pass if no failure is
+# detected, of course).
+#
+# It's only executed via workflow dispatch (automated
+# or manual), not by push/tag. And acceptd configuration
+# of phpunit, specially useful to run it with PHPUnit's
+# own isolation or any other option.
+
+on:
+  workflow_dispatch:
+    inputs:
+      phpunit_extra_options:
+        description: Additional options to apply to PHPUnit
+        required: false
+        default: ''
+
+env:
+  chunks: 7
+
+jobs:
+  collect:
+    name: Collect individual unit tests
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{steps.individual-tests.outputs.matrix }}
+
+    steps:
+      - name: Checking out code
+        uses: actions/checkout@v4
+
+      - name: Looking for all individual tests
+        id: individual-tests
+        run: |
+          count=0  # Number of individual tests found.
+          while read -r testfile; do # For each test file.
+              while read -r testname; do # For each unit test in a file.
+                  count=$((count + 1))
+                  # Sent it to the correct chunk file.
+                  chunk=$(((($count % $chunks)) + 1))
+                  echo "$testname $testfile" >> ./chunk_$chunk.txt
+              done < <(grep "function test_" "${testfile}" | sed -r "s/^.*function (test_[a-zA-Z0-9_]+).*/\1/")
+          done < <(find . -name "*_test.php")
+          # Generate the matrix to run tests.
+          echo "matrix=$(ls -1 chunk_*.txt | jq -R -s -c 'split("\n")[:-1]')" >> $GITHUB_OUTPUT
+          echo "$count individual tests collected in $chunks files"
+
+      - name: Upload individual tests files
+        uses: actions/upload-artifact@v4
+        with:
+          name: individual_tests
+          path: chunk_*.txt
+          retention-days: 1
+
+  test:
+    name: Run tests
+    needs: collect
+    runs-on: ubuntu-latest
+    services:
+      exttests:
+        image: moodlehq/moodle-exttests
+        ports:
+          - 8080:80
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+    strategy:
+      fail-fast: false
+      matrix:
+        file: ${{ fromJson(needs.collect.outputs.matrix) }}
+
+    steps:
+      - name: Setting up DB pgsql
+        uses: m4nu56/postgresql-action@v1
+        with:
+          postgresql version: 13
+          postgresql db: test
+          postgresql user: test
+          postgresql password: test
+
+      - name: Setting up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          ini-values: max_input_vars=5000
+          coverage: none
+
+      - name: Checking out code
+        uses: actions/checkout@v4
+
+      - name: Download individual test files
+        uses: actions/download-artifact@v4
+        with:
+          name: individual_tests # Make all the chunk files available for the next steps.
+
+      - name: Setting up PHPUnit
+        env:
+          dbtype: pgsql
+        run: |
+          echo "pathtophp=$(which php)" >> $GITHUB_ENV
+          cp .github/workflows/config-template.php config.php
+          mkdir ../moodledata
+          sudo locale-gen en_AU.UTF-8
+          php admin/tool/phpunit/cli/init.php --no-composer-self-update
+
+      - name: Run PHPUnit test (one by one)
+        env:
+          dbtype: pgsql
+        run: |
+          status=0
+          count=0
+          while read -r line; do # For each line in the chunk file
+              count=$((count + 1))
+              filter="${line% *}"
+              file="${line#* }"
+              # Run the individual unit test and report problems if needed to.
+              if ! php vendor/bin/phpunit \
+                      --fail-on-empty-test-suite \
+                      --fail-on-warning \
+                      --fail-on-risky \
+                      --filter "$filter" ${{ inputs.phpunit_extra_options }} \
+                      "$file" >/dev/null 2>&1; then
+                  if [ $status -eq 0 ]; then
+                      echo "Problems found, list of PHPUnit commands failing:"
+                  fi
+                  echo "vendor/bin/phpunit --filter '${filter}' ${{ inputs.phpunit_extra_options }} $file"
+                  status=$((status + 1))
+              fi
+          done < ${{ matrix.file }}
+          echo "Finished: $count individual tests executed, $status tests failed"
+          exit $status

.gitignore

@@ -56,3 +56,4 @@ moodle-plugin-ci.phar
 .hugo_build.lock
 phpcs.xml
 jsconfig.json
+UPGRADING-CURRENT.md

.grunt/components.js

@@ -40,9 +40,20 @@ const fetchComponentData = () => {
     if (!Object.entries(componentData).length) {
         componentData.subsystems = {};
         componentData.pathList = [];
+        componentData.components = {};
+        componentData.standardComponents = {};
 
         // Fetch the component definiitions from the distributed JSON file.
         const components = JSON.parse(fs.readFileSync(`${gruntFilePath}/lib/components.json`));
+        const pluginData = JSON.parse(fs.readFileSync(`${gruntFilePath}/lib/plugins.json`));
+
+        componentData.pluginTypes = components.plugintypes;
+
+        const standardPlugins = Object.entries(pluginData.standard).map(
+            ([pluginType, pluginNames]) => {
+                return pluginNames.map(pluginName => `${pluginType}_${pluginName}`);
+            }
+        ).reduce((acc, val) => acc.concat(val), []);
 
         // Build the list of moodle subsystems.
         componentData.subsystems.lib = 'core';
@@ -55,8 +66,8 @@ const fetchComponentData = () => {
             }
         }
 
-        // The list of components incldues the list of subsystems.
-        componentData.components = componentData.subsystems;
+        // The list of components includes the list of subsystems.
+        componentData.components = {...componentData.subsystems};
 
         // Go through each of the plugintypes.
         Object.entries(components.plugintypes).forEach(([pluginType, pluginTypePath]) => {
@@ -87,6 +98,20 @@ const fetchComponentData = () => {
             });
         });
 
+
+        // Create a list of the standard subsystem and plugins.
+        componentData.standardComponents = Object.fromEntries(
+            Object.entries(componentData.components).filter(([, name]) => {
+                if (name === 'core' || name.startsWith('core_')) {
+                    return true;
+                }
+                return standardPlugins.indexOf(name) !== -1;
+            })
+        );
+
+        componentData.componentMapping = Object.fromEntries(
+            Object.entries(componentData.components).map(([path, name]) => [name, path])
+        );
     }
 
     return componentData;

.grunt/notes/src/components.mjs

@@ -0,0 +1,110 @@
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+import * as Components from '../../components.js';
+
+const componentData = Components.fetchComponentData();
+
+/**
+ * The standard components shipped with core Moodle.
+ *
+ * @type {Object}
+ */
+export const standardComponents = componentData.standardComponents;
+
+/**
+ * All components of the current Moodle instance.
+ *
+ * @type {Object}
+ */
+export const allComponents = componentData.components;
+
+/**
+ * Get all components of the current Moodle instance.
+ *
+ * @returns {Array}
+ */
+export const getAllComponents = () => {
+    let components = new Map(Object.entries(componentData.pluginTypes).map(([value, path]) => ([path,{
+        path,
+        value,
+        name: `${value} (plugin type)`,
+    }])));
+
+    Object
+        .entries(componentData.components)
+        .filter(([path, value]) => Object.values(componentData.standardComponents).includes(value))
+        .forEach(([path, value]) => {
+            const entry = {
+                path,
+                value,
+                name: value,
+            };
+            if (Object.values(componentData.subsystems).includes(value)) {
+                if (components.has(path)) {
+                    entry.name = `${value} (subsystem / plugintype)`;
+                } else {
+                    entry.name = `${value} (subsystem)`;
+                }
+            }
+
+            components.set(path, entry);
+        });
+
+        return Array.from(components.values());
+};
+
+/**
+ * Whether the specified component is a standard component shipped with core Moodle.
+ *
+ * @param {string} componentName
+ * @returns {boolean}
+ */
+export const isStandardComponent = (componentName) => {
+    if (Object.values(componentData.standardComponents).includes(componentName)) {
+        return true;
+    }
+
+    if (Object.keys(componentData.pluginTypes).includes(componentName)) {
+        return true;
+    }
+
+    return false;
+};
+
+export const rewritePlugintypeAsSubsystem = (componentName) => {
+    if (Object.keys(componentData.pluginTypes).includes(componentName)) {
+        const pluginTypePath = componentData.pluginTypes[componentName];
+        if (Object.keys(componentData.subsystems).includes(pluginTypePath)) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
+/**
+ * Whether the specified component is a community component.
+ *
+ * @param {string} componentName
+ * @returns {boolean}
+ */
+export const isCommunityComponent = (componentName) => {
+    if (isStandardComponent(componentName)) {
+        return false;
+    }
+
+    return Object.values(componentData.components).indexOf(componentName) !== -1;
+}

.grunt/notes/src/create.mjs

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+
+import { createNote } from './note.mjs';
+import { getInitialValues } from './helpers.mjs';
+import * as Prompts from './prompts.mjs';
+import logger from './logger.mjs';
+
+export default async (options) => {
+    // Processs the initial values.
+    const initialValues = getInitialValues(options);
+
+    // Fetch information.
+    const messages = [];
+    const { issueNumber } = await inquirer.prompt([
+        Prompts.getIssuePrompt(),
+    ], initialValues);
+
+    let selection = {};
+    let notePath;
+    do {
+        selection = {};
+        selection = await inquirer.prompt([
+            Prompts.getComponentsPrompt(),
+            Prompts.getTypePrompt(),
+            Prompts.getMessagePromptInput(),
+        ], initialValues);
+        if (selection.message === '') {
+            selection = Object.assign(
+                selection,
+                await inquirer.prompt([
+                    Prompts.getMessagePromptEditor(),
+                ]),
+            );
+        }
+
+            logger.info(`
+    Creating upgrade note with the following options:
+
+    - Issue:     ${chalk.bold(issueNumber)}
+    - Component: ${chalk.bold(selection.components)}
+    - Type:      ${chalk.bold(selection.type)}
+    - Message:
+    ${chalk.bold(selection.message)}
+`);
+
+        messages.push({
+            components: [selection.components],
+            type: selection.type,
+            message: selection.message,
+        });
+
+        // Save the note so far.
+        if (notePath) {
+            await createNote(issueNumber, messages, notePath);
+            logger.info(`Updated note at: ${chalk.underline(chalk.bold(notePath))}`);
+        } else {
+            notePath = await createNote(issueNumber, messages);
+            logger.info(`Note created at: ${chalk.underline(chalk.bold(notePath))}`);
+        }
+
+        selection = Object.assign(
+            selection,
+            await inquirer.prompt([
+                Prompts.getAddAnotherPrompt(),
+            ], initialValues),
+        );
+    } while (selection.addAnother);
+};