tests/api/controllers/tags/GetTagNameTest.php

   1 <?php
   2
   3 namespace Shaarli\Api\Controllers;
   4
   5 use Shaarli\Config\ConfigManager;
   6
   7 use Slim\Container;
   8 use Slim\Http\Environment;
   9 use Slim\Http\Request;
  10 use Slim\Http\Response;
  11
  12 /**
  13  * Class GetTagNameTest
  14  *
  15  * Test getTag by tag name API service.
  16  *
  17  * @package Shaarli\Api\Controllers
  18  */
  19 class GetTagNameTest extends \PHPUnit_Framework_TestCase
  20 {
  21     /**
  22      * @var string datastore to test write operations
  23      */
  24     protected static $testDatastore = 'sandbox/datastore.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 Container instance.
  38      */
  39     protected $container;
  40
  41     /**
  42      * @var Tags controller instance.
  43      */
  44     protected $controller;
  45
  46     /**
  47      * Number of JSON fields per link.
  48      */
  49     const NB_FIELDS_TAG = 2;
  50
  51     /**
  52      * Before each test, instantiate a new Api with its config, plugins and links.
  53      */
  54     public function setUp()
  55     {
  56         $this->conf = new ConfigManager('tests/utils/config/configJson');
  57         $this->refDB = new \ReferenceLinkDB();
  58         $this->refDB->write(self::$testDatastore);
  59
  60         $this->container = new Container();
  61         $this->container['conf'] = $this->conf;
  62         $this->container['db'] = new \Shaarli\Bookmark\LinkDB(self::$testDatastore, true, false);
  63         $this->container['history'] = null;
  64
  65         $this->controller = new Tags($this->container);
  66     }
  67
  68     /**
  69      * After each test, remove the test datastore.
  70      */
  71     public function tearDown()
  72     {
  73         @unlink(self::$testDatastore);
  74     }
  75
  76     /**
  77      * Test basic getTag service: return gnu tag with 2 occurrences.
  78      */
  79     public function testGetTag()
  80     {
  81         $tagName = 'gnu';
  82         $env = Environment::mock([
  83             'REQUEST_METHOD' => 'GET',
  84         ]);
  85         $request = Request::createFromEnvironment($env);
  86
  87         $response = $this->controller->getTag($request, new Response(), ['tagName' => $tagName]);
  88         $this->assertEquals(200, $response->getStatusCode());
  89         $data = json_decode((string) $response->getBody(), true);
  90         $this->assertEquals(self::NB_FIELDS_TAG, count($data));
  91         $this->assertEquals($tagName, $data['name']);
  92         $this->assertEquals(2, $data['occurrences']);
  93     }
  94
  95     /**
  96      * Test getTag service which is not case sensitive: occurrences with both sTuff and stuff
  97      */
  98     public function testGetTagNotCaseSensitive()
  99     {
 100         $tagName = 'sTuff';
 101         $env = Environment::mock([
 102             'REQUEST_METHOD' => 'GET',
 103         ]);
 104         $request = Request::createFromEnvironment($env);
 105
 106         $response = $this->controller->getTag($request, new Response(), ['tagName' => $tagName]);
 107         $this->assertEquals(200, $response->getStatusCode());
 108         $data = json_decode((string) $response->getBody(), true);
 109         $this->assertEquals(self::NB_FIELDS_TAG, count($data));
 110         $this->assertEquals($tagName, $data['name']);
 111         $this->assertEquals(2, $data['occurrences']);
 112     }
 113
 114     /**
 115      * Test basic getTag service: get non existent tag => ApiTagNotFoundException.
 116      *
 117      * @expectedException Shaarli\Api\Exceptions\ApiTagNotFoundException
 118      * @expectedExceptionMessage Tag not found
 119      */
 120     public function testGetTag404()
 121     {
 122         $env = Environment::mock([
 123             'REQUEST_METHOD' => 'GET',
 124         ]);
 125         $request = Request::createFromEnvironment($env);
 126
 127         $this->controller->getTag($request, new Response(), ['tagName' => 'nopenope']);
 128     }
 129 }