Add PHPunit Tests

.github/workflows/moodle-ci.yml

@@ -0,0 +1,122 @@
+name: Moodle Plugin CI
+
+on: [push, pull_request]
+
+#start pgsql test
+jobs:
+  test_pgsql:
+    runs-on: ubuntu-18.04
+
+    services:
+      postgres:
+        image: postgres:10
+        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
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['7.4']
+        moodle-branch: ['MOODLE_311_STABLE']
+        database: [pgsql]
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        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 rwthanalytics/moodle-logstore_lanalytics
+          moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+
+      - name: PHP Lint
+        if: ${{ always() }}
+        run: moodle-plugin-ci phplint
+
+      - name: PHPUnit tests
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpunit
+  #end pgsql test
+
+  #start moodle mariadb matrix tests
+  test_mariadb:
+    runs-on: ubuntu-18.04
+
+    services:
+      mariadb:
+        image: mariadb:10.5
+        env:
+          MYSQL_USER: 'root'
+          MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['7.3', '7.4']
+        moodle-branch: ['MOODLE_311_STABLE', 'MOODLE_310_STABLE', 'MOODLE_39_STABLE']
+        database: [mariadb]
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        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 rwthanalytics/moodle-logstore_lanalytics
+          moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+
+      - name: PHP Lint
+        if: ${{ always() }}
+        run: moodle-plugin-ci phplint
+
+      - name: PHPUnit tests
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpunit
+#end moodle mariadb matrix tests

composer.json

@@ -5,7 +5,8 @@
   "homepage": "https://git.rwth-aachen.de/laixmo/moodle-local_learning_analytics",
   "license": "GPL-3.0+",
   "require": {
-    "composer/installers": "*"
+    "composer/installers": "*",
+    "nesbot/carbon": "^2.53"
   },
   "extra": {
     "installer-name": "learning_analytics"
@@ -14,4 +15,4 @@
     "issues": "https://git.rwth-aachen.de/laixmo/moodle-local_learning_analytics/issues",
     "source": "https://git.rwth-aachen.de/laixmo/moodle-local_learning_analytics"
   }
-}
+}

reports/activities/tests/query_helper_advanced_test.php

@@ -0,0 +1,180 @@
+<?php
+// 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/>.
+
+defined('MOODLE_INTERNAL') || die();
+
+use lareport_activities\query_helper;
+use PHPUnit\Framework\TestCase;
+use local_learning_analytics\event\report_viewed;
+use local_learning_analytics\report_list;
+require_once(__DIR__ . '/../../../../../config.php');
+
+//use: navigate in cmd to your moodle folder and enter vendor\bin\phpunit local_Learning_Analytics_reports_activities_testcase local\Learning_Analytics\reports\activities\tests\query_helper_advanced_test.php
+class local_Learning_Analytics_reports_activities_testcase extends \advanced_testcase {
+
+    public function test_activities() {
+        global $DB, $PAGE;
+        $this->resetAfterTest(true);
+        $this->setAdminUser();
+
+        $datagenerator = $this->getDataGenerator();
+        $activitygenerator = $this->getDataGenerator()->get_plugin_generator('mod_forum');
+
+        $this->preventResetByRollback();
+        set_config('enabled_stores', 'logstore_lanalytics', 'tool_log');
+        set_config('buffersize', 0, 'logstore_lanalytics');
+
+        $user = $datagenerator->create_user();
+        $category = $datagenerator->create_category();
+        $course = $datagenerator->create_course(array('name'=>'testcourse', 'category'=>$category->id));
+        $datagenerator->enrol_user($user->id, $course->id);
+
+        $forum = $activitygenerator->create_instance(array('course' => $course->id));
+
+        $instancequery = <<<SQL
+        SELECT
+            id
+        FROM {course_modules} AS cm
+        WHERE instance = ?
+SQL;
+
+        $contextquery = <<<SQL
+        SELECT
+            id
+        FROM {context} AS c
+        WHERE instanceid = ?
+SQL;
+
+        $logmanager = get_log_manager(true);
+        $contextinstance = $DB->get_record_sql($instancequery, [$forum->id]);
+        $instanceid = $contextinstance->id;
+        $context = $DB->get_record_sql($contextquery, [$instanceid]);
+        $contextid = $context->id;
+
+        for($i=0; $i<16; $i++) {
+            $event = report_viewed::create(array(
+                'contextid' => $contextid,
+                'objectid' => NULL
+            ));
+            $event->add_record_snapshot('forum', $forum);
+            $event->trigger();
+        }
+
+        $testresult1 = query_helper::query_activities($course->id,"" , []);
+
+        $this->assertEquals(17, $testresult1[$instanceid]->hits);
+
+        //second tests
+        $activitygenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');
+        $quiz = $activitygenerator->create_instance(array('course' => $course->id));
+
+        $contextinstance2 = $DB->get_record_sql($instancequery, [$quiz->id]);
+        $instanceid2 = $contextinstance2->id;
+        $context2 = $DB->get_record_sql($contextquery, [$instanceid2]);
+        $contextid2 = $context2->id;
+
+        for($i=0; $i<10; $i++) {
+            $event = report_viewed::create(array(
+                'contextid' => $contextid2,
+                'objectid' => NULL
+            ));
+            $event->add_record_snapshot('quiz', $quiz);
+            $event->trigger();
+        }
+
+        $testresult2 = query_helper::query_activities($course->id,"" , []);
+
+        $this->assertEquals(11, $testresult2[$instanceid2]->hits);
+    }
+
+    public function test_preview_query_most_clicked_activity() {
+        global $DB, $PAGE;
+        $this->resetAfterTest(true);
+        $this->setAdminUser();
+
+        $datagenerator = $this->getDataGenerator();
+        $activitygenerator = $this->getDataGenerator()->get_plugin_generator('mod_forum');
+
+        $this->preventResetByRollback();
+        set_config('enabled_stores', 'logstore_lanalytics', 'tool_log');
+        set_config('buffersize', 0, 'logstore_lanalytics');
+
+        $user = $datagenerator->create_user();
+        $category = $datagenerator->create_category();
+        $course = $datagenerator->create_course(array('name'=>'testcourse', 'category'=>$category->id));
+        $datagenerator->enrol_user($user->id, $course->id);
+
+        $forum = $activitygenerator->create_instance(array('course' => $course->id));
+
+        $instancequery = <<<SQL
+        SELECT
+            id
+        FROM {course_modules} AS cm
+        WHERE instance = ?
+SQL;
+
+        $contextquery = <<<SQL
+        SELECT
+            id
+        FROM {context} AS c
+        WHERE instanceid = ?
+SQL;
+
+        $logmanager = get_log_manager(true);
+        $contextinstance = $DB->get_record_sql($instancequery, [$forum->id]);
+        $instanceid = $contextinstance->id;
+        $context = $DB->get_record_sql($contextquery, [$instanceid]);
+        $contextid = $context->id;
+
+        $date = new \DateTime();
+        $date->setTime(23, 59, 59); // Include today.
+        $date->modify('-1 week');
+        $oneweekago = $date->getTimestamp();
+        $timestampBefore = $oneweekago - 40000;
+        $timestampAfter = $oneweekago + 40000;
+
+        $counterAfter = 0;
+        $counterBefore = 0;
+        for($i=0; $i<99; $i++) {
+            $counterAfter++;
+            $entry = [
+                'id' => $counterAfter,
+                'eventid' => 30,
+                'timecreated' => $timestampAfter,
+                'courseid' => $course->id,
+                'contextid' => $contextid,
+                'device' => 3611
+            ];
+            $DB->insert_record('logstore_lanalytics_log', $entry, false, false, true);
+            if($i%3==0) {
+                $counterBefore++;
+                $entry = [
+                    'id' => $counterBefore,
+                    'eventid' => 30,
+                    'timecreated' => $counterBefore,
+                    'courseid' => $course->id,
+                    'contextid' => $contextid,
+                    'device' => 3611
+                ];
+                $DB->insert_record('logstore_lanalytics_log', $entry, false, false, true);
+            }
+        }
+
+        $testresult1 = query_helper::preview_query_most_clicked_activity($course->id, 1);
+
+        $this->assertEquals(100, $testresult1[$instanceid]->hits);
+    }
+}

