src/Object/Tests/ArticleObjectTest.php
<?php
/**
* apparat-object
*
* @category Apparat
* @package Apparat\Object
* @subpackage Apparat\Object\Tests
* @author Joschi Kuphal <joschi@kuphal.net> / @jkphl
* @copyright Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
* @license http://opensource.org/licenses/MIT The MIT License (MIT)
*/
/***********************************************************************************
* The MIT License (MIT)
*
* Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @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\Model\Object\Article;
use Apparat\Object\Application\Service\TypeService;
use Apparat\Object\Domain\Model\Object\Id;
use Apparat\Object\Domain\Model\Object\Revision;
use Apparat\Object\Domain\Model\Object\Type;
use Apparat\Object\Domain\Model\Properties\MetaProperties;
use Apparat\Object\Domain\Model\Uri\RepositoryLocator;
use Apparat\Object\Ports\Types\Object as ObjectTypes;
/**
* Article object tests
*
* @package Apparat\Object
* @subpackage Apparat\Object\Tests
*/
class ArticleObjectTest extends AbstractObjectTest
{
/**
* Example object locator
*
* @var string
*/
const OBJECT_LOCATOR = '/2015/12/21/1-article/1';
/**
* Example hidden object locator
*
* @var string
*/
const HIDDEN_OBJECT_LOCATOR = '/2016/05/26/6-article/6';
/**
* Default privacy
*
* @var string
*/
protected static $defaultPrivacy;
/**
* Setup
*/
public static function setUpBeforeClass()
{
parent::setUpBeforeClass();
self::$defaultPrivacy = getenv('OBJECT_DEFAULT_PRIVACY');
TypeService::enableType(Type::ARTICLE);
TypeService::enableType(Type::CONTACT);
TypeService::enableType(Type::GEO);
TypeService::enableType(Type::IMAGE);
TypeService::enableType(Type::NOTE);
}
/**
* Tears down the fixture
*/
public function tearDown()
{
putenv('MOCK_FLOCK');
putenv('MOCK_RENAME');
putenv('OBJECT_DEFAULT_PRIVACY='.self::$defaultPrivacy);
parent::tearDown();
}
/**
* Load an article object
*
* @expectedException \Apparat\Object\Domain\Model\Object\OutOfBoundsException
* @expectedExceptionCode 1461619783
*/
public function testLoadArticleObject()
{
$articleObjectLocator = new RepositoryLocator(self::$repository, self::OBJECT_LOCATOR);
$articleObject = self::$repository->loadObject($articleObjectLocator);
$this->assertEquals(
getenv('APPARAT_BASE_URL').rtrim('/'.getenv('REPOSITORY_URL'), '/').self::OBJECT_LOCATOR,
$articleObject->getAbsoluteUrl()
);
$this->assertFalse($articleObject->isDeleted());
$this->assertFalse($articleObject->getRepositoryLocator()->isHidden());
/** @var Revision $invalidRevision */
$invalidRevision = Kernel::create(Revision::class, [99]);
$articleObject->useRevision($invalidRevision);
}
/**
* Load a hidden article object
*/
public function testLoadHiddenArticleObject()
{
$articleObjectLocator = new RepositoryLocator(self::$repository, self::HIDDEN_OBJECT_LOCATOR);
$articleObject = self::$repository->loadObject($articleObjectLocator);
$this->assertTrue($articleObject->isDeleted());
$this->assertTrue($articleObject->getRepositoryLocator()->isHidden());
}
/**
* Load an article object and test its system properties
*/
public function testLoadArticleObjectSystemProperties()
{
$articleObjectLocator = new RepositoryLocator(self::$repository, self::OBJECT_LOCATOR);
$articleObject = self::$repository->loadObject($articleObjectLocator);
$this->assertInstanceOf(Article::class, $articleObject);
$this->assertEquals(new Id(1), $articleObject->getId());
$this->assertEquals(Kernel::create(Type::class, [ObjectTypes::ARTICLE]), $articleObject->getObjectType());
$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".
"\n",
$articleObject->getPayload()
);
}
/**
* Load an article object and test its meta properties
*/
public function testLoadArticleObjectMetaProperties()
{
$articleObjectLocator = new RepositoryLocator(self::$repository, self::OBJECT_LOCATOR);
$articleObject = self::$repository->loadObject($articleObjectLocator);
$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()
{
$articleObjectLocator = new RepositoryLocator(self::$repository, self::OBJECT_LOCATOR);
$articleObject = self::$repository->loadObject($articleObjectLocator);
$this->assertEquals('/system/url', $articleObject->getDomain('uid'));
$this->assertEquals('value', $articleObject->getDomain('group:single'));
$articleObject->getDomain('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()
{
$articleObjectLocator = new RepositoryLocator(self::$repository, self::OBJECT_LOCATOR);
$articleObject = self::$repository->loadObject($articleObjectLocator);
$articleObject->getDomain('');
}
/**
* 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()
{
putenv('OBJECT_DEFAULT_PRIVACY=public');
// 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->getRepositoryLocator()
->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 an 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 = $this->createRepository($tempRepoDirectory);
// Create a new article in the temporary repository
return $fileRepository->createObject(ObjectTypes::ARTICLE, $payload, [], $creationDate);
}
/**
* 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->getRepositoryLocator()->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 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;
}
}