Issues in DMSEmbargoTest.php - New Issues - Inspection of "Merge remote-tracking branch 'origin/2.0'" - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f9f56b...97d556 )

by Robbie

created 2017-07-31 10:05 UTC

tests/DMSEmbargoTest.php (2 issues)

Labels

Duplication 2

Severity

Informational 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
class DMSEmbargoTest extends SapphireTest
{
    protected static $fixture_file = 'dmsembargotest.yml';

    public function createFakeHTTPRequest($id)
    {
        $r = new SS_HTTPRequest('GET', 'index/'.$id);
        $r->match('index/$ID');
        return $r;
    }

    public function testBasicEmbargo()
    {
        $oldTestMode = DMSDocument_Controller::$testMode;
        Config::inst()->update('DMS', 'folder_name', 'assets/_unit-test-123');

        $doc = DMS::inst()->storeDocument('dms/tests/DMS-test-lorum-file.pdf');
        $doc->CanViewType = 'LoggedInUsers';
        $docID = $doc->write();

        //fake a request for a document
        $controller = new DMSDocument_Controller();
        DMSDocument_Controller::$testMode = true;
        $result = $controller->index($this->createFakeHTTPRequest($docID));
        $this->assertEquals($doc->getFullPath(), $result, 'Correct underlying file returned (in test mode)');

        $doc->embargoIndefinitely();

        $this->logInWithPermission('ADMIN');
        $result = $controller->index($this->createFakeHTTPRequest($docID));
        $this->assertEquals($doc->getFullPath(), $result, 'Admins can still download embargoed files');

        $this->logInWithPermission('random-user-group');
        $result = $controller->index($this->createFakeHTTPRequest($docID));
        $this->assertNotEquals(
            $doc->getFullPath(),
            $result,
            'File no longer returned (in test mode) when switching to other user group'
        );

        DMSDocument_Controller::$testMode = $oldTestMode;
        DMSFilesystemTestHelper::delete('assets/_unit-test-123');
    }

    public function testEmbargoIndefinitely()
    {
        $doc = new DMSDocument();
        $doc->Filename = "DMS-test-lorum-file.pdf";
        $doc->Folder = "tests";
        $doc->write();

        $doc->embargoIndefinitely();
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $doc->clearEmbargo();
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");
    }

    public function testExpireAtDate()

    {
        $doc = new DMSDocument();
        $doc->Filename = "DMS-test-lorum-file.pdf";
        $doc->Folder = "tests";
        $doc->write();

        $doc->expireAtDate(strtotime('-1 second'));
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertTrue($doc->isExpired(), "Document is expired");

        $expireTime = "2019-04-05 11:43:13";
        $doc->expireAtDate($expireTime);
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        SS_Datetime::set_mock_now($expireTime);
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertTrue($doc->isExpired(), "Document is expired");
        SS_Datetime::clear_mock_now();

        $doc->expireAtDate(strtotime('-1 second'));
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertTrue($doc->isExpired(), "Document is expired");

        $doc->clearExpiry();
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");
    }

    public function testEmbargoUntilDate()

    {
        $doc = new DMSDocument();
        $doc->Filename = "DMS-test-lorum-file.pdf";
        $doc->Folder = "tests";
        $doc->write();

        $doc->embargoUntilDate(strtotime('+1 minute'));
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertTrue($doc->isEmbargoed(), "Document is embargoed");

        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $doc->embargoUntilDate(strtotime('-1 second'));
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $embargoTime = "2019-04-05 11:43:13";
        $doc->embargoUntilDate($embargoTime);
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        SS_Datetime::set_mock_now($embargoTime);
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        SS_Datetime::clear_mock_now();

        $doc->clearEmbargo();
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");
    }

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

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

        $s1->getDocumentSets()->first()->getDocuments()->add($doc);

        $s1->publish('Stage', 'Live');
        $s1->doPublish();
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $doc->embargoUntilPublished();
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $s1->publish('Stage', 'Live');
        $s1->doPublish();
        $doc = DataObject::get_by_id("DMSDocument", $dID);
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $doc->embargoUntilPublished();
        $doc = DataObject::get_by_id("DMSDocument", $dID);
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $doc->embargoIndefinitely();
        $doc = DataObject::get_by_id("DMSDocument", $dID);
        $this->assertTrue($doc->isHidden(), "Document is hidden");
        $this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $s1->publish('Stage', 'Live');
        $s1->doPublish();
        $doc = DataObject::get_by_id("DMSDocument", $dID);
        $this->assertTrue(
            $doc->isHidden(),
            "Document is still hidden because although the untilPublish flag is cleared, the indefinitely flag is there"
        );
        $this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");