reports/coursedashboard/tests/query_helper_advanced_test.php

@@ -0,0 +1,73 @@
+<?php
+// 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/>.
+
+defined('MOODLE_INTERNAL') || die();
+
+use lareport_coursedashboard\query_helper;
+use PHPUnit\Framework\TestCase;
+use local_learning_analytics\event\report_viewed;
+use local_learning_analytics\report_list;
+require_once(__DIR__ . '/../../../../../config.php');
+
+//use: navigate in cmd to your moodle folder and enter vendor\bin\phpunit local_Learning_Analytics_reports_coursedashboard_testcase local\Learning_Analytics\reports\coursedashboard\tests\query_helper_advanced_test.php
+class local_Learning_Analytics_reports_coursedashboard_testcase extends \advanced_testcase {
+
+    public function test_weekly_activity() {
+        global $DB, $PAGE;
+        $this->resetAfterTest(true);
+        $this->setAdminUser();
+
+        $datagenerator = $this->getDataGenerator();
+
+        $this->preventResetByRollback();
+        set_config('enabled_stores', 'logstore_lanalytics_log', 'tool_log');
+        set_config('buffersize', 0, 'logstore_lanalytics_log');
+
+        $category = $datagenerator->create_category();
+        $course = $datagenerator->create_course(array('name'=>'testcourse', 'category'=>$category->id));
+        $user = $datagenerator->create_user();
+        $datagenerator->enrol_user($user->id, $course->id);
+
+        $date = time() - (7 * 24 * 60 * 60);
+        $tooearlydate = time() - (7 * 24 * 60 * 60 * 2);
+
+        $entry1 = [
+            'id' => 1,
+            'eventid' => 30,
+            'timecreated' => $tooearlydate,
+            'courseid' => $course->id,
+            'contextid' => 46,
+            'device' => 3611
+        ];
+        $entry2 = [
+            'id' => 2,
+            'eventid' => 30,
+            'timecreated' => $date,
+            'courseid' => $course->id,
+            'contextid' => 46,
+            'device' => 3611
+        ];
+
+        $DB->insert_record('logstore_lanalytics_log', $entry1, false, false, true);
+        $DB->insert_record('logstore_lanalytics_log', $entry2, false, false, true);
+
+        $testweekresult = query_helper::query_weekly_activity($course->id);
+        $testweek = end($testweekresult);
+        $testweekclicks = $testweek->clicks;
+
+        $this->assertEquals(1, $testweekclicks);
+    }
+}