Completed
Pull Request — master (#99)
by Simon
02:33
created

testAnnotatePermissionChecker()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 4

Duplication

Lines 6
Ratio 100 %

Importance

Changes 0
Metric Value
cc 1
eloc 4
nc 1
nop 0
dl 6
loc 6
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
namespace SilverLeague\IDEAnnotator\Tests;
4
5
use SilverStripe\Core\Injector\Injector;
6
use SilverStripe\Core\Config\Config;
7
use SilverStripe\Dev\SapphireTest;
8
use SilverLeague\IDEAnnotator\DataObjectAnnotator;
9
use SilverStripe\Assets\File;
10
use SilverStripe\ORM\DataObject;
11
use SilverLeague\IDEAnnotator\AnnotatePermissionChecker;
12
use SilverStripe\Control\Director;
13
14
/**
15
 * Class DataObjectAnnotatorTest
16
 *
17
 * @mixin \PHPUnit_Framework_TestCase
18
 */
19
class AnnotatePermissionCheckerTest extends SapphireTest
20
{
21
22
    /**
23
     * @var AnnotatePermissionChecker $permissionChecker
24
     */
25
    private $permissionChecker = null;
26
27
    /**
28
     * @var MockDataObjectAnnotator
1 ignored issue
show
Bug introduced by
The type SilverLeague\IDEAnnotato...MockDataObjectAnnotator 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...
29
     */
30
    private $annotator;
31
32
33
    /**
34
     * Setup Defaults
35
     */
36
    protected function setUp()
37
    {
38
        parent::setUp();
39
        Config::modify()->set(Director::class, 'environment_type', 'dev');
40
        Config::modify()->set(DataObjectAnnotator::class, 'enabled', true);
41
        Config::modify()->set(DataObjectAnnotator::class, 'enabled_modules', ['ideannotator', 'mysite']);
42
43
        Config::modify()->merge(Team::class, 'extensions', [Team_Extension::class]);
2 ignored issues
show
Bug introduced by
The type SilverLeague\IDEAnnotator\Tests\Team_Extension 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...
Bug introduced by
The type SilverLeague\IDEAnnotator\Tests\Team 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...
44
45
        $this->annotator = Injector::inst()->get(MockDataObjectAnnotator::class);
46
        $this->permissionChecker = Injector::inst()->get(AnnotatePermissionChecker::class);
47
    }
48
49 View Code Duplication
    public function testIsEnabled()
0 ignored issues
show
Duplication introduced by
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...
50
    {
51
        $this->assertTrue($this->permissionChecker->isEnabled());
52
53
        Config::inst()->remove(DataObjectAnnotator::class, 'enabled');
0 ignored issues
show
Bug introduced by
The method remove() does not exist on SilverStripe\Config\Coll...nfigCollectionInterface. It seems like you code against a sub-type of SilverStripe\Config\Coll...nfigCollectionInterface such as SilverStripe\Config\Coll...nfigCollectionInterface. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

53
        Config::inst()->/** @scrutinizer ignore-call */ remove(DataObjectAnnotator::class, 'enabled');
Loading history...
54
        Config::modify()->set(DataObjectAnnotator::class, 'enabled', false);
55
        $this->assertFalse($this->permissionChecker->isEnabled());
56
    }
57
58 View Code Duplication
    public function testAnnotatePermissionChecker()
0 ignored issues
show
Duplication introduced by
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...
59
    {
60
        Config::modify()->set(DataObjectAnnotator::class, 'enabled', false);
61
        $this->assertFalse($this->permissionChecker->environmentIsAllowed());
62
        Config::modify()->set(DataObjectAnnotator::class, 'enabled', true);
63
        $this->assertTrue($this->permissionChecker->environmentIsAllowed());
64
    }
65
66
    /**
67
     * Test is a module name is in the @Config enabled_modules
68
     * and will be seen as allowed or disallowed correctly
69
     */
70
    public function testModuleIsAllowed()
71
    {
72
        $this->assertFalse($this->permissionChecker->moduleIsAllowed('framework'));
73
        $this->assertTrue($this->permissionChecker->moduleIsAllowed('mysite'));
74
        $this->assertTrue($this->permissionChecker->moduleIsAllowed('ideannotator'));
75
    }
76
77
    /**
78
     * Test if a DataObject is in an allowed module name
79
     * and will be seen as allowed or disallowed correctly
80
     */
81
    public function testDataObjectIsAllowed()
82
    {
83
        $this->assertTrue($this->permissionChecker->classNameIsAllowed(Team::class));
84
        $this->assertTrue($this->permissionChecker->classNameIsAllowed(Team_Extension::class));
85
86
        $this->assertFalse($this->permissionChecker->classNameIsAllowed(DataObject::class));
87
        $this->assertFalse($this->permissionChecker->classNameIsAllowed(File::class));
88
89
        Config::inst()->remove(DataObjectAnnotator::class, 'enabled_modules');
90
        Config::modify()->set(DataObjectAnnotator::class, 'enabled_modules', array('mysite'));
91
92
        $this->assertFalse($this->permissionChecker->classNameIsAllowed(Team::class));
93
    }
94
    public function tearDown()
95
    {
96
        parent::tearDown();
97
    }
98
}
99