Skip to content

Commit

Permalink
Merge pull request #38 from maths/dev
Browse files Browse the repository at this point in the history
Set up GitHub workflow
  • Loading branch information
EJMFarrow authored Mar 6, 2024
2 parents 4eeb9fd + 921627a commit 657785e
Show file tree
Hide file tree
Showing 23 changed files with 209 additions and 687 deletions.
124 changes: 124 additions & 0 deletions .github/workflows/moodle-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: Moodle Plugin CI

on: [push, pull_request]

jobs:
test:
runs-on: ubuntu-22.04

services:
postgres:
image: postgres:13
env:
POSTGRES_USER: 'postgres'
POSTGRES_HOST_AUTH_METHOD: 'trust'
ports:
- 5432:5432
options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
mariadb:
image: mariadb:10.6
env:
MYSQL_USER: 'root'
MYSQL_ALLOW_EMPTY_PASSWORD: "true"
MYSQL_CHARACTER_SET_SERVER: "utf8mb4"
MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci"

ports:
- 3306:3306
options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3

strategy:
fail-fast: false
matrix: # I don't know why, but mariadb is much slower, so mostly use pgsql.
include:
- php: '8.2'
moodle-branch: 'master'
database: 'pgsql'
- php: '8.1'
moodle-branch: 'MOODLE_402_STABLE'
database: 'pgsql'
- php: '8.0'
moodle-branch: 'MOODLE_402_STABLE'
database: 'pgsql'
# Edinburgh is planning to run the setup below for 2023-24.
- php: '7.4'
moodle-branch: 'MOODLE_401_STABLE'
database: 'mariadb'

steps:
- name: Check out repository code
uses: actions/checkout@v3
with:
path: plugin

- name: Setup PHP ${{ matrix.php }}
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
extensions: ${{ matrix.extensions }}
ini-values: max_input_vars=5000
coverage: none

- name: Initialise moodle-plugin-ci
run: |
composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
echo $(cd ci/bin; pwd) >> $GITHUB_PATH
echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
sudo locale-gen en_AU.UTF-8
echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
- name: Install moodle-plugin-ci
run: |
moodle-plugin-ci add-plugin maths/moodle-qbank_importasversion
moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
#cat ${{ github.workspace }}/moodle/config.php
env:
DB: ${{ matrix.database }}
MOODLE_BRANCH: ${{ matrix.moodle-branch }}

- name: PHP Lint
if: ${{ always() }}
run: moodle-plugin-ci phplint

- name: PHP Copy/Paste Detector
continue-on-error: true # This step will show errors but will not fail.
if: ${{ always() }}
run: moodle-plugin-ci phpcpd

- name: PHP Mess Detector
continue-on-error: true # This step will show errors but will not fail.
if: ${{ always() }}
run: moodle-plugin-ci phpmd

- name: Moodle Code Checker
continue-on-error: true
if: ${{ always() }}
run: moodle-plugin-ci codechecker --max-warnings 0

- name: Moodle PHPDoc Checker
continue-on-error: true
if: ${{ always() }}
run: moodle-plugin-ci phpdoc

- name: Validating
if: ${{ always() }}
run: moodle-plugin-ci validate

- name: Check upgrade savepoints
if: ${{ always() }}
run: moodle-plugin-ci savepoints

- name: Mustache Lint
if: ${{ always() }}
run: moodle-plugin-ci mustache

- name: Grunt
if: ${{ matrix.moodle-branch == 'MOODLE_401_STABLE' }}
run: moodle-plugin-ci grunt

