ObjectTest::testObjectAbsolute() - Code Metrics - Inspection of "Refactored ports & infrastructure" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2ca34f...a721bd )

by Joschi

created 2016-06-07 18:26 UTC

ObjectTest::testObjectAbsolute() A

↳ Parent: ObjectTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	5
rs	9.4285

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\Infrastructure
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Object\Tests {

    use Apparat\Kernel\Ports\Kernel;
    use Apparat\Object\Application\Factory\ObjectFactory;
    use Apparat\Object\Application\Model\Object\Article;
    use Apparat\Object\Domain\Model\Object\AbstractObject;
    use Apparat\Object\Domain\Model\Object\Id;
    use Apparat\Object\Domain\Model\Object\ResourceInterface;
    use Apparat\Object\Domain\Model\Object\Revision;
    use Apparat\Object\Domain\Model\Object\Type;
    use Apparat\Object\Domain\Model\Path\RepositoryPath;
    use Apparat\Object\Domain\Model\Properties\MetaProperties;
    use Apparat\Object\Domain\Model\Properties\SystemProperties;
    use Apparat\Object\Domain\Repository\Repository;
    use Apparat\Object\Infrastructure\Model\Object\Object;
    use Apparat\Object\Infrastructure\Repository\FileAdapterStrategy;
    use Apparat\Object\Ports\Facades\RepositoryFacade;
    use Apparat\Object\Ports\Types\Object as ObjectTypes;

    /**
     * Object tests
     *
     * @package Apparat\Object
     * @subpackage Apparat\Object\Test
     */
    class ObjectTest extends AbstractRepositoryEnabledTest
    {
        /**
         * Example object path
         *
         * @var string
         */
        const OBJECT_PATH = '/2015/12/21/1-article/1';
        /**
         * Example hidden object path
         *
         * @var string
         */
        const HIDDEN_OBJECT_PATH = '/2016/05/26/6-article/6';

        /**
         * Tears down the fixture
         */
        public function tearDown()
        {
            putenv('MOCK_FLOCK');
            putenv('MOCK_RENAME');
            TestTypeService::removeInvalidType();
            parent::tearDown();
        }

        /**
         * Test undefined object type
         *
         * @expectedException \Apparat\Object\Application\Factory\InvalidArgumentException
         * @expectedExceptionCode 1450905868
         */
        public function testUndefinedObjectType()
        {
            $resource = $this->createMock(ResourceInterface::class);
            $resource->method('getPropertyData')->willReturn([]);
            $repositoryPath = $this->getMockBuilder(RepositoryPath::class)->disableOriginalConstructor()->getMock();

            /** @var ResourceInterface $resource */
            /** @var RepositoryPath $repositoryPath */
            ObjectFactory::createFromResource($repositoryPath, $resource);
        }

        /**
         * Test invalid object type
         *
         * @expectedException \Apparat\Object\Domain\Model\Object\InvalidArgumentException
         * @expectedExceptionCode 1449871242
         */
        public function testInvalidObjectType()
        {
            $resource = $this->createMock(ResourceInterface::class);
            $resource->method('getPropertyData')->willReturn([SystemProperties::COLLECTION => ['type' => 'invalid']]);
            $articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);

            /** @var ResourceInterface $resource */
            ObjectFactory::createFromResource($articleObjectPath, $resource);
        }

        /**
         * Load an article object with an invalid visibility requirement
         *
         * @expectedException \Apparat\Object\Domain\Repository\InvalidArgumentException
         * @expectedExceptionCode 1449999646
         */
        public function testLoadArticleObjectInvalidVisibility()
        {
            $articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
            self::$repository->loadObject($articleObjectPath, 0);
        }

        /**
         * Load an article object
         *
         * @expectedException \Apparat\Object\Domain\Model\Object\OutOfBoundsException
         * @expectedExceptionCode 1461619783
         */
        public function testLoadArticleObject()
        {
            $articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
            $articleObject = self::$repository->loadObject($articleObjectPath);
            $this->assertEquals(
                getenv('APPARAT_BASE_URL').getenv('REPOSITORY_URL').self::OBJECT_PATH,
                $articleObject->getAbsoluteUrl()
            );
            $this->assertFalse($articleObject->isDeleted());
            $this->assertFalse($articleObject->getRepositoryPath()->isHidden());

            /** @var Revision $invalidRevision */
            $invalidRevision = Kernel::create(Revision::class, [99]);
            $articleObject->useRevision($invalidRevision);
        }

        /**
         * Load a hidden article object
         */
        public function testLoadHiddenArticleObject()
        {
            $articleObjectPath = new RepositoryPath(self::$repository, self::HIDDEN_OBJECT_PATH);
            $articleObject = self::$repository->loadObject($articleObjectPath);
            $this->assertTrue($articleObject->isDeleted());
            $this->assertTrue($articleObject->getRepositoryPath()->isHidden());
        }

        /**
         * Load an article object and test its system properties
         */
        public function testLoadArticleObjectSystemProperties()
        {
            $articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
            $articleObject = self::$repository->loadObject($articleObjectPath);
            $this->assertInstanceOf(Article::class, $articleObject);
            $this->assertEquals(new Id(1), $articleObject->getId());
            $this->assertEquals(Kernel::create(Type::class, [ObjectTypes::ARTICLE]), $articleObject->getType());
            $this->assertEquals(new Revision(1), $articleObject->getRevision());
            $this->assertFalse($articleObject->isDraft());
            $this->assertTrue($articleObject->isPublished());
            $this->assertEquals(new \DateTimeImmutable('2015-12-21T22:30:00'), $articleObject->getCreated());
            $this->assertEquals(new \DateTimeImmutable('2015-12-21T22:45:00'), $articleObject->getPublished());
            $this->assertNull($articleObject->getDeleted());
            $this->assertEquals('en', $articleObject->getLanguage());
            $this->assertEquals(
                "# Example article object\n\nThis file is an example for an object of type `\"article\"`. ".
                "It has a link to [Joschi Kuphal's website](https://jkphl.is) and features his avatar:\n".
                "![Joschi Kuphal](https://jkphl.is/avatar.jpg)",
                $articleObject->getPayload()
            );
        }

        /**
         * Load an article object and test its meta properties
         */
        public function testLoadArticleObjectMetaProperties()
        {
            $articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
            $articleObject = self::$repository->loadObject($articleObjectPath);
            $this->assertInstanceOf(Article::class, $articleObject);
            $this->assertEquals('Example article object', $articleObject->getDescription());
            $this->assertEquals(
                'Article objects feature a Markdown payload along with some custom properties',
                $articleObject->getAbstract()
            );
            $this->assertArrayEquals(['apparat', 'object', 'example', 'article'], $articleObject->getKeywords());
            $this->assertArrayEquals(['example', 'text'], $articleObject->getCategories());

            // TODO Replace with contributed-by relations
//            $authorCount = count($articleObject->getAuthors());
//            $articleObject->addAuthor(AuthorFactory::createFromString(AuthorTest::GENERIC_AUTHOR));
//            $this->assertEquals($authorCount + 1, count($articleObject->getAuthors()));
        }

        /**
         * Load an article object and test its domain properties
         *
         * @expectedException \Apparat\Object\Domain\Model\Properties\InvalidArgumentException
         * @expectedExceptionCode 1450818168
         */
        public function testLoadArticleObjectDomainProperties()
        {
            $articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
            $articleObject = self::$repository->loadObject($articleObjectPath);
            $this->assertEquals('/system/url', $articleObject->getDomainProperty('uid'));
            $this->assertEquals('value', $articleObject->getDomainProperty('group:single'));
            $articleObject->getDomainProperty('group:invalid');
        }

        /**
         * Load an article object and test an empty domain property name
         *
         * @expectedException \Apparat\Object\Domain\Model\Properties\InvalidArgumentException
         * @expectedExceptionCode 1450817720
         */
        public function testLoadArticleObjectDomainEmptyProperty()
        {
            $articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
            $articleObject = self::$repository->loadObject($articleObjectPath);
            $articleObject->getDomainProperty('');
        }

        /**
         * Test the object facade with an absolute object URL
         */
        public function testObjectAbsolute()
        {
            $object = Object::load(getenv('APPARAT_BASE_URL').getenv('REPOSITORY_URL').self::OBJECT_PATH);
            $this->assertInstanceOf(Article::class, $object);
        }

        /**
         * Test the object facade with a relative object URL
         */
        public function testObjectRelative()
        {
            $object = Object::load(getenv('REPOSITORY_URL').self::OBJECT_PATH);
            $this->assertInstanceOf(Article::class, $object);
        }

        /**
         * Test the object facade with an invalid relative object URL
         *
         * @expectedException \Apparat\Resource\Ports\InvalidReaderArgumentException
         * @expectedExceptionCode 1447616824
         */
        public function testObjectRelativeInvalid()
        {
            $object = Object::load(getenv('REPOSITORY_URL').'/2015/12/21/2-article/2');
            $this->assertInstanceOf(Article::class, $object);
        }

        /**
         * Test with a missing object type class
         *
         * @expectedException \Apparat\Object\Application\Factory\InvalidArgumentException
         * @expectedExceptionCode 1450824842
         */
        public function testInvalidObjectTypeClass()
        {
            TestTypeService::addInvalidType();

            $resource = $this->createMock(ResourceInterface::class);
            $resource->method('getPropertyData')->willReturn([SystemProperties::COLLECTION => ['type' => 'invalid']]);
            $articleObjectPath = new RepositoryPath(self::$repository, '/2016/02/16/5-invalid/5');

            /** @var ResourceInterface $resource */
            ObjectFactory::createFromResource($articleObjectPath, $resource);
        }

        /**
         * Test instantiation of object with invalid domain properties collection
         *
         * @expectedException \Apparat\Object\Domain\Model\Properties\InvalidArgumentException
         * @expectedExceptionCode 1452288429
         */
        public function testInvalidDomainPropertyCollectionClass()
        {
            $this->getMockBuilder(AbstractObject::class)
                ->setConstructorArgs([new RepositoryPath(self::$repository, self::OBJECT_PATH)])
                ->getMock();
        }

        /**
         * Test the property data
         */
        public function testObjectPropertyData()
        {
//  $frontMarkResource = Resource::frontMark('file://'.__DIR__.DIRECTORY_SEPARATOR.'Fixture'.self::OBJECT_PATH.'.md');
            $object = Object::load(getenv('REPOSITORY_URL').self::OBJECT_PATH);
            $this->assertTrue(is_array($object->getPropertyData()));
//        print_r($frontMarkResource->getData());
//        print_r($object->getPropertyData());
        }

        /**
         * Test mutation by altering metadata
         *
         * @expectedException \Apparat\Object\Domain\Model\Properties\OutOfBoundsException
         * @expectedExceptionCode 1462632083
         */
        public function testMetaDataMutation()
        {
            $object = Object::load(getenv('REPOSITORY_URL').self::OBJECT_PATH);
            $this->assertTrue(is_array($object->getPropertyData()));
            $objectUrl = $object->getAbsoluteUrl();
            $objectRevision = $object->getRevision();
            $object->setTitle($object->getTitle().' (mutated)');
            $object->setSlug($object->getSlug().'-mutated');
            $object->setDescription($object->getDescription().' (mutated)');
            $object->setAbstract($object->getAbstract());
            $object->setLicense(ltrim($object->getLicense().', ', ', ').'MIT');
            $object->setKeywords(array_merge($object->getKeywords(), ['mutated']));
            $object->setCategories($object->getCategories());
            $this->assertEquals(preg_replace('%\/(.?+)$%', '/.$1-2', $objectUrl), $object->getAbsoluteUrl());
            $this->assertEquals($objectRevision->getRevision() + 1, $object->getRevision()->getRevision());
            $this->assertTrue($object->hasBeenModified());
            $this->assertTrue($object->hasBeenMutated());
            $this->assertEquals('MIT', $object->getLicense());
            $this->assertEquals(ObjectTypes::PRIVACY_PRIVATE, $object->getPrivacy());
            $this->assertEquals(ObjectTypes::PRIVACY_PUBLIC,
                $object->setPrivacy(ObjectTypes::PRIVACY_PUBLIC)->getPrivacy());
            $object->setPrivacy('invalid');
        }

        /**
         * Test change by altering relations
         */
        public function testRelationChange()
        {
            // TODO: Implement
        }

        /**
         * Test to persist an earlier revision
         */
        public function testPersistEarlierRevision()
        {
            // TODO
        }

        /**
         * Test the creation and persisting of an article object with failing file lock
         *
         * @expectedException \Apparat\Object\Domain\Repository\RuntimeException
         * @expectedExceptionCode 1461406873
         */
        public function testCreateArticleObjectLockingImpossible()
        {
            putenv('MOCK_FLOCK=1');
            $this->testCreateAndPublishArticleObject();
        }

        /**
         * Test the creation and persisting of an article object
         *
         * @expectedException \Apparat\Object\Domain\Model\Object\RuntimeException
         * @expectedExceptionCode 1462124874
         */
        public function testCreateAndPublishArticleObject()
        {
            // Create a temporary repository & article
            $tempRepoDirectory = sys_get_temp_dir().DIRECTORY_SEPARATOR.'temp-repo';
            $payload = 'Revision 1 draft';
            $creationDate = new \DateTimeImmutable('yesterday');
            $article = $this->createRepositoryAndArticleObject($tempRepoDirectory, $payload, $creationDate);
            $this->assertInstanceOf(Article::class, $article);
            $this->assertEquals(MetaProperties::PRIVACY_PUBLIC, $article->getPrivacy());
            $this->assertEquals($payload, $article->getPayload());
            $this->assertFileExists($tempRepoDirectory.
                str_replace('/', DIRECTORY_SEPARATOR, $article->getRepositoryPath()
                    ->withExtension(getenv('OBJECT_RESOURCE_EXTENSION'))));
            $this->assertEquals($creationDate, $article->getCreated());

            // Alter and persist the object
            $article->setPayload('Revision 1 draft (updated)');
            $article->persist();

            // Publish and persist the first object revision
            $article->setPayload('Revision 1');
            $article->publish();
            $article->persist();

            // Draft a second object revision
            $article->setPayload('Revision 2 draft');
            $article->persist();

            // Publish and persist the second object revision
            $article->publish();
            $article->setPayload('Revision 2');
            $article->persist();

            // Modify and persist a third object draft revision
            $article->setPayload('Revision 3 draft');
            $article->persist();

            // Wait for 2 seconds, modify and re-persist the object
            $now = time();
            sleep(2);
            $article->setPayload('Revision 3 draft (delayed modification)');
            $article->persist();
            $this->assertGreaterThanOrEqual($now + 2, $article->getModified()->format('U'));

            // Iterate through all object revisions
            foreach ($article as $articleRevisionIndex => $articleRevision) {
                $this->assertInstanceOf(Article::class, $articleRevision);
                $this->assertInstanceOf(Revision::class, $articleRevisionIndex);
            }

            // Publish and persist a third object draft revision
            $article->publish()->persist();

            // Delete the object (and all it's revisions)
            $article->delete()->persist();

            // Undelete the object (and all it's revisions)
            $article->undelete()->persist();

            // Use the first revision
            $article->rewind();

            // Delete temporary repository
            $this->deleteRecursive($tempRepoDirectory);

            $article->persist();
        }

        /**
         * Create a temporary repository and article object
         *
         * @param string $tempRepoDirectory Repository directory
         * @param string $payload Article payload
         * @param \DateTimeInterface $creationDate Article creation date
         * @return Article Article object
         */
        protected function createRepositoryAndArticleObject(
            $tempRepoDirectory,
            $payload,
            \DateTimeInterface $creationDate = null
        ) {
            $fileRepository = RepositoryFacade::create(
                getenv('REPOSITORY_URL'),
                [
                    'type' => FileAdapterStrategy::TYPE,
                    'root' => $tempRepoDirectory,
                ]
            );
            $this->assertInstanceOf(Repository::class, $fileRepository);
            $this->assertEquals($fileRepository->getAdapterStrategy()->getRepositorySize(), 0);

            // Create a new article in the temporary repository
            return $fileRepository->createObject(ObjectTypes::ARTICLE, $payload, [], $creationDate);
        }

        /**
         * Recursively register a directory and all nested files and directories for deletion on teardown
         *
         * @param string $directory Directory
         */
        protected function deleteRecursive($directory)
        {
            $this->tmpFiles[] = $directory;
            foreach (scandir($directory) as $item) {
                if (!preg_match('%^\.+$%', $item)) {
                    $path = $directory.DIRECTORY_SEPARATOR.$item;
                    if (is_dir($path)) {
                        $this->deleteRecursive($path);
                        continue;
                    }

                    $this->tmpFiles[] = $path;
                }
            }
        }

        /**
         * Test the creation and persisting of an article object with failing file lock
         *
         * @expectedException \Apparat\Object\Infrastructure\Repository\RuntimeException
         * @expectedExceptionCode 1464269155
         */
        public function testDeleteArticleObjectImpossible()
        {
            putenv('MOCK_RENAME=1');
            $this->tmpFiles[] = $tempRepoDirectory = sys_get_temp_dir().DIRECTORY_SEPARATOR.'temp-repo';
            $article = $this->createRepositoryAndArticleObject($tempRepoDirectory, 'Revision 1 draft');
            $this->deleteRecursive($tempRepoDirectory);
            $article->delete()->persist();
        }

        /**
         * Test the creation and persisting of an article object with failing file lock
         *
         * @expectedException \Apparat\Object\Infrastructure\Repository\RuntimeException
         * @expectedExceptionCode 1464269179
         */
        public function testUndeleteArticleObjectImpossible()
        {
            $this->tmpFiles[] = $tempRepoDirectory = sys_get_temp_dir().DIRECTORY_SEPARATOR.'temp-repo';
            $article = $this->createRepositoryAndArticleObject($tempRepoDirectory, 'Revision 1 draft');
            $article->getRepositoryPath()->getRepository()->deleteObject($article);
            $this->deleteRecursive($tempRepoDirectory);
            putenv('MOCK_RENAME=1');
            $article->undelete()->persist();
        }
    }
}

