2017-05-06 17:32:16 +02:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Shaarli\Api\Controllers;
|
|
|
|
|
2020-09-26 14:18:01 +02:00
|
|
|
use malkusch\lock\mutex\NoMutex;
|
2020-01-17 21:34:12 +01:00
|
|
|
use Shaarli\Bookmark\BookmarkFileService;
|
2019-01-12 23:55:38 +01:00
|
|
|
use Shaarli\Bookmark\LinkDB;
|
2017-05-06 17:32:16 +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;
|
2017-05-06 17:32:16 +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 DeleteTagTest extends \Shaarli\TestCase
|
2017-05-06 17:32:16 +02:00
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var string datastore to test write operations
|
|
|
|
*/
|
|
|
|
protected static $testDatastore = 'sandbox/datastore.php';
|
|
|
|
|
2017-05-07 16:50:20 +02:00
|
|
|
/**
|
|
|
|
* @var string datastore to test write operations
|
|
|
|
*/
|
|
|
|
protected static $testHistory = 'sandbox/history.php';
|
|
|
|
|
2017-05-06 17:32:16 +02:00
|
|
|
/**
|
|
|
|
* @var ConfigManager instance
|
|
|
|
*/
|
|
|
|
protected $conf;
|
|
|
|
|
|
|
|
/**
|
2021-04-05 11:00:28 +02:00
|
|
|
* @var ReferenceLinkDB instance.
|
2017-05-06 17:32:16 +02:00
|
|
|
*/
|
|
|
|
protected $refDB = null;
|
|
|
|
|
|
|
|
/**
|
2020-01-17 21:34:12 +01:00
|
|
|
* @var BookmarkFileService instance.
|
2017-05-06 17:32:16 +02:00
|
|
|
*/
|
2020-01-17 21:34:12 +01:00
|
|
|
protected $bookmarkService;
|
2017-05-06 17:32:16 +02:00
|
|
|
|
2017-05-07 16:50:20 +02:00
|
|
|
/**
|
2019-01-12 23:55:38 +01:00
|
|
|
* @var HistoryController instance.
|
2017-05-07 16:50:20 +02:00
|
|
|
*/
|
|
|
|
protected $history;
|
|
|
|
|
2017-05-06 17:32:16 +02:00
|
|
|
/**
|
|
|
|
* @var Container instance.
|
|
|
|
*/
|
|
|
|
protected $container;
|
|
|
|
|
|
|
|
/**
|
2018-05-19 15:04:04 +02:00
|
|
|
* @var Tags controller instance.
|
2017-05-06 17:32:16 +02:00
|
|
|
*/
|
|
|
|
protected $controller;
|
|
|
|
|
2021-01-20 15:59:00 +01:00
|
|
|
/** @var PluginManager */
|
|
|
|
protected $pluginManager;
|
|
|
|
|
2020-09-26 14:18:01 +02:00
|
|
|
/** @var NoMutex */
|
|
|
|
protected $mutex;
|
|
|
|
|
2017-05-06 17:32:16 +02:00
|
|
|
/**
|
2020-01-17 21:34:12 +01:00
|
|
|
* Before each test, instantiate a new Api with its config, plugins and bookmarks.
|
2017-05-06 17:32:16 +02:00
|
|
|
*/
|
2020-09-26 15:08:39 +02:00
|
|
|
protected function setUp(): void
|
2017-05-06 17:32:16 +02:00
|
|
|
{
|
2020-09-26 14:18:01 +02:00
|
|
|
$this->mutex = new NoMutex();
|
2017-05-06 17:32:16 +02:00
|
|
|
$this->conf = new ConfigManager('tests/utils/config/configJson');
|
2020-01-17 21:34:12 +01:00
|
|
|
$this->conf->set('resource.datastore', self::$testDatastore);
|
2021-04-05 11:00:28 +02:00
|
|
|
$this->refDB = new ReferenceLinkDB();
|
2017-05-06 17:32:16 +02:00
|
|
|
$this->refDB->write(self::$testDatastore);
|
2021-04-05 11:00:28 +02:00
|
|
|
$refHistory = new ReferenceHistory();
|
2017-05-07 16:50:20 +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,
|
|
|
|
$this->mutex,
|
|
|
|
true
|
|
|
|
);
|
2020-01-17 21:34:12 +01:00
|
|
|
|
2017-05-06 17:32:16 +02:00
|
|
|
$this->container = new Container();
|
|
|
|
$this->container['conf'] = $this->conf;
|
2020-01-17 21:34:12 +01:00
|
|
|
$this->container['db'] = $this->bookmarkService;
|
2017-05-07 16:50:20 +02:00
|
|
|
$this->container['history'] = $this->history;
|
2017-05-06 17:32:16 +02:00
|
|
|
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->controller = new Tags($this->container);
|
2017-05-06 17:32:16 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* After each test, remove the test datastore.
|
|
|
|
*/
|
2020-09-26 15:08:39 +02:00
|
|
|
protected function tearDown(): void
|
2017-05-06 17:32:16 +02:00
|
|
|
{
|
|
|
|
@unlink(self::$testDatastore);
|
2017-05-07 16:50:20 +02:00
|
|
|
@unlink(self::$testHistory);
|
2017-05-06 17:32:16 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-05-19 15:04:04 +02:00
|
|
|
* Test DELETE tag endpoint: the tag should be removed.
|
2017-05-06 17:32:16 +02:00
|
|
|
*/
|
2018-05-19 15:04:04 +02:00
|
|
|
public function testDeleteTagValid()
|
2017-05-06 17:32:16 +02:00
|
|
|
{
|
2018-05-19 15:04:04 +02:00
|
|
|
$tagName = 'gnu';
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertTrue($tags[$tagName] > 0);
|
2017-05-06 17:32:16 +02:00
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'DELETE',
|
|
|
|
]);
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
|
2018-05-19 15:04:04 +02:00
|
|
|
$response = $this->controller->deleteTag($request, new Response(), ['tagName' => $tagName]);
|
2017-05-06 17:32:16 +02:00
|
|
|
$this->assertEquals(204, $response->getStatusCode());
|
|
|
|
$this->assertEmpty((string) $response->getBody());
|
|
|
|
|
2021-01-20 15:59:00 +01:00
|
|
|
$this->bookmarkService = new BookmarkFileService(
|
|
|
|
$this->conf,
|
|
|
|
$this->pluginManager,
|
|
|
|
$this->history,
|
|
|
|
$this->mutex,
|
|
|
|
true
|
|
|
|
);
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertFalse(isset($tags[$tagName]));
|
2017-05-07 16:50:20 +02:00
|
|
|
|
2020-01-17 21:34:12 +01:00
|
|
|
// 2 bookmarks affected
|
2017-05-07 16:50:20 +02:00
|
|
|
$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 DELETE tag endpoint: the tag should be removed.
|
|
|
|
*/
|
|
|
|
public function testDeleteTagCaseSensitivity()
|
|
|
|
{
|
|
|
|
$tagName = 'sTuff';
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertTrue($tags[$tagName] > 0);
|
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'DELETE',
|
|
|
|
]);
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
|
|
|
|
$response = $this->controller->deleteTag($request, new Response(), ['tagName' => $tagName]);
|
|
|
|
$this->assertEquals(204, $response->getStatusCode());
|
|
|
|
$this->assertEmpty((string) $response->getBody());
|
|
|
|
|
2021-01-20 15:59:00 +01:00
|
|
|
$this->bookmarkService = new BookmarkFileService(
|
|
|
|
$this->conf,
|
|
|
|
$this->pluginManager,
|
|
|
|
$this->history,
|
|
|
|
$this->mutex,
|
|
|
|
true
|
|
|
|
);
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertFalse(isset($tags[$tagName]));
|
|
|
|
$this->assertTrue($tags[strtolower($tagName)] > 0);
|
|
|
|
|
|
|
|
$historyEntry = $this->history->getHistory()[0];
|
2019-01-12 23:55:38 +01:00
|
|
|
$this->assertEquals(History::UPDATED, $historyEntry['event']);
|
2017-05-07 16:50:20 +02:00
|
|
|
$this->assertTrue(
|
|
|
|
(new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
|
|
|
|
);
|
2017-05-06 17:32:16 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-06-04 18:58:59 +02:00
|
|
|
* Test DELETE tag endpoint: reach not existing tag.
|
2017-05-06 17:32:16 +02:00
|
|
|
*/
|
|
|
|
public function testDeleteLink404()
|
|
|
|
{
|
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
|
|
|
$tagName = 'nopenope';
|
2020-01-17 21:34:12 +01:00
|
|
|
$tags = $this->bookmarkService->bookmarksCountPerTag();
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->assertFalse(isset($tags[$tagName]));
|
2017-05-06 17:32:16 +02:00
|
|
|
$env = Environment::mock([
|
|
|
|
'REQUEST_METHOD' => 'DELETE',
|
|
|
|
]);
|
|
|
|
$request = Request::createFromEnvironment($env);
|
|
|
|
|
2018-05-19 15:04:04 +02:00
|
|
|
$this->controller->deleteTag($request, new Response(), ['tagName' => $tagName]);
|
2017-05-06 17:32:16 +02:00
|
|
|
}
|
|
|
|
}
|