MultiDomainTest - Code Metrics - silverstripe/multi-domain - Measure and Improve Code Quality continuously with Scrutinizer

MultiDomainTest A
last analyzed 2019-06-18 02:00 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

Metric	Value
wmc	9
lcom	0
cbo	2
dl	0
loc	95
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	setUp()	17	1
A	testGetDomain()	5	1
A	testGetAllDomains()	9	2
A	getAllDomainsProvider()	7	1
A	testGetPrimaryDomain()	6	1
A	testDomainForUrl()	6	1
A	testDomainForUrlDefaultsToPrimaryDomain()	4	1
A	tearDown()	5	1

<?php

namespace SilverStripe\MultiDomain\Tests;

use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\MultiDomain\MultiDomain;
use SilverStripe\MultiDomain\MultiDomainDomain;

class MultiDomainTest extends SapphireTest
{
    /**
     * Set up some test domain configuration
     *
     * {@inheritDoc}
     */
    public function setUp()
    {
        parent::setUp();
        Config::nest();

        Config::inst()->remove(MultiDomain::class, 'domains');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        Config::inst()->update(MultiDomain::class, 'domains', array(
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            'primary' => array(
                'hostname' => 'foo.bar',
                'resolves_to' => 'bar.baz'
            ),
            'secondary' => array(
                'hostname' => 'localhost',
                'resolves_to' => 'local.dev'
            )
        ));
    }

    /**
     * Test that a MultiDomainDomain can be returned from the configured domains
     */
    public function testGetDomain()
    {
        $this->assertNull(MultiDomain::get_domain('does-not-exist'));
        $this->assertInstanceOf(MultiDomainDomain::class, MultiDomain::get_domain('primary'));
    }

    /**
     * Test that all domains can be returned, with or without the primary domain
     *
     * @dataProvider getAllDomainsProvider
     * @param bool $withPrimary
     */
    public function testGetAllDomains($withPrimary)
    {
        $result = MultiDomain::get_all_domains($withPrimary);
        $this->assertInternalType('array', $result);
        $this->assertNotEmpty($result);

        $expectedCount = $withPrimary ? 2 : 1;
        $this->assertCount($expectedCount, $result);
    }

    /**
     * @return array[]
     */
    public function getAllDomainsProvider()
    {
        return array(
            array(true),
            array(false)
        );
    }

    /**
     * Test that the primary domain can be returned
     */
    public function testGetPrimaryDomain()
    {
        $result = MultiDomain::get_primary_domain();
        $this->assertInstanceOf(MultiDomainDomain::class, $result);
        $this->assertTrue($result->isPrimary());
    }

    /**
     * Test that the correct domain can be returned by a provided URL
     */
    public function testDomainForUrl()
    {
        $result = MultiDomain::domain_for_url('foo.bar/my-page');
        $this->assertInstanceOf(MultiDomainDomain::class, $result);
        $this->assertSame('primary', $result->getKey());
    }

    /**
     * Test that if a URL doesn't match any domain then the primary domain is returned
     */
    public function testDomainForUrlDefaultsToPrimaryDomain()
    {
        $this->assertTrue(MultiDomain::domain_for_url('does-not-exist.com')->isPrimary());
    }

    public function tearDown()
    {
        Config::unnest();
        parent::tearDown();
    }
}


1			<?php
2
3			namespace SilverStripe\MultiDomain\Tests;
4
5			use SilverStripe\Core\Config\Config;
6			use SilverStripe\Dev\SapphireTest;
7			use SilverStripe\MultiDomain\MultiDomain;
8			use SilverStripe\MultiDomain\MultiDomainDomain;
9
10			class MultiDomainTest extends SapphireTest
11			{
12			/**
13			* Set up some test domain configuration
14			*
15			* {@inheritDoc}
16			*/
17			public function setUp()
18			{
19			parent::setUp();
20			Config::nest();
21
22			Config::inst()->remove(MultiDomain::class, 'domains');
			0 ignored issues – show Bug introduced 2019-06-18 02:00 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SilverStripe\Config\Coll...nfigCollectionInterface` as the method `remove()` does only exist in the following implementations of said interface: `SilverStripe\Config\Coll...s\DeltaConfigCollection`, `SilverStripe\Config\Coll...\MemoryConfigCollection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
23			Config::inst()->update(MultiDomain::class, 'domains', array(
			0 ignored issues – show Bug introduced 2019-06-18 02:00 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SilverStripe\Config\Coll...nfigCollectionInterface` as the method `update()` does only exist in the following implementations of said interface: `SilverStripe\Config\Coll...s\DeltaConfigCollection`, `SilverStripe\Config\Coll...\MemoryConfigCollection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
24			'primary' => array(
25			'hostname' => 'foo.bar',
26			'resolves_to' => 'bar.baz'
27			),
28			'secondary' => array(
29			'hostname' => 'localhost',
30			'resolves_to' => 'local.dev'
31			)
32			));
33			}
34
35			/**
36			* Test that a MultiDomainDomain can be returned from the configured domains
37			*/
38			public function testGetDomain()
39			{
40			$this->assertNull(MultiDomain::get_domain('does-not-exist'));
41			$this->assertInstanceOf(MultiDomainDomain::class, MultiDomain::get_domain('primary'));
42			}
43
44			/**
45			* Test that all domains can be returned, with or without the primary domain
46			*
47			* @dataProvider getAllDomainsProvider
48			* @param bool $withPrimary
49			*/
50			public function testGetAllDomains($withPrimary)
51			{
52			$result = MultiDomain::get_all_domains($withPrimary);
53			$this->assertInternalType('array', $result);
54			$this->assertNotEmpty($result);
55
56			$expectedCount = $withPrimary ? 2 : 1;
57			$this->assertCount($expectedCount, $result);
58			}
59
60			/**
61			* @return array[]
62			*/
63			public function getAllDomainsProvider()
64			{
65			return array(
66			array(true),
67			array(false)
68			);
69			}
70
71			/**
72			* Test that the primary domain can be returned
73			*/
74			public function testGetPrimaryDomain()
75			{
76			$result = MultiDomain::get_primary_domain();
77			$this->assertInstanceOf(MultiDomainDomain::class, $result);
78			$this->assertTrue($result->isPrimary());
79			}
80
81			/**
82			* Test that the correct domain can be returned by a provided URL
83			*/
84			public function testDomainForUrl()
85			{
86			$result = MultiDomain::domain_for_url('foo.bar/my-page');
87			$this->assertInstanceOf(MultiDomainDomain::class, $result);
88			$this->assertSame('primary', $result->getKey());
89			}
90
91			/**
92			* Test that if a URL doesn't match any domain then the primary domain is returned
93			*/
94			public function testDomainForUrlDefaultsToPrimaryDomain()
95			{
96			$this->assertTrue(MultiDomain::domain_for_url('does-not-exist.com')->isPrimary());
97			}
98
99			public function tearDown()
100			{
101			Config::unnest();
102			parent::tearDown();
103			}
104			}
105

silverstripe / multi-domain

MultiDomainTest A last analyzed 2019-06-18 02:00 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

MultiDomainTest A
last analyzed 2019-06-18 02:00 UTC