DMSDocumentTest::testGetPermissionDeniedReason() - Code Metrics - Inspection of "Added ability to secure DMS assets by user group o..." - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#110)

by Franco

created 2017-05-08 04:13 UTC

DMSDocumentTest::testGetPermissionDeniedReason() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	0

<?php
class DMSDocumentTest extends SapphireTest
namespace YourVendor;

class YourClass { }
{
    protected static $fixture_file = 'dmstest.yml';

    public function tearDownOnce()

    {
        self::$is_running_test = true;

        $d = DataObject::get('DMSDocument');
        foreach ($d as $d1) {
            $d1->delete();
        }
        $t = DataObject::get('DMSTag');
        foreach ($t as $t1) {
            $t1->delete();
        }

        self::$is_running_test = $this->originalIsRunningTest;
    }

    public function testPageRelations()
    {
        $s1 = $this->objFromFixture('SiteTree', 's1');
        $s2 = $this->objFromFixture('SiteTree', 's2');
        $s3 = $this->objFromFixture('SiteTree', 's3');
        $s4 = $this->objFromFixture('SiteTree', 's4');
        $s5 = $this->objFromFixture('SiteTree', 's5');
        $s6 = $this->objFromFixture('SiteTree', 's6');

        $d1 = $this->objFromFixture('DMSDocument', 'd1');

        $pages = $d1->Pages();
        $pagesArray = $pages->toArray();
        $this->assertEquals($pagesArray[0]->ID, $s1->ID, 'Page 1 associated correctly');

        $this->assertEquals($pagesArray[1]->ID, $s2->ID, 'Page 2 associated correctly');

        $this->assertEquals($pagesArray[2]->ID, $s3->ID, 'Page 3 associated correctly');

        $this->assertEquals($pagesArray[3]->ID, $s4->ID, 'Page 4 associated correctly');

        $this->assertEquals($pagesArray[4]->ID, $s5->ID, 'Page 5 associated correctly');

        $this->assertEquals($pagesArray[5]->ID, $s6->ID, 'Page 6 associated correctly');

    }

    public function testAddPageRelation()
    {
        $s1 = $this->objFromFixture('SiteTree', 's1');
        $s2 = $this->objFromFixture('SiteTree', 's2');
        $s3 = $this->objFromFixture('SiteTree', 's3');

        $doc = new DMSDocument();
        $doc->Filename = 'test file';
        $doc->Folder = '0';
        $doc->write();

        $doc->addPage($s1);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $doc->addPage($s2);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $doc->addPage($s3);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $pages = $doc->Pages();
        $pagesArray = $pages->toArray();
        $this->assertEquals($pagesArray[0]->ID, $s1->ID, 'Page 1 associated correctly');

        $this->assertEquals($pagesArray[1]->ID, $s2->ID, 'Page 2 associated correctly');

        $this->assertEquals($pagesArray[2]->ID, $s3->ID, 'Page 3 associated correctly');


        $doc->removePage($s1);

        $pages = $doc->Pages();
        $pagesArray = $pages->toArray();    // Page 1 is missing
        $this->assertEquals($pagesArray[0]->ID, $s2->ID, 'Page 2 still associated correctly');

        $this->assertEquals($pagesArray[1]->ID, $s3->ID, 'Page 3 still associated correctly');


        $documents = $s2->Documents();
        $documentsArray = $documents->toArray();
        $this->assertDOSContains(
            array(
                array('Filename' => $doc->Filename)
            ),
            $documentsArray,
            'Document associated with page'

        );

        $doc->removeAllPages();
        $pages = $doc->Pages();
        $this->assertEquals($pages->Count(), 0, 'All pages removed');


        $documents = $s2->Documents();
        $documentsArray = $documents->toArray();
        $this->assertNotContains($doc, $documentsArray, 'Document no longer associated with page');
    }

    public function testDeletingPageWithAssociatedDocuments()
    {
        $s1 = $this->objFromFixture('SiteTree', 's1');
        $s2 = $this->objFromFixture('SiteTree', 's2');
        $s2->publish('Stage', 'Live');
        $s2ID = $s2->ID;

        $doc = new DMSDocument();
        $doc->Filename = 'delete test file';
        $doc->Folder = '0';
        $doc->write();

        $doc->addPage($s1);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $doc->addPage($s2);


        $s1->delete();

        $documents = DataObject::get("DMSDocument", "\"Filename\" = 'delete test file'", false);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertEquals(

            $documents->Count(),
            '1',
            "Deleting one of the associated page doesn't affect the single document we created"
        );

        $s2->delete();
        $documents = DataObject::get("DMSDocument", "\"Filename\" = 'delete test file'");
        $this->assertEquals(

            $documents->Count(),
            '1',
            "Deleting a page from draft stage doesn't delete the associated docs,"
            . "even if it's the last page they're associated with"
        );

        $s2 = Versioned::get_one_by_stage('SiteTree', 'Live', sprintf('"SiteTree"."ID" = %d', $s2ID));
        $s2->doDeleteFromLive();

        $documents = DataObject::get("DMSDocument", "\"Filename\" = 'delete test file'");
        $this->assertEquals(

            $documents->Count(),
            '0',
            'However, deleting the live version of the last page that a document is '
            . 'associated with causes that document to be deleted as well'
        );
    }

