mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-08-02 08:45:39 +02:00
aa72425e84
Avoid PHPUnit throwing "test didn't run any assertions" notices in PHP. If nothing else, it keeps test output looking less broken by default, making it more likely that actual errors do get noticed.
513 lines
16 KiB
PHP
513 lines
16 KiB
PHP
<?php
|
|
class GridFieldTest extends SapphireTest {
|
|
|
|
/**
|
|
* @covers GridField::__construct
|
|
*/
|
|
public function testGridField() {
|
|
$obj = new GridField('testfield', 'testfield');
|
|
$this->assertTrue($obj instanceof GridField, 'Test that the constructor arguments are valid');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::__construct
|
|
* @covers GridField::getList
|
|
*/
|
|
public function testGridFieldSetList() {
|
|
$list = ArrayList::create(array(1=>'hello', 2=>'goodbye'));
|
|
$obj = new GridField('testfield', 'testfield', $list);
|
|
$this->assertEquals($list, $obj->getList(), 'Testing getList');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::__construct
|
|
* @covers GridField::getConfig
|
|
* @covers GridField::setComponents
|
|
* @covers GridField::getDefaultConfig
|
|
*/
|
|
public function testGridFieldDefaultConfig() {
|
|
$obj = new GridField('testfield', 'testfield');
|
|
|
|
$expectedComponents = new ArrayList(array(
|
|
new GridFieldToolbarHeader(),
|
|
$sort = new GridFieldSortableHeader(),
|
|
$filter = new GridFieldFilterHeader(),
|
|
new GridFieldDataColumns(),
|
|
new GridFieldPageCount('toolbar-header-right'),
|
|
$pagination = new GridFieldPaginator(),
|
|
new GridState_Component(),
|
|
));
|
|
$sort->setThrowExceptionOnBadDataType(false);
|
|
$filter->setThrowExceptionOnBadDataType(false);
|
|
$pagination->setThrowExceptionOnBadDataType(false);
|
|
|
|
$this->assertEquals($expectedComponents, $obj->getConfig()->getComponents(), 'Testing default Config');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::__construct
|
|
* @covers GridField::setComponents
|
|
*/
|
|
public function testGridFieldSetCustomConfig() {
|
|
|
|
$config = GridFieldConfig::create();
|
|
$config->addComponent(new GridFieldSortableHeader());
|
|
$config->addComponent(new GridFieldDataColumns());
|
|
|
|
$obj = new GridField('testfield', 'testfield', ArrayList::create(array()),$config);
|
|
|
|
$expectedComponents = new ArrayList(array(
|
|
0 => new GridFieldSortableHeader,
|
|
1 => new GridFieldDataColumns,
|
|
2 => new GridState_Component,
|
|
));
|
|
|
|
$this->assertEquals($expectedComponents, $obj->getConfig()->getComponents(), 'Testing default Config');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getModelClass
|
|
* @covers GridField::setModelClass
|
|
*/
|
|
public function testGridFieldModelClass() {
|
|
$obj = new GridField('testfield', 'testfield', Member::get());
|
|
$this->assertEquals('Member', $obj->getModelClass(), 'Should return Member');
|
|
$obj->setModelClass('DataModel');
|
|
$this->assertEquals('DataModel', $obj->getModelClass(), 'Should return Member');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getModelClass
|
|
*/
|
|
public function testGridFieldModelClassThrowsException() {
|
|
$this->setExpectedException('LogicException');
|
|
$obj = new GridField('testfield', 'testfield', ArrayList::create());
|
|
$obj->getModelClass();
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::setList
|
|
* @covers GridField::getList
|
|
*/
|
|
public function testSetAndGetList() {
|
|
$list = Member::get();
|
|
$arrayList = ArrayList::create(array(1,2,3));
|
|
$obj = new GridField('testfield', 'testfield', $list);
|
|
$this->assertEquals($list, $obj->getList());
|
|
$obj->setList($arrayList);
|
|
$this->assertEquals($arrayList, $obj->getList());
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getState
|
|
*/
|
|
public function testGetState() {
|
|
$obj = new GridField('testfield', 'testfield');
|
|
$this->assertTrue($obj->getState() instanceof GridState_Data);
|
|
$this->assertTrue($obj->getState(false) instanceof GridState);
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumns
|
|
*/
|
|
public function testGetColumns(){
|
|
$obj = new GridField('testfield', 'testfield', Member::get());
|
|
$expected = array (
|
|
0 => 'FirstName',
|
|
1 => 'Surname',
|
|
2 => 'Email',
|
|
);
|
|
$this->assertEquals($expected, $obj->getColumns());
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnCount
|
|
*/
|
|
public function testGetColumnCount() {
|
|
$obj = new GridField('testfield', 'testfield', Member::get());
|
|
$this->assertEquals(3, $obj->getColumnCount());
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnContent
|
|
*/
|
|
public function testGetColumnContent() {
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$obj = new GridField('testfield', 'testfield', $list);
|
|
$this->assertEquals('test@example.org', $obj->getColumnContent($list->first(), 'Email'));
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnContent
|
|
*/
|
|
public function testGetColumnContentBadArguments() {
|
|
$this->setExpectedException('InvalidArgumentException');
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$obj = new GridField('testfield', 'testfield', $list);
|
|
$obj->getColumnContent($list->first(), 'non-existing');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnAttributes
|
|
*/
|
|
public function testGetColumnAttributesEmptyArray() {
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$obj = new GridField('testfield', 'testfield', $list);
|
|
$this->assertEquals(array('class' => 'col-Email'), $obj->getColumnAttributes($list->first(), 'Email'));
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnAttributes
|
|
*/
|
|
public function testGetColumnAttributes() {
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
$obj = new GridField('testfield', 'testfield', $list, $config);
|
|
$this->assertEquals(array('class'=>'css-class'), $obj->getColumnAttributes($list->first(), 'Email'));
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnAttributes
|
|
*/
|
|
public function testGetColumnAttributesBadArguments() {
|
|
$this->setExpectedException('InvalidArgumentException');
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
$obj = new GridField('testfield', 'testfield', $list, $config);
|
|
$obj->getColumnAttributes($list->first(), 'Non-existing');
|
|
}
|
|
|
|
public function testGetColumnAttributesBadResponseFromComponent() {
|
|
$this->setExpectedException('LogicException');
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
$obj = new GridField('testfield', 'testfield', $list, $config);
|
|
$obj->getColumnAttributes($list->first(), 'Surname');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnMetadata
|
|
*/
|
|
public function testGetColumnMetadata() {
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
$obj = new GridField('testfield', 'testfield', $list, $config);
|
|
$this->assertEquals(array('metadata'=>'istrue'), $obj->getColumnMetadata('Email'));
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnMetadata
|
|
*/
|
|
public function testGetColumnMetadataBadResponseFromComponent() {
|
|
$this->setExpectedException('LogicException');
|
|
$list = new ArrayList(array(
|
|
new Member(array("ID" => 1, "Email" => "test@example.org" ))
|
|
));
|
|
$config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
$obj = new GridField('testfield', 'testfield', $list, $config);
|
|
$obj->getColumnMetadata('Surname');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getColumnMetadata
|
|
*/
|
|
public function testGetColumnMetadataBadArguments() {
|
|
$this->setExpectedException('InvalidArgumentException');
|
|
$list = ArrayList::create();
|
|
$config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
$obj = new GridField('testfield', 'testfield', $list, $config);
|
|
$obj->getColumnMetadata('non-exist-qweqweqwe');
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::handleAction
|
|
*/
|
|
public function testHandleActionBadArgument() {
|
|
$this->setExpectedException('InvalidArgumentException');
|
|
$obj = new GridField('testfield', 'testfield');
|
|
$obj->handleAction('prft', array(), array());
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::handleAction
|
|
*/
|
|
public function testHandleAction() {
|
|
$config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
$obj = new GridField('testfield', 'testfield', ArrayList::create(), $config);
|
|
$this->assertEquals('handledAction is executed', $obj->handleAction('jump', array(), array()));
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getCastedValue
|
|
*/
|
|
public function testGetCastedValue() {
|
|
$obj = new GridField('testfield', 'testfield');
|
|
$value = $obj->getCastedValue('This is a sentance. This ia another.', array('Text->FirstSentence'));
|
|
$this->assertEquals('This is a sentance.', $value);
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::getCastedValue
|
|
*/
|
|
public function testGetCastedValueObject() {
|
|
$obj = new GridField('testfield', 'testfield');
|
|
$value = $obj->getCastedValue('This is a sentance. This ia another.', 'Date');
|
|
$this->assertEquals(null, $value);
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::gridFieldAlterAction
|
|
*/
|
|
public function testGridFieldAlterAction() {
|
|
$this->markTestIncomplete();
|
|
|
|
// $config = GridFieldConfig::create()->addComponent(new GridFieldTest_Component);
|
|
// $obj = new GridField('testfield', 'testfield', ArrayList::create(), $config);
|
|
// $id = 'testGridStateActionField';
|
|
// Session::set($id, array('grid'=>'', 'actionName'=>'jump'));
|
|
// $form = new Form(new Controller(), 'mockform', new FieldList(array($obj)), new FieldList());
|
|
// $request = new SS_HTTPRequest('POST', 'url');
|
|
// $obj->gridFieldAlterAction(array('StateID'=>$id), $form, $request);
|
|
}
|
|
|
|
/**
|
|
* Test the interface for adding custom HTML fragment slots via a component
|
|
*/
|
|
public function testGridFieldCustomFragments() {
|
|
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"header-left-actions" => "left\$DefineFragment(nested-left)",
|
|
"header-right-actions" => "right",
|
|
));
|
|
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"nested-left" => "[inner]",
|
|
));
|
|
|
|
|
|
$config = GridFieldConfig::create()->addComponents(
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"header" => "<tr><td><div class=\"right\">\$DefineFragment(header-right-actions)</div>"
|
|
. "<div class=\"left\">\$DefineFragment(header-left-actions)</div></td></tr>",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"header-left-actions" => "left",
|
|
"header-right-actions" => "rightone",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"header-right-actions" => "righttwo",
|
|
))
|
|
);
|
|
$field = new GridField('testfield', 'testfield', ArrayList::create(), $config);
|
|
$form = new Form(new Controller(), 'testform', new FieldList(array($field)), new FieldList());
|
|
|
|
$this->assertContains("<div class=\"right\">rightone\nrighttwo</div><div class=\"left\">left</div>",
|
|
$field->FieldHolder());
|
|
}
|
|
|
|
/**
|
|
* Test the nesting of custom fragments
|
|
*/
|
|
public function testGridFieldCustomFragmentsNesting() {
|
|
$config = GridFieldConfig::create()->addComponents(
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"level-one" => "first",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"before" => "<div>\$DefineFragment(level-one)</div>",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"level-one" => "<strong>\$DefineFragment(level-two)</strong>",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"level-two" => "second",
|
|
))
|
|
);
|
|
$field = new GridField('testfield', 'testfield', ArrayList::create(), $config);
|
|
$form = new Form(new Controller(), 'testform', new FieldList(array($field)), new FieldList());
|
|
|
|
$this->assertContains("<div>first\n<strong>second</strong></div>",
|
|
$field->FieldHolder());
|
|
}
|
|
|
|
/**
|
|
* Test that circular dependencies throw an exception
|
|
*/
|
|
public function testGridFieldCustomFragmentsCircularDependencyThrowsException() {
|
|
$config = GridFieldConfig::create()->addComponents(
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"level-one" => "first",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"before" => "<div>\$DefineFragment(level-one)</div>",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"level-one" => "<strong>\$DefineFragment(level-two)</strong>",
|
|
)),
|
|
new GridFieldTest_HTMLFragments(array(
|
|
"level-two" => "<blink>\$DefineFragment(level-one)</blink>",
|
|
))
|
|
);
|
|
$field = new GridField('testfield', 'testfield', ArrayList::create(), $config);
|
|
$form = new Form(new Controller(), 'testform', new FieldList(array($field)), new FieldList());
|
|
|
|
$this->setExpectedException('LogicException');
|
|
$field->FieldHolder();
|
|
}
|
|
|
|
/**
|
|
* @covers GridField::FieldHolder
|
|
*/
|
|
public function testCanViewOnlyOddIDs() {
|
|
$this->logInWithPermission();
|
|
$list = new ArrayList(array(
|
|
new GridFieldTest_Permissions(array("ID" => 1, "Email" => "ongi.schwimmer@example.org",
|
|
'Name' => 'Ongi Schwimmer')),
|
|
new GridFieldTest_Permissions(array("ID" => 2, "Email" => "klaus.lozenge@example.org",
|
|
'Name' => 'Klaus Lozenge')),
|
|
new GridFieldTest_Permissions(array("ID" => 3, "Email" => "otto.fischer@example.org",
|
|
'Name' => 'Otto Fischer'))
|
|
));
|
|
|
|
$config = new GridFieldConfig();
|
|
$config->addComponent(new GridFieldDataColumns());
|
|
$obj = new GridField('testfield', 'testfield', $list, $config);
|
|
$form = new Form(new Controller(), 'mockform', new FieldList(array($obj)), new FieldList());
|
|
$content = new CSSContentParser($obj->FieldHolder());
|
|
|
|
$members = $content->getBySelector('.ss-gridfield-item tr');
|
|
|
|
$this->assertEquals(2, count($members));
|
|
|
|
$this->assertEquals((string)$members[0]->td[0], 'Ongi Schwimmer',
|
|
'First object Name should be Ongi Schwimmer');
|
|
$this->assertEquals((string)$members[0]->td[1], 'ongi.schwimmer@example.org',
|
|
'First object Email should be ongi.schwimmer@example.org');
|
|
|
|
$this->assertEquals((string)$members[1]->td[0], 'Otto Fischer',
|
|
'Second object Name should be Otto Fischer');
|
|
$this->assertEquals((string)$members[1]->td[1], 'otto.fischer@example.org',
|
|
'Second object Email should be otto.fischer@example.org');
|
|
}
|
|
|
|
public function testChainedDataManipulators() {
|
|
$config = new GridFieldConfig();
|
|
$data = new ArrayList(array(1, 2, 3, 4, 5, 6));
|
|
$gridField = new GridField('testfield', 'testfield', $data, $config);
|
|
$endList = $gridField->getManipulatedList();
|
|
$this->assertEquals($endList->Count(), 6);
|
|
|
|
$config->addComponent(new GridFieldTest_Component2);
|
|
$endList = $gridField->getManipulatedList();
|
|
$this->assertEquals($endList->Count(), 12);
|
|
|
|
$config->addComponent(new GridFieldPaginator(10));
|
|
$endList = $gridField->getManipulatedList();
|
|
$this->assertEquals($endList->Count(), 10);
|
|
}
|
|
}
|
|
|
|
class GridFieldTest_Component implements GridField_ColumnProvider, GridField_ActionProvider, TestOnly{
|
|
|
|
public function augmentColumns($gridField, &$columns) {}
|
|
|
|
public function getColumnContent($gridField, $record, $columnName) {}
|
|
|
|
public function getColumnAttributes($gridField, $record, $columnName) {
|
|
if($columnName=='Surname'){
|
|
return 'shouldnotbestring';
|
|
}
|
|
return array('class'=>'css-class');
|
|
}
|
|
|
|
public function getColumnMetadata($gridField, $columnName) {
|
|
if($columnName=='Surname'){
|
|
return 'shouldnotbestring';
|
|
} elseif( $columnName == 'FirstName') {
|
|
return array();
|
|
}
|
|
return array('metadata'=>'istrue');
|
|
}
|
|
public function getColumnsHandled($gridField) {
|
|
return array('Email', 'Surname', 'FirstName');
|
|
}
|
|
|
|
public function getActions($gridField) {
|
|
return array('jump');
|
|
}
|
|
|
|
public function handleAction(GridField $gridField, $actionName, $arguments, $data) {
|
|
return 'handledAction is executed';
|
|
}
|
|
|
|
|
|
}
|
|
|
|
class GridFieldTest_Component2 implements GridField_DataManipulator, TestOnly {
|
|
public function getManipulatedData(GridField $gridField, SS_List $dataList) {
|
|
$dataList = clone $dataList;
|
|
$dataList->merge(new ArrayList(array(7, 8, 9, 10, 11, 12)));
|
|
return $dataList;
|
|
}
|
|
}
|
|
|
|
class GridFieldTest_Team extends DataObject implements TestOnly {
|
|
static $db = array(
|
|
'Name' => 'Varchar',
|
|
'City' => 'Varchar'
|
|
);
|
|
|
|
static $many_many = array('Players' => 'GridFieldTest_Player');
|
|
}
|
|
|
|
class GridFieldTest_Player extends DataObject implements TestOnly {
|
|
static $db = array(
|
|
'Name' => 'Varchar',
|
|
'Email' => 'Varchar',
|
|
);
|
|
|
|
static $belongs_many_many = array('Teams' => 'GridFieldTest_Team');
|
|
}
|
|
|
|
class GridFieldTest_HTMLFragments implements GridField_HTMLProvider, TestOnly{
|
|
public function __construct($fragments) {
|
|
$this->fragments = $fragments;
|
|
}
|
|
|
|
public function getHTMLFragments($gridField) {
|
|
return $this->fragments;
|
|
}
|
|
}
|
|
|
|
class GridFieldTest_Permissions extends DataObject implements TestOnly {
|
|
public static $db = array(
|
|
'Name' => 'Varchar',
|
|
'Email' => 'Varchar',
|
|
);
|
|
|
|
public static $summary_fields = array(
|
|
'Name',
|
|
'Email'
|
|
);
|
|
|
|
public function canView($member = null) {
|
|
// Only records with odd numbers are viewable
|
|
if(!($this->ID % 2)){ return false; }
|
|
return true;
|
|
}
|
|
}
|