From 3413df37a5ebc27c0f03b2bd043487a738b104f9 Mon Sep 17 00:00:00 2001 From: Sara Arjona Date: Tue, 14 Dec 2021 18:12:35 +0100 Subject: [PATCH] MDL-73339 blog_recent: Add block only if main feature is enabled The Recent blog entries block should be added only if the blogs advanced feature is enabled. --- blocks/blog_recent/block_blog_recent.php | 12 ++++ .../tests/behat/block_blog_recent.feature | 9 ++- blocks/blog_recent/tests/blog_recent_test.php | 63 +++++++++++++++++++ 3 files changed, 79 insertions(+), 5 deletions(-) create mode 100644 blocks/blog_recent/tests/blog_recent_test.php diff --git a/blocks/blog_recent/block_blog_recent.php b/blocks/blog_recent/block_blog_recent.php index 7089194f8be..5bdaa614839 100644 --- a/blocks/blog_recent/block_blog_recent.php +++ b/blocks/blog_recent/block_blog_recent.php @@ -142,4 +142,16 @@ class block_blog_recent extends block_base { '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; + } } diff --git a/blocks/blog_recent/tests/behat/block_blog_recent.feature b/blocks/blog_recent/tests/behat/block_blog_recent.feature index ccb4c64efb3..bf4a64aaf3e 100644 --- a/blocks/blog_recent/tests/behat/block_blog_recent.feature +++ b/blocks/blog_recent/tests/behat/block_blog_recent.feature @@ -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 diff --git a/blocks/blog_recent/tests/blog_recent_test.php b/blocks/blog_recent/tests/blog_recent_test.php new file mode 100644 index 00000000000..88e1ec88cc6 --- /dev/null +++ b/blocks/blog_recent/tests/blog_recent_test.php @@ -0,0 +1,63 @@ +. + +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)); + } +}