From 9cec5dcaae005cb2f44a6acda0c36ecffaacf3b6 Mon Sep 17 00:00:00 2001
From: Ryan Wyllie <ryan@moodle.com>
Date: Mon, 4 Nov 2019 11:29:29 +0800
Subject: [PATCH] MDL-66770 mod_forum: fix subscription behat tests

---
 .../templates/forum_action_menu.mustache      |  5 +-
 mod/forum/tests/behat/behat_mod_forum.php     | 60 ++++++++++++++++
 .../behat/discussion_subscriptions.feature    | 72 +++++++------------
 .../behat_theme_classic_behat_mod_forum.php   | 67 +++++++++++++++++
 4 files changed, 156 insertions(+), 48 deletions(-)
 create mode 100644 theme/classic/tests/behat/behat_theme_classic_behat_mod_forum.php

diff --git a/mod/forum/templates/forum_action_menu.mustache b/mod/forum/templates/forum_action_menu.mustache
index 247df17664b..23750ca2105 100644
--- a/mod/forum/templates/forum_action_menu.mustache
+++ b/mod/forum/templates/forum_action_menu.mustache
@@ -50,7 +50,8 @@
     }
 }}
 <div class="ml-auto dropdown">
-    <button class="{{^settings.excludetext}}dropdown-toggle{{/settings.excludetext}} btn btn-link {{#settings.togglemoreicon}}btn-icon colour-inherit{{/settings.togglemoreicon}}"
+    <a href="#" class="{{^settings.excludetext}}dropdown-toggle{{/settings.excludetext}} btn btn-link {{#settings.togglemoreicon}}btn-icon colour-inherit text-decoration-none d-flex align-items-center justify-content-center{{/settings.togglemoreicon}}"
+        role="button"
         data-toggle="dropdown"
         aria-haspopup="true"
         tabindex="0"
