<?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/>.
/**
* Steps definitions related with blocks.
*
* @package core_block
* @category test
* @copyright 2012 David MonllaĆ³
* @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.
use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException;
> use Behat\Gherkin\Node\TableNode as TableNode;
require_once(__DIR__ . '/../../../lib/behat/behat_base.php');
/**
* Blocks management steps definitions.
*
* @package core_block
* @category test
* @copyright 2012 David MonllaĆ³
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class behat_blocks extends behat_base {
/**
* Adds the selected block. Editing mode must be previously enabled.
*
* @Given /^I add the "(?P<block_name_string>(?:[^"]|\\")*)" block$/
* @param string $blockname
*/
public function i_add_the_block($blockname) {
$addblock = get_string('addblock');
< $this->execute('behat_navigation::i_select_from_flat_navigation_drawer', $addblock);
> $this->execute('behat_general::i_click_on_in_the', [$addblock, 'link_exact', '.add_block_button', 'css_element']);
if (!$this->running_javascript()) {
$this->execute('behat_general::i_click_on_in_the', [$blockname, 'link_exact', '#region-main', 'css_element']);
} else {
$this->execute('behat_general::i_click_on_in_the', [$blockname, 'link_exact', $addblock, 'dialogue']);
}
}
/**
> * Adds the selected block to the specified region
* Adds the selected block if it is not already present. Editing mode must be previously enabled.
> *
*
> * Editing mode must be previously enabled.
* @Given /^I add the "(?P<block_name_string>(?:[^"]|\\")*)" block if not present$/
> *
* @param string $blockname
> * @Given /^I add the "(?P<block_name_string>(?:[^"]|\\")*)" block to the "(?P<region_string>(?:[^"]|\\")*)" region$/
*/
> * @param string $blockname
public function i_add_the_block_if_not_present($blockname) {
> * @param string $region
try {
> */
$this->get_text_selector_node('block', $blockname);
> public function i_add_the_block_to_the_region(string $blockname, string $region) {
} catch (ElementNotFoundException $e) {
> if (!$this->running_javascript()) {
$this->execute('behat_blocks::i_add_the_block', [$blockname]);
> throw new coding_exception('Adding block to specific region is not possible with Javascript disabled');
}
> }
}
> if ($region === "default") {
> $region = "";
/**
> }
* Opens a block's actions menu if it is not already opened.
> $csselement = 'a[data-key="addblock"][data-blockregion='.behat_context_helper::escape($region).']';
*
> $addblock = get_string('addblock');
* @Given /^I open the "(?P<block_name_string>(?:[^"]|\\")*)" blocks action menu$/
> $this->execute('behat_general::i_click_on', [$csselement, 'css_element']);
* @throws DriverException The step is not available when Javascript is disabled
> $this->execute('behat_general::i_click_on_in_the', [$blockname, 'link_exact', $addblock, 'dialogue']);
* @param string $blockname
> }
*/
>
public function i_open_the_blocks_action_menu($blockname) {
> /**
> * Adds the selected block to the specified region and fills configuration form.
if (!$this->running_javascript()) {
> *
// Action menu does not need to be open if Javascript is off.
> * Editing mode must be previously enabled.
return;
> *
}
> * @Given /^I add the "(?P<block_name_string>(?:[^"]|\\")*)" block to the (?P<region_string>(?:[^"]|\\")*) region with:$/
> * @param string $blockname
// If it is already opened we do nothing.
> * @param string $region
$blocknode = $this->get_text_selector_node('block', $blockname);
> * @param TableNode $data
if ($blocknode->hasClass('action-menu-shown')) {
> */
return;
> public function i_add_the_block_to_the_region_with(string $blockname, string $region, TableNode $data) {
}
> $blocklabel = get_string('textellipsis', 'moodle', $blockname);
> $this->execute('behat_blocks::i_add_the_block_to_the_region', [$blocklabel, $region]);
$this->execute('behat_general::i_click_on_in_the',
> $this->wait_for_pending_js();
array("a[data-toggle='dropdown']", "css_element", $this->escape($blockname), "block")
> $dialogname = get_string('addblock', 'core_block', $blockname);
);
> $this->execute('behat_forms::i_set_the_following_fields_in_container_to_these_values',
}
> [$dialogname, "dialogue", $data]);
> $this->execute('behat_general::i_click_on_in_the', ["Save changes", 'button', $dialogname, 'dialogue']);
/**
> }
* Clicks on Configure block for specified block. Page must be in editing mode.
>
*
> /**
* Argument block_name may be either the name of the block or CSS class of the block.
*
* @Given /^I configure the "(?P<block_name_string>(?:[^"]|\\")*)" block$/
* @param string $blockname
*/
public function i_configure_the_block($blockname) {
// Note that since $blockname may be either block name or CSS class, we can not use the exact label of "Configure" link.
$this->execute("behat_blocks::i_open_the_blocks_action_menu", $this->escape($blockname));
$this->execute('behat_general::i_click_on_in_the',
array("Configure", "link", $this->escape($blockname), "block")
);
}
/**
* Ensures that block can be added to the page but does not actually add it.
*
* @Then /^the add block selector should contain "(?P<block_name_string>(?:[^"]|\\")*)" block$/
* @param string $blockname
*/
public function the_add_block_selector_should_contain_block($blockname) {
$addblock = get_string('addblock');
< $this->execute('behat_navigation::i_select_from_flat_navigation_drawer', $addblock);
> $this->execute('behat_general::i_click_on', [$addblock, 'link_exact']);
>
$cancelstr = get_string('cancel');
if (!$this->running_javascript()) {
$this->execute('behat_general::should_exist_in_the', [$blockname, 'link_exact', '#region-main', 'css_element']);
$this->execute('behat_general::i_click_on_in_the', [$cancelstr, 'link_exact', '#region-main', 'css_element']);
} else {
$this->execute('behat_general::should_exist_in_the', [$blockname, 'link_exact', $addblock, 'dialogue']);
$this->execute('behat_general::i_click_on_in_the', [$cancelstr, 'button', $addblock, 'dialogue']);
}
}
/**
* Ensures that block can not be added to the page.
*
* @Then /^the add block selector should not contain "(?P<block_name_string>(?:[^"]|\\")*)" block$/
* @param string $blockname
*/
public function the_add_block_selector_should_not_contain_block($blockname) {
$addblock = get_string('addblock');
< $this->execute('behat_navigation::i_select_from_flat_navigation_drawer', $addblock);
> $this->execute('behat_general::i_click_on', [$addblock, 'link_exact']);
>
$cancelstr = get_string('cancel');
if (!$this->running_javascript()) {
$this->execute('behat_general::should_not_exist_in_the', [$blockname, 'link_exact', '#region-main', 'css_element']);
$this->execute('behat_general::i_click_on_in_the', [$cancelstr, 'link_exact', '#region-main', 'css_element']);
} else {
$this->execute('behat_general::should_not_exist_in_the', [$blockname, 'link_exact', $addblock, 'dialogue']);
$this->execute('behat_general::i_click_on_in_the', [$cancelstr, 'button', $addblock, 'dialogue']);
}
}
}