mirror/php-flarum
1
0
Fork 0
mirror of https://github.com/flarum/core.git synced 2025-06-10 00:25:07 +02:00
Code Issues Releases Wiki Activity

Improve ApiSerializer tests (#2733)

Browse Source 
The ApiSerializerTest was added before the ApiController extender, so I used a workaround at the time to check for the existence of the relationships on the serializer.
This commit is contained in:
Sami Mazouz 2021-03-23 22:33:51 +01:00 committed by GitHub
parent 706eaeda41
commit d642fb531c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 90 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
tests/integration/extenders/ApiSerializerTest.php
View File

@ -10,6 +10,7 @@
namespace Flarum\Tests\integration\extenders; namespace Flarum\Tests\integration\extenders;
use Carbon\Carbon; use Carbon\Carbon;
use Flarum\Api\Controller\ShowUserController;
use Flarum\Api\Serializer\AbstractSerializer; use Flarum\Api\Serializer\AbstractSerializer;
use Flarum\Api\Serializer\BasicUserSerializer; use Flarum\Api\Serializer\BasicUserSerializer;
use Flarum\Api\Serializer\DiscussionSerializer; use Flarum\Api\Serializer\DiscussionSerializer;
@ -320,6 +321,29 @@ class ApiSerializerTest extends TestCase
$this->assertEquals('newValue', $payload['data']['attributes']['someOtherCustomAttribute']); $this->assertEquals('newValue', $payload['data']['attributes']['someOtherCustomAttribute']);
} }
/**
* @test
*/
public function custom_relations_dont_exist_by_default()
{
$this->extend(
(new Extend\ApiController(ShowUserController::class))
->addInclude(['customSerializerRelation', 'postCustomRelation', 'anotherCustomRelation'])
);
$response = $this->send(
$this->request('GET', '/api/users/2', [
'authenticatedAs' => 1,
])
);
$responseJson = json_decode($response->getBody(), true);
$this->assertArrayNotHasKey('customSerializerRelation', $responseJson['data']['relationships']);
$this->assertArrayNotHasKey('postCustomRelation', $responseJson['data']['relationships']);
$this->assertArrayNotHasKey('anotherCustomRelation', $responseJson['data']['relationships']);
}
/** /**
* @test * @test
*/ */
@ -329,20 +353,21 @@ class ApiSerializerTest extends TestCase
(new Extend\Model(User::class)) (new Extend\Model(User::class))
->hasMany('customSerializerRelation', Discussion::class, 'user_id'), ->hasMany('customSerializerRelation', Discussion::class, 'user_id'),
(new Extend\ApiSerializer(UserSerializer::class)) (new Extend\ApiSerializer(UserSerializer::class))
->hasMany('customSerializerRelation', DiscussionSerializer::class) ->hasMany('customSerializerRelation', DiscussionSerializer::class),
(new Extend\ApiController(ShowUserController::class))
->addInclude('customSerializerRelation')
); );
$request = $this->request('GET', '/api/users/2', [ $response = $this->send(
$this->request('GET', '/api/users/2', [
'authenticatedAs' => 1, 'authenticatedAs' => 1,
]); ])
);
$serializer = $this->app()->getContainer()->make(UserSerializer::class); $responseJson = json_decode($response->getBody(), true);
$serializer->setRequest($request);
$relationship = $serializer->getRelationship(User::find(2), 'customSerializerRelation'); $this->assertArrayHasKey('customSerializerRelation', $responseJson['data']['relationships']);
$this->assertCount(3, $responseJson['data']['relationships']['customSerializerRelation']['data']);
$this->assertNotEmpty($relationship);
$this->assertCount(3, $relationship->toArray()['data']);
} }
/** /**
@ -354,20 +379,21 @@ class ApiSerializerTest extends TestCase
(new Extend\Model(User::class)) (new Extend\Model(User::class))
->hasOne('customSerializerRelation', Discussion::class, 'user_id'), ->hasOne('customSerializerRelation', Discussion::class, 'user_id'),
(new Extend\ApiSerializer(UserSerializer::class)) (new Extend\ApiSerializer(UserSerializer::class))
->hasOne('customSerializerRelation', DiscussionSerializer::class) ->hasOne('customSerializerRelation', DiscussionSerializer::class),
(new Extend\ApiController(ShowUserController::class))
->addInclude('customSerializerRelation')
); );
$request = $this->request('GET', '/api/users/2', [ $response = $this->send(
$this->request('GET', '/api/users/2', [
'authenticatedAs' => 1, 'authenticatedAs' => 1,
]); ])
);
$serializer = $this->app()->getContainer()->make(UserSerializer::class); $responseJson = json_decode($response->getBody(), true);
$serializer->setRequest($request);
$relationship = $serializer->getRelationship(User::find(2), 'customSerializerRelation'); $this->assertArrayHasKey('customSerializerRelation', $responseJson['data']['relationships']);
$this->assertEquals('discussions', $responseJson['data']['relationships']['customSerializerRelation']['data']['type']);
$this->assertNotEmpty($relationship);
$this->assertEquals('discussions', $relationship->toArray()['data']['type']);
} }
/** /**
@ -381,20 +407,21 @@ class ApiSerializerTest extends TestCase
(new Extend\ApiSerializer(UserSerializer::class)) (new Extend\ApiSerializer(UserSerializer::class))
->relationship('customSerializerRelation', function (AbstractSerializer $serializer, $model) { ->relationship('customSerializerRelation', function (AbstractSerializer $serializer, $model) {
return $serializer->hasOne($model, DiscussionSerializer::class, 'customSerializerRelation'); return $serializer->hasOne($model, DiscussionSerializer::class, 'customSerializerRelation');
}) }),
(new Extend\ApiController(ShowUserController::class))
->addInclude('customSerializerRelation')
); );
$request = $this->request('GET', '/api/users/2', [ $response = $this->send(
$this->request('GET', '/api/users/2', [
'authenticatedAs' => 1, 'authenticatedAs' => 1,
]); ])
);
$serializer = $this->app()->getContainer()->make(UserSerializer::class); $responseJson = json_decode($response->getBody(), true);
$serializer->setRequest($request);
$relationship = $serializer->getRelationship(User::find(2), 'customSerializerRelation'); $this->assertArrayHasKey('customSerializerRelation', $responseJson['data']['relationships']);
$this->assertEquals('discussions', $responseJson['data']['relationships']['customSerializerRelation']['data']['type']);
$this->assertNotEmpty($relationship);
$this->assertEquals('discussions', $relationship->toArray()['data']['type']);
} }
/** /**
@ -406,20 +433,21 @@ class ApiSerializerTest extends TestCase
(new Extend\Model(User::class)) (new Extend\Model(User::class))
->hasOne('customSerializerRelation', Discussion::class, 'user_id'), ->hasOne('customSerializerRelation', Discussion::class, 'user_id'),
(new Extend\ApiSerializer(UserSerializer::class)) (new Extend\ApiSerializer(UserSerializer::class))
->relationship('customSerializerRelation', CustomRelationshipInvokableClass::class) ->relationship('customSerializerRelation', CustomRelationshipInvokableClass::class),
(new Extend\ApiController(ShowUserController::class))
->addInclude('customSerializerRelation')
); );
$request = $this->request('GET', '/api/users/2', [ $response = $this->send(
$this->request('GET', '/api/users/2', [
'authenticatedAs' => 1, 'authenticatedAs' => 1,
]); ])
);
$serializer = $this->app()->getContainer()->make(UserSerializer::class); $responseJson = json_decode($response->getBody(), true);
$serializer->setRequest($request);
$relationship = $serializer->getRelationship(User::find(2), 'customSerializerRelation'); $this->assertArrayHasKey('customSerializerRelation', $responseJson['data']['relationships']);
$this->assertEquals('discussions', $responseJson['data']['relationships']['customSerializerRelation']['data']['type']);
$this->assertNotEmpty($relationship);
$this->assertEquals('discussions', $relationship->toArray()['data']['type']);
} }
/** /**
@ -431,20 +459,21 @@ class ApiSerializerTest extends TestCase
(new Extend\Model(User::class)) (new Extend\Model(User::class))
->hasMany('anotherCustomRelation', Discussion::class, 'user_id'), ->hasMany('anotherCustomRelation', Discussion::class, 'user_id'),
(new Extend\ApiSerializer(BasicUserSerializer::class)) (new Extend\ApiSerializer(BasicUserSerializer::class))
->hasMany('anotherCustomRelation', DiscussionSerializer::class) ->hasMany('anotherCustomRelation', DiscussionSerializer::class),
(new Extend\ApiController(ShowUserController::class))
->addInclude('anotherCustomRelation')
); );
$request = $this->request('GET', '/api/users/2', [ $response = $this->send(
$this->request('GET', '/api/users/2', [
'authenticatedAs' => 1, 'authenticatedAs' => 1,
]); ])
);
$serializer = $this->app()->getContainer()->make(UserSerializer::class); $responseJson = json_decode($response->getBody(), true);
$serializer->setRequest($request);
$relationship = $serializer->getRelationship(User::find(2), 'anotherCustomRelation'); $this->assertArrayHasKey('anotherCustomRelation', $responseJson['data']['relationships']);
$this->assertCount(3, $responseJson['data']['relationships']['anotherCustomRelation']['data']);
$this->assertNotEmpty($relationship);
$this->assertCount(3, $relationship->toArray()['data']);
} }
/** /**
@ -462,20 +491,21 @@ class ApiSerializerTest extends TestCase
(new Extend\ApiSerializer(UserSerializer::class)) (new Extend\ApiSerializer(UserSerializer::class))
->relationship('postCustomRelation', function (AbstractSerializer $serializer, $model) { ->relationship('postCustomRelation', function (AbstractSerializer $serializer, $model) {
return $serializer->hasOne($model, DiscussionSerializer::class, 'discussionCustomRelation'); return $serializer->hasOne($model, DiscussionSerializer::class, 'discussionCustomRelation');
}) }),
(new Extend\ApiController(ShowUserController::class))
->addInclude('postCustomRelation')
); );
$request = $this->request('GET', '/api/users/2', [ $response = $this->send(
$this->request('GET', '/api/users/2', [
'authenticatedAs' => 1, 'authenticatedAs' => 1,
]); ])
);
$serializer = $this->app()->getContainer()->make(UserSerializer::class); $responseJson = json_decode($response->getBody(), true);
$serializer->setRequest($request);
$relationship = $serializer->getRelationship(User::find(2), 'postCustomRelation'); $this->assertArrayHasKey('postCustomRelation', $responseJson['data']['relationships']);
$this->assertEquals('discussions', $responseJson['data']['relationships']['postCustomRelation']['data']['type']);
$this->assertNotEmpty($relationship);
$this->assertEquals('discussions', $relationship->toArray()['data']['type']);
} }
} }