    public function testUnpublishPageWithAssociatedDocuments()
    {
        $s2 = $this->objFromFixture('SiteTree', 's2');
        $s2->publish('Stage', 'Live');
        $s2ID = $s2->ID;

        $doc = new DMSDocument();
        $doc->Filename = 'delete test file';
        $doc->Folder = '0';
        $doc->write();

        $doc->addPage($s2);


        $s2->doDeleteFromLive();

        $documents = DataObject::get("DMSDocument", "\"Filename\" = 'delete test file'");
        $this->assertEquals(

            $documents->Count(),
            '1',
            "Deleting a page from live stage doesn't delete the associated docs,"
            . "even if it's the last page they're associated with"
        );

        $s2 = Versioned::get_one_by_stage('SiteTree', 'Stage', sprintf('"SiteTree"."ID" = %d', $s2ID));
        $s2->delete();
        $documents = DataObject::get("DMSDocument", "\"Filename\" = 'delete test file'");
        $this->assertEquals(

            $documents->Count(),
            '0',
            'However, deleting the draft version of the last page that a document is '
            . 'associated with causes that document to be deleted as well'
        );
    }

    public function testDefaultDownloadBehabiourCMSFields()
    {
        $document = singleton('DMSDocument');
        Config::inst()->update('DMSDocument', 'default_download_behaviour', 'open');
        $cmsFields = $document->getCMSFields();
        $this->assertEquals('open', $cmsFields->dataFieldByName('DownloadBehavior')->Value());



        Config::inst()->update('DMSDocument', 'default_download_behaviour', 'download');
        $cmsFields = $document->getCMSFields();
        $this->assertEquals('download', $cmsFields->dataFieldByName('DownloadBehavior')->Value());

    }

    /**
     * Ensure that related documents can be retrieved for a given DMS document
     */
    public function testRelatedDocuments()
    {
        $document = $this->objFromFixture('DMSDocument', 'document_with_relations');
        $this->assertGreaterThan(0, $document->RelatedDocuments()->count());

        $this->assertEquals(

            array('test-file-file-doesnt-exist-1', 'test-file-file-doesnt-exist-2'),
            $document->getRelatedDocuments()->column('Filename')
        );
    }

    /**
     * Test the extensibility of getRelatedDocuments
     */
    public function testGetRelatedDocumentsIsExtensible()
    {
        DMSDocument::add_extension('StubRelatedDocumentExtension');

        $emptyDocument = new DMSDocument;
        $relatedDocuments = $emptyDocument->getRelatedDocuments();

        $this->assertCount(1, $relatedDocuments);

        $this->assertSame('Extended', $relatedDocuments->first()->Filename);

    }

    /**
     * Ensure that the DMS Document CMS actions contains a grid field for managing related documents
     */
    public function testDocumentHasCmsFieldForManagingRelatedDocuments()
    {
        $document = $this->objFromFixture('DMSDocument', 'document_with_relations');

        $documentFields = $document->getCMSFields();
        /** @var FieldGroup $actions */
        $actions = $documentFields->fieldByName('ActionsPanel');

        $gridField = null;
        foreach ($actions->getChildren() as $child) {
            /** @var FieldGroup $child */
            if ($gridField = $child->fieldByName('RelatedDocuments')) {
                break;
            }
        }
        $this->assertInstanceOf('GridField', $gridField);


        /** @var GridFieldConfig $gridFieldConfig */
        $gridFieldConfig = $gridField->getConfig();

        $this->assertNotNull(

            'GridFieldAddExistingAutocompleter',
            $addExisting = $gridFieldConfig->getComponentByType('GridFieldAddExistingAutocompleter'),
            'Related documents GridField has an "add existing" autocompleter'
        );

        $this->assertNull(

            $gridFieldConfig->getComponentByType('GridFieldAddNewButton'),
            'Related documents GridField does not have an "add new" button'
        );
    }

    /*
     * Tests whether the permissions fields are added
     */
    public function testAddPermissionsFields()
    {
        $document = $this->objFromFixture('DMSDocument', 'd1');
        $fields = $document->getCMSFields();

        $this->assertNotNull($fields->fieldByName('CanViewType'));

        $this->assertNotNull($fields->fieldByName('ViewerGroups'));

    }

