tests/api/controllers/history/HistoryTest.php

   1 <?php
   2
   3
   4 namespace Shaarli\Api\Controllers;
   5
   6
   7 use Shaarli\Config\ConfigManager;
   8 use Slim\Container;
   9 use Slim\Http\Environment;
  10 use Slim\Http\Request;
  11 use Slim\Http\Response;
  12
  13 require_once 'tests/utils/ReferenceHistory.php';
  14
  15 class HistoryTest extends \PHPUnit_Framework_TestCase
  16 {
  17     /**
  18      * @var string datastore to test write operations
  19      */
  20     protected static $testHistory = 'sandbox/history.php';
  21
  22     /**
  23      * @var ConfigManager instance
  24      */
  25     protected $conf;
  26
  27     /**
  28      * @var \ReferenceHistory instance.
  29      */
  30     protected $refHistory = null;
  31
  32     /**
  33      * @var Container instance.
  34      */
  35     protected $container;
  36
  37     /**
  38      * @var History controller instance.
  39      */
  40     protected $controller;
  41
  42     /**
  43      * Before every test, instantiate a new Api with its config, plugins and links.
  44      */
  45     public function setUp()
  46     {
  47         $this->conf = new ConfigManager('tests/utils/config/configJson.json.php');
  48         $this->refHistory = new \ReferenceHistory();
  49         $this->refHistory->write(self::$testHistory);
  50         $this->container = new Container();
  51         $this->container['conf'] = $this->conf;
  52         $this->container['db'] = true;
  53         $this->container['history'] = new \History(self::$testHistory);
  54
  55         $this->controller = new History($this->container);
  56     }
  57
  58     /**
  59      * After every test, remove the test datastore.
  60      */
  61     public function tearDown()
  62     {
  63         @unlink(self::$testHistory);
  64     }
  65
  66     /**
  67      * Test /history service without parameter.
  68      */
  69     public function testGetHistory()
  70     {
  71         $env = Environment::mock([
  72             'REQUEST_METHOD' => 'GET',
  73         ]);
  74         $request = Request::createFromEnvironment($env);
  75
  76         $response = $this->controller->getHistory($request, new Response());
  77         $this->assertEquals(200, $response->getStatusCode());
  78         $data = json_decode((string) $response->getBody(), true);
  79
  80         $this->assertEquals($this->refHistory->count(), count($data));
  81
  82         $this->assertEquals(\History::DELETED, $data[0]['event']);
  83         $this->assertEquals(
  84             \DateTime::createFromFormat('Ymd_His', '20170303_121216')->format(\DateTime::ATOM),
  85             $data[0]['datetime']
  86         );
  87         $this->assertEquals(124, $data[0]['id']);
  88
  89         $this->assertEquals(\History::SETTINGS, $data[1]['event']);
  90         $this->assertEquals(
  91             \DateTime::createFromFormat('Ymd_His', '20170302_121215')->format(\DateTime::ATOM),
  92             $data[1]['datetime']
  93         );
  94         $this->assertNull($data[1]['id']);
  95
  96         $this->assertEquals(\History::UPDATED, $data[2]['event']);
  97         $this->assertEquals(
  98             \DateTime::createFromFormat('Ymd_His', '20170301_121214')->format(\DateTime::ATOM),
  99             $data[2]['datetime']
 100         );
 101         $this->assertEquals(123, $data[2]['id']);
 102
 103         $this->assertEquals(\History::CREATED, $data[3]['event']);
 104         $this->assertEquals(
 105             \DateTime::createFromFormat('Ymd_His', '20170201_121214')->format(\DateTime::ATOM),
 106             $data[3]['datetime']
 107         );
 108         $this->assertEquals(124, $data[3]['id']);
 109
 110         $this->assertEquals(\History::CREATED, $data[4]['event']);
 111         $this->assertEquals(
 112             \DateTime::createFromFormat('Ymd_His', '20170101_121212')->format(\DateTime::ATOM),
 113             $data[4]['datetime']
 114         );
 115         $this->assertEquals(123, $data[4]['id']);
 116     }
 117
 118     /**
 119      * Test /history service with limit parameter.
 120      */
 121     public function testGetHistoryLimit()
 122     {
 123         $env = Environment::mock([
 124             'REQUEST_METHOD' => 'GET',
 125             'QUERY_STRING' => 'limit=1'
 126         ]);
 127         $request = Request::createFromEnvironment($env);
 128
 129         $response = $this->controller->getHistory($request, new Response());
 130         $this->assertEquals(200, $response->getStatusCode());
 131         $data = json_decode((string) $response->getBody(), true);
 132
 133         $this->assertEquals(1, count($data));
 134
 135         $this->assertEquals(\History::DELETED, $data[0]['event']);
 136         $this->assertEquals(
 137             \DateTime::createFromFormat('Ymd_His', '20170303_121216')->format(\DateTime::ATOM),
 138             $data[0]['datetime']
 139         );
 140         $this->assertEquals(124, $data[0]['id']);
 141     }
 142
 143     /**
 144      * Test /history service with offset parameter.
 145      */
 146     public function testGetHistoryOffset()
 147     {
 148         $env = Environment::mock([
 149             'REQUEST_METHOD' => 'GET',
 150             'QUERY_STRING' => 'offset=4'
 151         ]);
 152         $request = Request::createFromEnvironment($env);
 153
 154         $response = $this->controller->getHistory($request, new Response());
 155         $this->assertEquals(200, $response->getStatusCode());
 156         $data = json_decode((string) $response->getBody(), true);
 157
 158         $this->assertEquals(1, count($data));
 159
 160         $this->assertEquals(\History::CREATED, $data[0]['event']);
 161         $this->assertEquals(
 162             \DateTime::createFromFormat('Ymd_His', '20170101_121212')->format(\DateTime::ATOM),
 163             $data[0]['datetime']
 164         );
 165         $this->assertEquals(123, $data[0]['id']);
 166     }
 167
 168     /**
 169      * Test /history service with since parameter.
 170      */
 171     public function testGetHistorySince()
 172     {
 173         $env = Environment::mock([
 174             'REQUEST_METHOD' => 'GET',
 175             'QUERY_STRING' => 'since=2017-03-03T00:00:00%2B00:00'
 176         ]);
 177         $request = Request::createFromEnvironment($env);
 178
 179         $response = $this->controller->getHistory($request, new Response());
 180         $this->assertEquals(200, $response->getStatusCode());
 181         $data = json_decode((string) $response->getBody(), true);
 182
 183         $this->assertEquals(1, count($data));
 184
 185         $this->assertEquals(\History::DELETED, $data[0]['event']);
 186         $this->assertEquals(
 187             \DateTime::createFromFormat('Ymd_His', '20170303_121216')->format(\DateTime::ATOM),
 188             $data[0]['datetime']
 189         );
 190         $this->assertEquals(124, $data[0]['id']);
 191     }
 192
 193     /**
 194      * Test /history service with since parameter.
 195      */
 196     public function testGetHistorySinceOffsetLimit()
 197     {
 198         $env = Environment::mock([
 199             'REQUEST_METHOD' => 'GET',
 200             'QUERY_STRING' => 'since=2017-02-01T00:00:00%2B00:00&offset=1&limit=1'
 201         ]);
 202         $request = Request::createFromEnvironment($env);
 203
 204         $response = $this->controller->getHistory($request, new Response());
 205         $this->assertEquals(200, $response->getStatusCode());
 206         $data = json_decode((string) $response->getBody(), true);
 207
 208         $this->assertEquals(1, count($data));
 209
 210         $this->assertEquals(\History::SETTINGS, $data[0]['event']);
 211         $this->assertEquals(
 212             \DateTime::createFromFormat('Ymd_His', '20170302_121215')->format(\DateTime::ATOM),
 213             $data[0]['datetime']
 214         );
 215     }
 216 }