silverstripe-framework/tests/model/VersionedTest.php

1245 lines
42 KiB
PHP
Raw Normal View History

<?php
use SilverStripe\ORM\DB;
use SilverStripe\ORM\Versioning\Versioned;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\DataExtension;
/**
* @package framework
* @subpackage tests
*/
class VersionedTest extends SapphireTest {
2014-08-15 08:53:05 +02:00
protected static $fixture_file = 'VersionedTest.yml';
protected $extraDataObjects = array(
'VersionedTest_DataObject',
'VersionedTest_Subclass',
'VersionedTest_AnotherSubclass',
'VersionedTest_RelatedWithoutVersion',
'VersionedTest_SingleStage',
'VersionedTest_WithIndexes',
'VersionedTest_PublicStage',
'VersionedTest_PublicViaExtension',
);
2014-08-15 08:53:05 +02:00
protected $requiredExtensions = array(
"VersionedTest_DataObject" => array('SilverStripe\\ORM\\Versioning\\Versioned'),
"VersionedTest_WithIndexes" => array('SilverStripe\\ORM\\Versioning\\Versioned'),
);
public function testUniqueIndexes() {
$tableExpectations = array(
'VersionedTest_WithIndexes' =>
array('value' => true, 'message' => 'Unique indexes are unique in main table'),
'VersionedTest_WithIndexes_versions' =>
array('value' => false, 'message' => 'Unique indexes are no longer unique in _versions table'),
'VersionedTest_WithIndexes_Live' =>
array('value' => true, 'message' => 'Unique indexes are unique in _Live table'),
);
// Test each table's performance
foreach ($tableExpectations as $tableName => $expectation) {
$indexes = DB::get_schema()->indexList($tableName);
2014-08-15 08:53:05 +02:00
// Check for presence of all unique indexes
$indexColumns = array_map(function($index) {
return $index['value'];
}, $indexes);
sort($indexColumns);
$expectedColumns = array('"UniqA"', '"UniqS"');
$this->assertEquals(
array_values($expectedColumns),
array_values(array_intersect($indexColumns, $expectedColumns)),
"$tableName has both indexes");
// Check unique -> non-unique conversion
foreach ($indexes as $indexKey => $indexSpec) {
if (in_array($indexSpec['value'], $expectedColumns)) {
$isUnique = $indexSpec['type'] === 'unique';
$this->assertEquals($isUnique, $expectation['value'], $expectation['message']);
}
}
}
}
public function testDeletingOrphanedVersions() {
$obj = new VersionedTest_Subclass();
$obj->ExtraField = 'Foo'; // ensure that child version table gets written
$obj->write();
2016-04-01 05:27:59 +02:00
$obj->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
2014-08-15 08:53:05 +02:00
$obj->ExtraField = 'Bar'; // ensure that child version table gets written
$obj->write();
2016-04-01 05:27:59 +02:00
$obj->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
2014-08-15 08:53:05 +02:00
$versions = DB::query("SELECT COUNT(*) FROM \"VersionedTest_Subclass_versions\""
. " WHERE \"RecordID\" = '$obj->ID'")->value();
2014-08-15 08:53:05 +02:00
$this->assertGreaterThan(0, $versions, 'At least 1 version exists in the history of the page');
2014-08-15 08:53:05 +02:00
// Force orphaning of all versions created earlier, only on parent record.
// The child versiones table should still have the correct relationship
DB::query("DELETE FROM \"VersionedTest_DataObject_versions\" WHERE \"RecordID\" = $obj->ID");
2014-08-15 08:53:05 +02:00
// insert a record with no primary key (ID)
DB::query("INSERT INTO \"VersionedTest_DataObject_versions\" (\"RecordID\") VALUES ($obj->ID)");
2014-08-15 08:53:05 +02:00
// run the script which should clean that up
$obj->augmentDatabase();
2014-08-15 08:53:05 +02:00
$versions = DB::query("SELECT COUNT(*) FROM \"VersionedTest_Subclass_versions\""
. " WHERE \"RecordID\" = '$obj->ID'")->value();
$this->assertEquals(0, $versions, 'Orphaned versions on child tables are removed');
2014-08-15 08:53:05 +02:00
// test that it doesn't delete records that we need
$obj->write();
2016-04-01 05:27:59 +02:00
$obj->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
2014-08-15 08:53:05 +02:00
$count = DB::query("SELECT COUNT(*) FROM \"VersionedTest_Subclass_versions\""
. " WHERE \"RecordID\" = '$obj->ID'")->value();
$obj->augmentDatabase();
2014-08-15 08:53:05 +02:00
$count2 = DB::query("SELECT COUNT(*) FROM \"VersionedTest_Subclass_versions\""
. " WHERE \"RecordID\" = '$obj->ID'")->value();
2014-08-15 08:53:05 +02:00
$this->assertEquals($count, $count2);
}
2014-08-15 08:53:05 +02:00
/**
* Test that publishing from invalid stage will throw exception
*/
public function testInvalidPublish() {
$obj = new VersionedTest_Subclass();
$obj->ExtraField = 'Foo'; // ensure that child version table gets written
$obj->write();
$this->setExpectedException(
'InvalidArgumentException',
"Can't find VersionedTest_DataObject#{$obj->ID} in stage Live"
);
// Fail publishing from live to stage
2016-04-01 05:27:59 +02:00
$obj->copyVersionToStage(Versioned::LIVE, Versioned::DRAFT);
}
public function testDuplicate() {
$obj1 = new VersionedTest_Subclass();
$obj1->ExtraField = 'Foo';
$obj1->write(); // version 1
2016-04-01 05:27:59 +02:00
$obj1->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$obj1->ExtraField = 'Foo2';
$obj1->write(); // version 2
// Make duplicate
$obj2 = $obj1->duplicate();
// Check records differ
$this->assertNotEquals($obj1->ID, $obj2->ID);
$this->assertEquals(2, $obj1->Version);
$this->assertEquals(1, $obj2->Version);
}
public function testForceChangeUpdatesVersion() {
$obj = new VersionedTest_DataObject();
$obj->Name = "test";
$obj->write();
2014-08-15 08:53:05 +02:00
$oldVersion = $obj->Version;
$obj->forceChange();
$obj->write();
2014-08-15 08:53:05 +02:00
$this->assertTrue(
($obj->Version > $oldVersion),
"A object Version is increased when just calling forceChange() without any other changes"
);
}
/**
* Test Versioned::get_including_deleted()
*/
public function testGetIncludingDeleted() {
// Get all ids of pages
2013-01-11 09:59:33 +01:00
$allPageIDs = DataObject::get(
2014-08-15 08:53:05 +02:00
'VersionedTest_DataObject',
2013-01-11 09:59:33 +01:00
"\"ParentID\" = 0", "\"VersionedTest_DataObject\".\"ID\" ASC"
)->column('ID');
2014-08-15 08:53:05 +02:00
// Modify a page, ensuring that the Version ID and Record ID will differ,
// and then subsequently delete it
$targetPage = $this->objFromFixture('VersionedTest_DataObject', 'page3');
$targetPage->Content = 'To be deleted';
$targetPage->write();
$targetPage->delete();
2014-08-15 08:53:05 +02:00
// Get all items, ignoring deleted
$remainingPages = DataObject::get("VersionedTest_DataObject", "\"ParentID\" = 0",
"\"VersionedTest_DataObject\".\"ID\" ASC");
// Check that page 3 has gone
$this->assertNotNull($remainingPages);
$this->assertEquals(array("Page 1", "Page 2", "Subclass Page 1"), $remainingPages->column('Title'));
2014-08-15 08:53:05 +02:00
// Get all including deleted
$allPages = Versioned::get_including_deleted("VersionedTest_DataObject", "\"ParentID\" = 0",
"\"VersionedTest_DataObject\".\"ID\" ASC");
// Check that page 3 is still there
$this->assertEquals(array("Page 1", "Page 2", "Page 3", "Subclass Page 1"), $allPages->column('Title'));
2014-08-15 08:53:05 +02:00
// Check that the returned pages have the correct IDs
$this->assertEquals($allPageIDs, $allPages->column('ID'));
2014-08-15 08:53:05 +02:00
// Check that this still works if we switch to reading the other stage
Versioned::set_stage(Versioned::LIVE);
$allPages = Versioned::get_including_deleted("VersionedTest_DataObject", "\"ParentID\" = 0",
"\"VersionedTest_DataObject\".\"ID\" ASC");
$this->assertEquals(array("Page 1", "Page 2", "Page 3", "Subclass Page 1"), $allPages->column('Title'));
2014-08-15 08:53:05 +02:00
// Check that the returned pages still have the correct IDs
$this->assertEquals($allPageIDs, $allPages->column('ID'));
}
2014-08-15 08:53:05 +02:00
public function testVersionedFieldsAdded() {
$obj = new VersionedTest_DataObject();
// Check that the Version column is added as a full-fledged column
$this->assertInstanceOf('SilverStripe\\ORM\\FieldType\\DBInt', $obj->dbObject('Version'));
2014-08-15 08:53:05 +02:00
$obj2 = new VersionedTest_Subclass();
// Check that the Version column is added as a full-fledged column
$this->assertInstanceOf('SilverStripe\\ORM\\FieldType\\DBInt', $obj2->dbObject('Version'));
}
public function testVersionedFieldsNotInCMS() {
$obj = new VersionedTest_DataObject();
// the version field in cms causes issues with Versioned::augmentWrite()
$this->assertNull($obj->getCMSFields()->dataFieldByName('Version'));
}
public function testPublishCreateNewVersion() {
$page1 = $this->objFromFixture('VersionedTest_DataObject', 'page1');
$page1->Content = 'orig';
$page1->write();
$firstVersion = $page1->Version;
2016-04-01 05:27:59 +02:00
$page1->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE, false);
$this->assertEquals(
$firstVersion,
$page1->Version,
'publish() with $createNewVersion=FALSE does not create a new version'
);
2014-08-15 08:53:05 +02:00
$page1->Content = 'changed';
$page1->write();
$secondVersion = $page1->Version;
$this->assertTrue($firstVersion < $secondVersion, 'write creates new version');
2016-04-01 05:27:59 +02:00
$page1->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE, true);
$thirdVersion = Versioned::get_latest_version('VersionedTest_DataObject', $page1->ID)->Version;
$liveVersion = Versioned::get_versionnumber_by_stage('VersionedTest_DataObject', 'Live', $page1->ID);
$stageVersion = Versioned::get_versionnumber_by_stage('VersionedTest_DataObject', 'Stage', $page1->ID);
$this->assertTrue(
$secondVersion < $thirdVersion,
'publish() with $createNewVersion=TRUE creates a new version'
);
$this->assertEquals(
$liveVersion,
$thirdVersion,
'publish() with $createNewVersion=TRUE publishes to live'
);
$this->assertEquals(
$stageVersion,
$secondVersion,
'publish() with $createNewVersion=TRUE does not affect stage'
);
}
2014-08-15 08:53:05 +02:00
public function testRollbackTo() {
$page1 = $this->objFromFixture('VersionedTest_AnotherSubclass', 'subclass1');
$page1->Content = 'orig';
$page1->write();
2016-04-01 05:27:59 +02:00
$page1->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$origVersion = $page1->Version;
2014-08-15 08:53:05 +02:00
$page1->Content = 'changed';
$page1->write();
2016-04-01 05:27:59 +02:00
$page1->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$changedVersion = $page1->Version;
$page1->doRollbackTo($origVersion);
$page1 = Versioned::get_one_by_stage('VersionedTest_DataObject', 'Stage', array(
'"VersionedTest_DataObject"."ID" = ?' => $page1->ID
));
2014-08-15 08:53:05 +02:00
$this->assertTrue($page1->Version == $changedVersion + 1, 'Create a new higher version number');
$this->assertEquals('orig', $page1->Content, 'Copies the content from the old version');
// check db entries
$version = DB::prepared_query("SELECT MAX(\"Version\") FROM \"VersionedTest_DataObject_versions\" WHERE \"RecordID\" = ?",
array($page1->ID)
)->value();
$this->assertEquals($page1->Version, $version, 'Correct entry in VersionedTest_DataObject_versions');
$version = DB::prepared_query("SELECT MAX(\"Version\") FROM \"VersionedTest_AnotherSubclass_versions\" WHERE \"RecordID\" = ?",
array($page1->ID)
)->value();
$this->assertEquals($page1->Version, $version, 'Correct entry in VersionedTest_AnotherSubclass_versions');
}
2014-08-15 08:53:05 +02:00
public function testDeleteFromStage() {
$page1 = $this->objFromFixture('VersionedTest_DataObject', 'page1');
$pageID = $page1->ID;
2014-08-15 08:53:05 +02:00
$page1->Content = 'orig';
$page1->write();
2016-04-01 05:27:59 +02:00
$page1->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
2014-08-15 08:53:05 +02:00
$this->assertEquals(1,
DB::query('SELECT COUNT(*) FROM "VersionedTest_DataObject" WHERE "ID" = '.$pageID)->value());
$this->assertEquals(1,
DB::query('SELECT COUNT(*) FROM "VersionedTest_DataObject_Live" WHERE "ID" = '.$pageID)->value());
2014-08-15 08:53:05 +02:00
$page1->deleteFromStage('Live');
2014-08-15 08:53:05 +02:00
// Confirm that deleteFromStage() doesn't manipulate the original record
$this->assertEquals($pageID, $page1->ID);
$this->assertEquals(1,
DB::query('SELECT COUNT(*) FROM "VersionedTest_DataObject" WHERE "ID" = '.$pageID)->value());
$this->assertEquals(0,
DB::query('SELECT COUNT(*) FROM "VersionedTest_DataObject_Live" WHERE "ID" = '.$pageID)->value());
$page1->delete();
$this->assertEquals(0, $page1->ID);
$this->assertEquals(0,
DB::query('SELECT COUNT(*) FROM "VersionedTest_DataObject" WHERE "ID" = '.$pageID)->value());
$this->assertEquals(0,
DB::query('SELECT COUNT(*) FROM "VersionedTest_DataObject_Live" WHERE "ID" = '.$pageID)->value());
}
public function testWritingNewToStage() {
$origReadingMode = Versioned::get_reading_mode();
2014-08-15 08:53:05 +02:00
Versioned::set_stage(Versioned::DRAFT);
$page = new VersionedTest_DataObject();
$page->Title = "testWritingNewToStage";
$page->URLSegment = "testWritingNewToStage";
$page->write();
2014-08-15 08:53:05 +02:00
$live = Versioned::get_by_stage('VersionedTest_DataObject', 'Live', array(
'"VersionedTest_DataObject_Live"."ID"' => $page->ID
));
$this->assertEquals(0, $live->count());
2014-08-15 08:53:05 +02:00
$stage = Versioned::get_by_stage('VersionedTest_DataObject', 'Stage',array(
'"VersionedTest_DataObject"."ID"' => $page->ID
));
$this->assertEquals(1, $stage->count());
$this->assertEquals($stage->First()->Title, 'testWritingNewToStage');
2014-08-15 08:53:05 +02:00
Versioned::set_reading_mode($origReadingMode);
}
/**
2014-08-15 08:53:05 +02:00
* This tests for the situation described in the ticket #5596.
* Writing new Page to live first creates a row in VersionedTest_DataObject table (to get the new ID),
* then "changes it's mind" in Versioned and writes VersionedTest_DataObject_Live. It does not remove
* the VersionedTest_DataObject record though.
2014-08-15 08:53:05 +02:00
*/
public function testWritingNewToLive() {
$origReadingMode = Versioned::get_reading_mode();
2014-08-15 08:53:05 +02:00
Versioned::set_stage(Versioned::LIVE);
$page = new VersionedTest_DataObject();
$page->Title = "testWritingNewToLive";
$page->URLSegment = "testWritingNewToLive";
$page->write();
2014-08-15 08:53:05 +02:00
$live = Versioned::get_by_stage('VersionedTest_DataObject', 'Live',array(
'"VersionedTest_DataObject_Live"."ID"' => $page->ID
));
$this->assertEquals(1, $live->count());
$this->assertEquals($live->First()->Title, 'testWritingNewToLive');
2014-08-15 08:53:05 +02:00
$stage = Versioned::get_by_stage('VersionedTest_DataObject', 'Stage',array(
'"VersionedTest_DataObject"."ID"' => $page->ID
));
$this->assertEquals(0, $stage->count());
2014-08-15 08:53:05 +02:00
Versioned::set_reading_mode($origReadingMode);
}
2014-08-15 08:53:05 +02:00
/**
* Tests DataObject::hasOwnTableDatabaseField
*/
public function testHasOwnTableDatabaseFieldWithVersioned() {
$noversion = new DataObject();
$versioned = new VersionedTest_DataObject();
$versionedSub = new VersionedTest_Subclass();
$versionedAno = new VersionedTest_AnotherSubclass();
$versionField = new VersionedTest_UnversionedWithField();
$this->assertFalse(
(bool) $noversion->hasOwnTableDatabaseField('Version'),
'Plain models have no version field.'
);
$this->assertEquals(
'Int', $versioned->hasOwnTableDatabaseField('Version'),
'The versioned ext adds an Int version field.'
);
$this->assertEquals(
null,
$versionedSub->hasOwnTableDatabaseField('Version'),
'Sub-classes of a versioned model don\'t have a Version field.'
);
$this->assertEquals(
null,
$versionedAno->hasOwnTableDatabaseField('Version'),
'Sub-classes of a versioned model don\'t have a Version field.'
);
$this->assertEquals(
'Varchar', $versionField->hasOwnTableDatabaseField('Version'),
'Models w/o Versioned can have their own Version field.'
);
}
2014-08-15 08:53:05 +02:00
/**
* Test that SQLSelect::queriedTables() applies the version-suffixes properly.
*/
public function testQueriedTables() {
Versioned::set_stage(Versioned::LIVE);
$this->assertEquals(array(
'VersionedTest_DataObject_Live',
'VersionedTest_Subclass_Live',
), DataObject::get('VersionedTest_Subclass')->dataQuery()->query()->queriedTables());
}
2014-08-15 08:53:05 +02:00
/**
* Virtual "sleep" that doesn't actually slow execution, only advances DBDateTime::now()
*
* @param int $minutes
*/
protected function sleep($minutes) {
$now = DBDatetime::now();
$date = DateTime::createFromFormat('Y-m-d H:i:s', $now->getValue());
$date->modify("+{$minutes} minutes");
DBDatetime::set_mock_now($date->format('Y-m-d H:i:s'));
}
/**
* Tests records selected by specific version
*/
public function testGetVersion() {
// Create a few initial versions to ensure this version
// doesn't clash with child versions
$this->sleep(1);
/** @var VersionedTest_DataObject $page2 */
$page2 = $this->objFromFixture('VersionedTest_DataObject', 'page2');
$page2->Title = 'dummy1';
$page2->write();
$this->sleep(1);
$page2->Title = 'dummy2';
$page2->write();
$this->sleep(1);
$page2->Title = 'Page 2 - v1';
$page2->write();
$version1Date = $page2->LastEdited;
$version1 = $page2->Version;
// Create another version where this object and some
// child records have been modified
$this->sleep(1);
/** @var VersionedTest_DataObject $page2a */
$page2a = $this->objFromFixture('VersionedTest_DataObject', 'page2a');
$page2a->Title = 'Page 2a - v2';
$page2a->write();
$this->sleep(1);
$page2->Title = 'Page 2 - v2';
$page2->write();
$version2Date = $page2->LastEdited;
$version2 = $page2->Version;
$this->assertGreaterThan($version1, $version2);
$this->assertDOSEquals(
[
['Title' => 'Page 2a - v2'],
['Title' => 'Page 2b'],
],
$page2->Children()
);
// test selecting v1
/** @var VersionedTest_DataObject $page2v1 */
$page2v1 = Versioned::get_version('VersionedTest_DataObject', $page2->ID, $version1);
$this->assertEquals('Page 2 - v1', $page2v1->Title);
// When selecting v1, related records should by filtered by
// the modified date of that version
$archiveParms = [
'Versioned.mode' => 'archive',
'Versioned.date' => $version1Date
];
$this->assertEquals($archiveParms, $page2v1->getInheritableQueryParams());
$this->assertArraySubset($archiveParms, $page2v1->Children()->getQueryParams());
$this->assertDOSEquals(
[
['Title' => 'Page 2a'],
['Title' => 'Page 2b'],
],
$page2v1->Children()
);
// When selecting v2, we get the same as on stage
/** @var VersionedTest_DataObject $page2v2 */
$page2v2 = Versioned::get_version('VersionedTest_DataObject', $page2->ID, $version2);
$this->assertEquals('Page 2 - v2', $page2v2->Title);
// When selecting v2, related records should by filtered by
// the modified date of that version
$archiveParms = [
'Versioned.mode' => 'archive',
'Versioned.date' => $version2Date
];
$this->assertEquals($archiveParms, $page2v2->getInheritableQueryParams());
$this->assertArraySubset($archiveParms, $page2v2->Children()->getQueryParams());
$this->assertDOSEquals(
[
['Title' => 'Page 2a - v2'],
['Title' => 'Page 2b'],
],
$page2v2->Children()
);
}
public function testGetVersionWhenClassnameChanged() {
$obj = new VersionedTest_DataObject;
$obj->Name = "test";
$obj->write();
$obj->Name = "test2";
$obj->ClassName = "VersionedTest_Subclass";
$obj->write();
$subclassVersion = $obj->Version;
2014-08-15 08:53:05 +02:00
$obj->Name = "test3";
$obj->ClassName = "VersionedTest_DataObject";
$obj->write();
2014-08-15 08:53:05 +02:00
// We should be able to pass the subclass and still get the correct class back
$obj2 = Versioned::get_version("VersionedTest_Subclass", $obj->ID, $subclassVersion);
$this->assertInstanceOf("VersionedTest_Subclass", $obj2);
$this->assertEquals("test2", $obj2->Name);
$obj3 = Versioned::get_latest_version("VersionedTest_Subclass", $obj->ID);
$this->assertEquals("test3", $obj3->Name);
$this->assertInstanceOf("VersionedTest_DataObject", $obj3);
}
2014-08-15 08:53:05 +02:00
public function testArchiveVersion() {
2014-08-15 08:53:05 +02:00
// In 2005 this file was created
DBDatetime::set_mock_now('2005-01-01 00:00:00');
$testPage = new VersionedTest_Subclass();
$testPage->Title = 'Archived page';
$testPage->Content = 'This is the content from 2005';
$testPage->ExtraField = '2005';
$testPage->write();
2014-08-15 08:53:05 +02:00
// In 2007 we updated it
DBDatetime::set_mock_now('2007-01-01 00:00:00');
$testPage->Content = "It's 2007 already!";
$testPage->ExtraField = '2007';
$testPage->write();
2014-08-15 08:53:05 +02:00
// In 2009 we updated it again
DBDatetime::set_mock_now('2009-01-01 00:00:00');
$testPage->Content = "I'm enjoying 2009";
$testPage->ExtraField = '2009';
$testPage->write();
2014-08-15 08:53:05 +02:00
// End mock, back to the present day:)
DBDatetime::clear_mock_now();
2014-08-15 08:53:05 +02:00
// Test 1 - 2006 Content
singleton('VersionedTest_Subclass')->flushCache(true);
Versioned::set_reading_mode('Archive.2006-01-01 00:00:00');
$testPage2006 = DataObject::get('VersionedTest_Subclass')->filter(array('Title' => 'Archived page'))->first();
$this->assertInstanceOf("VersionedTest_Subclass", $testPage2006);
$this->assertEquals("2005", $testPage2006->ExtraField);
$this->assertEquals("This is the content from 2005", $testPage2006->Content);
2014-08-15 08:53:05 +02:00
// Test 2 - 2008 Content
singleton('VersionedTest_Subclass')->flushCache(true);
Versioned::set_reading_mode('Archive.2008-01-01 00:00:00');
$testPage2008 = DataObject::get('VersionedTest_Subclass')->filter(array('Title' => 'Archived page'))->first();
$this->assertInstanceOf("VersionedTest_Subclass", $testPage2008);
$this->assertEquals("2007", $testPage2008->ExtraField);
$this->assertEquals("It's 2007 already!", $testPage2008->Content);
2014-08-15 08:53:05 +02:00
// Test 3 - Today
singleton('VersionedTest_Subclass')->flushCache(true);
Versioned::set_reading_mode('Stage.Stage');
$testPageCurrent = DataObject::get('VersionedTest_Subclass')->filter(array('Title' => 'Archived page'))
->first();
$this->assertInstanceOf("VersionedTest_Subclass", $testPageCurrent);
$this->assertEquals("2009", $testPageCurrent->ExtraField);
$this->assertEquals("I'm enjoying 2009", $testPageCurrent->Content);
}
public function testAllVersions()
{
// In 2005 this file was created
DBDatetime::set_mock_now('2005-01-01 00:00:00');
$testPage = new VersionedTest_Subclass();
$testPage->Title = 'Archived page';
$testPage->Content = 'This is the content from 2005';
$testPage->ExtraField = '2005';
$testPage->write();
2014-08-15 08:53:05 +02:00
// In 2007 we updated it
DBDatetime::set_mock_now('2007-01-01 00:00:00');
$testPage->Content = "It's 2007 already!";
$testPage->ExtraField = '2007';
$testPage->write();
2014-08-15 08:53:05 +02:00
// Check both versions are returned
$versions = Versioned::get_all_versions('VersionedTest_Subclass', $testPage->ID);
$content = array();
$extraFields = array();
foreach($versions as $version)
{
$content[] = $version->Content;
$extraFields[] = $version->ExtraField;
}
2014-08-15 08:53:05 +02:00
$this->assertEquals($versions->Count(), 2, 'All versions returned');
$this->assertEquals($content, array('This is the content from 2005', "It's 2007 already!"),
'Version fields returned');
$this->assertEquals($extraFields, array('2005', '2007'), 'Version fields returned');
2014-08-15 08:53:05 +02:00
// In 2009 we updated it again
DBDatetime::set_mock_now('2009-01-01 00:00:00');
$testPage->Content = "I'm enjoying 2009";
$testPage->ExtraField = '2009';
$testPage->write();
2014-08-15 08:53:05 +02:00
// End mock, back to the present day:)
DBDatetime::clear_mock_now();
2014-08-15 08:53:05 +02:00
$versions = Versioned::get_all_versions('VersionedTest_Subclass', $testPage->ID);
$content = array();
$extraFields = array();
foreach($versions as $version)
{
$content[] = $version->Content;
$extraFields[] = $version->ExtraField;
}
2014-08-15 08:53:05 +02:00
$this->assertEquals($versions->Count(), 3, 'Additional all versions returned');
$this->assertEquals($content,
array('This is the content from 2005', "It's 2007 already!", "I'm enjoying 2009"),
'Additional version fields returned');
$this->assertEquals($extraFields, array('2005', '2007', '2009'), 'Additional version fields returned');
}
public function testArchiveRelatedDataWithoutVersioned() {
DBDatetime::set_mock_now('2009-01-01 00:00:00');
$relatedData = new VersionedTest_RelatedWithoutVersion();
$relatedData->Name = 'Related Data';
$relatedDataId = $relatedData->write();
$testData = new VersionedTest_DataObject();
$testData->Title = 'Test';
$testData->Content = 'Before Content';
$testData->Related()->add($relatedData);
$id = $testData->write();
DBDatetime::set_mock_now('2010-01-01 00:00:00');
$testData->Content = 'After Content';
$testData->write();
Versioned::reading_archived_date('2009-01-01 19:00:00');
$fetchedData = VersionedTest_DataObject::get()->byId($id);
$this->assertEquals('Before Content', $fetchedData->Content, 'We see the correct content of the older version');
$relatedData = VersionedTest_RelatedWithoutVersion::get()->byId($relatedDataId);
$this->assertEquals(
1,
$relatedData->Related()->count(),
'We have a relation, with no version table, querying it still works'
);
}
public function testVersionedWithSingleStage() {
$tables = DB::table_list();
$this->assertContains(
2014-08-15 08:53:05 +02:00
'versionedtest_singlestage',
array_keys($tables),
'Contains base table'
);
$this->assertContains(
2014-08-15 08:53:05 +02:00
'versionedtest_singlestage_versions',
array_keys($tables),
'Contains versions table'
);
$this->assertNotContains(
2014-08-15 08:53:05 +02:00
'versionedtest_singlestage_live',
array_keys($tables),
'Does not contain separate table with _Live suffix'
);
$this->assertNotContains(
2014-08-15 08:53:05 +02:00
'versionedtest_singlestage_stage',
array_keys($tables),
'Does not contain separate table with _Stage suffix'
);
Versioned::set_stage(Versioned::DRAFT);
$obj = new VersionedTest_SingleStage(array('Name' => 'MyObj'));
$obj->write();
$this->assertNotNull(
VersionedTest_SingleStage::get()->byID($obj->ID),
'Writes to and reads from default stage if its set explicitly'
);
2014-08-15 08:53:05 +02:00
Versioned::set_stage(Versioned::LIVE);
$obj = new VersionedTest_SingleStage(array('Name' => 'MyObj'));
$obj->write();
$this->assertNotNull(
VersionedTest_SingleStage::get()->byID($obj->ID),
'Writes to and reads from default stage even if a non-matching stage is set'
);
}
2014-08-15 08:53:05 +02:00
/**
* Test that publishing processes respects lazy loaded fields
*/
public function testLazyLoadFields() {
$originalMode = Versioned::get_reading_mode();
2014-08-15 08:53:05 +02:00
// Generate staging record and retrieve it from stage in live mode
Versioned::set_stage(Versioned::DRAFT);
$obj = new VersionedTest_Subclass();
$obj->Name = 'bob';
$obj->ExtraField = 'Field Value';
$obj->write();
$objID = $obj->ID;
$filter = sprintf('"VersionedTest_DataObject"."ID" = \'%d\'', Convert::raw2sql($objID));
Versioned::set_stage(Versioned::LIVE);
2014-08-15 08:53:05 +02:00
// Check fields are unloaded prior to access
$objLazy = Versioned::get_one_by_stage('VersionedTest_DataObject', 'Stage', $filter, false);
$lazyFields = $objLazy->getQueriedDatabaseFields();
$this->assertTrue(isset($lazyFields['ExtraField_Lazy']));
$this->assertEquals('VersionedTest_Subclass', $lazyFields['ExtraField_Lazy']);
2014-08-15 08:53:05 +02:00
// Check lazy loading works when viewing a Stage object in Live mode
$this->assertEquals('Field Value', $objLazy->ExtraField);
2014-08-15 08:53:05 +02:00
// Test that writeToStage respects lazy loaded fields
$objLazy = Versioned::get_one_by_stage('VersionedTest_DataObject', 'Stage', $filter, false);
$objLazy->writeToStage('Live');
$objLive = Versioned::get_one_by_stage('VersionedTest_DataObject', 'Live', $filter, false);
$liveLazyFields = $objLive->getQueriedDatabaseFields();
2014-08-15 08:53:05 +02:00
// Check fields are unloaded prior to access
$this->assertTrue(isset($liveLazyFields['ExtraField_Lazy']));
$this->assertEquals('VersionedTest_Subclass', $liveLazyFields['ExtraField_Lazy']);
2014-08-15 08:53:05 +02:00
// Check that live record has original value
$this->assertEquals('Field Value', $objLive->ExtraField);
2014-08-15 08:53:05 +02:00
Versioned::set_reading_mode($originalMode);
}
2014-08-15 08:53:05 +02:00
public function testLazyLoadFieldsRetrieval() {
// Set reading mode to Stage
Versioned::set_stage(Versioned::DRAFT);
// Create object only in reading stage
$original = new VersionedTest_Subclass();
$original->ExtraField = 'Foo';
$original->write();
// Query for object using base class
$query = VersionedTest_DataObject::get()->filter('ID', $original->ID);
// Set reading mode to Live
Versioned::set_stage(Versioned::LIVE);
$fetched = $query->first();
$this->assertTrue($fetched instanceof VersionedTest_Subclass);
$this->assertEquals($original->ID, $fetched->ID); // Eager loaded
$this->assertEquals($original->ExtraField, $fetched->ExtraField); // Lazy loaded
}
/**
* Tests that reading mode persists between requests
*/
public function testReadingPersistent() {
$session = Injector::inst()->create('Session', array());
$adminID = $this->logInWithPermission('ADMIN');
$session->inst_set('loggedInAs', $adminID);
2014-08-15 08:53:05 +02:00
// Set to stage
Director::test('/?stage=Stage', null, $session);
$this->assertEquals(
'Stage.Stage',
$session->inst_get('readingMode'),
'Check querystring changes reading mode to Stage'
);
Director::test('/', null, $session);
$this->assertEquals(
'Stage.Stage',
$session->inst_get('readingMode'),
'Check that subsequent requests in the same session remain in Stage mode'
);
2014-08-15 08:53:05 +02:00
// Test live persists
Director::test('/?stage=Live', null, $session);
$this->assertEquals(
'Stage.Live',
$session->inst_get('readingMode'),
'Check querystring changes reading mode to Live'
);
Director::test('/', null, $session);
$this->assertEquals(
'Stage.Live',
$session->inst_get('readingMode'),
'Check that subsequent requests in the same session remain in Live mode'
);
2014-08-15 08:53:05 +02:00
// Test that session doesn't redundantly store the default stage if it doesn't need to
$session2 = Injector::inst()->create('Session', array());
$session2->inst_set('loggedInAs', $adminID);
Director::test('/', null, $session2);
$this->assertArrayNotHasKey('readingMode', $session2->inst_changedData());
Director::test('/?stage=Live', null, $session2);
$this->assertArrayNotHasKey('readingMode', $session2->inst_changedData());
2014-08-15 08:53:05 +02:00
// Test choose_site_stage
unset($_GET['stage']);
unset($_GET['archiveDate']);
Session::set('readingMode', 'Stage.Stage');
Versioned::choose_site_stage();
$this->assertEquals('Stage.Stage', Versioned::get_reading_mode());
Session::set('readingMode', 'Archive.2014-01-01');
Versioned::choose_site_stage();
$this->assertEquals('Archive.2014-01-01', Versioned::get_reading_mode());
Session::clear('readingMode');
Versioned::choose_site_stage();
$this->assertEquals('Stage.Live', Versioned::get_reading_mode());
}
/**
* Test that stage parameter is blocked by non-administrative users
*/
public function testReadingModeSecurity() {
$this->setExpectedException('SS_HTTPResponse_Exception');
$session = Injector::inst()->create('Session', array());
$result = Director::test('/?stage=Stage', null, $session);
}
/**
* Ensures that the latest version of a record is the expected value
*
* @param DataObject $record
* @param int $version
*/
protected function assertRecordHasLatestVersion($record, $version) {
foreach(ClassInfo::ancestry(get_class($record), true) as $table) {
$versionForClass = DB::prepared_query(
$sql = "SELECT MAX(\"Version\") FROM \"{$table}_versions\" WHERE \"RecordID\" = ?",
array($record->ID)
)->value();
$this->assertEquals($version, $versionForClass, "That the table $table has the latest version $version");
}
}
/**
* Tests that multi-table dataobjects are correctly versioned
*/
public function testWriteToStage() {
// Test subclass with versioned extension directly added
$record = VersionedTest_Subclass::create();
$record->Title = "Test A";
$record->ExtraField = "Test A";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 1);
2016-04-01 05:27:59 +02:00
$record->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$this->assertRecordHasLatestVersion($record, 1);
$record->Title = "Test A2";
$record->ExtraField = "Test A2";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 2);
// Test subclass without changes to base class
$record = VersionedTest_Subclass::create();
$record->ExtraField = "Test B";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 1);
2016-04-01 05:27:59 +02:00
$record->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$this->assertRecordHasLatestVersion($record, 1);
$record->ExtraField = "Test B2";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 2);
// Test subclass without changes to sub class
$record = VersionedTest_Subclass::create();
$record->Title = "Test C";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 1);
2016-04-01 05:27:59 +02:00
$record->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$this->assertRecordHasLatestVersion($record, 1);
$record->Title = "Test C2";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 2);
// Test subclass with versioned extension only added to the base clases
$record = VersionedTest_AnotherSubclass::create();
$record->Title = "Test A";
$record->AnotherField = "Test A";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 1);
2016-04-01 05:27:59 +02:00
$record->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$this->assertRecordHasLatestVersion($record, 1);
$record->Title = "Test A2";
$record->AnotherField = "Test A2";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 2);
// Test subclass without changes to base class
$record = VersionedTest_AnotherSubclass::create();
$record->AnotherField = "Test B";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 1);
2016-04-01 05:27:59 +02:00
$record->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$this->assertRecordHasLatestVersion($record, 1);
$record->AnotherField = "Test B2";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 2);
// Test subclass without changes to sub class
$record = VersionedTest_AnotherSubclass::create();
$record->Title = "Test C";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 1);
2016-04-01 05:27:59 +02:00
$record->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$this->assertRecordHasLatestVersion($record, 1);
$record->Title = "Test C2";
$record->writeToStage("Stage");
$this->assertRecordHasLatestVersion($record, 2);
}
public function testVersionedHandlesRenamedDataObjectFields(){
Config::inst()->remove('VersionedTest_RelatedWithoutVersion','db','Name','Varchar');
Config::inst()->update('VersionedTest_RelatedWithoutVersion','db',array(
"NewField" => "Varchar",
));
VersionedTest_RelatedWithoutVersion::add_extension("SilverStripe\\ORM\\Versioning\\Versioned");
$this->resetDBSchema(true);
$testData = new VersionedTest_RelatedWithoutVersion();
$testData->NewField = 'Test';
$testData->write();
}
public function testCanView() {
$public1ID = $this->idFromFixture('VersionedTest_PublicStage', 'public1');
$public2ID = $this->idFromFixture('VersionedTest_PublicViaExtension', 'public2');
$privateID = $this->idFromFixture('VersionedTest_DataObject', 'page1');
$singleID = $this->idFromFixture('VersionedTest_SingleStage', 'single');
// Test that all (and only) public pages are viewable in stage mode
Session::clear("loggedInAs");
Versioned::set_stage(Versioned::DRAFT);
$public1 = Versioned::get_one_by_stage('VersionedTest_PublicStage', 'Stage', array('"ID"' => $public1ID));
$public2 = Versioned::get_one_by_stage('VersionedTest_PublicViaExtension', 'Stage', array('"ID"' => $public2ID));
$private = Versioned::get_one_by_stage('VersionedTest_DataObject', 'Stage', array('"ID"' => $privateID));
// Also test an object that has just a single-stage (eg. is only versioned)
$single = Versioned::get_one_by_stage('VersionedTest_SingleStage', 'Stage', array('"ID"' => $singleID));
$this->assertTrue($public1->canView());
$this->assertTrue($public2->canView());
$this->assertFalse($private->canView());
$this->assertFalse($single->canView());
// Adjusting the current stage should not allow objects loaded in stage to be viewable
Versioned::set_stage(Versioned::LIVE);
$this->assertTrue($public1->canView());
$this->assertTrue($public2->canView());
$this->assertFalse($private->canView());
$this->assertFalse($single->canView());
// Writing the private page to live should be fine though
2016-04-01 05:27:59 +02:00
$private->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$privateLive = Versioned::get_one_by_stage('VersionedTest_DataObject', 'Live', array('"ID"' => $privateID));
$this->assertTrue($private->canView());
$this->assertTrue($privateLive->canView());
// But if the private version becomes different to the live version, it's once again disallowed
Versioned::set_stage(Versioned::DRAFT);
$private->Title = 'Secret Title';
$private->write();
$this->assertFalse($private->canView());
$this->assertTrue($privateLive->canView());
// And likewise, viewing a live page (when mode is draft) should be ok
Versioned::set_stage(Versioned::DRAFT);
$this->assertFalse($private->canView());
$this->assertTrue($privateLive->canView());
// Logging in as admin should allow all permissions
$this->logInWithPermission('ADMIN');
Versioned::set_stage(Versioned::DRAFT);
$this->assertTrue($public1->canView());
$this->assertTrue($public2->canView());
$this->assertTrue($private->canView());
$this->assertTrue($single->canView());
}
2015-12-09 02:53:21 +01:00
public function testCanViewStage() {
$public = $this->objFromFixture('VersionedTest_PublicStage', 'public1');
$private = $this->objFromFixture('VersionedTest_DataObject', 'page1');
Session::clear("loggedInAs");
Versioned::set_stage(Versioned::DRAFT);
2015-12-09 02:53:21 +01:00
// Test that all (and only) public pages are viewable in stage mode
// Unpublished records are not viewable in live regardless of permissions
$this->assertTrue($public->canViewStage('Stage'));
$this->assertFalse($private->canViewStage('Stage'));
$this->assertFalse($public->canViewStage('Live'));
$this->assertFalse($private->canViewStage('Live'));
// Writing records to live should make both stage and live modes viewable
2016-04-01 05:27:59 +02:00
$private->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
$public->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
2015-12-09 02:53:21 +01:00
$this->assertTrue($public->canViewStage('Stage'));
$this->assertTrue($private->canViewStage('Stage'));
$this->assertTrue($public->canViewStage('Live'));
$this->assertTrue($private->canViewStage('Live'));
// If the draft mode changes, the live mode remains public, although the updated
// draft mode is secured for non-public records.
$private->Title = 'Secret Title';
$private->write();
$public->Title = 'Public Title';
$public->write();
$this->assertTrue($public->canViewStage('Stage'));
$this->assertFalse($private->canViewStage('Stage'));
$this->assertTrue($public->canViewStage('Live'));
$this->assertTrue($private->canViewStage('Live'));
}
/**
* Values that are overwritten with null are saved to the _versions table correctly.
*/
public function testWriteNullValueToVersion()
{
$record = VersionedTest_Subclass::create();
$record->Title = "Test A";
$record->write();
$version = Versioned::get_latest_version($record->ClassName, $record->ID);
$this->assertEquals(1, $version->Version);
$this->assertEquals($record->Title, $version->Title);
$record->Title = null;
$record->write();
$version = Versioned::get_latest_version($record->ClassName, $record->ID);
$this->assertEquals(2, $version->Version);
$this->assertEquals($record->Title, $version->Title);
}
}
/**
* @method VersionedTest_DataObject Parent()
* @method HasManyList Children()
* @method ManyManyList Related()
*
* @package framework
* @subpackage tests
2016-04-01 05:27:59 +02:00
* @mixin Versioned
*/
class VersionedTest_DataObject extends DataObject implements TestOnly {
private static $db = array(
"Name" => "Varchar",
'Title' => 'Varchar',
'Content' => 'HTMLText',
);
private static $extensions = array(
"SilverStripe\\ORM\\Versioning\\Versioned",
);
2014-08-15 08:53:05 +02:00
private static $has_one = array(
'Parent' => 'VersionedTest_DataObject',
);
private static $has_many = array(
'Children' => 'VersionedTest_DataObject',
);
private static $many_many = array(
'Related' => 'VersionedTest_RelatedWithoutVersion',
);
public function canView($member = null) {
$extended = $this->extendedCan(__FUNCTION__, $member);
if($extended !== null) {
return $extended;
}
return true;
}
}
2016-04-01 05:27:59 +02:00
/**
* @mixin Versioned
*/
class VersionedTest_WithIndexes extends DataObject implements TestOnly {
private static $db = array(
'UniqA' => 'Int',
'UniqS' => 'Int',
);
private static $extensions = array(
"SilverStripe\\ORM\\Versioning\\Versioned"
);
private static $indexes = array(
'UniqS_idx' => 'unique ("UniqS")',
'UniqA_idx' => array('type' => 'unique', 'name' => 'UniqA_idx', 'value' => '"UniqA"',),
);
}
/**
* @package framework
* @subpackage tests
*/
class VersionedTest_RelatedWithoutVersion extends DataObject implements TestOnly {
private static $db = array(
'Name' => 'Varchar'
);
private static $belongs_many_many = array(
'Related' => 'VersionedTest_DataObject'
);
}
/**
* @package framework
* @subpackage tests
*/
class VersionedTest_Subclass extends VersionedTest_DataObject implements TestOnly {
private static $db = array(
"ExtraField" => "Varchar",
);
}
/**
* @package framework
* @subpackage tests
*/
class VersionedTest_AnotherSubclass extends VersionedTest_DataObject implements TestOnly {
private static $db = array(
"AnotherField" => "Varchar"
);
}
/**
* @package framework
* @subpackage tests
*/
class VersionedTest_UnversionedWithField extends DataObject implements TestOnly {
private static $db = array('Version' => 'Varchar(255)');
}
2016-04-01 05:27:59 +02:00
/**
* @mixin Versioned
*/
class VersionedTest_SingleStage extends DataObject implements TestOnly {
private static $db = array(
'Name' => 'Varchar'
);
private static $extensions = array(
'SilverStripe\ORM\Versioning\Versioned("Versioned")'
);
}
/**
* Versioned dataobject with public stage mode
2016-04-01 05:27:59 +02:00
*
* @mixin Versioned
*/
class VersionedTest_PublicStage extends DataObject implements TestOnly {
private static $db = array(
'Title' => 'Varchar'
);
private static $extensions = array(
"SilverStripe\\ORM\\Versioning\\Versioned"
);
public function canView($member = null) {
$extended = $this->extendedCan(__FUNCTION__, $member);
if($extended !== null) {
return $extended;
}
return true;
}
public function canViewVersioned($member = null) {
// All non-live modes are public
return true;
}
}
/**
* Public access is provided via extension rather than overriding canViewVersioned
2016-04-01 05:27:59 +02:00
*
* @mixin Versioned
* @mixin VersionedTest_PublicExtension
*/
class VersionedTest_PublicViaExtension extends DataObject implements TestOnly {
public function canView($member = null) {
$extended = $this->extendedCan(__FUNCTION__, $member);
if($extended !== null) {
return $extended;
}
return true;
}
private static $db = array(
'Title' => 'Varchar'
);
private static $extensions = array(
"SilverStripe\\ORM\\Versioning\\Versioned",
"VersionedTest_PublicExtension"
);
}
/**
* Alters stage mode of extended object to be public
*/
class VersionedTest_PublicExtension extends DataExtension implements TestOnly {
public function canViewNonLive($member = null) {
return true;
}
}