CodeIgniter4/tests/system/CommonSingleServiceTest.php at develop · bowatts/CodeIgniter4 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter;

use CodeIgniter\Autoloader\FileLocator;
use CodeIgniter\Config\Services;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\Mock\MockSecurity;
use Config\App;
use ReflectionClass;
use ReflectionMethod;

/**
 * @internal
 *
 * @group Others
 */
final class CommonSingleServiceTest extends CIUnitTestCase
{
    /**
     * @dataProvider serviceNamesProvider
     */
    public function testSingleServiceWithNoParamsSupplied(string $service): void
    {
        Services::injectMock('security', new MockSecurity(new App()));

        $service1 = single_service($service);
        $service2 = single_service($service);

        assert($service1 !== null);

        $this->assertInstanceOf(get_class($service1), $service2);
        $this->assertNotSame($service1, $service2);
    }

    /**
     * @dataProvider serviceNamesProvider
     */
    public function testSingleServiceWithAtLeastOneParamSupplied(string $service): void
    {
        if ($service === 'commands') {
            $locator = $this->getMockBuilder(FileLocator::class)
                ->setConstructorArgs([Services::autoloader()])
                ->onlyMethods(['listFiles'])
                ->getMock();

            // `Commands::discoverCommand()` is an expensive operation
            $locator->method('listFiles')->with('Commands/')->willReturn([]);
            Services::injectMock('locator', $locator);
        }

        $params = [];
        $method = new ReflectionMethod(Services::class, $service);

        $params[] = $method->getNumberOfParameters() === 1 ? true : $method->getParameters()[0]->getDefaultValue();

        $service1 = single_service($service, ...$params);
        $service2 = single_service($service, ...$params);

        assert($service1 !== null);

        $this->assertInstanceOf(get_class($service1), $service2);
        $this->assertNotSame($service1, $service2);

        if ($service === 'commands') {
            $this->resetServices();
        }
    }

    public function testSingleServiceWithAllParamsSupplied(): void
    {
        $cache1 = single_service('cache', null, true);
        $cache2 = single_service('cache', null, true);

        assert($cache1 !== null);
        assert($cache2 !== null);

        // Assert that even passing true as last param this will
        // not create a shared instance.
        $this->assertInstanceOf(get_class($cache1), $cache2);
        $this->assertNotSame($cache1, $cache2);
    }

    public function testSingleServiceWithGibberishGiven(): void
    {
        $this->assertNull(single_service('foo'));
        $this->assertNull(single_service('bar'));
        $this->assertNull(single_service('baz'));
        $this->assertNull(single_service('caches'));
        $this->assertNull(single_service('timers'));
    }

    public static function serviceNamesProvider(): iterable
    {
        static $services = [];
        static $excl     = [
            '__callStatic',
            'createRequest',
            'serviceExists',
            'reset',
            'resetSingle',
            'injectMock',
            'encrypter', // Encrypter needs a starter key
            'session', // Headers already sent
        ];

        if ($services === []) {
            $methods = (new ReflectionClass(Services::class))->getMethods(ReflectionMethod::IS_PUBLIC);

            foreach ($methods as $method) {
                $name = $method->getName();

                if (in_array($name, $excl, true)) {
                    continue;
                }

                $services[$name] = [$name];
            }

            ksort($services);
        }

        yield from $services;
    }
}