Completed
Push — master ( ad5412...95547f )
by Joschi
03:34
created

ObjectRoutesTest::testListResponse()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 17
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 17
rs 9.4285
cc 1
eloc 9
nc 1
nop 0
1
<?php
2
3
/**
4
 * apparat-server
5
 *
6
 * @category    Apparat
7
 * @package     Apparat\Server
8
 * @subpackage  Apparat\Server\Tests
9
 * @author      Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
12
 */
13
14
/***********************************************************************************
15
 *  The MIT License (MIT)
16
 *
17
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18
 *
19
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
20
 *  this software and associated documentation files (the "Software"), to deal in
21
 *  the Software without restriction, including without limitation the rights to
22
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23
 *  the Software, and to permit persons to whom the Software is furnished to do so,
24
 *  subject to the following conditions:
25
 *
26
 *  The above copyright notice and this permission notice shall be included in all
27
 *  copies or substantial portions of the Software.
28
 *
29
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35
 ***********************************************************************************/
36
37
namespace Apparat\Server\Tests;
38
39
use Apparat\Kernel\Ports\Kernel;
40
use Apparat\Server\Infrastructure\Action\DayAction;
41
use Apparat\Server\Infrastructure\Action\ErrorAction;
42
use Apparat\Server\Infrastructure\Action\HourAction;
43
use Apparat\Server\Infrastructure\Action\MinuteAction;
44
use Apparat\Server\Infrastructure\Action\MonthAction;
45
use Apparat\Server\Infrastructure\Action\ObjectAction;
46
use Apparat\Server\Infrastructure\Action\ObjectsAction;
47
use Apparat\Server\Infrastructure\Action\SecondAction;
48
use Apparat\Server\Infrastructure\Action\TypeAction;
49
use Apparat\Server\Infrastructure\Action\YearAction;
50
use Apparat\Server\Infrastructure\Model\Server;
51
use Apparat\Server\Infrastructure\Route\AuraErrorRoute;
52
use Apparat\Server\Infrastructure\Route\AuraObjectRoute;
53
use Psr\Http\Message\ResponseInterface;
54
use Zend\Diactoros\ServerRequest;
55
use Zend\Diactoros\Uri;
56
57
/**
58
 * Default routes test
59
 *
60
 * @package Apparat\Server
61
 * @subpackage Apparat\Server\Tests
62
 */
