SubsiteAdminFunctionalTest::getAndFollowAll() - Code Metrics - Inspection of "Merge pull request #326 from creative-commoners/pu..." - silverstripe/silverstripe-subsites - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0ebf95...33622c )

by Damian

created 2017-12-05 19:55 UTC

SubsiteAdminFunctionalTest::getAndFollowAll() A

↳ Parent: SubsiteAdminFunctionalTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
c	0
b	0
f	0
nc	2
nop	1
dl	0
loc	9
rs	9.6666

<?php

namespace SilverStripe\Subsites\Tests;

use Page;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\CMS\Controllers\CMSPageEditController;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Subsites\Model\Subsite;

class SubsiteAdminFunctionalTest extends FunctionalTest
{
    protected static $fixture_file = 'SubsiteTest.yml';
    protected static $use_draft_site = true;

    protected $autoFollowRedirection = false;

    /**
     * Helper: FunctionalTest is only able to follow redirection once, we want to go all the way.
     * @param string $url
     * @return \SilverStripe\Control\HTTPResponse
     */
    public function getAndFollowAll($url)
    {
        $response = $this->get($url);
        while ($location = $response->getHeader('Location')) {

            $response = $this->mainSession->followRedirection();
        }
        echo $response->getHeader('Location');

        return $response;
    }

    /**
     * Anonymous user cannot access anything.
     */
    public function testAnonymousIsForbiddenAdminAccess()
    {
        $this->logOut();

        $response = $this->getAndFollowAll('admin/pages/?SubsiteID=0');

        $this->assertContains('Security/login', $this->mainSession->lastUrl(), 'Admin is disallowed');

        $subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');
        $response = $this->getAndFollowAll("admin/pages/?SubsiteID={$subsite1->ID}");
        $this->assertContains('Security/login', $this->mainSession->lastUrl(), 'Admin is disallowed');

        $response = $this->getAndFollowAll('admin/subsite_xhr');
        $this->assertContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is disallowed');
    }

    /**
     * Admin should be able to access all subsites and the main site
     */
    public function testAdminCanAccessAllSubsites()

    {
        $this->logInAs('admin');

        $this->getAndFollowAll('admin/pages/?SubsiteID=0');
        $this->assertEquals(0, $this->session()->get('SubsiteID'), 'Can access main site.');
        $this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');

        $subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');
        $this->getAndFollowAll("admin/pages/?SubsiteID={$subsite1->ID}");

        // Check the session manually, since the state is unique to the request, not this test
        $this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Can access other subsite.');
        $this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');

        $response = $this->getAndFollowAll('admin/subsite_xhr');

        $this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is reachable');
    }

    public function testAdminIsRedirectedToObjectsSubsite()
    {
        $this->logInAs('admin');

        $mainSubsitePage = $this->objFromFixture(Page::class, 'mainSubsitePage');
        $subsite1Home = $this->objFromFixture(Page::class, 'subsite1_home');

        // Requesting a page from another subsite will redirect to that subsite
        Config::modify()->set(CMSPageEditController::class, 'treats_subsite_0_as_global', false);
        $response = $this->get("admin/pages/edit/show/$subsite1Home->ID");

        $this->assertEquals(302, $response->getStatusCode());
        $this->assertContains(
            'admin/pages/edit/show/' . $subsite1Home->ID . '?SubsiteID=' . $subsite1Home->SubsiteID,
            $response->getHeader('Location')
        );

        // Loading a non-main-site object still switches the subsite if configured with treats_subsite_0_as_global
        Config::modify()->set(CMSPageEditController::class, 'treats_subsite_0_as_global', true);

        $response = $this->get("admin/pages/edit/show/$subsite1Home->ID");
        $this->assertEquals(302, $response->getStatusCode());
        $this->assertContains(
            'admin/pages/edit/show/' . $subsite1Home->ID . '?SubsiteID=' . $subsite1Home->SubsiteID,
            $response->getHeader('Location')
        );

        // Loading a main-site object does not change the subsite if configured with treats_subsite_0_as_global
        $response = $this->get("admin/pages/edit/show/$mainSubsitePage->ID");
        $this->assertEquals(200, $response->getStatusCode());
    }

    /**
     * User which has AccessAllSubsites set to 1 should be able to access all subsites and main site,
     * even though he does not have the ADMIN permission.
     */
    public function testEditorCanAccessAllSubsites()

    {
        $this->logInAs('editor');

        $this->get('admin/pages/?SubsiteID=0');
        $this->assertEquals(0, $this->session()->get('SubsiteID'), 'Can access main site.');
        $this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');

        $subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');
        $this->get("admin/pages/?SubsiteID={$subsite1->ID}");
        $this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Can access other subsite.');
        $this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');

        $response = $this->get('admin/subsite_xhr');

        $this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is reachable');
    }

