first commit

communication/provider/matrix/tests/behat/behat_communication_matrix.php

@@ -0,0 +1,66 @@
+<?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/>.
+
+// phpcs:disable PSR1.Classes.ClassDeclaration.MissingNamespace
+
+use Behat\Behat\Hook\Scope\BeforeScenarioScope;
+use communication_matrix\matrix_test_helper_trait;
+use Moodle\BehatExtension\Exception\SkippedException;
+
+require_once(__DIR__ . '/../matrix_test_helper_trait.php');
+require_once(__DIR__ . '/../../../../../lib/behat/behat_base.php');
+require_once(__DIR__ . '/../../../../tests/communication_test_helper_trait.php');
+
+/**
+ * Class behat_communication_matrix for behat custom steps and configuration for matrix.
+ *
+ * @package    communication_matrix
+ * @category   test
+ * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class behat_communication_matrix extends \behat_base {
+    use \core_communication\communication_test_helper_trait;
+    use matrix_test_helper_trait;
+
+    /**
+     * BeforeScenario hook to reset the mock server.
+     *
+     * @BeforeScenario @communication_matrix
+     *
+     * @param BeforeScenarioScope $scope
+     */
+    public function before_scenario(BeforeScenarioScope $scope) {
+        if (defined('TEST_COMMUNICATION_MATRIX_MOCK_SERVER')) {
+            $this->reset_mock();
+        }
+    }
+
+    /**
+     * Setup and configure and mock server for matrix.
+     *
+     * @Given /^a Matrix mock server is configured$/
+     */
+    public function initialize_mock_server(): void {
+        if (!defined('TEST_COMMUNICATION_MATRIX_MOCK_SERVER')) {
+            throw new SkippedException(
+                'The TEST_COMMUNICATION_MATRIX_MOCK_SERVER constant must be defined to run communication_matrix tests'
+            );
+        }
+        $this->setup_communication_configs();
+        $this->initialise_mock_configs();
+    }
+}

communication/provider/matrix/tests/behat/matrix_form_fields.feature

@@ -0,0 +1,34 @@
+@communication @communication_matrix
+Feature: Communication matrix form field
+  In order to create a new communication room in matrix
+  As a teacher
+  I can update the room the information from course
+
+  Background: Make sure the mock server is initialized and a course is created for teacher
+    Given the following "users" exist:
+      | username | firstname | lastname | email |
+      | teacher1 | Teacher | 1 | teacher1@example.com |
+    And the following "courses" exist:
+      | fullname    | shortname   | category |
+      | Test course | Test course | 0        |
+    And the following "course enrolments" exist:
+      | user     | course      | role    |
+      | teacher1 | Test course | editingteacher |
+
+  @javascript
+  Scenario: I can add room name and topic for matrix room
+    Given a Matrix mock server is configured
+    And I am on the "Test course" "Course" page logged in as "teacher1"
+    When I navigate to "Communication" in current page administration
+    And I set the following fields to these values:
+      | selectedcommunication | communication_matrix |
+    And I wait to be redirected
+    And I set the following fields to these values:
+      | communication_matrixroomname | Sampleroomname  |
+      | matrixroomtopic              | Sampleroomtopic |
+    And I should see "Room name"
+    And I should see "Room topic"
+    And I press "Save changes"
+    And I navigate to "Communication" in current page administration
+    Then the field "Room name" matches value "Sampleroomname"
+    And the field "Room topic" matches value "Sampleroomtopic"

communication/provider/matrix/tests/behat/matrix_room_banner.feature

@@ -0,0 +1,52 @@
+@communication @communication_matrix
+Feature: Display communication room status banner
+  Show a banner depending on the room status
+  As a teacher or admin
+
+  Background:
+    Given a Matrix mock server is configured
+    And the following "users" exist:
+      | username | firstname | lastname | email                |
+      | teacher1 | Teacher   | 1        | teacher1@example.com |
+      | student1 | Student   | 1        | student1@example.com |
+    And the following "courses" exist:
+      | fullname    | shortname   | category | selectedcommunication | communicationroomname |
+      | Test course | Test course | 0        | communication_matrix  | matrixroom            |
+    And the following "course enrolments" exist:
+      | user     | course      | role           |
+      | teacher1 | Test course | editingteacher |
+      | student1 | Test course | student        |
+
+  Scenario: I can see the room has been created and in a pending status
+    When I am on the "Test course" "Course" page logged in as "teacher1"
+    Then I should see "Your Matrix room will be ready soon." in the "page-content" "region"
+    When I am on the "Test course" "Course" page logged in as "student1"
+    # Not for students to see.
+    Then I should not see "Your Matrix room will be ready soon." in the "page-content" "region"
+
+  Scenario: I can see the room has been created and ready to access
+    When I run all adhoc tasks
+    And I am on the "Test course" "Course" page logged in as "teacher1"
+    Then I should see "Your Matrix room is ready." in the "page-content" "region"
+    # This is a one time message per user.
+    When I reload the page
+    Then I should not see "Your Matrix room is ready." in the "page-content" "region"
+    # Not for students to see.
+    When I am on the "Test course" "Course" page logged in as "student1"
+    Then I should not see "Your Matrix room is ready." in the "page-content" "region"
+
+  Scenario: Enabling or disabling the matrix plugin hides the banner accordingly
+    Given I am on the "Test course" "Course" page logged in as "teacher1"
+    Then I should see "Your Matrix room will be ready soon." in the "page-content" "region"
+    When I log in as "admin"
+    And I navigate to "Plugins > Communication > Manage communication providers" in site administration
+    And I should see "Matrix"
+    And I click on "Disable" "link" in the "Matrix" "table_row"
+    And I am on the "Test course" "Course" page logged in as "teacher1"
+    And I should not see "Your Matrix room will be ready soon." in the "page-content" "region"
+    And I log in as "admin"
+    And I navigate to "Plugins > Communication > Manage communication providers" in site administration
+    And I should see "Matrix"
+    And I click on "Enable" "link" in the "Matrix" "table_row"
+    And I am on the "Test course" "Course" page logged in as "teacher1"
+    Then I should see "Your Matrix room will be ready soon." in the "page-content" "region"