        $doc->clearEmbargo();
        $doc = DataObject::get_by_id("DMSDocument", $dID);
        $this->assertFalse($doc->isHidden(), "Document is not hidden");
        $this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
        $this->assertFalse($doc->isExpired(), "Document is not expired");
    }
}


1		<?php
2		class DMSEmbargoTest extends SapphireTest
3		{
4		protected static $fixture_file = 'dmsembargotest.yml';
5
6		public function createFakeHTTPRequest($id)
7		{
8		$r = new SS_HTTPRequest('GET', 'index/'.$id);
9		$r->match('index/$ID');
10		return $r;
11		}
12
13		public function testBasicEmbargo()
14		{
15		$oldTestMode = DMSDocument_Controller::$testMode;
16		Config::inst()->update('DMS', 'folder_name', 'assets/_unit-test-123');
17
18		$doc = DMS::inst()->storeDocument('dms/tests/DMS-test-lorum-file.pdf');
19		$doc->CanViewType = 'LoggedInUsers';
20		$docID = $doc->write();
21
22		//fake a request for a document
23		$controller = new DMSDocument_Controller();
24		DMSDocument_Controller::$testMode = true;
25		$result = $controller->index($this->createFakeHTTPRequest($docID));
26		$this->assertEquals($doc->getFullPath(), $result, 'Correct underlying file returned (in test mode)');
27
28		$doc->embargoIndefinitely();
29
30		$this->logInWithPermission('ADMIN');
31		$result = $controller->index($this->createFakeHTTPRequest($docID));
32		$this->assertEquals($doc->getFullPath(), $result, 'Admins can still download embargoed files');
33
34		$this->logInWithPermission('random-user-group');
35		$result = $controller->index($this->createFakeHTTPRequest($docID));
36		$this->assertNotEquals(
37		$doc->getFullPath(),
38		$result,
39		'File no longer returned (in test mode) when switching to other user group'
40		);
41
42		DMSDocument_Controller::$testMode = $oldTestMode;
43		DMSFilesystemTestHelper::delete('assets/_unit-test-123');
44		}
45
46		public function testEmbargoIndefinitely()
47		{
48		$doc = new DMSDocument();
49		$doc->Filename = "DMS-test-lorum-file.pdf";
50		$doc->Folder = "tests";
51		$doc->write();
52
53		$doc->embargoIndefinitely();
54		$this->assertTrue($doc->isHidden(), "Document is hidden");
55		$this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
56		$this->assertFalse($doc->isExpired(), "Document is not expired");
57
58		$doc->clearEmbargo();
59		$this->assertFalse($doc->isHidden(), "Document is not hidden");
60		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
61		$this->assertFalse($doc->isExpired(), "Document is not expired");
62		}
63
64	View Code Duplication	public function testExpireAtDate()
		0 ignored issues – show Duplication introduced 2017-07-31 10:07 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
65		{
66		$doc = new DMSDocument();
67		$doc->Filename = "DMS-test-lorum-file.pdf";
68		$doc->Folder = "tests";
69		$doc->write();
70
71		$doc->expireAtDate(strtotime('-1 second'));
72		$this->assertTrue($doc->isHidden(), "Document is hidden");
73		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
74		$this->assertTrue($doc->isExpired(), "Document is expired");
75
76		$expireTime = "2019-04-05 11:43:13";
77		$doc->expireAtDate($expireTime);
78		$this->assertFalse($doc->isHidden(), "Document is not hidden");
79		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
80		$this->assertFalse($doc->isExpired(), "Document is not expired");
81
82		SS_Datetime::set_mock_now($expireTime);
83		$this->assertTrue($doc->isHidden(), "Document is hidden");
84		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
85		$this->assertTrue($doc->isExpired(), "Document is expired");
86		SS_Datetime::clear_mock_now();
87
88		$doc->expireAtDate(strtotime('-1 second'));
89		$this->assertTrue($doc->isHidden(), "Document is hidden");
90		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
91		$this->assertTrue($doc->isExpired(), "Document is expired");
92
93		$doc->clearExpiry();
94		$this->assertFalse($doc->isHidden(), "Document is not hidden");
95		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
96		$this->assertFalse($doc->isExpired(), "Document is not expired");
97		}
98
99	View Code Duplication	public function testEmbargoUntilDate()
		0 ignored issues – show Duplication introduced 2017-07-31 10:07 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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...
100		{
101		$doc = new DMSDocument();
102		$doc->Filename = "DMS-test-lorum-file.pdf";
103		$doc->Folder = "tests";
104		$doc->write();
105
106		$doc->embargoUntilDate(strtotime('+1 minute'));
107		$this->assertTrue($doc->isHidden(), "Document is hidden");
108		$this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
109
110		$this->assertFalse($doc->isExpired(), "Document is not expired");
111
112		$doc->embargoUntilDate(strtotime('-1 second'));
113		$this->assertFalse($doc->isHidden(), "Document is not hidden");
114		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
115		$this->assertFalse($doc->isExpired(), "Document is not expired");
116
117		$embargoTime = "2019-04-05 11:43:13";
118		$doc->embargoUntilDate($embargoTime);
119		$this->assertTrue($doc->isHidden(), "Document is hidden");
120		$this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
121		$this->assertFalse($doc->isExpired(), "Document is not expired");
122
123		SS_Datetime::set_mock_now($embargoTime);
124		$this->assertFalse($doc->isHidden(), "Document is not hidden");
125		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
126		$this->assertFalse($doc->isExpired(), "Document is not expired");
127
128		SS_Datetime::clear_mock_now();
129
130		$doc->clearEmbargo();
131		$this->assertFalse($doc->isHidden(), "Document is not hidden");
132		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
133		$this->assertFalse($doc->isExpired(), "Document is not expired");
134		}
135
136		public function testEmbargoUntilPublished()
137		{
138		$s1 = $this->objFromFixture('SiteTree', 's1');
139
140		$doc = new DMSDocument();
141		$doc->Filename = "test file";
142		$doc->Folder = "0";
143		$dID = $doc->write();
144
145		$s1->getDocumentSets()->first()->getDocuments()->add($doc);
146
147		$s1->publish('Stage', 'Live');
148		$s1->doPublish();
149		$this->assertFalse($doc->isHidden(), "Document is not hidden");
150		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
151		$this->assertFalse($doc->isExpired(), "Document is not expired");
152
153		$doc->embargoUntilPublished();
154		$this->assertTrue($doc->isHidden(), "Document is hidden");
155		$this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
156		$this->assertFalse($doc->isExpired(), "Document is not expired");
157
158		$s1->publish('Stage', 'Live');
159		$s1->doPublish();
160		$doc = DataObject::get_by_id("DMSDocument", $dID);
161		$this->assertFalse($doc->isHidden(), "Document is not hidden");
162		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
163		$this->assertFalse($doc->isExpired(), "Document is not expired");
164
165		$doc->embargoUntilPublished();
166		$doc = DataObject::get_by_id("DMSDocument", $dID);
167		$this->assertTrue($doc->isHidden(), "Document is hidden");
168		$this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
169		$this->assertFalse($doc->isExpired(), "Document is not expired");
170
171		$doc->embargoIndefinitely();
172		$doc = DataObject::get_by_id("DMSDocument", $dID);
173		$this->assertTrue($doc->isHidden(), "Document is hidden");
174		$this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
175		$this->assertFalse($doc->isExpired(), "Document is not expired");
176
177		$s1->publish('Stage', 'Live');
178		$s1->doPublish();
179		$doc = DataObject::get_by_id("DMSDocument", $dID);
180		$this->assertTrue(
181		$doc->isHidden(),
182		"Document is still hidden because although the untilPublish flag is cleared, the indefinitely flag is there"
183		);
184		$this->assertTrue($doc->isEmbargoed(), "Document is embargoed");
185		$this->assertFalse($doc->isExpired(), "Document is not expired");
186
187		$doc->clearEmbargo();
188		$doc = DataObject::get_by_id("DMSDocument", $dID);
189		$this->assertFalse($doc->isHidden(), "Document is not hidden");
190		$this->assertFalse($doc->isEmbargoed(), "Document is not embargoed");
191		$this->assertFalse($doc->isExpired(), "Document is not expired");
192		}
193		}
194

silverstripe / silverstripe-dms

Push — master ( f9f56b...97d556 )

tests/DMSEmbargoTest.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like