63
class ObjectRoutesTest extends AbstractServerTest
64
{
65
    /**
66
     * Server instance
67
     *
68
     * @var Server
69
     */
70
    protected static $server = null;
71
    /**
72
     * Configured object date precision
73
     *
74
     * @var int
75
     */
76
    protected static $objectDatePrecision;
77
78
    /**
79
     * This method is called before the first test of this test class is run.
80
     *
81
     * @since Method available since Release 3.4.0
82
     */
83
    public static function setUpBeforeClass()
84
    {
85
        parent::setUpBeforeClass();
86
87
        self::$objectDatePrecision = intval(getenv('OBJECT_DATE_PRECISION'));
88
        putenv('OBJECT_DATE_PRECISION=6');
89
90
        self::$server = Kernel::create(Server::class);
91
92
        // Enable the object route
93
        self::$server->enableObjectRoute();
94
    }
95
96
    /**
97
     * This method is called after the last test of this test class is run.
98
     *
99
     * @since Method available since Release 3.4.0
100
     */
101
    public static function tearDownAfterClass()
102
    {
103
        parent::tearDownAfterClass();
104
        putenv('OBJECT_DATE_PRECISION='.self::$objectDatePrecision);
105
    }
106
107
    /**
108
     * Test dispatching default route requests to actions
109
     *
110
     * @dataProvider getObjectRouteRequestAction
111
     * @param string $request Server request
112
     * @param string $actionClass Action class
113
     */
114
    public function testObjectRouteAction($request, $actionClass)
115
    {
116
        $uri = new Uri($request);
117
        $request = new ServerRequest();
118
        $request = $request->withUri($uri);
119
120
        // Dispatch the route
121
        $route = self::$server->dispatchRequestToRoute($request);
122
        $this->assertInstanceOf(AuraObjectRoute::class, $route);
123
124
        // Get the associated action
125
        $action = self::$server->getRouteAction($request, $route);
126
        $this->assertInstanceOf($actionClass, $action);
127
    }
128
129
    /**
130
     * Provide default route requests and expected action classes
131
     */
132
    public function getObjectRouteRequestAction()
133
    {
134
        return [
135
            ['http://apparat/blog/2016', YearAction::class],
136
            ['http://apparat/blog/*', YearAction::class],
137
138
            ['http://apparat/blog/2016/06', MonthAction::class],
139
            ['http://apparat/blog/*/*', MonthAction::class],
140
141
            ['http://apparat/blog/2016/06/08', DayAction::class],
142
            ['http://apparat/blog/*/*/*', DayAction::class],
143
144
            ['http://apparat/blog/2016/06/08/19', HourAction::class],
145
            ['http://apparat/blog/*/*/*/*', HourAction::class],
146
147
            ['http://apparat/blog/2016/06/08/19/14', MinuteAction::class],
148
            ['http://apparat/blog/*/*/*/*/*', MinuteAction::class],
149
150
            ['http://apparat/blog/2016/06/08/19/14/52', SecondAction::class],
151
            ['http://apparat/blog/*/*/*/*/*/*', SecondAction::class],
152
153
            ['http://apparat/blog/2016/06/08/19/14/52/1', ObjectAction::class],
154
            ['http://apparat/blog/2016/06/08/19/14/52/.1', ObjectAction::class],
155
            ['http://apparat/blog/2016/06/08/19/14/52/~1', ObjectAction::class],
156
            ['http://apparat/blog/2016/06/08/19/14/52/1-article', ObjectAction::class],
157
            ['http://apparat/blog/2016/06/08/19/14/52/1-*', ObjectAction::class],
158
            ['http://apparat/blog/2016/06/08/19/14/52/.1-article', ObjectAction::class],
159
            ['http://apparat/blog/2016/06/08/19/14/52/~1-article', ObjectAction::class],
160
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/1', ObjectAction::class],
161
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/*', ObjectAction::class],
162
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/.1', ObjectAction::class],
163
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/.*', ObjectAction::class],
164
            ['http://apparat/blog/2016/06/08/19/14/52/1-*/1', ObjectAction::class],
165
            ['http://apparat/blog/2016/06/08/19/14/52/1-*/*', ObjectAction::class],
166
            ['http://apparat/blog/2016/06/08/19/14/52/1-*/.1', ObjectAction::class],
167
            ['http://apparat/blog/2016/06/08/19/14/52/1-*/.*', ObjectAction::class],
168
            ['http://apparat/blog/2016/06/08/19/14/52/1-*/~1', ObjectAction::class],
169
            ['http://apparat/blog/2016/06/08/19/14/52/1-*/~*', ObjectAction::class],
170
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/1-1', ObjectAction::class],
171
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/.1-1', ObjectAction::class],
172
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/~1-1', ObjectAction::class],
173
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/*-1', ObjectAction::class],
174
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/.*-1', ObjectAction::class],
175
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/~*-1', ObjectAction::class],
176
177
            ['http://apparat/blog/2016/06/08/19/14/52/*-article', TypeAction::class],
178
            ['http://apparat/blog/2016/06/08/19/14/52/.*-article', TypeAction::class],
179
            ['http://apparat/blog/2016/06/08/19/14/52/~*-article', TypeAction::class],
180
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/*', TypeAction::class],
181
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/.*', TypeAction::class],
182
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/~*', TypeAction::class],
183
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/*-1', TypeAction::class],
184
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/*-*', TypeAction::class],
185
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/.*-1', TypeAction::class],
186
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/.*-*', TypeAction::class],
187
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/~*-1', TypeAction::class],
188
            ['http://apparat/blog/2016/06/08/19/14/52/*-article/~*-*', TypeAction::class],
189
190
            ['http://apparat/blog/2016/06/08/19/14/52/*', ObjectsAction::class],
191
            ['http://apparat/blog/2016/06/08/19/14/52/*-*', ObjectsAction::class],
192
            ['http://apparat/blog/2016/06/08/19/14/52/.*', ObjectsAction::class],
193
            ['http://apparat/blog/2016/06/08/19/14/52/~*', ObjectsAction::class],
194
            ['http://apparat/blog/2016/06/08/19/14/52/*/*', ObjectsAction::class],
195
            ['http://apparat/blog/2016/06/08/19/14/52/*/.*', ObjectsAction::class],
196
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/*', ObjectsAction::class],
197
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/.*', ObjectsAction::class],
198
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/~*', ObjectsAction::class],
199
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/*-1', ObjectsAction::class],
200
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/*-*', ObjectsAction::class],
201
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/.*-1', ObjectsAction::class],
202
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/.*-*', ObjectsAction::class],
203
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/~*-1', ObjectsAction::class],
204
            ['http://apparat/blog/2016/06/08/19/14/52/*-*/~*-*', ObjectsAction::class],
205
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/1-*', ObjectsAction::class],
206
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/.1-*', ObjectsAction::class],
207
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/~1-*', ObjectsAction::class],
208
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/*-*', ObjectsAction::class],
209
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/.*-*', ObjectsAction::class],
210
            ['http://apparat/blog/2016/06/08/19/14/52/1-article/~*-*', ObjectsAction::class],
211
        ];
212
    }
213
214
    /**
215
     * Test an object route mismatch
216
     */
217
    public function testObjectRouteMismatch()
218
    {
219
        $uri = new Uri('http://apparat/blog/');
220
        $request = new ServerRequest();
221
        $request = $request->withUri($uri);
222
223
        // Dispatch the route
224
        $route = self::$server->dispatchRequestToRoute($request);
225
        $this->assertInstanceOf(AuraErrorRoute::class, $route);
226
227
        $action = self::$server->getRouteAction($request, $route);
228
        $this->assertInstanceOf(ErrorAction::class, $action);
229
    }
230
231
    /**
232
     * Test an object list response
233
     */
234
    public function testListResponse()
235
    {
236
        $uri = new Uri('http://apparat/blog/*/*/*/*/*/*/*');
237
        $request = new ServerRequest();
238
        $request = $request->withUri($uri);
239
240
        // Dispatch the route
241
        $route = self::$server->dispatchRequestToRoute($request);
242
        $this->assertInstanceOf(AuraObjectRoute::class, $route);
243
244
        // Resolve the route action
245
        $action = self::$server->getRouteAction($request, $route);
246
        $this->assertInstanceOf(ObjectsAction::class, $action);
247
248
        // Create the response
249
        $this->assertInstanceOf(ResponseInterface::class, $action());
250
    }
251
}
252