2018-05-19 15:04:04 +02:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Shaarli\Api\Controllers;
|
|
|
|
|
2020-09-26 14:18:01 +02:00
|
|
|
use malkusch\lock\mutex\NoMutex;
|
2018-05-19 15:04:04 +02:00
|
|
|
use Shaarli\Api\Exceptions\ApiBadParametersException;
|
2020-01-17 21:34:12 +01:00
|
|
|
use Shaarli\Bookmark\BookmarkFileService;
|
2019-01-12 23:55:38 +01:00
|
|
|
use Shaarli\Bookmark\LinkDB;
|
2018-05-19 15:04:04 +02:00
|
|
|
use Shaarli\Config\ConfigManager;
|
2019-01-12 23:55:38 +01:00
|
|
|
use Shaarli\History;
|
2021-01-20 15:59:00 +01:00
|
|
|
use Shaarli\Plugin\PluginManager;
|
2021-04-05 11:00:28 +02:00
|
|
|
use Shaarli\Tests\Utils\ReferenceHistory;
|
|
|
|
use Shaarli\Tests\Utils\ReferenceLinkDB;
|
2018-05-19 15:04:04 +02:00
|
|
|
use Slim\Container;
|
|
|
|
use Slim\Http\Environment;
|
|
|
|
use Slim\Http\Request;
|
|
|
|
use Slim\Http\Response;
|
|
|
|
|
2020-09-29 14:41:40 +02:00
|
|
|
class PutTagTest extends \Shaarli\TestCase
|
2018-05-19 15:04:04 +02:00
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var string datastore to test write operations
|
|
|
|
*/
|
|
|
|
protected static $testDatastore = 'sandbox/datastore.php';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string datastore to test write operations
|
|
|
|
*/
|
|
|
|
protected static $testHistory = 'sandbox/history.php';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var ConfigManager instance
|
|
|
|
*/
|
|
|
|
protected $conf;
|
|
|
|
|
|
|
|
/**
|
2021-04-05 11:00:28 +02:00
|
|
|
* @var ReferenceLinkDB instance.
|
2018-05-19 15:04:04 +02:00
|
|
|
*/
|
|
|
|
protected $refDB = null;
|
|
|
|
|
|
|
|
/**
|
2019-01-12 23:55:38 +01:00
|
|
|
* @var HistoryController instance.
|
2018-05-19 15:04:04 +02:00
|
|
|
*/
|
|
|
|
protected $history;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var Container instance.
|
|
|
|
*/
|
|
|
|
protected $container;
|
|
|
|
|
|
|
|
/**
|
2020-01-17 21:34:12 +01:00
|
|
|
* @var BookmarkFileService instance.
|
2018-05-19 15:04:04 +02:00
|
|
|
*/
|
2020-01-17 21:34:12 +01:00
|
|
|
protected $bookmarkService;
|
2018-05-19 15:04:04 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var Tags controller instance.
|
|
|
|
*/
|
|
|
|
protected $controller;
|
|
|
|
|
2021-01-20 15:59:00 +01:00
|
|
|
/** @var PluginManager */
|
|
|
|
protected $pluginManager;
|
|
|
|
|
2018-05-19 15:04:04 +02:00
|
|
|
/**
|
|
|
|
* Number of JSON field per link.
|
|
|
|
*/
|
2021-04-05 11:00:28 +02:00
|
|
|
protected const NB_FIELDS_TAG = 2;
|
2018-05-19 15:04:04 +02:00
|
|
|
|
|
|
|
/**
|
2020-01-17 21:34:12 +01:00
|
|
|
* Before every test, instantiate a new Api with its config, plugins and bookmarks.
|
2018-05-19 15:04:04 +02:00
|
|
|
*/
|
2020-09-26 15:08:39 +02:00
|
|
|
protected function setUp(): void
|
2018-05-19 15:04:04 +02:00
|
|
|
{
|
2020-09-26 14:18:01 +02:00
|
|
|
$mutex = new NoMutex();
|
2020-01-17 21:34:12 +01:00
|
|
|
$this->conf = new ConfigManager('tests/utils/config/configJson');
|
|
|
|
$this->conf->set('resource.datastore', self::$testDatastore);
|
2021-04-05 11:00:28 +02:00
|
|
|
$this->refDB = new ReferenceLinkDB();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->refDB->write(self::$testDatastore);
|
2021-04-05 11:00:28 +02:00
|
|
|
$refHistory = new ReferenceHistory();
|
2018-05-19 15:04:04 +02:00
|
|
|
$refHistory->write(self::$testHistory);
|
2019-01-12 23:55:38 +01:00
|
|
|
$this->history = new History(self::$testHistory);
|
2021-01-20 15:59:00 +01:00
|
|
|
$this->pluginManager = new PluginManager($this->conf);
|
|
|
|
$this->bookmarkService = new BookmarkFileService(
|
|
|
|
$this->conf,
|
|
|
|
$this->pluginManager,
|
|
|
|
$this->history,
|
|
|
|
$mutex,
|
|
|
|
true
|
|
|
|
);
|
2018-05-19 15:04:04 +02:00
|
|
|
|
|
|
|
$this->container = new Container();
|
|
|
|
$this->container['conf'] = $this->conf;
|
2020-01-17 21:34:12 +01:00
|
|
|
$this->container['db'] = $this->bookmarkService;
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->container['history'] = $this->history;
|
|
|
|
|
|
|
|
$this->controller = new Tags($this->container);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* After every test, remove the test datastore.
|
|
|
|
*/
|
2020-09-26 15:08:39 +02:00
|
|
|
protected function tearDown(): void
|
2018-05-19 15:04:04 +02:00
|
|
|
{
|
|
|
|
@unlink(self::$testDatastore);
|
|
|
|
@unlink(self::$testHistory);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test tags update
|
|
|
|
*/
|
|
|
|
public function testPutLinkValid()
|
|
|
|
{
|
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'PUT',
|
|
|
|
]);
|
|
|
|
$tagName = 'gnu';
|
|
|
|
$update = ['name' => $newName = 'newtag'];
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
$request = $request->withParsedBody($update);
|
|
|
|
|
|
|
|
$response = $this->controller->putTag($request, new Response(), ['tagName' => $tagName]);
|
|
|
|
$this->assertEquals(200, $response->getStatusCode());
|
|
|
|
$data = json_decode((string) $response->getBody(), true);
|
|
|
|
$this->assertEquals(self::NB_FIELDS_TAG, count($data));
|
|
|
|
$this->assertEquals($newName, $data['name']);
|
|
|
|
$this->assertEquals(2, $data['occurrences']);
|
|
|
|
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertNotTrue(isset($tags[$tagName]));
|
|
|
|
$this->assertEquals(2, $tags[$newName]);
|
|
|
|
|
|
|
|
$historyEntry = $this->history->getHistory()[0];
|
2019-01-12 23:55:38 +01:00
|
|
|
$this->assertEquals(History::UPDATED, $historyEntry['event']);
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertTrue(
|
|
|
|
(new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
|
|
|
|
);
|
|
|
|
$historyEntry = $this->history->getHistory()[1];
|
2019-01-12 23:55:38 +01:00
|
|
|
$this->assertEquals(History::UPDATED, $historyEntry['event']);
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertTrue(
|
|
|
|
(new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test tag update with an existing tag: they should be merged
|
|
|
|
*/
|
|
|
|
public function testPutTagMerge()
|
|
|
|
{
|
|
|
|
$tagName = 'gnu';
|
|
|
|
$newName = 'w3c';
|
|
|
|
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertEquals(1, $tags[$newName]);
|
|
|
|
$this->assertEquals(2, $tags[$tagName]);
|
|
|
|
|
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'PUT',
|
|
|
|
]);
|
|
|
|
$update = ['name' => $newName];
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
$request = $request->withParsedBody($update);
|
|
|
|
|
|
|
|
$response = $this->controller->putTag($request, new Response(), ['tagName' => $tagName]);
|
|
|
|
$this->assertEquals(200, $response->getStatusCode());
|
|
|
|
$data = json_decode((string) $response->getBody(), true);
|
|
|
|
$this->assertEquals(self::NB_FIELDS_TAG, count($data));
|
|
|
|
$this->assertEquals($newName, $data['name']);
|
|
|
|
$this->assertEquals(3, $data['occurrences']);
|
|
|
|
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertNotTrue(isset($tags[$tagName]));
|
|
|
|
$this->assertEquals(3, $tags[$newName]);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test tag update with an empty new tag name => ApiBadParametersException
|
|
|
|
*/
|
|
|
|
public function testPutTagEmpty()
|
|
|
|
{
|
2020-09-27 14:07:08 +02:00
|
|
|
$this->expectException(\Shaarli\Api\Exceptions\ApiBadParametersException::class);
|
|
|
|
$this->expectExceptionMessage('New tag name is required in the request body');
|
|
|
|
|
2018-05-19 15:04:04 +02:00
|
|
|
$tagName = 'gnu';
|
|
|
|
$newName = '';
|
|
|
|
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertEquals(2, $tags[$tagName]);
|
|
|
|
|
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'PUT',
|
|
|
|
]);
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
|
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'PUT',
|
|
|
|
]);
|
|
|
|
$update = ['name' => $newName];
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
$request = $request->withParsedBody($update);
|
|
|
|
|
|
|
|
try {
|
|
|
|
$this->controller->putTag($request, new Response(), ['tagName' => $tagName]);
|
|
|
|
} catch (ApiBadParametersException $e) {
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertEquals(2, $tags[$tagName]);
|
|
|
|
throw $e;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Test tag update on non existent tag => ApiTagNotFoundException.
|
|
|
|
*/
|
|
|
|
public function testPutTag404()
|
|
|
|
{
|
2020-09-27 14:07:08 +02:00
|
|
|
$this->expectException(\Shaarli\Api\Exceptions\ApiTagNotFoundException::class);
|
|
|
|
$this->expectExceptionMessage('Tag not found');
|
|
|
|
|
2018-05-19 15:04:04 +02:00
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'PUT',
|
|
|
|
]);
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
|
|
|
|
$this->controller->putTag($request, new Response(), ['tagName' => 'nopenope']);
|
|
|
|
}
|
|
|
|
}
|