Files
dokuwiki-plugin-struct/_test/SearchTest.php
2024-02-06 10:03:36 +01:00

448 lines
15 KiB
PHP

<?php
namespace dokuwiki\plugin\struct\test;
use dokuwiki\plugin\struct\meta;
/**
* Tests for the building of SQL-Queries for the struct plugin
*
* @group plugin_struct
* @group plugins
*
*/
class SearchTest extends StructTest
{
public function setUp(): void
{
parent::setUp();
$this->loadSchemaJSON('schema1');
$this->loadSchemaJSON('schema2');
$_SERVER['REMOTE_USER'] = 'testuser';
$as = mock\Assignments::getInstance();
$page = 'page01';
$as->assignPageSchema($page, 'schema1');
$as->assignPageSchema($page, 'schema2');
saveWikiText($page, "===== TestTitle =====\nabc", "Summary");
p_get_metadata($page);
$now = time();
$this->saveData(
$page,
'schema1',
[
'first' => 'first data',
'second' => ['second data', 'more data', 'even more'],
'third' => 'third data',
'fourth' => 'fourth data'
],
$now
);
$this->saveData(
$page,
'schema2',
[
'afirst' => 'first data',
'asecond' => ['second data', 'more data', 'even more'],
'athird' => 'third data',
'afourth' => 'fourth data'
],
$now
);
$as->assignPageSchema('test:document', 'schema1');
$as->assignPageSchema('test:document', 'schema2');
$this->saveData(
'test:document',
'schema1',
[
'first' => 'document first data',
'second' => ['second', 'more'],
'third' => '',
'fourth' => 'fourth data'
],
$now
);
$this->saveData(
'test:document',
'schema2',
[
'afirst' => 'first data',
'asecond' => ['second data', 'more data', 'even more'],
'athird' => 'third data',
'afourth' => 'fourth data'
],
$now
);
for ($i = 10; $i <= 20; $i++) {
$this->saveData(
"page$i",
'schema2',
[
'afirst' => "page$i first data",
'asecond' => ["page$i second data"],
'athird' => "page$i third data",
'afourth' => "page$i fourth data"
],
$now
);
$as->assignPageSchema("page$i", 'schema2');
}
}
public function test_simple()
{
$search = new mock\Search();
$search->addSchema('schema1');
$search->addColumn('%pageid%');
$search->addColumn('first');
$search->addColumn('second');
/** @var meta\Value[][] $result */
$result = $search->getRows();
$this->assertCount(2, $result, 'result rows');
$this->assertCount(3, $result[0], 'result columns');
$this->assertEquals('page01', $result[0][0]->getValue());
$this->assertEquals('first data', $result[0][1]->getValue());
$this->assertEquals(['second data', 'more data', 'even more'], $result[0][2]->getValue());
}
public function test_simple_title()
{
$search = new mock\Search();
$search->addSchema('schema1');
$search->addColumn('%title%');
$search->addColumn('first');
$search->addColumn('second');
/** @var meta\Value[][] $result */
$result = $search->getRows();
$this->assertCount(2, $result, 'result rows');
$this->assertCount(3, $result[0], 'result columns');
$this->assertEquals('["page01","TestTitle"]', $result[0][0]->getValue());
$this->assertEquals('first data', $result[0][1]->getValue());
$this->assertEquals(['second data', 'more data', 'even more'], $result[0][2]->getValue());
}
public function test_search_published()
{
$search = new mock\Search();
$search->isNotPublisher();
$search->addSchema('schema1');
$search->addColumn('%pageid%');
$search->addColumn('first');
$search->addColumn('second');
/** @var meta\Value[][] $result */
$result = $search->getRows();
$this->assertCount(0, $result, 'result rows');
}
public function test_search_lasteditor()
{
$search = new mock\Search();
$search->addSchema('schema1');
$search->addColumn('%title%');
$search->addColumn('%lasteditor%');
$search->addColumn('first');
$search->addColumn('second');
/** @var meta\Value[][] $result */
$result = $search->getRows();
$this->assertCount(2, $result, 'result rows');
$this->assertCount(4, $result[0], 'result columns');
$this->assertEquals('testuser', $result[0][1]->getValue());
$this->assertEquals(['second data', 'more data', 'even more'], $result[0][3]->getValue());
}
/**
* @group slow
*/
public function test_search_lastupdate()
{
sleep(1);
saveWikiText('page01', "===== TestTitle =====\nabcd", "Summary");
p_get_metadata('page01');
$search = new mock\Search();
$search->addSchema('schema1');
$search->addColumn('%pageid%');
$search->addColumn('%lastupdate%');
$search->addColumn('first');
$search->addColumn('second');
/** @var meta\Value[][] $result */
$result = $search->getRows();
$expected_time = dformat(filemtime(wikiFN('page01')), '%Y-%m-%d %H:%M:%S');
$this->assertCount(2, $result, 'result rows');
$this->assertCount(4, $result[0], 'result columns');
$this->assertEquals($expected_time, $result[0][1]->getValue(), "Is your date.timezone set up in php.ini?");
$this->assertEquals(['second data', 'more data', 'even more'], $result[0][3]->getValue());
}
/**
* @group slow
*/
public function test_search_lastsummary()
{
sleep(1);
$summary = 'Summary';
saveWikiText('page01', "===== TestTitle =====\nabcd", $summary);
p_get_metadata('page01');
$search = new mock\Search();
$search->addSchema('schema1');
$search->addColumn('%pageid%');
$search->addColumn('%lastsummary%');
$search->addColumn('first');
$search->addColumn('second');
/** @var meta\Value[][] $result */
$result = $search->getRows();
$this->assertCount(2, $result, 'result rows');
$this->assertCount(4, $result[0], 'result columns');
$this->assertEquals($summary, $result[0][1]->getValue());
$this->assertEquals(array('second data', 'more data', 'even more'), $result[0][3]->getValue());
}
public function test_search()
{
$search = new mock\Search();
$search->addSchema('schema1');
$search->addSchema('schema2', 'foo');
$this->assertCount(2, $search->schemas);
$search->addColumn('first');
$this->assertEquals('schema1', $search->columns[0]->getTable());
$this->assertEquals(1, $search->columns[0]->getColref());
$search->addColumn('afirst');
$this->assertEquals('schema2', $search->columns[1]->getTable());
$this->assertEquals(1, $search->columns[1]->getColref());
$search->addColumn('schema1.third');
$this->assertEquals('schema1', $search->columns[2]->getTable());
$this->assertEquals(3, $search->columns[2]->getColref());
$search->addColumn('foo.athird');
$this->assertEquals('schema2', $search->columns[3]->getTable());
$this->assertEquals(3, $search->columns[3]->getColref());
$search->addColumn('asecond');
$this->assertEquals('schema2', $search->columns[4]->getTable());
$this->assertEquals(2, $search->columns[4]->getColref());
$search->addColumn('doesntexist');
$this->assertEquals(5, count($search->columns));
$search->addColumn('%pageid%');
$this->assertEquals('schema1', $search->columns[5]->getTable());
$exception = false;
try {
$search->columns[5]->getColref();
} catch (meta\StructException $e) {
$exception = true;
}
$this->assertTrue($exception, "Struct exception expected for accesing colref of PageColumn");
$search->addSort('first', false);
$this->assertCount(1, $search->sortby);
$search->addFilter('%pageid%', '%ag%', '~', 'AND');
$search->addFilter('second', '%sec%', '~', 'AND');
$search->addFilter('first', '%rst%', '~', 'AND');
$result = $search->getRows();
$count = $search->getCount();
$this->assertEquals(1, $count, 'result count');
$this->assertCount(1, $result, 'result rows');
$this->assertCount(6, $result[0], 'result columns');
// sort by multi-column
$search->addSort('second');
$this->assertCount(2, $search->sortby);
$result = $search->getRows();
$count = $search->getCount();
$this->assertEquals(1, $count, 'result count');
$this->assertCount(1, $result, 'result rows');
$this->assertCount(6, $result[0], 'result columns');
}
public function test_ranges()
{
$search = new mock\Search();
$search->addSchema('schema2');
$search->addColumn('%pageid%');
$search->addColumn('afirst');
$search->addColumn('asecond');
$search->addFilter('%pageid%', '%ag%', '~', 'AND');
$search->addSort('%pageid%', false);
/** @var meta\Value[][] $result */
$result = $search->getRows();
$count = $search->getCount();
// check result dimensions
$this->assertEquals(12, $count, 'result count');
$this->assertCount(12, $result, 'result rows');
$this->assertCount(3, $result[0], 'result columns');
// check sorting
$this->assertEquals('page20', $result[0][0]->getValue());
$this->assertEquals('page19', $result[1][0]->getValue());
$this->assertEquals('page18', $result[2][0]->getValue());
// now with limit
// new search object because result is fetched only once
$search = new mock\Search();
$search->addSchema('schema2');
$search->addColumn('%pageid%');
$search->addColumn('afirst');
$search->addColumn('asecond');
$search->addFilter('%pageid%', '%ag%', '~', 'AND');
$search->addSort('%pageid%', false);
$search->setLimit(5);
/** @var meta\Value[][] $result */
$result = $search->getRows();
$count = $search->getCount();
// check result dimensions
$this->assertEquals(12, $count, 'result count'); // full result set
$this->assertCount(5, $result, 'result rows'); // wanted result set
// check the values
$this->assertEquals('page20', $result[0][0]->getValue());
$this->assertEquals('page16', $result[4][0]->getValue());
// now add offset
// again a new object
$search = new mock\Search();
$search->addSchema('schema2');
$search->addColumn('%pageid%');
$search->addColumn('afirst');
$search->addColumn('asecond');
$search->addFilter('%pageid%', '%ag%', '~', 'AND');
$search->addSort('%pageid%', false);
$search->setLimit(5);
$search->setOffset(5);
$result = $search->getRows();
$count = $search->getCount();
// check result dimensions
$this->assertEquals(12, $count, 'result count'); // full result set
$this->assertCount(5, $result, 'result rows'); // wanted result set
// check the values
$this->assertEquals('page15', $result[0][0]->getValue());
$this->assertEquals('page11', $result[4][0]->getValue());
}
public static function addFilter_testdata()
{
return [
['%pageid%', 'val', '<>', 'OR', [['%pageid%', 'val', '!=', 'OR']], false, 'replace <> comp'],
['%pageid%', 'val', '*~', 'OR', [['%pageid%', '%val%', 'LIKE', 'OR']], false, 'replace *~ comp'],
['%pageid%', 'val*', '~', 'OR', [['%pageid%', 'val%', 'LIKE', 'OR']], false, 'replace * in value'],
['%pageid%', 'val.*', '=*', 'OR', [['%pageid%', 'val.*', 'REGEXP', 'OR']], false, 'replace * in value'],
['nonexisting', 'val', '~', 'OR', [], false, 'ignore missing columns'],
['%pageid%', 'val', '?', 'OR', [], '\dokuwiki\plugin\struct\meta\StructException', 'wrong comperator'],
['%pageid%', 'val', '=', 'NOT', [], '\dokuwiki\plugin\struct\meta\StructException', 'wrong type']
];
}
/**
* @dataProvider addFilter_testdata
*
*/
public function test_addFilter($colname, $value, $comp, $type, $expected_filter, $expectException, $msg)
{
$search = new mock\Search();
$search->addSchema('schema2');
$search->addColumn('%pageid%');
if ($expectException !== false) $this->setExpectedException($expectException);
$search->addFilter($colname, $value, $comp, $type);
if (count($expected_filter) === 0) {
$this->assertCount(0, $search->filter, $msg);
return;
}
$this->assertEquals($expected_filter[0][0], $search->filter[0][0]->getLabel(), $msg);
$this->assertEquals($expected_filter[0][1], $search->filter[0][1], $msg);
$this->assertEquals($expected_filter[0][2], $search->filter[0][2], $msg);
$this->assertEquals($expected_filter[0][3], $search->filter[0][3], $msg);
}
public function test_wildcard()
{
$search = new mock\Search();
$search->addSchema('schema2', 'alias');
$search->addColumn('*');
$this->assertCount(4, $search->getColumns());
$search = new mock\Search();
$search->addSchema('schema2', 'alias');
$search->addColumn('schema2.*');
$this->assertCount(4, $search->getColumns());
$search = new mock\Search();
$search->addSchema('schema2', 'alias');
$search->addColumn('alias.*');
$this->assertCount(4, $search->getColumns());
$search = new mock\Search();
$search->addSchema('schema2', 'alias');
$search->addColumn('nope.*');
$this->assertCount(0, $search->getColumns());
}
public function test_filterValueList()
{
$search = new mock\Search();
//simple - single quote
$this->assertEquals(array('test'),
$this->callInaccessibleMethod($search, 'parseFilterValueList', array('("test")')));
//simple - double quote
$this->assertEquals(array('test'),
$this->callInaccessibleMethod($search, 'parseFilterValueList', array("('test')")));
//many elements
$this->assertEquals(array('test', 'test2', '18'),
$this->callInaccessibleMethod($search, 'parseFilterValueList', array('("test", \'test2\', 18)')));
$str = <<<'EOD'
("t\"est", 't\'est2', 18)
EOD;
//escape sequences
$this->assertEquals(array('t"est', "t'est2", '18'),
$this->callInaccessibleMethod($search, 'parseFilterValueList', array($str)));
//numbers
$this->assertEquals(array('18.7', '10e5', '-100'),
$this->callInaccessibleMethod($search, 'parseFilterValueList', array('(18.7, 10e5, -100)')));
}
}