    /**
     * Test view permissions
     */
    public function testCanView()
    {
        /** @var DMSDocument $document */
        $document = $this->objFromFixture('DMSDocument', 'doc-logged-in-users');
        // Make sure user is logged out
        if ($member = Member::currentUser()) {
            $member->logOut();
        }

        // Logged out user test
        $this->assertFalse($document->canView());


        // Logged in user test
        $adminID = $this->logInWithPermission();
        $admin = Member::get()->byID($adminID);
        $this->assertTrue($document->canView($admin));

        /** @var Member $member */
        $admin->logout();

        // Check anyone
        $document = $this->objFromFixture('DMSDocument', 'doc-anyone');
        $this->assertTrue($document->canView());


        // Check OnlyTheseUsers
        $document = $this->objFromFixture('DMSDocument', 'doc-only-these-users');
        $reportAdminID = $this->logInWithPermission('cable-guy');
        /** @var Member $reportAdmin */
        $reportAdmin = Member::get()->byID($reportAdminID);
        $this->assertFalse($document->canView($reportAdmin));

        // Add reportAdmin to group
        $reportAdmin->addToGroupByCode('content-author');
        $this->assertTrue($document->canView($reportAdmin));

        $reportAdmin->logout();
    }

    /**
     * Tests edit permissions
     */
    public function testCanEdit()
    {
        // Make sure user is logged out
        if ($member = Member::currentUser()) {
            $member->logOut();
        }

        /** @var DMSDocument $document1 */
        $document1 = $this->objFromFixture('DMSDocument', 'doc-logged-in-users');

        // Logged out user test
        $this->assertFalse($document1->canEdit());


        //Logged in user test
        $contentAuthor = $this->objFromFixture('Member', 'editor');
        $this->assertTrue($document1->canEdit($contentAuthor));


        // Check OnlyTheseUsers
        /** @var DMSDocument $document2 */
        $document2 = $this->objFromFixture('DMSDocument', 'doc-only-these-users');
        /** @var Member $cableGuy */
        $cableGuy = $this->objFromFixture('Member', 'non-editor');
        $this->assertFalse($document2->canEdit($cableGuy));


        $cableGuy->addToGroupByCode('content-author');
        $this->assertTrue($document2->canEdit($cableGuy));

    }

    /**
     * Test permission denied reasons for documents
     */
    public function testGetPermissionDeniedReason()
    {
        /** @var DMSDocument $document1 */
        $doc1 = $this->objFromFixture('DMSDocument', 'doc-logged-in-users');
        $this->assertContains('Please log in to view this document', $doc1->getPermissionDeniedReason());

        /** @var DMSDocument $doc2 */
        $doc2 = $this->objFromFixture('DMSDocument', 'doc-only-these-users');
        $this->assertContains('You are not authorised to view this document', $doc2->getPermissionDeniedReason());

        /** @var DMSDocument $doc3 */
        $doc3 = $this->objFromFixture('DMSDocument', 'doc-anyone');
        $this->assertEquals('', $doc3->getPermissionDeniedReason());

    }
}


1		<?php
2		class DMSDocumentTest extends SapphireTest
		0 ignored issues – show Coding Style Compatibility introduced 2017-05-05 03:19 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
3		{
4		protected static $fixture_file = 'dmstest.yml';
5
6	View Code Duplication	public function tearDownOnce()
		0 ignored issues – show Duplication introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
7		{
8		self::$is_running_test = true;
9
10		$d = DataObject::get('DMSDocument');
11		foreach ($d as $d1) {
12		$d1->delete();
13		}
14		$t = DataObject::get('DMSTag');
15		foreach ($t as $t1) {
16		$t1->delete();
17		}
18
19		self::$is_running_test = $this->originalIsRunningTest;
20		}
21
22		public function testPageRelations()
23		{
24		$s1 = $this->objFromFixture('SiteTree', 's1');
25		$s2 = $this->objFromFixture('SiteTree', 's2');
26		$s3 = $this->objFromFixture('SiteTree', 's3');
27		$s4 = $this->objFromFixture('SiteTree', 's4');
28		$s5 = $this->objFromFixture('SiteTree', 's5');
29		$s6 = $this->objFromFixture('SiteTree', 's6');
30
31		$d1 = $this->objFromFixture('DMSDocument', 'd1');
32
33		$pages = $d1->Pages();
34		$pagesArray = $pages->toArray();
35		$this->assertEquals($pagesArray[0]->ID, $s1->ID, 'Page 1 associated correctly');
		0 ignored issues – show Bug introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<DMSDocumentTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
36		$this->assertEquals($pagesArray[1]->ID, $s2->ID, 'Page 2 associated correctly');
		0 ignored issues – show Bug introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report The method `assertEquals()` does not seem to exist on `object<DMSDocumentTest>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...

silverstripe / silverstripe-dms

Pull Request — master (#110)

DMSDocumentTest::testGetPermissionDeniedReason() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like