Repository navigation
Expand file tree
/
Copy pathStateOperationMetadataTest.php
More file actions
244 lines (208 loc) · 14.5 KB
/
Copy pathStateOperationMetadataTest.php
File metadata and controls
244 lines (208 loc) · 14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<?php
/*
* This file is part of the Silverback API Components Bundle Project
*
* (c) Daniel West <daniel@silverback.is>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Silverback\ApiComponentsBundle\Tests\ApiPlatform\Metadata\Resource;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Operation\PathSegmentNameGeneratorInterface;
use ApiPlatform\Metadata\Operations;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Put;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use PHPUnit\Framework\TestCase;
use Silverback\ApiComponentsBundle\ApiPlatform\Metadata\Resource\ComponentResourceMetadataFactory;
use Silverback\ApiComponentsBundle\ApiPlatform\Metadata\Resource\UploadableResourceMetadataCollectionFactory;
use Silverback\ApiComponentsBundle\ApiPlatform\Metadata\Resource\UserResourceMetadataCollectionFactory;
use Silverback\ApiComponentsBundle\AttributeReader\UploadableAttributeReaderInterface;
use Silverback\ApiComponentsBundle\DataProcessor\StateProcessor\ComponentMoveStateProcessor;
use Silverback\ApiComponentsBundle\DataProvider\StateProvider\DownloadStateProvider;
use Silverback\ApiComponentsBundle\DataProvider\StateProvider\UploadStateProvider;
use Silverback\ApiComponentsBundle\Model\Component\ComponentMove;
use Silverback\ApiComponentsBundle\Tests\Functional\TestBundle\Entity\DummyComponent;
use Silverback\ApiComponentsBundle\Tests\Functional\TestBundle\Entity\DummyUploadable;
use Silverback\ApiComponentsBundle\Tests\Functional\TestBundle\Entity\User;
class StateOperationMetadataTest extends TestCase
{
public function test_the_usage_operation_is_named_after_its_key_so_providers_can_recognise_it(): void
{
$segments = $this->createStub(PathSegmentNameGeneratorInterface::class);
$segments->method('getSegmentName')->willReturn('dummy_components');
$factory = new ComponentResourceMetadataFactory($this->decorated(DummyComponent::class, 'DummyComponent'), $segments);
$operation = $factory->create(DummyComponent::class)->getOperation('_api_/dummy_components/{id}/usage_get_usage');
self::assertSame('_api_/dummy_components/{id}/usage_get_usage', $operation->getName());
self::assertSame('/dummy_components/{id}/usage', $operation->getUriTemplate());
self::assertSame(['public' => false, 'no_store' => true], $operation->getCacheHeaders());
self::assertSame('main_controller', $operation->getController());
self::assertSame("is_granted('ROLE_ADMIN')", $operation->getSecurity());
}
public function test_the_move_operation_is_a_post_of_a_move_under_the_components_iri_through_the_main_controller(): void
{
$segments = $this->createStub(PathSegmentNameGeneratorInterface::class);
$segments->method('getSegmentName')->willReturn('dummy_components');
$factory = new ComponentResourceMetadataFactory($this->decorated(DummyComponent::class, 'DummyComponent'), $segments);
$operation = $factory->create(DummyComponent::class)->getOperation('_api_/dummy_components/{id}/move_post_move');
self::assertInstanceOf(HttpOperation::class, $operation);
self::assertSame('_api_/dummy_components/{id}/move_post_move', $operation->getName());
self::assertSame('/dummy_components/{id}/move', $operation->getUriTemplate());
self::assertSame('POST', $operation->getMethod());
self::assertSame(200, $operation->getStatus());
self::assertSame(['id'], $operation->getUriVariables());
self::assertSame('main_controller', $operation->getController());
self::assertTrue($operation->canRead());
self::assertTrue($operation->canDeserialize());
self::assertTrue($operation->canValidate());
self::assertTrue($operation->canWrite());
self::assertSame(ComponentMove::class, $operation->getInput()['class'] ?? null);
self::assertSame(ComponentMove::class, $operation->getOutput()['class'] ?? null);
self::assertSame(['groups' => ['ComponentMove:read'], 'skip_null_values' => false], $operation->getNormalizationContext());
self::assertSame(['groups' => ['ComponentMove:write'], 'api_assign_object_to_populate' => false], $operation->getDenormalizationContext());
self::assertSame(ComponentMoveStateProcessor::class, $operation->getProcessor());
}
public function test_a_resource_that_is_not_a_component_gets_no_move_operation(): void
{
$segments = $this->createStub(PathSegmentNameGeneratorInterface::class);
$segments->method('getSegmentName')->willReturn('users');
$factory = new ComponentResourceMetadataFactory($this->decorated(User::class, 'User'), $segments);
self::assertSame(['item_get'], array_keys(iterator_to_array($factory->create(User::class)[0]->getOperations() ?? [])));
}
public function test_the_me_operation_keeps_the_controller_of_the_get_operation_it_is_made_from(): void
{
$factory = new UserResourceMetadataCollectionFactory($this->decorated(User::class, 'User'));
$operation = $factory->create(User::class)->getOperation('_api_me');
self::assertSame('_api_me', $operation->getName());
self::assertSame('main_controller', $operation->getController());
}
public function test_a_user_put_merges_into_the_stored_user_instead_of_replacing_it(): void
{
$get = new Get(uriTemplate: '/items/{id}', uriVariables: ['id'], shortName: 'User', class: User::class, name: 'item_get', extraProperties: ['kept' => 1]);
$put = new Put(uriTemplate: '/items/{id}', uriVariables: ['id'], shortName: 'User', class: User::class, name: 'item_put', extraProperties: ['kept' => 1, 'standard_put' => true]);
$decorated = $this->createStub(ResourceMetadataCollectionFactoryInterface::class);
$decorated->method('create')->willReturn(new ResourceMetadataCollection(User::class, [
(new ApiResource(shortName: 'User', class: User::class))->withOperations(new Operations(['item_get' => $get, 'item_put' => $put])),
]));
$factory = new UserResourceMetadataCollectionFactory($decorated);
$metadata = $factory->create(User::class);
self::assertSame(['kept' => 1, 'standard_put' => false], $metadata->getOperation('item_put')->getExtraProperties());
self::assertSame(['kept' => 1], $metadata->getOperation('item_get')->getExtraProperties());
}
public function test_a_put_on_a_resource_that_is_not_a_user_is_left_alone(): void
{
$put = new Put(uriTemplate: '/items/{id}', uriVariables: ['id'], shortName: 'DummyComponent', class: DummyComponent::class, name: 'item_put', extraProperties: ['standard_put' => true]);
$decorated = $this->createStub(ResourceMetadataCollectionFactoryInterface::class);
$decorated->method('create')->willReturn(new ResourceMetadataCollection(DummyComponent::class, [
(new ApiResource(shortName: 'DummyComponent', class: DummyComponent::class))->withOperations(new Operations(['item_put' => $put])),
]));
$factory = new UserResourceMetadataCollectionFactory($decorated);
self::assertSame(['standard_put' => true], $factory->create(DummyComponent::class)->getOperation('item_put')->getExtraProperties());
}
public function test_the_upload_and_download_operations_are_marked_for_their_providers_and_keep_the_main_controller(): void
{
$reader = $this->createStub(UploadableAttributeReaderInterface::class);
$reader->method('isConfigured')->willReturn(true);
$reader->method('getConfiguredProperties')->willReturn([]);
$segments = $this->createStub(PathSegmentNameGeneratorInterface::class);
$segments->method('getSegmentName')->willReturn('dummy_uploadables');
$factory = new UploadableResourceMetadataCollectionFactory($this->decorated(DummyUploadable::class, 'DummyUploadable', ['kept' => 1], [new Patch(uriTemplate: '/items/{id}', shortName: 'DummyUploadable', class: DummyUploadable::class, name: 'item_patch')]), $reader, $segments);
$metadata = $factory->create(DummyUploadable::class);
$upload = $metadata->getOperation('_api_/dummy_uploadables/{id}/upload_post');
$download = $metadata->getOperation('_api_/dummy_uploadables/{id}/download/{property}_get');
self::assertSame(['kept' => 1, UploadStateProvider::OPERATION_EXTRA_PROPERTY => true], $upload->getExtraProperties());
self::assertSame(['kept' => 1, DownloadStateProvider::OPERATION_EXTRA_PROPERTY => true], $download->getExtraProperties());
self::assertSame('main_controller', $upload->getController());
self::assertSame('main_controller', $download->getController());
self::assertFalse($upload->canDeserialize());
self::assertFalse($download->canSerialize());
}
public function test_the_upload_operation_takes_every_security_of_the_patch_operation_and_the_download_keeps_the_gets(): void
{
$metadata = $this->uploadableFactory([
self::securedGet(),
new Put(uriTemplate: '/items/{id}', shortName: 'DummyUploadable', class: DummyUploadable::class, name: 'item_put', security: 'put', securityMessage: 'put message'),
new Patch(uriTemplate: '/items/{id}', shortName: 'DummyUploadable', class: DummyUploadable::class, name: 'item_patch', security: 'patch', securityMessage: 'patch message', securityPostDenormalize: 'patch denormalize', securityPostDenormalizeMessage: 'patch denormalize message', securityPostValidation: 'patch validation', securityPostValidationMessage: 'patch validation message'),
])->create(DummyUploadable::class);
self::assertSame(['patch', 'patch message', 'patch denormalize', 'patch denormalize message', 'patch validation', 'patch validation message'], self::securityOf($metadata->getOperation(self::UPLOAD)));
self::assertSame(['get', 'get message', 'get denormalize', 'get denormalize message', 'get validation', 'get validation message'], self::securityOf($metadata->getOperation(self::DOWNLOAD)));
self::assertSame('/items/{id}/upload', $metadata->getOperation(self::UPLOAD)->getUriTemplate());
self::assertSame('POST', $metadata->getOperation(self::UPLOAD)->getMethod());
}
public function test_the_upload_operation_takes_the_put_operations_security_when_there_is_no_patch(): void
{
$metadata = $this->uploadableFactory([
self::securedGet(),
new Put(uriTemplate: '/items/{id}', shortName: 'DummyUploadable', class: DummyUploadable::class, name: 'item_put', security: 'put', securityMessage: 'put message'),
new Put(uriTemplate: '/other/{id}', shortName: 'DummyUploadable', class: DummyUploadable::class, name: 'other_put', security: 'other put'),
])->create(DummyUploadable::class);
self::assertSame(['put', 'put message', null, null, null, null], self::securityOf($metadata->getOperation(self::UPLOAD)));
}
public function test_a_resource_with_no_patch_or_put_gets_no_item_upload_operation_but_keeps_its_download(): void
{
$metadata = $this->uploadableFactory([self::securedGet()])->create(DummyUploadable::class);
self::assertSame(['item_get', self::DOWNLOAD], array_keys(iterator_to_array($metadata[0]->getOperations() ?? [])));
}
private const string UPLOAD = '_api_/items/{id}/upload_post';
private const string DOWNLOAD = '_api_/items/{id}/download/{property}_get';
private static function securedGet(): Get
{
return new Get(uriTemplate: '/items/{id}', uriVariables: ['id'], shortName: 'DummyUploadable', class: DummyUploadable::class, name: 'item_get', security: 'get', securityMessage: 'get message', securityPostDenormalize: 'get denormalize', securityPostDenormalizeMessage: 'get denormalize message', securityPostValidation: 'get validation', securityPostValidationMessage: 'get validation message');
}
/**
* @return list<string|\Stringable|null>
*/
private static function securityOf(Operation $operation): array
{
return [
$operation->getSecurity(),
$operation->getSecurityMessage(),
$operation->getSecurityPostDenormalize(),
$operation->getSecurityPostDenormalizeMessage(),
$operation->getSecurityPostValidation(),
$operation->getSecurityPostValidationMessage(),
];
}
/**
* @param list<HttpOperation> $operations
*/
private function uploadableFactory(array $operations): UploadableResourceMetadataCollectionFactory
{
$reader = $this->createStub(UploadableAttributeReaderInterface::class);
$reader->method('isConfigured')->willReturn(true);
$reader->method('getConfiguredProperties')->willReturn([]);
$segments = $this->createStub(PathSegmentNameGeneratorInterface::class);
$segments->method('getSegmentName')->willReturn('items');
$decorated = $this->createStub(ResourceMetadataCollectionFactoryInterface::class);
$named = [];
foreach ($operations as $operation) {
$named[(string) $operation->getName()] = $operation;
}
$decorated->method('create')->willReturn(new ResourceMetadataCollection(DummyUploadable::class, [
(new ApiResource(shortName: 'DummyUploadable', class: DummyUploadable::class))->withOperations(new Operations($named)),
]));
return new UploadableResourceMetadataCollectionFactory($decorated, $reader, $segments);
}
/**
* @param array<string, mixed> $extraProperties
* @param list<HttpOperation> $otherOperations
*/
private function decorated(string $class, string $shortName, array $extraProperties = [], array $otherOperations = []): ResourceMetadataCollectionFactoryInterface
{
$get = new Get(uriTemplate: '/items/{id}', uriVariables: ['id'], shortName: $shortName, class: $class, name: 'item_get', controller: 'main_controller', extraProperties: $extraProperties);
$operations = ['item_get' => $get];
foreach ($otherOperations as $operation) {
$operations[(string) $operation->getName()] = $operation;
}
$decorated = $this->createStub(ResourceMetadataCollectionFactoryInterface::class);
$decorated->method('create')->willReturn(new ResourceMetadataCollection($class, [
(new ApiResource(shortName: $shortName, class: $class))->withOperations(new Operations($operations)),
]));
return $decorated;
}
}