add workflow from moodle-plugin-ci

Author: kwibus

.github/workflows/moodle-ci.yml

@@ -0,0 +1,124 @@
+---
+name: Moodle Plugin CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    services:
+      postgres:
+        image: postgres:14
+        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
+        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:
+        php: ['7.4', '8.0', '8.1']
+        moodle-branch: ['MOODLE_401_STABLE']
+        database: [pgsql, mariadb]
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+        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
+          # If you are not using code coverage, keep "none". Otherwise, use "pcov" (Moodle 3.10 and up) or "xdebug".
+          # If you try to use code coverage with "none", it will fallback to phpdbg (which has known problems).
+          coverage: none
+
+      - name: Initialise moodle-plugin-ci
+        run: |
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
+          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 install --plugin ./plugin --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+          # Uncomment this to run Behat tests using the Moodle App.
+          # MOODLE_APP: 'true'
+
+      - name: PHP Lint
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phplint ./plugin
+
+      - name: PHP Mess Detector
+        continue-on-error: true # This step will show errors but will not fail
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpmd ./plugin
+
+      - name: Moodle Code Checker
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpcs --max-warnings 0 ./plugin
+
+      - name: Moodle PHPDoc Checker
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpdoc --max-warnings 0 ./plugin
+
+      - name: Validating
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci validate ./plugin
+
+      - name: Check upgrade savepoints
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci savepoints ./plugin
+ 
+      - name: Mustache Lint
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci mustache ./plugin
+
+      # no javascript used in  this pluing
+      # - name: Grunt
+      #   if: ${{ !cancelled() }}
+      #   run: moodle-plugin-ci grunt --max-lint-warnings 0 ./plugin
+
+      - name: PHPUnit tests
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpunit --fail-on-warning ./plugin
+
+      - name: Behat features
+        id: behat
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci behat --profile chrome ./plugin
+
+      - name: Upload Behat Faildump
+        if: ${{ failure() && steps.behat.outcome == 'failure' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: Behat Faildump (${{ join(matrix.*, ', ') }})
+          path: ${{ github.workspace }}/moodledata/behat_dump
+          retention-days: 7
+          if-no-files-found: ignore
+
+      - name: Mark cancelled jobs as failed.
+        if: ${{ cancelled() }}
+        run: exit 1

.gitignore

@@ -1,2 +1 @@
-/vendor/
 .well-known/

.gitlab-ci.yml

@@ -36,7 +36,7 @@ default:
     - export PATH="/opt/moodle-plugin-ci/bin:/opt/moodle-plugin-ci/vendor/bin:$PATH"
     # TODO not always needed
     # install moodle
-    # - moodle-plugin-ci install --db-host db 
+    # - moodle-plugin-ci install --db-host db
     # - '{ php -S 0.0.0.0:8000 -t "$CI_PROJECT_DIR/moodle" >/dev/null 2>&1 & }'
 
 # install dependencies:

classes/claim/address.php

@@ -29,10 +29,9 @@
  */
 class address implements claim {
 
-
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user user user want the address claim from
      * @return array() Returns address information of user
      */
     public function claim($user): array {

classes/claim/claim.php

@@ -33,7 +33,7 @@ interface claim {
 
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user user user want the address claim from
      * @return array() Returns address information of user
      */
     public function claim(array $user);

classes/claim/email.php

@@ -31,7 +31,7 @@ class email implements claim {
 
     /**
      * Get email claim.
-     * @param array of core_user user user want the email claim from
+     * @param array $user core_user user user want the email claim from
      * @return array() Returns email information of user
      */
     public function claim($user) {

classes/claim/enrolments.php

@@ -31,7 +31,7 @@ class enrolments implements claim {
     // TODO maybe also return role, and external id.
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user want the address claim from
      * @return array() Returns address information of user enrolments which array of course short names
      */
     public function claim($user) {

classes/claim/phone.php

@@ -31,7 +31,7 @@ class phone implements claim {
 
     /**
      * Get phone claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user want the address claim from
      * @return array() Returns phone_number information of user
      */
     public function claim($user) {

classes/claim/profile.php

@@ -32,7 +32,7 @@ class profile implements claim {
 
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user want the address claim from
      * @return array() Returns profile information of user
      */
     public function claim($user) {

classes/client.php

@@ -27,26 +27,38 @@
  * class that manges settings for client for this IdP.
  */
 class client {
-    /**@var int id primary for this client in the database */
+    /** @var int $id primary for this client in the database */
     public int $id; // Has to be pulic now because the way its send to database in update.
 
-    /**@var string $clientid name of the client */
+    /** @var string $clientid name of the client */
     public string $clientid;
-    /**@var string $clientsecret password of this client*/
+
+    /** @var string $clientsecret password of this client*/
     public string $clientsecret;
-    /**@var string $redirecturi addres of the clinet to send user to after identification*/
+
+    /** @var string $redirecturi addres of the clinet to send user to after identification*/
     public string $redirecturi;
-    /**@var array $granttypes types of oauth flows server will accept for this client*/
+
+    /** @var array $granttypes types of oauth flows server will accept for this client*/
     public array $granttypes;
-    /**@var array $scopes the client is allowed to request, which in our case are the claims*/
+
+    /** @var array $scope the client is allowed to request, which in our case are the claims*/
     public array $scope;
-    /**@var int $userid if client grantype used is client_authenticat. which user the client inperonates */
+
+    /** @var int $userid if client grantype used is client_authenticat. which user the client inperonates */
     public int $userid;
-    /**@var int $noconfirmation if user is asked to confirm that client is allowed to get this information of the user*/
+
+    /** @var int $noconfirmation if user is asked to confirm that client is allowed to get this information of the user*/
     public int $noconfirmation;
 
     /**
      * Initialze the client class.
+     * @param int $clientid
+     * @param string $redirecturi
+     * @param array $granttypes
+     * @param array $scope
+     * @param int $userid
+     * @param bool $noconfirmation
      */
     public function __construct($clientid, $redirecturi, $granttypes, $scope, $userid, $noconfirmation) {
         $this->clientid = $clientid;
@@ -71,6 +83,8 @@ public function id() {
     // TODO Use $storage->getClientDetails instead .
     /**
      * Get client by client id from database.
+     *
+     * @param int $id clientid
      */
     public static function get_client_by_id($id) {
         global $DB;
@@ -130,6 +144,8 @@ public function delete() {
 
     /**
      * Generate public private key pair
+     *
+     * @param int $clientid
      */
     public static function generate_key_pair($clientid) {
         global $DB;