@@ -65,7 +66,7 @@
         {{^settings.excludetext}}
             {{#str}} settings, mod_forum {{/str}}
         {{/settings.excludetext}}
-    </button>
+    </a>
     <div class="dropdown-menu dropdown-menu-right"
          aria-labelledby="forum-action-menu-{{id}}-menu"
          data-rel="menu-content"
diff --git a/mod/forum/tests/behat/behat_mod_forum.php b/mod/forum/tests/behat/behat_mod_forum.php
index 29241df4a95..d167882e6d3 100644
--- a/mod/forum/tests/behat/behat_mod_forum.php
+++ b/mod/forum/tests/behat/behat_mod_forum.php
@@ -252,6 +252,66 @@ class behat_mod_forum extends behat_base {
         }
     }
 
+    /**
+     * Checks if the user can subscribe to the forum.
+     *
+     * @Given /^I can subscribe to this forum$/
+     */
+    public function i_can_subscribe_to_this_forum() {
+        if ($this->running_javascript()) {
+            $this->execute('behat_general::i_click_on', [get_string('actionsmenu'), 'link']);
+        }
+
+        $this->execute('behat_general::assert_page_contains_text', [get_string('subscribe', 'mod_forum')]);
+
+        if ($this->running_javascript()) {
+            $this->execute('behat_general::i_click_on', [get_string('actionsmenu'), 'link']);
+        }
+    }
+
+    /**
+     * Checks if the user can unsubscribe from the forum.
+     *
+     * @Given /^I can unsubscribe from this forum$/
+     */
+    public function i_can_unsubscribe_from_this_forum() {
+        if ($this->running_javascript()) {
+            $this->execute('behat_general::i_click_on', [get_string('actionsmenu'), 'link']);
+        }
+
+        $this->execute('behat_general::assert_page_contains_text', [get_string('unsubscribe', 'mod_forum')]);
+
+        if ($this->running_javascript()) {
+            $this->execute('behat_general::i_click_on', [get_string('actionsmenu'), 'link']);
+        }
+    }
+
+    /**
+     * Subscribes to the forum.
+     *
+     * @Given /^I subscribe to this forum$/
+     */
+    public function i_subscribe_to_this_forum() {
+        if ($this->running_javascript()) {
+            $this->execute('behat_general::i_click_on', [get_string('actionsmenu'), 'link']);
+        }
+
+        $this->execute('behat_general::click_link', [get_string('subscribe', 'mod_forum')]);
+    }
+
+    /**
+     * Unsubscribes from the forum.
+     *
+     * @Given /^I unsubscribe from this forum$/
+     */
+    public function i_unsubscribe_from_this_forum() {
+        if ($this->running_javascript()) {
+            $this->execute('behat_general::i_click_on', [get_string('actionsmenu'), 'link']);
+        }
+
+        $this->execute('behat_general::click_link', [get_string('unsubscribe', 'mod_forum')]);
+    }
+
     /**
      * Fetch user ID from its username.
      *
diff --git a/mod/forum/tests/behat/discussion_subscriptions.feature b/mod/forum/tests/behat/discussion_subscriptions.feature
index 484cfe7a975..e1939280dd9 100644
--- a/mod/forum/tests/behat/discussion_subscriptions.feature
+++ b/mod/forum/tests/behat/discussion_subscriptions.feature
@@ -34,35 +34,29 @@ Feature: A user can control their own subscription preferences for a discussion
     When I log in as "student1"
     And I am on "Course 1" course homepage
     And I follow "Test forum name"
-    Then I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    Then I can subscribe to this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
-    And I follow "Subscribe to this forum"
+    And I subscribe to this forum
     And I should see "Student One will be notified of new posts in 'Test forum name'"
-    And I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    And I can unsubscribe from this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
-    And I follow "Unsubscribe from this forum"
+    And I unsubscribe from this forum
     And I should see "Student One will NOT be notified of new posts in 'Test forum name'"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
 
@@ -83,35 +77,29 @@ Feature: A user can control their own subscription preferences for a discussion
     When I log in as "student1"
     And I am on "Course 1" course homepage
     And I follow "Test forum name"
-    Then I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    Then I can unsubscribe from this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    And I can unsubscribe from this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    And I can unsubscribe from this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    And I can unsubscribe from this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
-    And I follow "Unsubscribe from this forum"
+    And I unsubscribe from this forum
     And I should see "Student One will NOT be notified of new posts in 'Test forum name'"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
-    And I follow "Subscribe to this forum"
+    And I subscribe to this forum
     And I should see "Student One will be notified of new posts in 'Test forum name'"
-    And I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    And I can unsubscribe from this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
 
@@ -132,13 +120,11 @@ Feature: A user can control their own subscription preferences for a discussion
     And I log in as "student1"
     And I am on "Course 1" course homepage
     And I follow "Test forum name"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I log out
@@ -153,14 +139,12 @@ Feature: A user can control their own subscription preferences for a discussion
     And I log in as "student1"
     And I am on "Course 1" course homepage
     And I follow "Test forum name"
-    And I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    And I can unsubscribe from this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
-    When I follow "Unsubscribe from this forum"
+    When I unsubscribe from this forum
     Then I should see "Student One will NOT be notified of new posts in 'Test forum name'"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
 
@@ -181,13 +165,11 @@ Feature: A user can control their own subscription preferences for a discussion
     And I log in as "student1"
     And I am on "Course 1" course homepage
     And I follow "Test forum name"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I click on "label[for^=subscription-toggle]" "css_element" in the "Test post subject one" "table_row"
-    And I click on "Actions menu" "link"
-    And I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
     And I log out
@@ -202,14 +184,12 @@ Feature: A user can control their own subscription preferences for a discussion
     And I log in as "student1"
     And I am on "Course 1" course homepage
     And I follow "Test forum name"
-    And I click on "Actions menu" "link"
-    And I should see "Unsubscribe from this forum"
+    And I can unsubscribe from this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
-    When I follow "Unsubscribe from this forum"
+    When I unsubscribe from this forum
     And I should see "Student One will NOT be notified of new posts in 'Test forum name'"
-    And I click on "Actions menu" "link"
-    Then I should see "Subscribe to this forum"
+    And I can subscribe to this forum
     And "Unsubscribe from this discussion" "checkbox" should exist in the "Test post subject one" "table_row"
     And "Subscribe to this discussion" "checkbox" should exist in the "Test post subject two" "table_row"
 
diff --git a/theme/classic/tests/behat/behat_theme_classic_behat_mod_forum.php b/theme/classic/tests/behat/behat_theme_classic_behat_mod_forum.php
new file mode 100644
index 00000000000..193e7de3e9c
--- /dev/null
+++ b/theme/classic/tests/behat/behat_theme_classic_behat_mod_forum.php
@@ -0,0 +1,67 @@
+<?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/>.
+
+/**
+ * Step definitions related to mod_forum overrides for the Classic theme.
+ *
+ * @package    theme_classic
+ * @category   test
+ * @copyright  2019 Ryan Wyllie <ryan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
+
+require_once(__DIR__ . '/../../../../mod/forum/tests/behat/behat_mod_forum.php');
+
+/**
+ * Step definitions related to mod_forum overrides for the Classic theme.
+ *
+ * @package    theme_classic
+ * @category   test
+ * @copyright  2019 Ryan Wyllie <ryan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class behat_theme_classic_behat_mod_forum extends behat_mod_forum {
+
+    /**
+     * Checks if the user can subscribe to the forum.
+     */
+    public function i_can_subscribe_to_this_forum() {
+        $this->execute('behat_general::assert_page_contains_text', [get_string('subscribe', 'mod_forum')]);
+    }
+
+    /**
+     * Checks if the user can unsubscribe from the forum.
+     */
+    public function i_can_unsubscribe_from_this_forum() {
+        $this->execute('behat_general::assert_page_contains_text', [get_string('unsubscribe', 'mod_forum')]);
+    }
+
+    /**
+     * Subscribes to the forum.
+     */
+    public function i_subscribe_to_this_forum() {
+        $this->execute('behat_general::click_link', [get_string('subscribe', 'mod_forum')]);
+    }
+
+    /**
+     * Unsubscribes from the forum.
+     */
+    public function i_unsubscribe_from_this_forum() {
+        $this->execute('behat_general::click_link', [get_string('unsubscribe', 'mod_forum')]);
+    }
+}