SiteTreeContentReviewTest::testSiteConfigSettingsAreUsedAsDefaults() - Code Metrics - Inspection of "Merge branch '3'" - silverstripe/silverstripe-contentreview - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 587724...a55d5c )

by Robbie

created 2017-10-12 00:27 UTC

testSiteConfigSettingsAreUsedAsDefaults() A

↳ Parent: SiteTreeContentReviewTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	20
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	20
rs	9.4285
cc	1
eloc	9
nc	1
nop	0

<?php

namespace SilverStripe\ContentReview\Tests;

use Page;
use SilverStripe\CMS\Controllers\CMSPageEditController;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\ContentReview\Extensions\SiteTreeContentReview;
use SilverStripe\ContentReview\Extensions\ContentReviewOwner;
use SilverStripe\ContentReview\Extensions\ContentReviewCMSExtension;
use SilverStripe\ContentReview\Extensions\ContentReviewDefaultSettings;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Security\Group;
use SilverStripe\Security\Member;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\Versioned\Versioned;

/**
 * @mixin PHPUnit_Framework_TestCase
 */
class SiteTreeContentReviewTest extends ContentReviewBaseTest
{
    /**
     * @var string
     */
    protected static $fixture_file = 'ContentReviewTest.yml';

    /**
     * @var array
     */
    protected static $required_extensions = [
        SiteTree::class              => [SiteTreeContentReview::class],
        Group::class                 => [ContentReviewOwner::class],
        Member::class                => [ContentReviewOwner::class],
        CMSPageEditController::class => [ContentReviewCMSExtension::class],
        SiteConfig::class            => [ContentReviewDefaultSettings::class],
    ];

    public function testOwnerNames()
    {
        /** @var Member $editor */
        $editor = $this->objFromFixture(Member::class, "editor");

        $this->logInAs($editor);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();
        $page->ReviewPeriodDays = 10;
        $page->ContentReviewType = "Custom";

        $page->ContentReviewUsers()->push($editor);
        $page->write();


        $this->assertTrue($page->canPublish());

        $this->assertTrue($page->doPublish());

        $this->assertEquals($page->OwnerNames, "Test Editor", "Test Editor should be the owner");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "about");

        $page->OwnerUsers()->removeAll();
        $page->write();


        $this->assertTrue($page->canPublish());

        $this->assertTrue($page->doPublish());

