Merge pull request #37 from adlnet/Unit-testing

Unit testing / db fix

Author: MeganBohland

.github/workflows/ci.yml

@@ -0,0 +1,122 @@
+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
+        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
+
+      - name: PHP Mess Detector
+        continue-on-error: true # This step will show errors but will not fail
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpmd
+
+      - name: Moodle Code Checker
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpcs --max-warnings 0
+
+      - name: Moodle PHPDoc Checker
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpdoc --max-warnings 0
+
+      - name: Validating
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci validate
+
+      - name: Check upgrade savepoints
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci savepoints
+
+      - name: Mustache Lint
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci mustache
+
+      - name: Grunt
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci grunt --max-lint-warnings 0
+
+      - name: PHPUnit tests
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpunit --fail-on-warning
+
+      - name: Behat features
+        id: behat
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci behat --profile chrome
+
+      - 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

classes/local/cmi5_connectors.php

@@ -74,13 +74,15 @@ public function cmi5launch_create_course($id, $tenanttoken, $filename) {
         $databody = $filename->get_content();
         // Sends the stream to the specified URL.
         $result = $this->cmi5launch_send_request_to_cmi5_player_post($databody, $url, $filetype, $tenanttoken);
-
+     
         // Check result and display message if not 200.
         $resulttest = $this->cmi5launch_connectors_error_message($result, "creating the course");
 
         if ($resulttest == true) {
             // Return an array with course info.
             return $result;
+        } else {
+            return false;
         }
     }
 
@@ -118,6 +120,8 @@ public function cmi5launch_create_tenant($urltosend, $username, $password, $newt
 
             // Return an array with tenant name and info.
             return $returnedinfo;
+        } else {
+            return false;
         };
     }
 
@@ -149,6 +153,8 @@ public function cmi5launch_retrieve_registration_with_get($registration, $id) {
         if ($resulttest == true) {
 
             return $result;
+        } else {
+            return false;
         }
     }
 
@@ -207,6 +213,8 @@ public function cmi5launch_retrieve_registration_with_post($courseid, $id) {
             $registration = $registrationinfo["code"];
 
             return $registration;
+        } else {
+            return false;
         }
     }
 
@@ -236,11 +244,13 @@ public function cmi5launch_retrieve_token($url, $username, $password, $audience,
         $result = $this->cmi5launch_send_request_to_cmi5_player_post($data, $url, $filetype, $username, $password);
 
         // Check result and display message if not 200.
-        $resulttest = $this->cmi5launch_connectors_error_message($result, "retrieving the registration");
+        $resulttest = $this->cmi5launch_connectors_error_message($result, "retrieving the token");
 
         if ($resulttest == true) {
 
             return $result;
+        } else {
+            return false;
         }
     }
 
@@ -269,6 +279,7 @@ public function cmi5launch_retrieve_url($id, $auindex) {
         $playerurl = $settings['cmi5launchplayerurl'];
         $courseid = $userscourse->courseid;
 
+    
         // Build URL for launch URL request.
         $url = $playerurl . "/api/v1/course/" . $courseid  ."/launch-url/" . $auindex;
 
@@ -301,6 +312,8 @@ public function cmi5launch_retrieve_url($id, $auindex) {
             $urldecoded = json_decode($result, true);
 
             return $urldecoded;
+        } else {
+            return false;
         }
     }
 
@@ -322,13 +335,14 @@ public function cmi5launch_send_request_to_cmi5_player_post($databody, $url, $fi
         } else if ("json") {
             $contenttype = "application/json\r\n";
         }
-
+   
         // If number of args is greater than one it is for retrieving tenant info and args are username and password.
         if (count($tokenorpassword) == 2 ) {
 
             $username = $tokenorpassword[0];
             $password = $tokenorpassword[1];
 
+        
             // Use key 'http' even if you send the request to https://...
             // There can be multiple headers but as an array under the ONE header.
             // Content(body) must be JSON encoded here, as that is what CMI5 player accepts.
@@ -342,13 +356,11 @@ public function cmi5launch_send_request_to_cmi5_player_post($databody, $url, $fi
                 ),
             );
 
-            // The options are here placed into a stream to be sent.
-            $context  = stream_context_create($options);
-
             // Sends the stream to the specified URL and stores results.
             // The false is use_include_path, which we dont want in this case, we want to go to the url.
-            $result = file_get_contents( $url, false, $context );
+            $result = $this->cmi5launch_stream_and_send( $url, $options );
 