- name: PHPUnit tests
if: ${{ always() }}
run: moodle-plugin-ci phpunit
10 changes: 5 additions & 5 deletions classes/cli_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ public function validate_and_clean_args(): void {
}
if (isset($cliargs['manifestpath'])) {
if (isset($cliargs['directory']) && strlen($cliargs['directory']) > 0 ) {
echo "\nYou have supplied a manifest file path and a directory. " .
"Please use only one.\n";
echo "\nYou have supplied a manifest file path (possibly as a default in your config file) " .
"and a directory. Please use only one.\n";
static::call_exit();
}
}
Expand Down Expand Up @@ -189,8 +189,8 @@ public function validate_and_clean_args(): void {
if (isset($cliargs['coursename']) || isset($cliargs['modulename'])
|| isset($cliargs['coursecategory']) || (isset($cliargs['instanceid'])
|| isset($cliargs['contextlevel']) )) {
echo "\nYou have specified a manifest file. Contextlevel, instance id, " .
"course name, module name and/or course category are not needed. " .
echo "\nYou have specified a manifest file (possibly as a default in your config file). " .
"Contextlevel, instance id, course name, module name and/or course category are not needed. " .
"Context data can be extracted from the file.\n";
static::call_exit();
}
Expand Down Expand Up @@ -589,7 +589,7 @@ public function create_gitignore(string $manifestpath):void {
/**
* Check if the repository has been initialised
*
* @param string $manifestpath
* @param string $fullmanifestpath
* @return void
*/
public function check_repo_initialised(string $fullmanifestpath):void {
Expand Down
2 changes: 1 addition & 1 deletion classes/external/delete_question.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/externallib.php');
require_once($CFG->dirroot . '/lib/externallib.php');
require_once($CFG->libdir . '/questionlib.php');
require_once($CFG->dirroot. '/question/bank/gitsync/lib.php');

Expand Down
2 changes: 1 addition & 1 deletion classes/external/export_question.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/externallib.php');
require_once($CFG->dirroot . '/lib/externallib.php');
require_once($CFG->libdir . '/questionlib.php');
require_once($CFG->dirroot . '/question/format/xml/format.php');
require_once($CFG->dirroot. '/question/bank/gitsync/lib.php');
Expand Down
2 changes: 1 addition & 1 deletion classes/external/get_question_list.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/externallib.php');
require_once($CFG->dirroot . '/lib/externallib.php');
require_once($CFG->libdir . '/questionlib.php');
require_once($CFG->dirroot. '/question/bank/gitsync/lib.php');

Expand Down
2 changes: 1 addition & 1 deletion classes/external/import_question.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir . '/externallib.php');
require_once($CFG->dirroot . '/lib/externallib.php');
require_once($CFG->libdir . '/questionlib.php');
require_once($CFG->dirroot . '/question/format/xml/format.php');
require_once($CFG->dirroot. '/question/bank/gitsync/lib.php');
Expand Down
7 changes: 7 additions & 0 deletions cli/config_sample.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,12 @@ $instance = 'instance1';
// Windows users must change backslash \ to forward slash /.
$rootdirectory = '/home/user/questions';

// You can set a default manifest file path for import, export and delete.
// You will need to run createrepo or importrepotomoodle first to create the file.
// You will need to set the default back to null if you want to import or delete
// from a new context. Setting the contextlevel CLI parameter will not
// override this path and will cause the script to abort.
$manifestpath = null;

// Are you using Git and wanting repository checks performed automatically?
$usegit = true;
2 changes: 1 addition & 1 deletion cli/deletefrommoodle.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
'longopt' => 'manifestpath',
'shortopt' => 'f',
'description' => 'Filepath of manifest file relative to root directory.',
'default' => null,
'default' => $manifestpath,
'variable' => 'manifestpath',
'valuerequired' => true,
],
Expand Down
2 changes: 1 addition & 1 deletion cli/exportrepofrommoodle.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
'longopt' => 'manifestpath',
'shortopt' => 'f',
'description' => 'Filepath of manifest file relative to root directory.',
'default' => null,
'default' => $manifestpath,
'variable' => 'manifestpath',
'valuerequired' => true,
],
Expand Down
2 changes: 1 addition & 1 deletion cli/importrepotomoodle.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
'longopt' => 'manifestpath',
'shortopt' => 'f',
'description' => 'Filepath of manifest file relative to root directory.',
'default' => null,
'default' => $manifestpath,
'variable' => 'manifestpath',
'valuerequired' => true,
],
Expand Down
102 changes: 9 additions & 93 deletions testrepo/top/cat-1/First-Question.xml
Original file line number Diff line number Diff line change
@@ -1,109 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<quiz>
<!-- question: 35001 -->
<question type="stack">
<question type="shortanswer">
<name>
<text>First Question</text>
</name>
<questiontext format="html">
<text><![CDATA[<p></p><p>Differentiate \((x-1)^3\) with respect to x.</p><p>[[input:ans1]] [[validation:ans1]]<br></p>]]></text>
<text><![CDATA[<p dir="ltr" style="text-align: left;">This is a test question.<br></p>]]></text>
</questiontext>
<generalfeedback format="html">
<text></text>
</generalfeedback>
<defaultgrade>1</defaultgrade>
<penalty>0.1</penalty>
<penalty>0.3333333</penalty>
<hidden>0</hidden>
<idnumber></idnumber>
<stackversion>
<text>2023072101</text>
</stackversion>
<questionvariables>
<text></text>
</questionvariables>
<specificfeedback format="html">
<text>[[feedback:prt1]]</text>
</specificfeedback>
<questionnote>
<text></text>
</questionnote>
<questiondescription format="html">
<text></text>
</questiondescription>
<questionsimplify>1</questionsimplify>
<assumepositive>0</assumepositive>
<assumereal>0</assumereal>
<prtcorrect format="html">
<text><![CDATA[<span style="font-size: 1.5em; color:green;"><i class="fa fa-check"></i></span> Correct answer, well done.]]></text>
</prtcorrect>
<prtpartiallycorrect format="html">
<text><![CDATA[<span style="font-size: 1.5em; color:orange;"><i class="fa fa-adjust"></i> Your answer is partially correct.</span>]]></text>
</prtpartiallycorrect>
<prtincorrect format="html">
<text><![CDATA[<span style="font-size: 1.5em; color:red;"><i class="fa fa-times"></i></span> Incorrect answer.]]></text>
</prtincorrect>
<multiplicationsign>dot</multiplicationsign>
<sqrtsign>1</sqrtsign>
<complexno>i</complexno>
<inversetrig>cos-1</inversetrig>
<logicsymbol>lang</logicsymbol>
<matrixparens>[</matrixparens>
<variantsselectionseed></variantsselectionseed>
<input>
<name>ans1</name>
<type>algebraic</type>
<tans>3*(x-1)^2</tans>
<boxsize>15</boxsize>
<strictsyntax>1</strictsyntax>
<insertstars>0</insertstars>
<syntaxhint></syntaxhint>
<syntaxattribute>0</syntaxattribute>
<forbidwords></forbidwords>
<allowwords></allowwords>
<forbidfloat>1</forbidfloat>
<requirelowestterms>0</requirelowestterms>
<checkanswertype>0</checkanswertype>
<mustverify>1</mustverify>
<showvalidation>1</showvalidation>
<options></options>
</input>
<prt>
<name>prt1</name>
<value>1.0000000</value>
<autosimplify>1</autosimplify>
<feedbackstyle>1</feedbackstyle>
<feedbackvariables>
<usecase>0</usecase>
<answer fraction="100" format="moodle_auto_format">
<text>This is a test answer.</text>
<feedback format="html">
<text></text>
</feedbackvariables>
<node>
<name>0</name>
<description></description>
<answertest>AlgEquiv</answertest>
<sans>ans1</sans>
<tans>3*(x-1)^2</tans>
<testoptions></testoptions>
<quiet>0</quiet>
<truescoremode>=</truescoremode>
<truescore>1</truescore>
<truepenalty></truepenalty>
<truenextnode>-1</truenextnode>
<trueanswernote>prt1-1-T</trueanswernote>
<truefeedback format="html">
<text></text>
</truefeedback>
<falsescoremode>=</falsescoremode>
<falsescore>0</falsescore>
<falsepenalty></falsepenalty>
<falsenextnode>-1</falsenextnode>
<falseanswernote>prt1-1-F</falseanswernote>
<falsefeedback format="html">
<text></text>
</falsefeedback>
</node>
</prt>
<tags>
<tag><text>tag1</text></tag>
<tag><text>tag2</text></tag>
</tags>
</feedback>
</answer>
</question>
</quiz>
Loading

0 comments on commit 657785e

Please sign in to comment.