Unit tests using assertMatchesJsonSchema fail for ManyToOne properties

[devzenfr]

API Platform version(s) affected: 3.2.13

Description

Since #6098 has been merged, my Unit Tests including assertMatchesResourceCollectionJsonSchema or assertMatchesResourceItemJsonSchema fail for ManyToOne properties.

The error message is Object value found, but a string or a null is required.

How to reproduce

I have a BlogArticle Entity that contains a blogCategory property. This category is serialized into the json answer for Get and GetCollection operations.

#[ORM\ManyToOne(targetEntity: BlogCategory::class, inversedBy: 'blogArticles')]
#[ORM\JoinColumn(nullable: true)]
#[Groups([
    'blog_article:read',
    'blog_article:read:get_collection',
])]
private ?BlogCategory $blogCategory;

I test my GetCollection api calls with the following method:

public function testGetCollection(): void
{
    static::createClient()->request('GET', '/blog_articles');

    self::assertResponseIsSuccessful();
    $this->assertJsonContains([
        '@type' => 'hydra:Collection',
        'hydra:totalItems' => 11,
    ]);

    $this->assertMatchesResourceCollectionJsonSchema(BlogArticle::class);
}

Possible Solution

Inside ApiTestAssertionsTrait, I noticed these changes for methods assertMatchesResourceCollectionJsonSchemaand assertMatchesResourceItemJsonSchema =>

$schema = $schemaFactory->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, $operation, null, $serializationContext);

became

$schema = $schemaFactory->buildSchema($resourceClass, $format, Schema::TYPE_OUTPUT, $operation, null, ($serializationContext ?? []) + [BackwardCompatibleSchemaFactory::SCHEMA_DRAFT4_VERSION => true]);

If I change it back to the previous version, my tests are working again but I get new errors instead =>

quantity: Use of exclusiveMinimum requires presence of minimum  

For this property of the Recipe entity

#[ORM\Column(type: 'integer', options: ['default' => 1])]
#[Positive]
#[Groups([
    'recipe:read',
])]
private int $quantity = 1;

All my tests were green when using API Platform 3.1.

Thanks for your help!

[jvengeon]

Same problems for me in 3.2.13

quoteValidityPeriod: Use of exclusiveMinimum requires presence of minimum
logo: Object value found, but a string or a null is required

Got this with
self::assertMatchesResourceItemJsonSchema(BillingCompany::class);

#[ORM\Column(type: 'smallint', nullable: true)]
#[Groups(['billing_company:read', 'billing_company:edit'])]
#[Assert\NotBlank]
#[Assert\Positive]
private ?int $quoteValidityPeriod = null;

#[ORM\OneToOne(targetEntity: File::class, cascade: ['persist'])]
#[ORM\JoinColumn(nullable: true)]
public ?File $logo = null;

[kevin-macquer-omnilog]

@jvengeon @devzenfr can you test with the change in this PR? I had the same problem and this fixed the issues with my tests.
#6157

[devzenfr]

@jvengeon @devzenfr can you test with the change in this PR? I had the same problem and this fixed the issues with my tests. #6157

This works fine on my side too! I hope this can be merged.

[jvengeon]

Thanks, this works for my first problem logo: Object value found, but a string or a null is required
The second problem is always here : quoteValidityPeriod: Use of exclusiveMinimum requires presence of minimum but probably fix by #6041

[kevin-macquer-omnilog]

@jvengeon Hum this is very strange since my change are supposed to restore 3.12 test behaviours.
Can you confirm that your test works on 3.12 but doesn't work for 3.13?

[jvengeon]

The problem Use of exclusiveMinimum requires presence of minimum exists since 3.2.7

[soyuka]

just released it, can you try?

[louismariegaborit]

We tried and it's ok.

[devzenfr]

All my tests are green again, seems great! Thanks @kevin-macquer-omnilog and @soyuka 🙏

I can close this.