+            
             // Else the args are what we need for posting a course.
         } else {
 
@@ -370,12 +382,11 @@ public function cmi5launch_send_request_to_cmi5_player_post($databody, $url, $fi
                 ),
             );
 
-            // The options are placed into a stream to be sent.
-            $context  = stream_context_create(($options));
+
 
             // Sends the stream to the specified URL and stores results.
             // The false is use_include_path, which we dont want in this case, we want to go to the url.
-            $result = file_get_contents( $url, false, $context );
+            $result = $this->cmi5launch_stream_and_send( $url, $options );
 
         }
 
@@ -404,14 +415,14 @@ public function cmi5launch_send_request_to_cmi5_player_get($token, $url) {
             ),
         );
 
-        // The options are here placed into a stream to be sent.
-        $context  = stream_context_create(($options));
 
-        // Sends the stream to the specified URL and stores results. False is to not use_include_path, we want to go to the url.
-        $launchresponse = file_get_contents( $url, false, $context );
+        // Sends the stream to the specified URL and stores results.
+        // The false is use_include_path, which we dont want in this case, we want to go to the url.
+        $launchresponse = $this->cmi5launch_stream_and_send( $url, $options );
 
         $sessiondecoded = json_decode($launchresponse, true);
 
+        // Return response.
         return $sessiondecoded;
     }
 
@@ -442,6 +453,8 @@ public function cmi5launch_retrieve_session_info_from_player($sessionid, $id) {
         if ($resulttest == true) {
 
             return $result;
+        } else {
+            return false;
         }
     }
 
@@ -454,7 +467,7 @@ public function cmi5launch_retrieve_session_info_from_player($sessionid, $id) {
      * @param string $type - The type missing to be added to the error message.
      * @return bool
      */
-    public function cmi5launch_connectors_error_message($resulttotest, $type) {
+    public static function cmi5launch_connectors_error_message($resulttotest, $type) {
 
         // Decode result because if it is not 200 then something went wrong
         // If it's a string, decode it.
@@ -464,12 +477,24 @@ public function cmi5launch_connectors_error_message($resulttotest, $type) {
             $resulttest = $resulttotest;
         }
 
-        if ($resulttest === false || array_key_exists("statusCode", $resulttest) && $resulttest["statusCode"] != 200) {
+        // I think splittin these to return two seperate messages deppennnding on whether player is running is better.
+        // Player cannot return an error if not runnin,
+        if ($resulttest === false ){
+
+            echo "<br>";
+
+            echo "Something went wrong " . $type . ". CMI5 Player is not communicating. Is it running?";
 
             echo "<br>";
 
-            echo "Something went wrong " . $type . ". CMI5 Player returned " . var_dump($resulttotest);
+            return false;
+        }
+        else if( array_key_exists("statusCode", $resulttest) && $resulttest["statusCode"] != 200) {
+
+            echo "<br>";
 
+            echo "Something went wrong " . $type . ". CMI5 Player returned " . $resulttest["statusCode"] . " error. With message '" 
+                . $resulttest["message"] . "'." ;
             echo "<br>";
 
             return false;
@@ -479,4 +504,27 @@ public function cmi5launch_connectors_error_message($resulttotest, $type) {
             return true;
         }
     }
+
+    /**
+     * Wrapper function to allow for testing where file_get_contents cannot be overriden.
+     * Also has create_stream as this makes a resource which interfers with testing.
+     * @param mixed $url - the url to be sent to 
+     * @param mixed $use_include_path
+     * @param mixed $context - the data to be sent
+     * @param mixed $offset
+     * @param mixed $maxlen
+     * @return mixed $result - either a string or false.
+     */
+    public function cmi5launch_stream_and_send($options, $url) {
+
+        // The options are placed into a stream to be sent.
+        $context  = stream_context_create(($options));
+
+        // Sends the stream to the specified URL and stores results.
+        // The false is use_include_path, which we dont want in this case, we want to go to the url.
+        $result = file_get_contents( $url, false, $context );
+
+        // Return result.
+        return $result;
+    }
 }

classes/local/course.php

@@ -24,6 +24,8 @@
  defined('MOODLE_INTERNAL') || die();
 
 class course {
+
+    // Lowercase values are for saving to DB.
     public $id, $url, $ausgrades, $type, $lmsid, $grade, $scores, $title, $moveon, $auindex,
     $parents, $objectives, $launchurl, $sessions = array(), $sessionid, $returnurl, $description = [], $activitytype, $launchmethod,
     $masteryscore, $progress, $noattempt, $completed, $passed, $inprogress, $satisfied, $moodlecourseid;