nextcloud-server/tests/lib/AppFramework/Utility/SimpleContainerTest.php

<?php

/**
 * ownCloud - App Framework
 *
 * @author Bernhard Posselt
 * @copyright 2014 Bernhard Posselt <dev@bernhard-posselt.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace Test\AppFramework\Utility;

use OC\AppFramework\Utility\SimpleContainer;


interface TestInterface {}

class ClassEmptyConstructor implements IInterfaceConstructor {}

class ClassSimpleConstructor implements IInterfaceConstructor {
    public $test;
    public function __construct($test) {
        $this->test = $test;
    }
}

class ClassComplexConstructor {
    public $class;
    public $test;
    public function __construct(ClassSimpleConstructor $class, $test) {
        $this->class = $class;
        $this->test = $test;
    }
}

interface IInterfaceConstructor {}
class ClassInterfaceConstructor {
    public $class;
    public $test;
    public function __construct(IInterfaceConstructor $class, $test) {
        $this->class = $class;
        $this->test = $test;
    }
}


class SimpleContainerTest extends \Test\TestCase {


    private $container;

    public function setUp() {
        $this->container = new SimpleContainer();
    }


    public function testRegister() {
        $this->container->registerParameter('test', 'abc');
        $this->assertEquals('abc', $this->container->query('test'));
    }


    /**
     * @expectedException \OCP\AppFramework\QueryException
     */
    public function testNothingRegistered() {
        $this->container->query('something really hard');
    }


    /**
     * @expectedException \OCP\AppFramework\QueryException
     */
    public function testNotAClass() {
        $this->container->query('Test\AppFramework\Utility\TestInterface');
    }


    public function testNoConstructorClass() {
        $object = $this->container->query('Test\AppFramework\Utility\ClassEmptyConstructor');
        $this->assertTrue($object instanceof ClassEmptyConstructor);
    }


    public function testInstancesOnlyOnce() {
        $object = $this->container->query('Test\AppFramework\Utility\ClassEmptyConstructor');
        $object2 = $this->container->query('Test\AppFramework\Utility\ClassEmptyConstructor');
        $this->assertSame($object, $object2);
    }

    public function testConstructorSimple() {
        $this->container->registerParameter('test', 'abc');
        $object = $this->container->query(
            'Test\AppFramework\Utility\ClassSimpleConstructor'
        );
        $this->assertTrue($object instanceof ClassSimpleConstructor);
        $this->assertEquals('abc', $object->test);
    }


    public function testConstructorComplex() {
        $this->container->registerParameter('test', 'abc');
        $object = $this->container->query(
            'Test\AppFramework\Utility\ClassComplexConstructor'
        );
        $this->assertTrue($object instanceof ClassComplexConstructor);
        $this->assertEquals('abc', $object->class->test);
        $this->assertEquals('abc', $object->test);
    }


    public function testConstructorComplexInterface() {
        $this->container->registerParameter('test', 'abc');
        $this->container->registerService(
        'Test\AppFramework\Utility\IInterfaceConstructor', function ($c) {
            return $c->query('Test\AppFramework\Utility\ClassSimpleConstructor');
        });
        $object = $this->container->query(
            'Test\AppFramework\Utility\ClassInterfaceConstructor'
        );
        $this->assertTrue($object instanceof ClassInterfaceConstructor);
        $this->assertEquals('abc', $object->class->test);
        $this->assertEquals('abc', $object->test);
    }


    public function testOverrideService() {
        $this->container->registerService(
        'Test\AppFramework\Utility\IInterfaceConstructor', function ($c) {
            return $c->query('Test\AppFramework\Utility\ClassSimpleConstructor');
        });
        $this->container->registerService(
        'Test\AppFramework\Utility\IInterfaceConstructor', function ($c) {
            return $c->query('Test\AppFramework\Utility\ClassEmptyConstructor');
        });
        $object = $this->container->query(
            'Test\AppFramework\Utility\IInterfaceConstructor'
        );
        $this->assertTrue($object instanceof ClassEmptyConstructor);
    }

    public function testRegisterAliasParamter() {
        $this->container->registerParameter('test', 'abc');
        $this->container->registerAlias('test1', 'test');
        $this->assertEquals('abc', $this->container->query('test1'));
    }

    public function testRegisterAliasService() {
        $this->container->registerService('test', function() {
            return new \StdClass;
        }, true);
        $this->container->registerAlias('test1', 'test');
        $this->assertSame(
            $this->container->query('test'), $this->container->query('test'));
        $this->assertSame(
            $this->container->query('test1'), $this->container->query('test1'));
        $this->assertSame(
            $this->container->query('test'), $this->container->query('test1'));
    }

    public function sanitizeNameProvider() {
        return [
            ['ABC\\Foo', 'ABC\\Foo'],
            ['\\ABC\\Foo', '\\ABC\\Foo'],
            ['\\ABC\\Foo', 'ABC\\Foo'],
            ['ABC\\Foo', '\\ABC\\Foo'],
        ];
    }

    /**
     * @dataProvider sanitizeNameProvider
     */
    public function testSanitizeName($register, $query) {
        $this->container->registerService($register, function() {
            return 'abc';
        });
        $this->assertEquals('abc', $this->container->query($query));
    }

    /**
     * @expectedException \OCP\AppFramework\QueryException
     */
    public function testConstructorComplexNoTestParameterFound() {
        $object = $this->container->query(
            'Test\AppFramework\Utility\ClassComplexConstructor'
        );
    }

    public function testRegisterFactory() {
        $this->container->registerService('test', function() {
            return new \StdClass();
        }, false);
        $this->assertNotSame(
            $this->container->query('test'), $this->container->query('test'));
    }

    public function testRegisterAliasFactory() {
        $this->container->registerService('test', function() {
            return new \StdClass();
        }, false);
        $this->container->registerAlias('test1', 'test');
        $this->assertNotSame(
            $this->container->query('test'), $this->container->query('test'));
        $this->assertNotSame(
            $this->container->query('test1'), $this->container->query('test1'));
        $this->assertNotSame(
            $this->container->query('test'), $this->container->query('test1'));
    }

}