    /**
     * Test a member who only has access to one subsite (subsite1) and only some sections (pages and security).
     */
    public function testSubsiteAdmin()
    {
        $this->markTestSkipped('wip');
        $this->logInAs('subsite1member');

        $subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');

        // Check allowed URL.
        $this->getAndFollowAll("admin/pages/?SubsiteID={$subsite1->ID}");
        $this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Can access own subsite.');
        $this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Can access permitted section.');

        // Check forbidden section in allowed subsite.
        $this->getAndFollowAll("admin/assets/?SubsiteID={$subsite1->ID}");
        $this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Is redirected within subsite.');
        $this->assertNotContains(
            'admin/assets',
            $this->mainSession->lastUrl(),
            'Is redirected away from forbidden section'
        );

        // Check forbidden site, on a section that's allowed on another subsite
        $this->getAndFollowAll('admin/pages/?SubsiteID=0');
        $this->assertEquals(
            $this->session()->get('SubsiteID'),
            $subsite1->ID,
            'Is redirected to permitted subsite.'
        );

        // Check forbidden site, on a section that's not allowed on any other subsite
        $this->getAndFollowAll('admin/assets/?SubsiteID=0');
        $this->assertEquals(
            $this->session()->get('SubsiteID'),
            $subsite1->ID,
            'Is redirected to first permitted subsite.'
        );
        $this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'Is not denied access');

        // Check the standalone XHR controller.
        $response = $this->getAndFollowAll('admin/subsite_xhr');

        $this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is reachable');
    }
}


1		<?php
2
3		namespace SilverStripe\Subsites\Tests;
4
5		use Page;
		0 ignored issues – show Bug introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The type `Page` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6		use SilverStripe\CMS\Controllers\CMSPageEditController;
