Spaces:
No application file
No application file
File size: 10,297 Bytes
d2897cd |
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 |
<?php
declare(strict_types=1);
namespace Mautic\LeadBundle\Tests\Controller\Api;
use Doctrine\Common\Annotations\Annotation\IgnoreAnnotation;
use Mautic\CoreBundle\Test\MauticMysqlTestCase;
use PHPUnit\Framework\Assert;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* @IgnoreAnnotation("covers")
*/
final class FieldApiControllerFunctionalTest extends MauticMysqlTestCase
{
protected $useCleanupRollback = false;
protected function setUp(): void
{
$this->configParams['create_custom_field_in_background'] = 'testFieldApiEndpointsWithBackgroundProcessingEnabled' === $this->getName();
parent::setUp();
}
public function testCreatingMultiselectField(): void
{
$payload = [
'label' => 'Shops (TB)',
'alias' => 'shops',
'type' => 'multiselect',
'isPubliclyUpdatable' => true,
'isUniqueIdentifier' => false,
'properties' => [
'list' => [
['label' => 'label1', 'value' => 'value1'],
['label' => 'label2', 'value' => 'value2'],
],
],
];
$typeSafePayload = $this->generateTypeSafePayload($payload);
$this->client->request(Request::METHOD_POST, '/api/fields/contact/new', $typeSafePayload);
$clientResponse = $this->client->getResponse();
$fieldResponse = json_decode($clientResponse->getContent(), true);
Assert::assertSame(Response::HTTP_CREATED, $clientResponse->getStatusCode(), $clientResponse->getContent());
Assert::assertTrue($fieldResponse['field']['isPublished']);
Assert::assertGreaterThan(0, $fieldResponse['field']['id']);
Assert::assertSame($payload['label'], $fieldResponse['field']['label']);
Assert::assertSame($payload['alias'], $fieldResponse['field']['alias']);
Assert::assertSame($payload['type'], $fieldResponse['field']['type']);
Assert::assertSame($payload['isPubliclyUpdatable'], $fieldResponse['field']['isPubliclyUpdatable']);
Assert::assertSame($payload['isUniqueIdentifier'], $fieldResponse['field']['isUniqueIdentifier']);
Assert::assertSame($payload['properties'], $fieldResponse['field']['properties']);
// Cleanup
$this->client->request(Request::METHOD_DELETE, '/api/fields/contact/'.$fieldResponse['field']['id'].'/delete', $payload);
$clientResponse = $this->client->getResponse();
Assert::assertSame(Response::HTTP_OK, $clientResponse->getStatusCode(), $clientResponse->getContent());
}
/**
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::saveEntity
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::newEntityAction
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::editEntityAction
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::deleteEntityAction
* @covers \Mautic\LeadBundle\Field\Command\CreateCustomFieldCommand::execute
*/
public function testFieldApiEndpointsWithBackgroundProcessingEnabled(): void
{
$alias = uniqid('field');
$payload = $this->getCreatePayload($alias);
$id = $this->assertCreateResponse($payload, Response::HTTP_ACCEPTED);
// Test that the command will create the field
$commandTester = $this->testSymfonyCommand('mautic:custom-field:create-column', ['--id' => $id]);
$this->assertEquals(0, $commandTester->getStatusCode());
// Test fetching
$this->assertGetResponse($payload, $id);
// Test editing
$payload = $this->getEditPayload($id);
$this->assertPatchResponse($payload, $id, $alias);
// Test deleting
$this->assertDeleteResponse($payload, $id, $alias);
}
/**
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::saveEntity
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::newEntityAction
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::editEntityAction
* @covers \Mautic\LeadBundle\Controller\Api\FieldApiController::deleteEntityAction
*/
public function testFieldApiEndpointsWithBackgroundProcessingDisabled(): void
{
$alias = uniqid('field');
$payload = $this->getCreatePayload($alias);
$id = $this->assertCreateResponse($payload, Response::HTTP_CREATED);
// Test fetching
$this->assertGetResponse($payload, $id);
// Test editing
$payload = $this->getEditPayload($id);
$this->assertPatchResponse($payload, $id, $alias);
// Test deleting
$this->assertDeleteResponse($payload, $id, $alias);
}
private function assertCreateResponse(array $payload, int $expectedStatusCode): int
{
// Test creating a new field
$typeSafePayload = $this->generateTypeSafePayload($payload);
$this->client->request('POST', '/api/fields/contact/new', $typeSafePayload);
$clientResponse = $this->client->getResponse();
$response = json_decode($clientResponse->getContent(), true);
// should be "accepted" if pushed to the background; otherwise "created"
$this->assertEquals($expectedStatusCode, $clientResponse->getStatusCode());
// Assert that the fields returned are what is expected
foreach ($payload as $key => $value) {
$this->assertTrue(isset($response['field'][$key]));
if (Response::HTTP_ACCEPTED === $expectedStatusCode && 'isPublished' === $key) {
// This should be false because the background job publishes once ready
$this->assertEquals(false, $response['field'][$key]);
continue;
}
$this->assertEquals($value, $response['field'][$key]);
}
return $response['field']['id'];
}
private function assertGetResponse(array $payload, int $id): void
{
// Test get and that the field was published
$this->client->request('GET', sprintf('/api/fields/contact/%s', $id));
$clientResponse = $this->client->getResponse();
$response = json_decode($clientResponse->getContent(), true);
$this->assertEquals(Response::HTTP_OK, $clientResponse->getStatusCode());
// Assert that the fields returned are what is expected and the field is now published
foreach ($payload as $key => $value) {
$this->assertTrue(isset($response['field'][$key]));
$this->assertEquals($value, $response['field'][$key]);
}
}
private function assertPatchResponse(array $payload, int $id, string $alias): void
{
$typeSafePayload = $this->generateTypeSafePayload($payload);
$this->client->request('PATCH', sprintf('/api/fields/contact/%s/edit', $id), $typeSafePayload);
$clientResponse = $this->client->getResponse();
$this->assertEquals(Response::HTTP_OK, $clientResponse->getStatusCode());
$response = json_decode($clientResponse->getContent(), true);
// Assert that the fields returned are what is expected noting that certain fields should not be editable
foreach ($payload as $key => $value) {
$this->assertTrue(isset($response['field'][$key]));
match ($key) {
'alias' => $this->assertEquals($alias, $response['field'][$key]),
'object' => $this->assertEquals('lead', $response['field'][$key]),
'type' => $this->assertEquals('text', $response['field'][$key]),
default => $this->assertEquals($value, $response['field'][$key]),
};
}
}
private function assertDeleteResponse(array $payload, int $id, string $alias): void
{
// Test the field is deleted
$this->client->request('DELETE', sprintf('/api/fields/contact/%s/delete', $id));
$clientResponse = $this->client->getResponse();
$this->assertEquals(Response::HTTP_OK, $clientResponse->getStatusCode());
$response = json_decode($clientResponse->getContent(), true);
// Assert that the fields returned are what is expected
foreach ($payload as $key => $value) {
// use array has key because ID will now be null
$this->assertArrayHasKey($key, $response['field']);
match ($key) {
'id' => $this->assertNull($response['field'][$key]),
'alias' => $this->assertEquals($alias, $response['field'][$key]),
'object' => $this->assertEquals('lead', $response['field'][$key]),
'type' => $this->assertEquals('text', $response['field'][$key]),
default => $this->assertEquals($value, $response['field'][$key]),
};
}
}
private function getCreatePayload(string $alias): array
{
return [
'isPublished' => true,
'label' => 'New Field',
'alias' => $alias,
'type' => 'text',
'group' => 'core',
'object' => 'lead',
'defaultValue' => 'foobar',
'isRequired' => true,
'isPubliclyUpdatable' => true,
'isUniqueIdentifier' => true,
'isVisible' => false,
'isListable' => false,
'properties' => [],
];
}
private function getEditPayload(int $id): array
{
return [
'id' => $id,
'label' => 'Foo Bar',
'alias' => 'should_not_change',
'type' => 'text',
'group' => 'core',
'object' => 'company',
'defaultValue' => 'foobar',
'isRequired' => false,
'isPubliclyUpdatable' => false,
'isUniqueIdentifier' => false,
'isVisible' => true,
'isListable' => true,
'properties' => [],
];
}
}
|