        $this->assertEquals("", $page->OwnerNames);
    }

    public function testPermissionsExists()
    {
        $perms = singleton(SiteTreeContentReview::class)->providePermissions();

        $this->assertTrue(isset($perms["EDIT_CONTENT_REVIEW_FIELDS"]));
    }

    public function testUserWithPermissionCanEdit()

    {
        /** @var Member $editor */
        $editor = $this->objFromFixture(Member::class, "editor");

        $this->logInAs($editor);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();

        $fields = $page->getSettingsFields();


        $this->assertNotNull($fields->dataFieldByName("NextReviewDate"));
    }

    public function testUserWithoutPermissionCannotEdit()

    {
        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        $this->logInAs($author);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();

        $fields = $page->getSettingsFields();


        $this->assertNull($fields->dataFieldByName("NextReviewDate"));
    }

    public function testAutomaticallyToNotSetReviewDate()
    {
        /** @var Member $editor */
        $editor = $this->objFromFixture(Member::class, "editor");

        $this->logInAs($editor);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();

        $page->ReviewPeriodDays = 10;
        $page->write();


        $this->assertTrue($page->doPublish());

        $this->assertEquals(null, $page->NextReviewDate);
    }

    public function testAddReviewNote()
    {
        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "home");

        $page->addReviewNote($author, "This is a message");

        /** @var Page|SiteTreeContentReview $page */
        $homepage = $this->objFromFixture(Page::class, "home");

        $this->assertEquals(1, $homepage->ReviewLogs()->count());
        $this->assertEquals("This is a message", $homepage->ReviewLogs()->first()->Note);
    }

    public function testGetContentReviewOwners()
    {
        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "group-owned");

        $owners = $page->ContentReviewOwners();

        $this->assertEquals(1, $owners->count());
        $this->assertEquals("[email protected]", $owners->first()->Email);
    }

    public function testCanNotBeReviewBecauseNoReviewDate()

    {
        DBDatetime::set_mock_now("2010-01-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "no-review");

        $this->assertFalse($page->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }

    public function testCanNotBeReviewedBecauseInFuture()

    {
        DBDatetime::set_mock_now("2010-01-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "staff");

        $this->assertFalse($page->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }

    public function testCanNotBeReviewedByUser()

    {
        DBDatetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "home");

        $this->assertFalse($page->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }

    public function testCanBeReviewedByUser()

    {
        DBDatetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "staff");

        $this->assertTrue($page->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }

    public function testCanNotBeReviewedByGroup()

    {
        DBDatetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "editor");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "contact");

        $this->assertFalse($page->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }

    public function testCanBeReviewedByGroup()

    {
        DBDatetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "contact");

        $this->assertTrue($page->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }

    public function testCanBeReviewedFromInheritedSetting()

    {
        DBDatetime::set_mock_now("2013-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");

        /** @var Page|SiteTreeContentReview $parentPage */
        $parentPage = $this->objFromFixture(Page::class, "contact");

        $parentPage->NextReviewDate = "2013-01-01";
        $parentPage->write();


        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "contact-child");

        $this->assertTrue($page->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }

    public function testUnModifiedPagesDontChangeEditor()
    {
        DBDatetime::set_mock_now("2013-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "author");
        $this->logInAs($author);

        // Page which is un-modified doesn't advance version of have an editor assigned
        $contactPage = $this->objFromFixture(Page::class, "contact");
        $contactPageVersion = $contactPage->Version;
        $contactPage->write();
        $this->assertEmpty($contactPage->LastEditedByName);

        $this->assertEquals(
            $contactPageVersion,
            Versioned::get_versionnumber_by_stage(SiteTree::class, 'Stage', $contactPage->ID, false)
        );

        // Page with modifications gets marked
        $homePage = $this->objFromFixture(Page::class, "home");
        $homePageVersion = $homePage->Version;
        $homePage->Content = '<p>Welcome!</p>';
        $homePage->write();
        $this->assertNotEmpty($homePage->LastEditedByName);

        $this->assertEquals($author->getTitle(), $homePage->LastEditedByName);

        $this->assertGreaterThan(
            $homePageVersion,
            Versioned::get_versionnumber_by_stage(SiteTree::class, 'Stage', $homePage->ID, false)
        );

        DBDatetime::clear_mock_now();
    }

    public function testReviewActionVisibleForAuthor()
    {
        DBDatetime::set_mock_now('2020-03-01 12:00:00');

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, 'contact');

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, 'author');

        $this->logInAs($author);

        $fields = $page->getCMSActions();


        $this->assertInstanceOf(LiteralField::class, $fields->fieldByName('ContentReviewButton'));

        DBDatetime::clear_mock_now();
    }

    public function testReviewActionNotVisibleForEditor()

    {
        DBDatetime::set_mock_now("2020-03-01 12:00:00");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture(Page::class, "contact");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, "editor");

        $this->logInAs($author);

        $fields = $page->getCMSActions();


        $this->assertNull($fields->fieldByName("ActionMenus.ReviewContent"));

        DBDatetime::clear_mock_now();
    }

    public function testSiteConfigSettingsAreUsedAsDefaults()
    {
        DBDatetime::set_mock_now("2020-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture(Member::class, 'editor');

        /** @var SiteConfig $siteConfig */
        $siteConfig = SiteConfig::current_site_config();

        // Set the author to a default user for reviewing
        $siteConfig->OwnerUsers()->add($author);

        $emptyPage = new Page;
        $emptyPage->NextReviewDate = '2020-02-20 12:00:00';

        $this->assertTrue($emptyPage->canBeReviewedBy($author));

        DBDatetime::clear_mock_now();
    }
}


1			<?php
2
3			namespace SilverStripe\ContentReview\Tests;
4
5			use Page;
6			use SilverStripe\CMS\Controllers\CMSPageEditController;
7			use SilverStripe\CMS\Model\SiteTree;
8			use SilverStripe\ContentReview\Extensions\SiteTreeContentReview;
9			use SilverStripe\ContentReview\Extensions\ContentReviewOwner;
10			use SilverStripe\ContentReview\Extensions\ContentReviewCMSExtension;
11			use SilverStripe\ContentReview\Extensions\ContentReviewDefaultSettings;
12			use SilverStripe\Forms\LiteralField;
13			use SilverStripe\Security\Group;
14			use SilverStripe\Security\Member;
15			use SilverStripe\SiteConfig\SiteConfig;
16			use SilverStripe\ORM\FieldType\DBDatetime;
17			use SilverStripe\Versioned\Versioned;
18
19			/**
20			* @mixin PHPUnit_Framework_TestCase
21			*/
22			class SiteTreeContentReviewTest extends ContentReviewBaseTest
23			{
24			/**
25			* @var string
26			*/
27			protected static $fixture_file = 'ContentReviewTest.yml';
28
29			/**
30			* @var array
31			*/
32			protected static $required_extensions = [
33			SiteTree::class => [SiteTreeContentReview::class],
34			Group::class => [ContentReviewOwner::class],
35			Member::class => [ContentReviewOwner::class],
36			CMSPageEditController::class => [ContentReviewCMSExtension::class],
37			SiteConfig::class => [ContentReviewDefaultSettings::class],
38			];
39
40			public function testOwnerNames()

silverstripe / silverstripe-contentreview

Push — master ( 587724...a55d5c )

testSiteConfigSettingsAreUsedAsDefaults() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like