7		use SilverStripe\Core\Config\Config;
8		use SilverStripe\Dev\FunctionalTest;
9		use SilverStripe\Subsites\Model\Subsite;
10
11		class SubsiteAdminFunctionalTest extends FunctionalTest
12		{
13		protected static $fixture_file = 'SubsiteTest.yml';
14		protected static $use_draft_site = true;
15
16		protected $autoFollowRedirection = false;
17
18		/**
19		* Helper: FunctionalTest is only able to follow redirection once, we want to go all the way.
20		* @param string $url
21		* @return \SilverStripe\Control\HTTPResponse
22		*/
23		public function getAndFollowAll($url)
24		{
25		$response = $this->get($url);
26		while ($location = $response->getHeader('Location')) {
		0 ignored issues – show Unused Code introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The assignment to `$location` is dead and can be removed. Loading history...
27		$response = $this->mainSession->followRedirection();
28		}
29		echo $response->getHeader('Location');
30
31		return $response;
32		}
33
34		/**
35		* Anonymous user cannot access anything.
36		*/
37		public function testAnonymousIsForbiddenAdminAccess()
38		{
39		$this->logOut();
40
41		$response = $this->getAndFollowAll('admin/pages/?SubsiteID=0');
		0 ignored issues – show Unused Code introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The assignment to `$response` is dead and can be removed. Loading history...
42		$this->assertContains('Security/login', $this->mainSession->lastUrl(), 'Admin is disallowed');
43
44		$subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');
45		$response = $this->getAndFollowAll("admin/pages/?SubsiteID={$subsite1->ID}");
46		$this->assertContains('Security/login', $this->mainSession->lastUrl(), 'Admin is disallowed');
47
48		$response = $this->getAndFollowAll('admin/subsite_xhr');
49		$this->assertContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is disallowed');
50		}
51
52		/**
53		* Admin should be able to access all subsites and the main site
54		*/
55	View Code Duplication	public function testAdminCanAccessAllSubsites()
		0 ignored issues – show Duplication introduced 2017-08-29 05:09 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...
56		{
57		$this->logInAs('admin');
58
59		$this->getAndFollowAll('admin/pages/?SubsiteID=0');
60		$this->assertEquals(0, $this->session()->get('SubsiteID'), 'Can access main site.');
61		$this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');
62
63		$subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');
64		$this->getAndFollowAll("admin/pages/?SubsiteID={$subsite1->ID}");
65
66		// Check the session manually, since the state is unique to the request, not this test
67		$this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Can access other subsite.');
68		$this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');
69
70		$response = $this->getAndFollowAll('admin/subsite_xhr');
		0 ignored issues – show Unused Code introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The assignment to `$response` is dead and can be removed. Loading history...
71		$this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is reachable');
72		}
73
74		public function testAdminIsRedirectedToObjectsSubsite()
75		{
76		$this->logInAs('admin');
77
78		$mainSubsitePage = $this->objFromFixture(Page::class, 'mainSubsitePage');
79		$subsite1Home = $this->objFromFixture(Page::class, 'subsite1_home');
80
81		// Requesting a page from another subsite will redirect to that subsite
82		Config::modify()->set(CMSPageEditController::class, 'treats_subsite_0_as_global', false);
83		$response = $this->get("admin/pages/edit/show/$subsite1Home->ID");
84
85		$this->assertEquals(302, $response->getStatusCode());
86		$this->assertContains(
87		'admin/pages/edit/show/' . $subsite1Home->ID . '?SubsiteID=' . $subsite1Home->SubsiteID,
88		$response->getHeader('Location')
89		);
90
91		// Loading a non-main-site object still switches the subsite if configured with treats_subsite_0_as_global
92		Config::modify()->set(CMSPageEditController::class, 'treats_subsite_0_as_global', true);
93
94		$response = $this->get("admin/pages/edit/show/$subsite1Home->ID");
95		$this->assertEquals(302, $response->getStatusCode());
96		$this->assertContains(
97		'admin/pages/edit/show/' . $subsite1Home->ID . '?SubsiteID=' . $subsite1Home->SubsiteID,
98		$response->getHeader('Location')
99		);
100
101		// Loading a main-site object does not change the subsite if configured with treats_subsite_0_as_global
102		$response = $this->get("admin/pages/edit/show/$mainSubsitePage->ID");
103		$this->assertEquals(200, $response->getStatusCode());
104		}
105
106		/**
107		* User which has AccessAllSubsites set to 1 should be able to access all subsites and main site,
108		* even though he does not have the ADMIN permission.
109		*/
110	View Code Duplication	public function testEditorCanAccessAllSubsites()
		0 ignored issues – show Duplication introduced 2017-08-29 05:09 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...
111		{
112		$this->logInAs('editor');
113
114		$this->get('admin/pages/?SubsiteID=0');
115		$this->assertEquals(0, $this->session()->get('SubsiteID'), 'Can access main site.');
116		$this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');
117
118		$subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');
119		$this->get("admin/pages/?SubsiteID={$subsite1->ID}");
120		$this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Can access other subsite.');
121		$this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Lands on the correct section');
122
123		$response = $this->get('admin/subsite_xhr');
		0 ignored issues – show Unused Code introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The assignment to `$response` is dead and can be removed. Loading history...
124		$this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is reachable');
125		}
126
127		/**
128		* Test a member who only has access to one subsite (subsite1) and only some sections (pages and security).
129		*/
130		public function testSubsiteAdmin()
131		{
132		$this->markTestSkipped('wip');
133		$this->logInAs('subsite1member');
134
135		$subsite1 = $this->objFromFixture(Subsite::class, 'subsite1');
136
137		// Check allowed URL.
138		$this->getAndFollowAll("admin/pages/?SubsiteID={$subsite1->ID}");
139		$this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Can access own subsite.');
140		$this->assertContains('admin/pages', $this->mainSession->lastUrl(), 'Can access permitted section.');
141
142		// Check forbidden section in allowed subsite.
143		$this->getAndFollowAll("admin/assets/?SubsiteID={$subsite1->ID}");
144		$this->assertEquals($subsite1->ID, $this->session()->get('SubsiteID'), 'Is redirected within subsite.');
145		$this->assertNotContains(
146		'admin/assets',
147		$this->mainSession->lastUrl(),
148		'Is redirected away from forbidden section'
149		);
150
151		// Check forbidden site, on a section that's allowed on another subsite
152		$this->getAndFollowAll('admin/pages/?SubsiteID=0');
153		$this->assertEquals(
154		$this->session()->get('SubsiteID'),
155		$subsite1->ID,
156		'Is redirected to permitted subsite.'
157		);
158
159		// Check forbidden site, on a section that's not allowed on any other subsite
160		$this->getAndFollowAll('admin/assets/?SubsiteID=0');
161		$this->assertEquals(
162		$this->session()->get('SubsiteID'),
163		$subsite1->ID,
164		'Is redirected to first permitted subsite.'
165		);
166		$this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'Is not denied access');
167
168		// Check the standalone XHR controller.
169		$response = $this->getAndFollowAll('admin/subsite_xhr');
		0 ignored issues – show Unused Code introduced 2017-12-04 02:38 UTC by Report Bug Copy Issue Report The assignment to `$response` is dead and can be removed. Loading history...
170		$this->assertNotContains('Security/login', $this->mainSession->lastUrl(), 'SubsiteXHRController is reachable');
171		}
172		}
173

silverstripe / silverstripe-subsites

Push — master ( 0ebf95...33622c )

SubsiteAdminFunctionalTest::getAndFollowAll() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like