silverstripe-framework/tests/php/ORM/MarkedSetTest.php

445 lines
16 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\ORM\Tests;
use DOMDocument;
use SilverStripe\Dev\CSSContentParser;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\Hierarchy\MarkedSet;
use SilverStripe\Versioned\Versioned;
/**
* Test set of marked Hierarchy-extended DataObjects
*/
class MarkedSetTest extends SapphireTest
{
protected static $fixture_file = 'HierarchyTest.yml';
protected static $extra_dataobjects = [
HierarchyTest\TestObject::class,
HierarchyTest\HideTestObject::class,
HierarchyTest\HideTestSubObject::class,
];
API Refactor bootstrap, request handling See https://github.com/silverstripe/silverstripe-framework/pull/7037 and https://github.com/silverstripe/silverstripe-framework/issues/6681 Squashed commit of the following: commit 8f65e5653211240650eaa4fa65bb83b45aae6d58 Author: Ingo Schommer <me@chillu.com> Date: Thu Jun 22 22:25:50 2017 +1200 Fixed upgrade guide spelling commit 76f95944fa89b0b540704b8d744329f690f9698c Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 16:38:34 2017 +1200 BUG Fix non-test class manifest including sapphiretest / functionaltest commit 9379834cb4b2e5177a2600049feec05bf111c16b Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 15:50:47 2017 +1200 BUG Fix nesting bug in Kernel commit 188ce35d82599360c40f0f2de29579c56fb90761 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 15:14:51 2017 +1200 BUG fix db bootstrapping issues commit 7ed4660e7a63915e8e974deeaba9807bc4d38b0d Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 14:49:07 2017 +1200 BUG Fix issue in DetailedErrorFormatter commit 738f50c497166f81ccbe3f40fbcff895ce71f82f Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 11:49:19 2017 +1200 Upgrading notes on mysite/_config.php commit 6279d28e5e455916f902a2f963c014d8899f7fc7 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 11:43:28 2017 +1200 Update developer documentation commit 5c90d53a84ef0139c729396949a7857fae60436f Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 10:48:44 2017 +1200 Update installer to not use global databaseConfig commit f9b2ba4755371f08bd95f6908ac612fcbb7ca205 Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 21:04:39 2017 +1200 Fix behat issues commit 5b59a912b60282b4dad4ef10ed3b97c5d0a761ac Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 17:07:11 2017 +1200 Move HTTPApplication to SilverStripe\Control namespace commit e2c4a18f637bdd3d276619554de60ee8b4d95ced Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 16:29:03 2017 +1200 More documentation Fix up remaining tests Refactor temp DB into TempDatabase class so it’s available outside of unit tests. commit 5d235e64f341d6251bfe9f4833f15cc8593c5034 Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 12:13:15 2017 +1200 API HTTPRequestBuilder::createFromEnvironment() now cleans up live globals BUG Fix issue with SSViewer Fix Security / View tests commit d88d4ed4e48291cb65407f222f190064b1f1deeb Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 20 16:39:43 2017 +1200 API Refactor AppKernel into CoreKernel commit f7946aec3391139ae1b4029c353c327a36552b36 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 20 16:00:40 2017 +1200 Docs and minor cleanup commit 12bd31f9366327650b5c0c0f96cd0327d44faf0a Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 20 15:34:34 2017 +1200 API Remove OutputMiddleware API Move environment / global / ini management into Environment class API Move getTempFolder into TempFolder class API Implement HTTPRequestBuilder / CLIRequestBuilder BUG Restore SS_ALLOWED_HOSTS check in original location API CoreKernel now requires $basePath to be passed in API Refactor installer.php to use application to bootstrap API move memstring conversion globals to Convert BUG Fix error in CoreKernel nesting not un-nesting itself properly. commit bba979114624247cf463cf2a8c9e4be9a7c3a772 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 18:07:53 2017 +1200 API Create HTTPMiddleware and standardise middleware for request handling commit 2a10c2397bdc53001013f607b5d38087ce6c0730 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 17:42:42 2017 +1200 Fixed ORM tests commit d75a8d1d93398af4bd0432df9e4bc6295c15a3fe Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 17:15:07 2017 +1200 FIx i18n tests commit 06364af3c379c931889c4cc34dd920fee3db204a Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 16:59:34 2017 +1200 Fix controller namespace Move states to sub namespace commit 2a278e2953d2dbb19f78d91c919048e1fc935436 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 12:49:45 2017 +1200 Fix forms namespace commit b65c21241bee019730027071d815dbf7571197a4 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 15 18:56:48 2017 +1200 Update API usages commit d1d4375c95a264a6b63cbaefc2c1d12f808bfd82 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 15 18:41:44 2017 +1200 API Refactor $flush into HTPPApplication API Enforce health check in Controller::pushCurrent() API Better global backup / restore Updated Director::test() to use new API commit b220534f06732db4fa940d8724c2a85c0ba2495a Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 22:05:57 2017 +1200 Move app nesting to a test state helper commit 603704165c08d0c1c81fd5e6bb9506326eeee17b Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 21:46:04 2017 +1200 Restore kernel stack to fix multi-level nesting commit 2f6336a15bf79dc8c2edd44cec1931da2dd51c28 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 17:23:21 2017 +1200 API Implement kernel nesting commit fc7188da7d6ad6785354bab61f08700454c81d91 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 15:43:13 2017 +1200 Fix core tests commit a0ae7235148fffd71f2f02d1fe7fe45bf3aa39eb Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 15:23:52 2017 +1200 Fix manifest tests commit ca033952513633e182040d3d13e1caa9000ca184 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 15:00:00 2017 +1200 API Move extension management into test state commit c66d4339777663a8a04661fea32a0cf35b95d20f Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 14:10:59 2017 +1200 API Refactor SapphireTest state management into SapphireTestState API Remove Injector::unregisterAllObjects() API Remove FakeController commit f26ae75c6ecaafa0dec1093264e0187191e6764d Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 12 18:04:34 2017 +1200 Implement basic CLI application object commit 001d5596621404892de0a5413392379eff990641 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 12 17:39:38 2017 +1200 Remove references to SapphireTest::is_running_test() Upgrade various code commit de079c041dacd96bc4f4b66421fa2b2cc4c320f8 Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 7 18:07:33 2017 +1200 API Implement APP object API Refactor of Session
2017-06-22 12:50:45 +02:00
public static function getExtraDataObjects()
{
// Prevent setup breaking if versioned module absent
if (class_exists(Versioned::class)) {
return parent::getExtraDataObjects();
}
return [];
}
public function setUp()
{
parent::setUp();
// Note: Soft support for versioned module optionality
if (!class_exists(Versioned::class)) {
$this->markTestSkipped('MarkedSetTest requires the Versioned extension');
}
}
/**
* Test that you can call MarkedSet::markExpanded/Unexpanded/Open() on a obj, and that
* calling MarkedSet::isMarked() on a different instance of that object will return true.
*/
public function testItemMarkingIsntRestrictedToSpecificInstance()
{
// Build new object
$set = new MarkedSet(HierarchyTest\TestObject::singleton());
// Mark a few objs
$set->markExpanded($this->objFromFixture(HierarchyTest\TestObject::class, 'obj2'));
$set->markExpanded($this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a'));
$set->markExpanded($this->objFromFixture(HierarchyTest\TestObject::class, 'obj2b'));
$set->markUnexpanded($this->objFromFixture(HierarchyTest\TestObject::class, 'obj3'));
// Query some objs in a different context and check their m
$objs = DataObject::get(HierarchyTest\TestObject::class, '', '"ID" ASC');
$marked = $expanded = [];
foreach ($objs as $obj) {
if ($set->isMarked($obj)) {
$marked[] = $obj->Title;
}
if ($set->isExpanded($obj)) {
$expanded[] = $obj->Title;
}
}
$this->assertEquals(['Obj 2', 'Obj 3', 'Obj 2a', 'Obj 2b'], $marked);
$this->assertEquals(['Obj 2', 'Obj 2a', 'Obj 2b'], $expanded);
}
/**
* @covers \SilverStripe\ORM\Hierarchy\MarkedSet::markChildren()
*/
public function testMarkChildrenDoesntUnmarkPreviouslyMarked()
{
$obj3 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj3');
$obj3aa = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj3aa');
$obj3ba = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj3ba');
$obj3ca = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj3ca');
$set = new MarkedSet($obj3);
$set->markPartialTree();
$set->markToExpose($obj3aa);
$set->markToExpose($obj3ba);
$set->markToExpose($obj3ca);
$expected = <<<EOT
<ul>
<li>Obj 3a
<ul>
<li>Obj 3aa
</li>
<li>Obj 3ab
</li>
</ul>
</li>
<li>Obj 3b
<ul>
<li>Obj 3ba
</li>
<li>Obj 3bb
</li>
</ul>
</li>
<li>Obj 3c
<ul>
<li>Obj 3c
</li>
</ul>
</li>
<li>Obj 3d
</li>
</ul>
EOT;
$this->assertHTMLSame($expected, $set->renderChildren());
}
public function testGetChildrenCustomTemplate()
{
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
$obj2aa = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2aa');
// Render marked tree
$set = new MarkedSet(HierarchyTest\TestObject::singleton(), 'AllChildrenIncludingDeleted', 'numChildren', 30);
$set->markPartialTree();
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
$this->assertTreeContains(
$html,
[$obj2],
'Contains root elements'
);
$this->assertTreeContains(
$html,
[$obj2, $obj2a],
'Contains child elements (in correct nesting)'
);
$this->assertTreeContains(
$html,
[$obj2, $obj2a, $obj2aa],
'Contains grandchild elements (in correct nesting)'
);
}
public function testGetChildrenAsULMinNodeCount()
{
$obj1 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj1');
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
// Render marked tree
$set = new MarkedSet(HierarchyTest\TestObject::singleton(), 'AllChildrenIncludingDeleted', 'numChildren');
$set->setNodeCountThreshold(3); // Set low enough that it should be fulfilled by root only elements
$set->markPartialTree();
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
$this->assertTreeContains(
$html,
[$obj1],
'Contains root elements'
);
$this->assertTreeContains(
$html,
[$obj2],
'Contains root elements'
);
$this->assertTreeNotContains(
$html,
[$obj2, $obj2a],
'Does not contains child elements because they exceed minNodeCount'
);
}
public function testGetChildrenAsULMinNodeCountWithMarkToExpose()
{
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
$obj2aa = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2aa');
// Render marked tree
$set = new MarkedSet(HierarchyTest\TestObject::singleton(), 'AllChildrenIncludingDeleted', 'numChildren');
$set->setNodeCountThreshold(3); // Set low enough that it should be fulfilled by root only elements
$set->markPartialTree();
// Mark certain node which should be included regardless of minNodeCount restrictions
$set->markToExpose($obj2aa);
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
$this->assertTreeContains(
$html,
[$obj2],
'Contains root elements'
);
$this->assertTreeContains(
$html,
[$obj2, $obj2a, $obj2aa],
'Does contain marked children nodes regardless of configured threshold'
);
}
public function testGetChildrenAsULMinNodeCountWithFilters()
{
$obj1 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj1');
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
$obj2aa = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2aa');
// Render marked tree
$set = new MarkedSet(HierarchyTest\TestObject::singleton(), 'AllChildrenIncludingDeleted', 'numChildren');
$set->setNodeCountThreshold(3); // Set low enough that it should be fulfilled by root only elements
// Includes nodes by filter regardless of minNodeCount restrictions
$set->setMarkingFilterFunction(
function ($record) use ($obj2, $obj2a, $obj2aa) {
// Results need to include parent hierarchy, even if we just want to
// match the innermost node.
return in_array($record->ID, [$obj2->ID, $obj2a->ID, $obj2aa->ID]);
}
);
$set->markPartialTree();
// Mark certain node which should be included regardless of minNodeCount restrictions
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
$this->assertTreeNotContains(
$html,
[$obj1],
'Does not contain root elements which dont match the filter'
);
$this->assertTreeContains(
$html,
[$obj2, $obj2a, $obj2aa],
'Contains non-root elements which match the filter'
);
}
public function testGetChildrenAsULHardLimitsNodes()
{
$obj1 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj1');
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
$obj2aa = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2aa');
// Render marked tree
$set = new MarkedSet(HierarchyTest\TestObject::singleton(), 'AllChildrenIncludingDeleted', 'numChildren');
$set->setNodeCountThreshold(3); // Set low enough that it should miss out one node
// Includes nodes by filter regardless of minNodeCount restrictions
$set->setMarkingFilterFunction(
function ($record) use ($obj2, $obj2a, $obj2aa) {
// Results need to include parent hierarchy, even if we just want to
// match the innermost node.
return in_array($record->ID, [$obj2->ID, $obj2a->ID, $obj2aa->ID]);
}
);
$set->markPartialTree();
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
$this->assertTreeNotContains(
$html,
[$obj1, $obj2aa],
'Does not contain root elements which dont match the filter or are limited'
);
$this->assertTreeContains(
$html,
[$obj2, $obj2a],
'Contains non-root elements which match the filter'
);
}
public function testGetChildrenAsULNodeThresholdLeaf()
{
$obj1 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj1');
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
$obj3 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj3');
$obj3a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj3a');
// Render marked tree
$set = new MarkedSet(HierarchyTest\TestObject::singleton(), 'AllChildrenIncludingDeleted', 'numChildren');
$set->setNodeCountThreshold(99);
$set->setMaxChildNodes(2); // Force certain children to exceed limits
$set->markPartialTree();
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
$this->assertTreeContains(
$html,
[$obj1],
'Does contain root elements regardless of count'
);
$this->assertTreeContains(
$html,
[$obj3],
'Does contain root elements regardless of count'
);
$this->assertTreeContains(
$html,
[$obj2, $obj2a],
'Contains children which do not exceed threshold'
);
$this->assertTreeNotContains(
$html,
[$obj3, $obj3a],
'Does not contain children which exceed threshold'
);
}
/**
* This test checks that deleted ('archived') child pages don't set a css class on the parent
* node that makes it look like it has children
*/
public function testGetChildrenAsULNodeDeletedOnLive()
{
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
$obj2aa = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2aa');
$obj2ab = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2b');
// delete all children under obj2
$obj2a->delete();
$obj2aa->delete();
$obj2ab->delete();
$set = new MarkedSet(
HierarchyTest\TestObject::singleton(),
'AllChildren',
'numChildren'
);
// Don't pre-load all children
$set->setNodeCountThreshold(1);
$set->markPartialTree();
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
// Get the class attribute from the $obj2 node in the sitetree, class 'jstree-leaf' means it's a leaf node
$nodeClass = $this->getNodeClassFromTree($html, $obj2);
$this->assertEquals('jstree-leaf closed', $nodeClass, 'object2 should not have children in the sitetree');
}
/**
* This test checks that deleted ('archived') child pages _do_ set a css class on the parent
* node that makes it look like it has children when getting all children including deleted
*/
public function testGetChildrenAsULNodeDeletedOnStage()
{
$obj2 = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2');
$obj2a = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2a');
$obj2aa = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2aa');
$obj2ab = $this->objFromFixture(HierarchyTest\TestObject::class, 'obj2b');
// delete all children under obj2
$obj2a->delete();
$obj2aa->delete();
$obj2ab->delete();
$set = new MarkedSet(
HierarchyTest\TestObject::singleton(),
'AllChildrenIncludingDeleted',
'numHistoricalChildren'
);
// Don't pre-load all children
$set->setNodeCountThreshold(1);
$set->markPartialTree();
$template = __DIR__ . '/HierarchyTest/MarkedSetTest_HTML.ss';
$html = $set->renderChildren($template);
// Get the class attribute from the $obj2 node in the sitetree
$nodeClass = $this->getNodeClassFromTree($html, $obj2);
// Object2 can now be expanded
$this->assertEquals('unexpanded jstree-closed closed', $nodeClass, 'obj2 should have children in the sitetree');
}
/**
* @param String $html [description]
* @param array $nodes Breadcrumb path as array
* @param String $message
*/
protected function assertTreeContains($html, $nodes, $message = null)
{
$parser = new CSSContentParser($html);
$xpath = '/';
foreach ($nodes as $node) {
$xpath .= '/ul/li[@data-id="' . $node->ID . '"]';
}
$match = $parser->getByXpath($xpath);
self::assertThat((bool)$match, self::isTrue(), $message);
}
/**
* @param String $html [description]
* @param array $nodes Breadcrumb path as array
* @param String $message
*/
protected function assertTreeNotContains($html, $nodes, $message = null)
{
$parser = new CSSContentParser($html);
$xpath = '/';
foreach ($nodes as $node) {
$xpath .= '/ul/li[@data-id="' . $node->ID . '"]';
}
$match = $parser->getByXpath($xpath);
self::assertThat((bool)$match, self::isFalse(), $message);
}
/**
* Get the HTML class attribute from a node in the sitetree
*
* @param string$html
* @param DataObject $node
* @return string
*/
protected function getNodeClassFromTree($html, $node)
{
$parser = new CSSContentParser($html);
$xpath = '//ul/li[@data-id="' . $node->ID . '"]';
$object = $parser->getByXpath($xpath);
foreach ($object[0]->attributes() as $key => $attr) {
if ($key == 'class') {
return (string)$attr;
}
}
return '';
}
protected function assertHTMLSame($expected, $actual, $message = '')
{
// Trim each line, strip empty lines
$expected = implode("\n", array_filter(array_map('trim', explode("\n", $expected))));
$actual = implode("\n", array_filter(array_map('trim', explode("\n", $actual))));
$this->assertXmlStringEqualsXmlString($expected, $actual, $message);
}
}