tests/api/controllers/tags/DeleteTagTest.php

   1 <?php
   2
   3
   4 namespace Shaarli\Api\Controllers;
   5
   6 use Shaarli\Bookmark\LinkDB;
   7 use Shaarli\Config\ConfigManager;
   8 use Shaarli\History;
   9 use Slim\Container;
  10 use Slim\Http\Environment;
  11 use Slim\Http\Request;
  12 use Slim\Http\Response;
  13
  14 class DeleteTagTest extends \PHPUnit\Framework\TestCase
  15 {
  16     /**
  17      * @var string datastore to test write operations
  18      */
  19     protected static $testDatastore = 'sandbox/datastore.php';
  20
  21     /**
  22      * @var string datastore to test write operations
  23      */
  24     protected static $testHistory = 'sandbox/history.php';
  25
  26     /**
  27      * @var ConfigManager instance
  28      */
  29     protected $conf;
  30
  31     /**
  32      * @var \ReferenceLinkDB instance.
  33      */
  34     protected $refDB = null;
  35
  36     /**
  37      * @var LinkDB instance.
  38      */
  39     protected $linkDB;
  40
  41     /**
  42      * @var HistoryController instance.
  43      */
  44     protected $history;
  45
  46     /**
  47      * @var Container instance.
  48      */
  49     protected $container;
  50
  51     /**
  52      * @var Tags controller instance.
  53      */
  54     protected $controller;
  55
  56     /**
  57      * Before each test, instantiate a new Api with its config, plugins and links.
  58      */
  59     public function setUp()
  60     {
  61         $this->conf = new ConfigManager('tests/utils/config/configJson');
  62         $this->refDB = new \ReferenceLinkDB();
  63         $this->refDB->write(self::$testDatastore);
  64         $this->linkDB = new LinkDB(self::$testDatastore, true, false);
  65         $refHistory = new \ReferenceHistory();
  66         $refHistory->write(self::$testHistory);
  67         $this->history = new History(self::$testHistory);
  68         $this->container = new Container();
  69         $this->container['conf'] = $this->conf;
  70         $this->container['db'] = $this->linkDB;
  71         $this->container['history'] = $this->history;
  72
  73         $this->controller = new Tags($this->container);
  74     }
  75
  76     /**
  77      * After each test, remove the test datastore.
  78      */
  79     public function tearDown()
  80     {
  81         @unlink(self::$testDatastore);
  82         @unlink(self::$testHistory);
  83     }
  84
  85     /**
  86      * Test DELETE tag endpoint: the tag should be removed.
  87      */
  88     public function testDeleteTagValid()
  89     {
  90         $tagName = 'gnu';
  91         $tags = $this->linkDB->linksCountPerTag();
  92         $this->assertTrue($tags[$tagName] > 0);
  93         $env = Environment::mock([
  94             'REQUEST_METHOD' => 'DELETE',
  95         ]);
  96         $request = Request::createFromEnvironment($env);
  97
  98         $response = $this->controller->deleteTag($request, new Response(), ['tagName' => $tagName]);
  99         $this->assertEquals(204, $response->getStatusCode());
 100         $this->assertEmpty((string) $response->getBody());
 101
 102         $this->linkDB = new LinkDB(self::$testDatastore, true, false);
 103         $tags = $this->linkDB->linksCountPerTag();
 104         $this->assertFalse(isset($tags[$tagName]));
 105
 106         // 2 links affected
 107         $historyEntry = $this->history->getHistory()[0];
 108         $this->assertEquals(History::UPDATED, $historyEntry['event']);
 109         $this->assertTrue(
 110             (new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
 111         );
 112         $historyEntry = $this->history->getHistory()[1];
 113         $this->assertEquals(History::UPDATED, $historyEntry['event']);
 114         $this->assertTrue(
 115             (new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
 116         );
 117     }
 118
 119     /**
 120      * Test DELETE tag endpoint: the tag should be removed.
 121      */
 122     public function testDeleteTagCaseSensitivity()
 123     {
 124         $tagName = 'sTuff';
 125         $tags = $this->linkDB->linksCountPerTag();
 126         $this->assertTrue($tags[$tagName] > 0);
 127         $env = Environment::mock([
 128             'REQUEST_METHOD' => 'DELETE',
 129         ]);
 130         $request = Request::createFromEnvironment($env);
 131
 132         $response = $this->controller->deleteTag($request, new Response(), ['tagName' => $tagName]);
 133         $this->assertEquals(204, $response->getStatusCode());
 134         $this->assertEmpty((string) $response->getBody());
 135
 136         $this->linkDB = new LinkDB(self::$testDatastore, true, false);
 137         $tags = $this->linkDB->linksCountPerTag();
 138         $this->assertFalse(isset($tags[$tagName]));
 139         $this->assertTrue($tags[strtolower($tagName)] > 0);
 140
 141         $historyEntry = $this->history->getHistory()[0];
 142         $this->assertEquals(History::UPDATED, $historyEntry['event']);
 143         $this->assertTrue(
 144             (new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
 145         );
 146     }
 147
 148     /**
 149      * Test DELETE tag endpoint: reach not existing tag.
 150      *
 151      * @expectedException Shaarli\Api\Exceptions\ApiTagNotFoundException
 152      * @expectedExceptionMessage Tag not found
 153      */
 154     public function testDeleteLink404()
 155     {
 156         $tagName = 'nopenope';
 157         $tags = $this->linkDB->linksCountPerTag();
 158         $this->assertFalse(isset($tags[$tagName]));
 159         $env = Environment::mock([
 160             'REQUEST_METHOD' => 'DELETE',
 161         ]);
 162         $request = Request::createFromEnvironment($env);
 163
 164         $this->controller->deleteTag($request, new Response(), ['tagName' => $tagName]);
 165     }
 166 }