namespace Apparat\Object\Infrastructure\Repository {

    /**
     * Mocked version of the native flock() function
     *
     * @param resource $handle An open file pointer.
     * @param int $operation Operation is one of the following: LOCK_SH to acquire a shared lock (reader).
     * @param int $wouldblock The optional third argument is set to true if the lock would block (EWOULDBLOCK errno
     *     condition).
     * @return bool True on success or False on failure.
     */
    function flock($handle, $operation, &$wouldblock = null)
    {
        return (getenv('MOCK_FLOCK') != 1) ? \flock($handle, $operation, $wouldblock) : false;
    }

    /**
     * Mocked version of the native rename() function
     *
     * @param string $oldname The old name. The wrapper used in oldname must match the wrapper used in newname.
     * @param @param string $newname The new name.
     * @return bool true on success or false on failure.
     */
    function rename($oldname, $newname)
    {
        return (getenv('MOCK_RENAME') != 1) ? \rename($oldname, $newname) : false;
    }
}


1			<?php
2
3			/**
4			* apparat-object
5			*
6			* @category Apparat
7			* @package Apparat\Object
8			* @subpackage Apparat\Object\Infrastructure
9			* @author Joschi Kuphal <[email protected]> / @jkphl
10			* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11			* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12			*/
13
14			/***********************************************************************************
15			* The MIT License (MIT)
16			*
17			* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18			*
19			* Permission is hereby granted, free of charge, to any person obtaining a copy of
20			* this software and associated documentation files (the "Software"), to deal in
21			* the Software without restriction, including without limitation the rights to
22			* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23			* the Software, and to permit persons to whom the Software is furnished to do so,
24			* subject to the following conditions:
25			*
26			* The above copyright notice and this permission notice shall be included in all
27			* copies or substantial portions of the Software.
28			*
29			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31			* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32			* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33			* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34			* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35			***********************************************************************************/
36
37			namespace Apparat\Object\Tests {
38
39			use Apparat\Kernel\Ports\Kernel;
40			use Apparat\Object\Application\Factory\ObjectFactory;
41			use Apparat\Object\Application\Model\Object\Article;
42			use Apparat\Object\Domain\Model\Object\AbstractObject;
43			use Apparat\Object\Domain\Model\Object\Id;
44			use Apparat\Object\Domain\Model\Object\ResourceInterface;
45			use Apparat\Object\Domain\Model\Object\Revision;
46			use Apparat\Object\Domain\Model\Object\Type;
47			use Apparat\Object\Domain\Model\Path\RepositoryPath;
48			use Apparat\Object\Domain\Model\Properties\MetaProperties;
49			use Apparat\Object\Domain\Model\Properties\SystemProperties;
50			use Apparat\Object\Domain\Repository\Repository;
51			use Apparat\Object\Infrastructure\Model\Object\Object;
52			use Apparat\Object\Infrastructure\Repository\FileAdapterStrategy;
53			use Apparat\Object\Ports\Facades\RepositoryFacade;
54			use Apparat\Object\Ports\Types\Object as ObjectTypes;
55
56			/**
57			* Object tests
58			*
59			* @package Apparat\Object
60			* @subpackage Apparat\Object\Test
61			*/
62			class ObjectTest extends AbstractRepositoryEnabledTest
63			{
64			/**
65			* Example object path
66			*
67			* @var string
68			*/
69			const OBJECT_PATH = '/2015/12/21/1-article/1';
70			/**
71			* Example hidden object path
72			*
73			* @var string
74			*/
75			const HIDDEN_OBJECT_PATH = '/2016/05/26/6-article/6';
76
77			/**
78			* Tears down the fixture
79			*/
80			public function tearDown()
81			{
82			putenv('MOCK_FLOCK');
83			putenv('MOCK_RENAME');
84			TestTypeService::removeInvalidType();
85			parent::tearDown();
86			}
87
88			/**
89			* Test undefined object type
90			*
91			* @expectedException \Apparat\Object\Application\Factory\InvalidArgumentException
92			* @expectedExceptionCode 1450905868
93			*/
94			public function testUndefinedObjectType()
95			{
96			$resource = $this->createMock(ResourceInterface::class);
97			$resource->method('getPropertyData')->willReturn([]);
98			$repositoryPath = $this->getMockBuilder(RepositoryPath::class)->disableOriginalConstructor()->getMock();
99
100			/** @var ResourceInterface $resource */
101			/** @var RepositoryPath $repositoryPath */
102			ObjectFactory::createFromResource($repositoryPath, $resource);
103			}
104
105			/**
106			* Test invalid object type
107			*
108			* @expectedException \Apparat\Object\Domain\Model\Object\InvalidArgumentException
109			* @expectedExceptionCode 1449871242
110			*/
111			public function testInvalidObjectType()
112			{
113			$resource = $this->createMock(ResourceInterface::class);
114			$resource->method('getPropertyData')->willReturn([SystemProperties::COLLECTION => ['type' => 'invalid']]);
115			$articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
116
117			/** @var ResourceInterface $resource */
118			ObjectFactory::createFromResource($articleObjectPath, $resource);
119			}
120
121			/**
122			* Load an article object with an invalid visibility requirement
123			*
124			* @expectedException \Apparat\Object\Domain\Repository\InvalidArgumentException
125			* @expectedExceptionCode 1449999646
126			*/
127			public function testLoadArticleObjectInvalidVisibility()
128			{
129			$articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
130			self::$repository->loadObject($articleObjectPath, 0);
131			}
132
133			/**
134			* Load an article object
135			*
136			* @expectedException \Apparat\Object\Domain\Model\Object\OutOfBoundsException
137			* @expectedExceptionCode 1461619783
138			*/
139			public function testLoadArticleObject()
140			{
141			$articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
142			$articleObject = self::$repository->loadObject($articleObjectPath);
143			$this->assertEquals(
144			getenv('APPARAT_BASE_URL').getenv('REPOSITORY_URL').self::OBJECT_PATH,
145			$articleObject->getAbsoluteUrl()
146			);
147			$this->assertFalse($articleObject->isDeleted());
148			$this->assertFalse($articleObject->getRepositoryPath()->isHidden());
149
150			/** @var Revision $invalidRevision */
151			$invalidRevision = Kernel::create(Revision::class, [99]);
152			$articleObject->useRevision($invalidRevision);
153			}
154
155			/**
156			* Load a hidden article object
157			*/
158			public function testLoadHiddenArticleObject()
159			{
160			$articleObjectPath = new RepositoryPath(self::$repository, self::HIDDEN_OBJECT_PATH);
161			$articleObject = self::$repository->loadObject($articleObjectPath);
162			$this->assertTrue($articleObject->isDeleted());
163			$this->assertTrue($articleObject->getRepositoryPath()->isHidden());
164			}
165
166			/**
167			* Load an article object and test its system properties
168			*/
169			public function testLoadArticleObjectSystemProperties()
170			{
171			$articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
172			$articleObject = self::$repository->loadObject($articleObjectPath);
173			$this->assertInstanceOf(Article::class, $articleObject);
174			$this->assertEquals(new Id(1), $articleObject->getId());
175			$this->assertEquals(Kernel::create(Type::class, [ObjectTypes::ARTICLE]), $articleObject->getType());
176			$this->assertEquals(new Revision(1), $articleObject->getRevision());
177			$this->assertFalse($articleObject->isDraft());
178			$this->assertTrue($articleObject->isPublished());
179			$this->assertEquals(new \DateTimeImmutable('2015-12-21T22:30:00'), $articleObject->getCreated());
180			$this->assertEquals(new \DateTimeImmutable('2015-12-21T22:45:00'), $articleObject->getPublished());
181			$this->assertNull($articleObject->getDeleted());
182			$this->assertEquals('en', $articleObject->getLanguage());
183			$this->assertEquals(
184			"# Example article object\n\nThis file is an example for an object of type `\"article\"`. ".
185			"It has a link to [Joschi Kuphal's website](https://jkphl.is) and features his avatar:\n".
186			"![Joschi Kuphal](https://jkphl.is/avatar.jpg)",
187			$articleObject->getPayload()
188			);
189			}
190
191			/**
192			* Load an article object and test its meta properties
193			*/
194			public function testLoadArticleObjectMetaProperties()
195			{
196			$articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
197			$articleObject = self::$repository->loadObject($articleObjectPath);
198			$this->assertInstanceOf(Article::class, $articleObject);
199			$this->assertEquals('Example article object', $articleObject->getDescription());
200			$this->assertEquals(
201			'Article objects feature a Markdown payload along with some custom properties',
202			$articleObject->getAbstract()
203			);
204			$this->assertArrayEquals(['apparat', 'object', 'example', 'article'], $articleObject->getKeywords());
205			$this->assertArrayEquals(['example', 'text'], $articleObject->getCategories());
206
207			// TODO Replace with contributed-by relations
208			// $authorCount = count($articleObject->getAuthors());
209			// $articleObject->addAuthor(AuthorFactory::createFromString(AuthorTest::GENERIC_AUTHOR));
210			// $this->assertEquals($authorCount + 1, count($articleObject->getAuthors()));
211			}
212
213			/**
214			* Load an article object and test its domain properties
215			*
216			* @expectedException \Apparat\Object\Domain\Model\Properties\InvalidArgumentException
217			* @expectedExceptionCode 1450818168
218			*/
219			public function testLoadArticleObjectDomainProperties()
220			{
221			$articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
222			$articleObject = self::$repository->loadObject($articleObjectPath);
223			$this->assertEquals('/system/url', $articleObject->getDomainProperty('uid'));
224			$this->assertEquals('value', $articleObject->getDomainProperty('group:single'));
225			$articleObject->getDomainProperty('group:invalid');
226			}
227
228			/**
229			* Load an article object and test an empty domain property name
230			*
231			* @expectedException \Apparat\Object\Domain\Model\Properties\InvalidArgumentException
232			* @expectedExceptionCode 1450817720
233			*/
234			public function testLoadArticleObjectDomainEmptyProperty()
235			{
236			$articleObjectPath = new RepositoryPath(self::$repository, self::OBJECT_PATH);
237			$articleObject = self::$repository->loadObject($articleObjectPath);
238			$articleObject->getDomainProperty('');
239			}
240
241			/**
242			* Test the object facade with an absolute object URL
243			*/
244			public function testObjectAbsolute()
245			{
246			$object = Object::load(getenv('APPARAT_BASE_URL').getenv('REPOSITORY_URL').self::OBJECT_PATH);
247			$this->assertInstanceOf(Article::class, $object);
248			}
249
250			/**
251			* Test the object facade with a relative object URL
252			*/
253			public function testObjectRelative()
254			{
255			$object = Object::load(getenv('REPOSITORY_URL').self::OBJECT_PATH);
256			$this->assertInstanceOf(Article::class, $object);
257			}
258
259			/**
260			* Test the object facade with an invalid relative object URL
261			*
262			* @expectedException \Apparat\Resource\Ports\InvalidReaderArgumentException
263			* @expectedExceptionCode 1447616824
264			*/
265			public function testObjectRelativeInvalid()
266			{
267			$object = Object::load(getenv('REPOSITORY_URL').'/2015/12/21/2-article/2');
268			$this->assertInstanceOf(Article::class, $object);
269			}
270
271			/**
272			* Test with a missing object type class
273			*
274			* @expectedException \Apparat\Object\Application\Factory\InvalidArgumentException
275			* @expectedExceptionCode 1450824842
276			*/
277			public function testInvalidObjectTypeClass()
278			{
279			TestTypeService::addInvalidType();
280
281			$resource = $this->createMock(ResourceInterface::class);
282			$resource->method('getPropertyData')->willReturn([SystemProperties::COLLECTION => ['type' => 'invalid']]);
283			$articleObjectPath = new RepositoryPath(self::$repository, '/2016/02/16/5-invalid/5');
284
285			/** @var ResourceInterface $resource */
286			ObjectFactory::createFromResource($articleObjectPath, $resource);
287			}
288
289			/**
290			* Test instantiation of object with invalid domain properties collection
291			*
292			* @expectedException \Apparat\Object\Domain\Model\Properties\InvalidArgumentException
293			* @expectedExceptionCode 1452288429
294			*/
295			public function testInvalidDomainPropertyCollectionClass()
296			{
297			$this->getMockBuilder(AbstractObject::class)
298			->setConstructorArgs([new RepositoryPath(self::$repository, self::OBJECT_PATH)])
299			->getMock();
300			}
301
302			/**
303			* Test the property data
304			*/
305			public function testObjectPropertyData()
306			{
307			// $frontMarkResource = Resource::frontMark('file://'.__DIR__.DIRECTORY_SEPARATOR.'Fixture'.self::OBJECT_PATH.'.md');
308			$object = Object::load(getenv('REPOSITORY_URL').self::OBJECT_PATH);
309			$this->assertTrue(is_array($object->getPropertyData()));
310			// print_r($frontMarkResource->getData());
311			// print_r($object->getPropertyData());
312			}
313
314			/**
315			* Test mutation by altering metadata
316			*
317			* @expectedException \Apparat\Object\Domain\Model\Properties\OutOfBoundsException
318			* @expectedExceptionCode 1462632083
319			*/
320			public function testMetaDataMutation()
321			{
322			$object = Object::load(getenv('REPOSITORY_URL').self::OBJECT_PATH);
323			$this->assertTrue(is_array($object->getPropertyData()));
324			$objectUrl = $object->getAbsoluteUrl();
325			$objectRevision = $object->getRevision();
326			$object->setTitle($object->getTitle().' (mutated)');
327			$object->setSlug($object->getSlug().'-mutated');
328			$object->setDescription($object->getDescription().' (mutated)');
329			$object->setAbstract($object->getAbstract());
330			$object->setLicense(ltrim($object->getLicense().', ', ', ').'MIT');
331			$object->setKeywords(array_merge($object->getKeywords(), ['mutated']));
332			$object->setCategories($object->getCategories());
333			$this->assertEquals(preg_replace('%\/(.?+)$%', '/.$1-2', $objectUrl), $object->getAbsoluteUrl());
334			$this->assertEquals($objectRevision->getRevision() + 1, $object->getRevision()->getRevision());
335			$this->assertTrue($object->hasBeenModified());
336			$this->assertTrue($object->hasBeenMutated());
337			$this->assertEquals('MIT', $object->getLicense());
338			$this->assertEquals(ObjectTypes::PRIVACY_PRIVATE, $object->getPrivacy());
339			$this->assertEquals(ObjectTypes::PRIVACY_PUBLIC,
340			$object->setPrivacy(ObjectTypes::PRIVACY_PUBLIC)->getPrivacy());
341			$object->setPrivacy('invalid');
342			}
343
344			/**
345			* Test change by altering relations
346			*/
347			public function testRelationChange()
348			{
349			// TODO: Implement
350			}
351
352			/**
353			* Test to persist an earlier revision
354			*/
355			public function testPersistEarlierRevision()
356			{
357			// TODO
358			}
359
360			/**
361			* Test the creation and persisting of an article object with failing file lock
362			*
363			* @expectedException \Apparat\Object\Domain\Repository\RuntimeException
364			* @expectedExceptionCode 1461406873
365			*/
366			public function testCreateArticleObjectLockingImpossible()
367			{
368			putenv('MOCK_FLOCK=1');
369			$this->testCreateAndPublishArticleObject();
370			}
371
372			/**
373			* Test the creation and persisting of an article object
374			*
375			* @expectedException \Apparat\Object\Domain\Model\Object\RuntimeException
376			* @expectedExceptionCode 1462124874
377			*/
378			public function testCreateAndPublishArticleObject()
379			{
380			// Create a temporary repository & article
381			$tempRepoDirectory = sys_get_temp_dir().DIRECTORY_SEPARATOR.'temp-repo';
382			$payload = 'Revision 1 draft';
383			$creationDate = new \DateTimeImmutable('yesterday');
384			$article = $this->createRepositoryAndArticleObject($tempRepoDirectory, $payload, $creationDate);
385			$this->assertInstanceOf(Article::class, $article);
386			$this->assertEquals(MetaProperties::PRIVACY_PUBLIC, $article->getPrivacy());
387			$this->assertEquals($payload, $article->getPayload());
388			$this->assertFileExists($tempRepoDirectory.
389			str_replace('/', DIRECTORY_SEPARATOR, $article->getRepositoryPath()
390			->withExtension(getenv('OBJECT_RESOURCE_EXTENSION'))));
391			$this->assertEquals($creationDate, $article->getCreated());
392
393			// Alter and persist the object
394			$article->setPayload('Revision 1 draft (updated)');
395			$article->persist();
396
397			// Publish and persist the first object revision
398			$article->setPayload('Revision 1');
399			$article->publish();
400			$article->persist();
401
402			// Draft a second object revision
403			$article->setPayload('Revision 2 draft');
404			$article->persist();
405
406			// Publish and persist the second object revision
407			$article->publish();
408			$article->setPayload('Revision 2');
409			$article->persist();
410
411			// Modify and persist a third object draft revision
412			$article->setPayload('Revision 3 draft');
413			$article->persist();
414
415			// Wait for 2 seconds, modify and re-persist the object
416			$now = time();
417			sleep(2);
418			$article->setPayload('Revision 3 draft (delayed modification)');
419			$article->persist();
420			$this->assertGreaterThanOrEqual($now + 2, $article->getModified()->format('U'));
421
422			// Iterate through all object revisions
423			foreach ($article as $articleRevisionIndex => $articleRevision) {
424			$this->assertInstanceOf(Article::class, $articleRevision);
425			$this->assertInstanceOf(Revision::class, $articleRevisionIndex);
426			}
427
428			// Publish and persist a third object draft revision
429			$article->publish()->persist();
430
431			// Delete the object (and all it's revisions)
432			$article->delete()->persist();
433
434			// Undelete the object (and all it's revisions)
435			$article->undelete()->persist();
436
437			// Use the first revision
438			$article->rewind();
439
440			// Delete temporary repository
441			$this->deleteRecursive($tempRepoDirectory);
442
443			$article->persist();
444			}
445
446			/**
447			* Create a temporary repository and article object
448			*
449			* @param string $tempRepoDirectory Repository directory
450			* @param string $payload Article payload
451			* @param \DateTimeInterface $creationDate Article creation date
452			* @return Article Article object
453			*/
454			protected function createRepositoryAndArticleObject(
455			$tempRepoDirectory,
456			$payload,
457			\DateTimeInterface $creationDate = null
458			) {
459			$fileRepository = RepositoryFacade::create(
460			getenv('REPOSITORY_URL'),
461			[
462			'type' => FileAdapterStrategy::TYPE,
463			'root' => $tempRepoDirectory,
464			]
465			);
466			$this->assertInstanceOf(Repository::class, $fileRepository);
467			$this->assertEquals($fileRepository->getAdapterStrategy()->getRepositorySize(), 0);
468
469			// Create a new article in the temporary repository
470			return $fileRepository->createObject(ObjectTypes::ARTICLE, $payload, [], $creationDate);
471			}
472
473			/**
474			* Recursively register a directory and all nested files and directories for deletion on teardown
475			*
476			* @param string $directory Directory
477			*/
478			protected function deleteRecursive($directory)
479			{
480			$this->tmpFiles[] = $directory;
481			foreach (scandir($directory) as $item) {
482			if (!preg_match('%^\.+$%', $item)) {
483			$path = $directory.DIRECTORY_SEPARATOR.$item;
484			if (is_dir($path)) {
485			$this->deleteRecursive($path);
486			continue;
487			}
488
489			$this->tmpFiles[] = $path;
490			}
491			}
492			}
493
494			/**
495			* Test the creation and persisting of an article object with failing file lock
496			*
497			* @expectedException \Apparat\Object\Infrastructure\Repository\RuntimeException
498			* @expectedExceptionCode 1464269155
499			*/
500			public function testDeleteArticleObjectImpossible()
501			{
502			putenv('MOCK_RENAME=1');
503			$this->tmpFiles[] = $tempRepoDirectory = sys_get_temp_dir().DIRECTORY_SEPARATOR.'temp-repo';
504			$article = $this->createRepositoryAndArticleObject($tempRepoDirectory, 'Revision 1 draft');
505			$this->deleteRecursive($tempRepoDirectory);
506			$article->delete()->persist();
507			}
508
509			/**
510			* Test the creation and persisting of an article object with failing file lock
511			*
512			* @expectedException \Apparat\Object\Infrastructure\Repository\RuntimeException
513			* @expectedExceptionCode 1464269179
514			*/
515			public function testUndeleteArticleObjectImpossible()
516			{
517			$this->tmpFiles[] = $tempRepoDirectory = sys_get_temp_dir().DIRECTORY_SEPARATOR.'temp-repo';
518			$article = $this->createRepositoryAndArticleObject($tempRepoDirectory, 'Revision 1 draft');
519			$article->getRepositoryPath()->getRepository()->deleteObject($article);
520			$this->deleteRecursive($tempRepoDirectory);
521			putenv('MOCK_RENAME=1');
522			$article->undelete()->persist();
523			}
524			}
525			}
526
527			namespace Apparat\Object\Infrastructure\Repository {
528
529			/**
530			* Mocked version of the native flock() function
531			*
532			* @param resource $handle An open file pointer.
533			* @param int $operation Operation is one of the following: LOCK_SH to acquire a shared lock (reader).
534			* @param int $wouldblock The optional third argument is set to true if the lock would block (EWOULDBLOCK errno
535			* condition).
536			* @return bool True on success or False on failure.
537			*/
538			function flock($handle, $operation, &$wouldblock = null)
539			{
540			return (getenv('MOCK_FLOCK') != 1) ? \flock($handle, $operation, $wouldblock) : false;
541			}
542
543			/**
544			* Mocked version of the native rename() function
545			*
546			* @param string $oldname The old name. The wrapper used in oldname must match the wrapper used in newname.
547			* @param @param string $newname The new name.
548			* @return bool true on success or false on failure.
549			*/
550			function rename($oldname, $newname)
551			{
552			return (getenv('MOCK_RENAME') != 1) ? \rename($oldname, $newname) : false;
553			}
554			}
555

apparat / object

Push — master ( 2ca34f...a721bd )

ObjectTest::testObjectAbsolute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like