Skip to content

Commit

Permalink
MDL-73339 blog_recent: Add block only if main feature is enabled
Browse files Browse the repository at this point in the history
The Recent blog entries block should be added only if the blogs
advanced feature is enabled.
  • Loading branch information
sarjona committed Dec 30, 2021
1 parent 1e09ac1 commit 3413df3
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 5 deletions.
12 changes: 12 additions & 0 deletions blocks/blog_recent/block_blog_recent.php
Expand Up @@ -142,4 +142,16 @@ public function get_config_for_external() {
'plugin' => new stdClass(),
];
}

/**
* This block shouldn't be added to a page if the blogs advanced feature is disabled.
*
* @param moodle_page $page
* @return bool
*/
public function can_block_be_added(moodle_page $page): bool {
global $CFG;

return $CFG->enableblogs;
}
}
9 changes: 4 additions & 5 deletions blocks/blog_recent/tests/behat/block_blog_recent.feature
Expand Up @@ -16,13 +16,12 @@ Feature: Feature: Users can use the recent blog entries block to view recent blo
| teacher1 | C1 | editingteacher |

Scenario: Add the recent blogs block to a course when blogs are disabled
Given I log in as "admin"
And the following config values are set as admin:
| enableblogs | 0 |
And I log out
And I log in as "teacher1"
Given I log in as "teacher1"
And I am on "Course 1" course homepage with editing mode on
When I add the "Recent blog entries" block
And the following config values are set as admin:
| enableblogs | 0 |
And I reload the page
Then I should see "Blogging is disabled!" in the "Recent blog entries" "block"

Scenario: Add the recent blogs block to a course when there are not any blog posts
Expand Down
63 changes: 63 additions & 0 deletions blocks/blog_recent/tests/blog_recent_test.php
@@ -0,0 +1,63 @@
<?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/>.

namespace block_blog_recent\tests;

use advanced_testcase;
use block_blog_recent;
use context_course;

/**
* PHPUnit block_blog_recent tests
*
* @package block_blog_recent
* @category test
* @copyright 2021 Sara Arjona (sara@moodle.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @coversDefaultClass \block_blog_recent
*/
class blog_recent_test extends advanced_testcase {
public static function setUpBeforeClass(): void {
require_once(__DIR__ . '/../../moodleblock.class.php');
require_once(__DIR__ . '/../block_blog_recent.php');
}

/**
* Test the behaviour of can_block_be_added() method.
*
* @covers ::can_block_be_added
*/
public function test_can_block_be_added(): void {
$this->resetAfterTest();
$this->setAdminUser();

// Create a course and prepare the page where the block will be added.
$course = $this->getDataGenerator()->create_course();
$page = new \moodle_page();
$page->set_context(context_course::instance($course->id));
$page->set_pagelayout('course');

$block = new block_blog_recent();

// If blogs advanced feature is enabled, the method should return true.
set_config('enableblogs', true);
$this->assertTrue($block->can_block_be_added($page));

// However, if the blogs advanced feature is disabled, the method should return false.
set_config('enableblogs', false);
$this->assertFalse($block->can_block_be_added($page));
}
}

0 comments on commit 3413df3

Please sign in to comment.