2016-10-13 05:53:30 +02:00
|
|
|
<?php
|
|
|
|
|
2016-10-14 03:30:05 +02:00
|
|
|
namespace SilverStripe\Dev\Tests;
|
|
|
|
|
2021-10-27 04:39:47 +02:00
|
|
|
use PHPUnit\Framework\ExpectationFailedException;
|
2016-10-13 05:53:30 +02:00
|
|
|
use SilverStripe\Dev\SapphireTest;
|
2017-09-27 09:25:37 +02:00
|
|
|
use SilverStripe\ORM\ArrayList;
|
2017-09-26 13:16:02 +02:00
|
|
|
use SilverStripe\Security\Member;
|
|
|
|
use SilverStripe\Security\Permission;
|
2024-09-18 03:53:44 +02:00
|
|
|
use PHPUnit\Framework\Attributes\DataProvider;
|
|
|
|
use PHPUnit\Framework\Attributes\DataProviderExternal;
|
|
|
|
use SilverStripe\Dev\Exceptions\ExpectedErrorException;
|
|
|
|
use SilverStripe\Dev\Exceptions\ExpectedNoticeException;
|
|
|
|
use SilverStripe\Dev\Exceptions\ExpectedWarningException;
|
2016-10-13 05:53:30 +02:00
|
|
|
|
2024-09-18 03:53:44 +02:00
|
|
|
/**
|
|
|
|
* @sometag This is a test annotation used in the testGetAnnotations test
|
|
|
|
*/
|
2016-10-13 05:53:30 +02:00
|
|
|
class SapphireTestTest extends SapphireTest
|
|
|
|
{
|
2017-09-27 09:25:37 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return array
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
public static function provideResolveFixturePath()
|
2017-09-27 09:25:37 +02:00
|
|
|
{
|
|
|
|
return [
|
2017-10-17 09:22:11 +02:00
|
|
|
'sameDirectory' => [
|
|
|
|
__DIR__ . '/CsvBulkLoaderTest.yml',
|
|
|
|
'./CsvBulkLoaderTest.yml',
|
|
|
|
'Could not resolve fixture path relative from same directory',
|
|
|
|
],
|
|
|
|
'filenameOnly' => [
|
|
|
|
__DIR__ . '/CsvBulkLoaderTest.yml',
|
|
|
|
'CsvBulkLoaderTest.yml',
|
|
|
|
'Could not resolve fixture path from filename only',
|
|
|
|
],
|
|
|
|
'parentPath' => [
|
|
|
|
dirname(__DIR__) . '/ORM/DataObjectTest.yml',
|
|
|
|
'../ORM/DataObjectTest.yml',
|
|
|
|
'Could not resolve fixture path from parent path',
|
|
|
|
],
|
|
|
|
'absolutePath' => [
|
|
|
|
dirname(__DIR__) . '/ORM/DataObjectTest.yml',
|
|
|
|
dirname(__DIR__) . '/ORM/DataObjectTest.yml',
|
|
|
|
'Could not relsolve fixture path from absolute path',
|
|
|
|
],
|
2017-09-27 09:25:37 +02:00
|
|
|
];
|
|
|
|
}
|
|
|
|
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProvider('provideResolveFixturePath')]
|
2017-10-17 09:22:11 +02:00
|
|
|
public function testResolveFixturePath($expected, $path, $message)
|
2016-12-16 05:34:21 +01:00
|
|
|
{
|
|
|
|
$this->assertEquals(
|
2017-09-27 09:25:37 +02:00
|
|
|
$expected,
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->resolveFixturePath($path),
|
|
|
|
$message
|
2016-12-16 05:34:21 +01:00
|
|
|
);
|
|
|
|
}
|
2017-09-26 13:16:02 +02:00
|
|
|
|
2017-09-27 09:25:37 +02:00
|
|
|
/**
|
|
|
|
* @useDatabase
|
|
|
|
*/
|
2017-09-26 13:16:02 +02:00
|
|
|
public function testActWithPermission()
|
|
|
|
{
|
|
|
|
$this->logOut();
|
|
|
|
$this->assertFalse(Permission::check('ADMIN'));
|
|
|
|
$this->actWithPermission('ADMIN', function () {
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertTrue(Permission::check('ADMIN'), 'Member should now have ADMIN role');
|
2017-09-26 13:16:02 +02:00
|
|
|
// check nested actAs calls work as expected
|
|
|
|
Member::actAs(null, function () {
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertFalse(Permission::check('ADMIN'), 'Member should not act as ADMIN any more after reset');
|
2017-09-26 13:16:02 +02:00
|
|
|
});
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2017-09-27 09:25:37 +02:00
|
|
|
/**
|
|
|
|
* @useDatabase
|
|
|
|
*/
|
2017-09-26 13:16:02 +02:00
|
|
|
public function testCreateMemberWithPermission()
|
|
|
|
{
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertEmpty(
|
|
|
|
Member::get()->filter(['Email' => 'TESTPERM@example.org']),
|
|
|
|
'DB should not have the test member created when the test starts'
|
|
|
|
);
|
2017-09-26 13:16:02 +02:00
|
|
|
$this->createMemberWithPermission('TESTPERM');
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertCount(
|
|
|
|
1,
|
|
|
|
Member::get()->filter(['Email' => 'TESTPERM@example.org']),
|
|
|
|
'Database should now contain the test member'
|
|
|
|
);
|
2017-09-27 09:25:37 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $match
|
|
|
|
* @param $itemsForList
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideAllMatchingList')]
|
2017-10-17 09:22:11 +02:00
|
|
|
public function testAssertListAllMatch($match, $itemsForList, $message)
|
2017-09-27 09:25:37 +02:00
|
|
|
{
|
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertListAllMatch($match, $list, $message);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* generate SS_List as this is not possible in dataProvider
|
|
|
|
*
|
|
|
|
* @param array $itemsForList
|
|
|
|
*
|
|
|
|
* @return ArrayList
|
|
|
|
*/
|
|
|
|
private function generateArrayListFromItems($itemsForList)
|
|
|
|
{
|
|
|
|
$list = ArrayList::create();
|
|
|
|
foreach ($itemsForList as $data) {
|
|
|
|
$list->push(Member::create($data));
|
|
|
|
}
|
|
|
|
return $list;
|
2017-09-27 09:25:37 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $match
|
|
|
|
* @param $itemsForList
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideNotMatchingList')]
|
2017-09-27 09:25:37 +02:00
|
|
|
public function testAssertListAllMatchFailsWhenNotMatchingAllItems($match, $itemsForList)
|
|
|
|
{
|
2021-10-27 04:39:47 +02:00
|
|
|
$this->expectException(ExpectationFailedException::class);
|
2017-09-27 09:25:37 +02:00
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
|
|
|
|
$this->assertListAllMatch($match, $list);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $matches
|
|
|
|
* @param $itemsForList
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideEqualListsWithEmptyList')]
|
2017-09-27 09:25:37 +02:00
|
|
|
public function testAssertListContains($matches, $itemsForList)
|
|
|
|
{
|
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
$list->push(Member::create(['FirstName' => 'Foo', 'Surname' => 'Foo']));
|
|
|
|
$list->push(Member::create(['FirstName' => 'Bar', 'Surname' => 'Bar']));
|
|
|
|
$list->push(Member::create(['FirstName' => 'Baz', 'Surname' => 'Baz']));
|
|
|
|
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertListContains($matches, $list, 'The list does not contain the expected items');
|
2017-09-27 09:25:37 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $matches
|
|
|
|
* @param $itemsForList array
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideNotContainingList')]
|
2017-09-27 09:25:37 +02:00
|
|
|
public function testAssertListContainsFailsIfListDoesNotContainMatch($matches, $itemsForList)
|
|
|
|
{
|
2021-10-27 04:39:47 +02:00
|
|
|
$this->expectException(ExpectationFailedException::class);
|
2017-09-27 09:25:37 +02:00
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
$list->push(Member::create(['FirstName' => 'Foo', 'Surname' => 'Foo']));
|
|
|
|
$list->push(Member::create(['FirstName' => 'Bar', 'Surname' => 'Bar']));
|
|
|
|
$list->push(Member::create(['FirstName' => 'Baz', 'Surname' => 'Baz']));
|
|
|
|
|
|
|
|
$this->assertListContains($matches, $list);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $matches
|
|
|
|
* @param $itemsForList
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideNotContainingList')]
|
2017-09-27 09:25:37 +02:00
|
|
|
public function testAssertListNotContains($matches, $itemsForList)
|
|
|
|
{
|
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertListNotContains($matches, $list, 'List contains forbidden items');
|
2017-09-27 09:25:37 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $matches
|
|
|
|
* @param $itemsForList
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideEqualLists')]
|
2017-09-27 09:25:37 +02:00
|
|
|
public function testAssertListNotContainsFailsWhenListContainsAMatch($matches, $itemsForList)
|
|
|
|
{
|
2021-10-27 04:39:47 +02:00
|
|
|
$this->expectException(ExpectationFailedException::class);
|
2017-09-27 09:25:37 +02:00
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
$list->push(Member::create(['FirstName' => 'Foo', 'Surname' => 'Foo']));
|
|
|
|
$list->push(Member::create(['FirstName' => 'Bar', 'Surname' => 'Bar']));
|
|
|
|
$list->push(Member::create(['FirstName' => 'Baz', 'Surname' => 'Baz']));
|
|
|
|
|
|
|
|
$this->assertListNotContains($matches, $list);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $matches
|
|
|
|
* @param $itemsForList
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideEqualListsWithEmptyList')]
|
2017-09-27 09:25:37 +02:00
|
|
|
public function testAssertListEquals($matches, $itemsForList)
|
|
|
|
{
|
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
|
2017-10-17 09:22:11 +02:00
|
|
|
$this->assertListEquals($matches, $list, 'Lists do not equal');
|
2017-09-27 09:25:37 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param $matches
|
|
|
|
* @param $itemsForList
|
|
|
|
*/
|
2024-09-18 03:53:44 +02:00
|
|
|
#[DataProviderExternal('\SilverStripe\Dev\Tests\SapphireTestTest\DataProvider', 'provideNonEqualLists')]
|
2017-09-27 09:25:37 +02:00
|
|
|
public function testAssertListEqualsFailsOnNonEqualLists($matches, $itemsForList)
|
|
|
|
{
|
2021-10-27 04:39:47 +02:00
|
|
|
$this->expectException(ExpectationFailedException::class);
|
2017-09-27 09:25:37 +02:00
|
|
|
$list = $this->generateArrayListFromItems($itemsForList);
|
|
|
|
|
|
|
|
$this->assertListEquals($matches, $list);
|
|
|
|
}
|
2024-09-18 03:53:44 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This test intentionally has non-sensical annotations to test the parser
|
|
|
|
*
|
|
|
|
* @lorem ipsum
|
|
|
|
* @param $one something
|
|
|
|
* @param $two else
|
|
|
|
*/
|
|
|
|
public function testGetAnnotations(): void
|
|
|
|
{
|
|
|
|
$this->assertSame([
|
|
|
|
'method' => [
|
|
|
|
'lorem' => [
|
|
|
|
'ipsum'
|
|
|
|
],
|
|
|
|
'param' => [
|
|
|
|
'$one something',
|
|
|
|
'$two else',
|
|
|
|
],
|
|
|
|
],
|
|
|
|
'class' => [
|
|
|
|
'sometag' => [
|
|
|
|
'This is a test annotation used in the testGetAnnotations test'
|
|
|
|
],
|
|
|
|
],
|
|
|
|
], $this->getAnnotations());
|
|
|
|
}
|
|
|
|
|
|
|
|
#[DataProvider('provideEnableErrorHandler')]
|
|
|
|
public function testEnableErrorHandler(int $errno, ?string $expectedClass): void
|
|
|
|
{
|
|
|
|
$this->enableErrorHandler();
|
|
|
|
$bool = false;
|
|
|
|
if ($expectedClass) {
|
|
|
|
$this->expectException($expectedClass);
|
|
|
|
$this->expectExceptionMessage('test');
|
|
|
|
}
|
|
|
|
if ($errno === E_USER_DEPRECATED) {
|
|
|
|
// Prevent deprecation notices from being displayed
|
|
|
|
set_error_handler(function ($errno, $errstr) use (&$bool) {
|
|
|
|
if ($errno === E_USER_DEPRECATED) {
|
|
|
|
$bool = true;
|
|
|
|
}
|
|
|
|
});
|
|
|
|
trigger_error('test', $errno);
|
|
|
|
}
|
|
|
|
trigger_error('test', $errno);
|
|
|
|
if ($errno === E_USER_DEPRECATED) {
|
|
|
|
restore_error_handler();
|
|
|
|
$this->assertTrue($bool);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
public static function provideEnableErrorHandler(): array
|
|
|
|
{
|
|
|
|
// Only E_USER_* errors can be triggered, so that's all that's being tested
|
|
|
|
return [
|
|
|
|
'error' => [
|
|
|
|
'errno' => E_USER_ERROR,
|
|
|
|
'expectedClass' => ExpectedErrorException::class,
|
|
|
|
],
|
|
|
|
'notice' => [
|
|
|
|
'errno' => E_USER_NOTICE,
|
|
|
|
'expectedClass' => ExpectedNoticeException::class,
|
|
|
|
],
|
|
|
|
'warning' => [
|
|
|
|
'errno' => E_USER_WARNING,
|
|
|
|
'expectedClass' => ExpectedWarningException::class,
|
|
|
|
],
|
|
|
|
'deprecated' => [
|
|
|
|
'errno' => E_USER_DEPRECATED,
|
|
|
|
'expectedClass' => null,
|
|
|
|
],
|
|
|
|
];
|
|
|
|
}
|
2016-10-13 05:53:30 +02:00
|
|
|
}
|