tests/api/controllers/PostLinkTest.php

   1 <?php
   2
   3 namespace Shaarli\Api\Controllers;
   4
   5
   6 use Shaarli\Config\ConfigManager;
   7 use Slim\Container;
   8 use Slim\Http\Environment;
   9 use Slim\Http\Request;
  10 use Slim\Http\Response;
  11
  12 /**
  13  * Class PostLinkTest
  14  *
  15  * Test POST Link REST API service.
  16  *
  17  * @package Shaarli\Api\Controllers
  18  */
  19 class PostLinkTest 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 Links controller instance.
  43      */
  44     protected $controller;
  45
  46     /**
  47      * Number of JSON field per link.
  48      */
  49     const NB_FIELDS_LINK = 9;
  50
  51     /**
  52      * Before every 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.json.php');
  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 \LinkDB(self::$testDatastore, true, false);
  63
  64         $this->controller = new Links($this->container);
  65
  66         $mock = $this->getMock('\Slim\Router', ['relativePathFor']);
  67         $mock->expects($this->any())
  68              ->method('relativePathFor')
  69              ->willReturn('api/v1/links/1');
  70
  71         // affect @property-read... seems to work
  72         $this->controller->getCi()->router = $mock;
  73
  74         // Used by index_url().
  75         $this->controller->getCi()['environment'] = [
  76             'SERVER_NAME' => 'domain.tld',
  77             'SERVER_PORT' => 80,
  78             'SCRIPT_NAME' => '/',
  79         ];
  80     }
  81
  82     /**
  83      * After every test, remove the test datastore.
  84      */
  85     public function tearDown()
  86     {
  87         @unlink(self::$testDatastore);
  88     }
  89
  90     /**
  91      * Test link creation without any field: creates a blank note.
  92      */
  93     public function testPostLinkMinimal()
  94     {
  95         $env = Environment::mock([
  96             'REQUEST_METHOD' => 'POST',
  97         ]);
  98
  99         $request = Request::createFromEnvironment($env);
 100
 101         $response = $this->controller->postLink($request, new Response());
 102         $this->assertEquals(201, $response->getStatusCode());
 103         $this->assertEquals('api/v1/links/1', $response->getHeader('Location')[0]);
 104         $data = json_decode((string) $response->getBody(), true);
 105         $this->assertEquals(self::NB_FIELDS_LINK, count($data));
 106         $this->assertEquals(43, $data['id']);
 107         $this->assertRegExp('/[\w-_]{6}/', $data['shorturl']);
 108         $this->assertEquals('http://domain.tld/?' . $data['shorturl'], $data['url']);
 109         $this->assertEquals('?' . $data['shorturl'], $data['title']);
 110         $this->assertEquals('', $data['description']);
 111         $this->assertEquals([], $data['tags']);
 112         $this->assertEquals(false, $data['private']);
 113         $this->assertTrue(new \DateTime('5 seconds ago') < \DateTime::createFromFormat(\DateTime::ATOM, $data['created']));
 114         $this->assertEquals('', $data['updated']);
 115     }
 116
 117     /**
 118      * Test link creation with all available fields.
 119      */
 120     public function testPostLinkFull()
 121     {
 122         $link = [
 123             'url' => 'website.tld/test?foo=bar',
 124             'title' => 'new entry',
 125             'description' => 'shaare description',
 126             'tags' => ['one', 'two'],
 127             'private' => true,
 128         ];
 129         $env = Environment::mock([
 130             'REQUEST_METHOD' => 'POST',
 131             'CONTENT_TYPE' => 'application/json'
 132         ]);
 133
 134         $request = Request::createFromEnvironment($env);
 135         $request = $request->withParsedBody($link);
 136         $response = $this->controller->postLink($request, new Response());
 137
 138         $this->assertEquals(201, $response->getStatusCode());
 139         $this->assertEquals('api/v1/links/1', $response->getHeader('Location')[0]);
 140         $data = json_decode((string) $response->getBody(), true);
 141         $this->assertEquals(self::NB_FIELDS_LINK, count($data));
 142         $this->assertEquals(43, $data['id']);
 143         $this->assertRegExp('/[\w-_]{6}/', $data['shorturl']);
 144         $this->assertEquals('http://' . $link['url'], $data['url']);
 145         $this->assertEquals($link['title'], $data['title']);
 146         $this->assertEquals($link['description'], $data['description']);
 147         $this->assertEquals($link['tags'], $data['tags']);
 148         $this->assertEquals(true, $data['private']);
 149         $this->assertTrue(new \DateTime('2 seconds ago') < \DateTime::createFromFormat(\DateTime::ATOM, $data['created']));
 150         $this->assertEquals('', $data['updated']);
 151     }
 152
 153     /**
 154      * Test link creation with an existing link (duplicate URL). Should return a 409 HTTP error and the existing link.
 155      */
 156     public function testPostLinkDuplicate()
 157     {
 158         $link = [
 159             'url' => 'mediagoblin.org/',
 160             'title' => 'new entry',
 161             'description' => 'shaare description',
 162             'tags' => ['one', 'two'],
 163             'private' => true,
 164         ];
 165         $env = Environment::mock([
 166             'REQUEST_METHOD' => 'POST',
 167             'CONTENT_TYPE' => 'application/json'
 168         ]);
 169
 170         $request = Request::createFromEnvironment($env);
 171         $request = $request->withParsedBody($link);
 172         $response = $this->controller->postLink($request, new Response());
 173
 174         $this->assertEquals(409, $response->getStatusCode());
 175         $data = json_decode((string) $response->getBody(), true);
 176         $this->assertEquals(self::NB_FIELDS_LINK, count($data));
 177         $this->assertEquals(7, $data['id']);
 178         $this->assertEquals('IuWvgA', $data['shorturl']);
 179         $this->assertEquals('http://mediagoblin.org/', $data['url']);
 180         $this->assertEquals('MediaGoblin', $data['title']);
 181         $this->assertEquals('A free software media publishing platform #hashtagOther', $data['description']);
 182         $this->assertEquals(['gnu', 'media', 'web', '.hidden', 'hashtag'], $data['tags']);
 183         $this->assertEquals(false, $data['private']);
 184         $this->assertEquals(
 185             \DateTime::createFromFormat(\LinkDB::LINK_DATE_FORMAT, '20130614_184135'),
 186             \DateTime::createFromFormat(\DateTime::ATOM, $data['created'])
 187         );
 188         $this->assertEquals(
 189             \DateTime::createFromFormat(\LinkDB::LINK_DATE_FORMAT, '20130615_184230'),
 190             \DateTime::createFromFormat(\DateTime::ATOM, $data['updated'])
 191         );
 192     }
 193 }