DMSDocumentTest::testDocumentHasNoCMSFieldsForManagingRelatedDocumentsIfCantEdit() - Code Metrics - Inspection of "FIX document and documentset permissions" - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#168)

by Franco

created 2017-06-08 23:08 UTC

DMSDocumentTest::testDocumentHasNoCMSFieldsForManagingRelatedDocumentsIfCantEdit() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
class DMSDocumentTest extends SapphireTest
namespace YourVendor;

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

    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');
        $gridField = $this->getGridFieldFromDocument($document);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertInstanceOf('GridField', $gridField);


        $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'
        );
    }

    /**
     * Ensures that the DMS Document CMS Related and Versions fields are removed if user can't edit
     */
    public function testDocumentHasNoCMSFieldsForManagingRelatedDocumentsIfCantEdit()
    {
        $this->logInWithPermission('another-user');
        $document = $this->objFromFixture('DMSDocument', 'doc-only-these-users');
        $gridField = $this->getGridFieldFromDocument($document);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    }

    /**
     * Ensure that the related documents list does not include the current document itself
     */
    public function testGetRelatedDocumentsForAutocompleter()
    {
        $document = $this->objFromFixture('DMSDocument', 'd1');
        $gridField = $this->getGridFieldFromDocument($document);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertInstanceOf('GridField', $gridField);


        $config = $gridField->getConfig();

        $autocompleter = $config->getComponentByType('GridFieldAddExistingAutocompleter');
        $autocompleter->setResultsFormat('$Filename');

        $jsonResult = $autocompleter->doSearch(
            $gridField,
            new SS_HTTPRequest('GET', '/', array('gridfield_relationsearch' => 'test'))
        );

        $this->assertNotContains('test-file-file-doesnt-exist-1', $jsonResult);
        $this->assertContains('test-file-file-doesnt-exist-2', $jsonResult);
        $this->assertEquals(array('Title:PartialMatch', 'Filename:PartialMatch'), $autocompleter->getSearchFields());

    }

    /**
     * @return GridField
     */
    protected function getGridFieldFromDocument(DMSDocument $document)
    {
        $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;
            }
        }
        return $gridField;
    }

    /**
     * Ensure that HTML is returned containing list items with action panel steps
     */
    public function testGetActionTaskHtml()
    {
        $document = $this->objFromFixture('DMSDocument', 'd1');
        $document->addActionPanelTask('example', 'Example');

        $result = $document->getActionTaskHtml();

        $this->assertContains('<label class="left">Actions</label>', $result);
        $this->assertContains('<li class="ss-ui-button dmsdocument-action" data-panel="', $result);
        $this->assertContains('permission', $result);
        $this->assertContains('Example', $result);

        // Test remove with array
        $document->removeActionPanelTask('example')->removeActionPanelTask('embargo');
        // Test remove with string
        $document->removeActionPanelTask('find-usage');
        $result = $document->getActionTaskHtml();

        $this->assertNotContains('Example', $result);
        $this->assertNotContains('embargo', $result);
        $this->assertNotContains('find-usage', $result);
    }

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

        $this->assertInstanceOf('CompositeField', $result);

        $this->assertNotNull($result->getChildren()->fieldByName('CanViewType'));

        $this->assertNotNull($result->getChildren()->fieldByName('ViewerGroups'));

    }

    /**
     * Test view permissions
     */
    public function testCanView()
    {
        /** @var DMSDocument $document */
        $document = $this->objFromFixture('DMSDocument', 'doc-logged-in-users');
        $this->logoutMember();
        // 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()
    {
        $this->logoutMember();

        /** @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));

    }

    /**
     * Tests delete permissions
     */
    public function testCanDelete()

    {
        $this->logoutMember();
        $document1 = $this->objFromFixture('DMSDocument', 'doc-logged-in-users');

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


        // Test editors can delete
        $contentAuthor = $this->objFromFixture('Member', 'editor');
        $this->assertTrue($document1->canDelete($contentAuthor));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Tests create permission
     */
    public function testCanCreate()

    {
        $this->logoutMember();
        $document1 = $this->objFromFixture('DMSDocument', 'doc-logged-in-users');
        $this->logInWithPermission('CMS_ACCESS_DMSDocumentAdmin');
        // Test CMS access can create
        $this->assertTrue($document1->canCreate());


        $this->logoutMember();

        // Test editors can create
        $contentAuthor = $this->objFromFixture('Member', 'editor');
        $this->assertTrue($document1->canCreate($contentAuthor));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Logs out any active member
     */
    protected function logoutMember()
    {
        if ($member = Member::currentUser()) {
            $member->logOut();
        }
    }

    /**
     * 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());

    }

    /**
     * Ensure that all pages that a document belongs to (via many document sets) can be retrieved in one list
     */
    public function testGetRelatedPages()
    {
        $document = $this->objFromFixture('DMSDocument', 'd1');
        $result = $document->getRelatedPages();
        $this->assertCount(3, $result, 'Document 1 is related to 3 Pages');

        $this->assertSame(array('s1', 's2', 's3'), $result->column('URLSegment'));

    }

    /**
     * Test that the title is returned if it is set, otherwise the filename without ID
     */
    public function testGetTitleOrFilenameWithoutId()
    {
        $d1 = $this->objFromFixture('DMSDocument', 'd1');
        $this->assertSame('test-file-file-doesnt-exist-1', $d1->getTitle());


        $d2 = $this->objFromFixture('DMSDocument', 'd2');
        $this->assertSame('File That Doesn\'t Exist (Title)', $d2->getTitle());

    }

    /**
     * Ensure that the folder a document's file is stored in can be retrieved, and that delete() will also delete
     * the file and the record
     */
    public function testGetStorageFolderThenDelete()
    {
        Config::inst()->update('DMS', 'folder_name', 'assets/_unit-tests');

        $document = DMS::inst()->storeDocument('dms/tests/DMS-test-lorum-file.pdf');
        $filename = $document->getStorageFolder() . '/' . $document->getFilename();

        $this->assertTrue(file_exists($filename));

        $document->delete();
        $this->assertFalse($document->exists());

        $this->assertFalse(file_exists($filename));


        DMSFilesystemTestHelper::delete('assets/_unit-tests');
    }

    /**
     * Test that the link contains an ID and URL slug
     */
    public function testGetLink()
    {
        Config::inst()->update('DMS', 'folder_name', 'assets/_unit-tests');

        $document = DMS::inst()->storeDocument('dms/tests/DMS-test-lorum-file.pdf');

        $expected = '/dmsdocument/' . $document->ID . '-dms-test-lorum-file-pdf';
        $this->assertSame($expected, $document->Link());

        $this->assertSame($expected, $document->getLink());

    }

    /**
     * Ensure that the description can be returned in HTML format
     */
    public function testGetDescriptionWithLineBreak()
    {
        $document = DMSDocument::create();
        $document->Description = "Line 1\nLine 2\nLine 3";
        $document->write();

        $this->assertSame("Line 1<br />\nLine 2<br />\nLine 3", $document->getDescriptionWithLineBreak());

    }
}


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		public function testDefaultDownloadBehabiourCMSFields()
7		{
8		$document = singleton('DMSDocument');
9		Config::inst()->update('DMSDocument', 'default_download_behaviour', 'open');
10		$cmsFields = $document->getCMSFields();
11		$this->assertEquals('open', $cmsFields->dataFieldByName('DownloadBehavior')->Value());
		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...
12
13
14		Config::inst()->update('DMSDocument', 'default_download_behaviour', 'download');
15		$cmsFields = $document->getCMSFields();
16		$this->assertEquals('download', $cmsFields->dataFieldByName('DownloadBehavior')->Value());
		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...
17		}
18
19		/**
20		* Ensure that related documents can be retrieved for a given DMS document
21		*/
22		public function testRelatedDocuments()
23		{
24		$document = $this->objFromFixture('DMSDocument', 'document_with_relations');
25		$this->assertGreaterThan(0, $document->RelatedDocuments()->count());
		0 ignored issues – show Bug introduced 2017-05-02 00:42 UTC by Report Bug Copy Issue Report The method `assertGreaterThan()` 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...
26		$this->assertEquals(
		0 ignored issues – show Bug introduced 2017-05-02 00:42 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...
27		array('test-file-file-doesnt-exist-1', 'test-file-file-doesnt-exist-2'),
28		$document->getRelatedDocuments()->column('Filename')
29		);
30		}
31
32		/**
33		* Test the extensibility of getRelatedDocuments
34		*/
35	View Code Duplication	public function testGetRelatedDocumentsIsExtensible()

silverstripe / silverstripe-dms

Pull Request — master (#168)

DMSDocumentTest::testDocumentHasNoCMSFieldsForManagingRelatedDocumentsIfCantEdit() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like