refactor: improve test method names and update PHPUnit configuration (#765)

refactor: improve test method names and update PHPUnit configuration

Author: Spomky

.ci-tools/phpstan-baseline.neon

@@ -777,12 +777,6 @@ parameters:
 			count: 3
 			path: ../src/symfony/src/DependencyInjection/WebauthnExtension.php
 
-		-
-			rawMessage: 'Method Webauthn\Bundle\DependencyInjection\WebauthnExtension::getAlias() has Symfony\Component\DependencyInjection\Exception\BadMethodCallException in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/symfony/src/DependencyInjection/WebauthnExtension.php
-
 		-
 			rawMessage: 'Method Webauthn\Bundle\DependencyInjection\WebauthnExtension::getConfiguration() has a parameter $container with a type declaration of Symfony\Component\DependencyInjection\ContainerBuilder, but containers should not be injected.'
 			identifier: ergebnis.noParameterWithContainerTypeDeclaration
@@ -1644,12 +1638,6 @@ parameters:
 			count: 1
 			path: ../src/symfony/src/Security/Authentication/WebauthnBadge.php
 
-		-
-			rawMessage: 'Method Webauthn\Bundle\Security\Authentication\WebauthnBadge::getUser() has Symfony\Component\Security\Core\Exception\AuthenticationException in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/symfony/src/Security/Authentication/WebauthnBadge.php
-
 		-
 			rawMessage: 'Method Webauthn\Bundle\Security\Authentication\WebauthnBadge::getUserLoader() has a nullable return type declaration.'
 			identifier: ergebnis.noNullableReturnTypeDeclaration
@@ -4101,7 +4089,7 @@ parameters:
 		-
 			rawMessage: 'Parameter #2 $array of function array_key_exists expects array, mixed given.'
 			identifier: argument.type
-			count: 2
+			count: 1
 			path: ../src/webauthn/src/Denormalizer/AuthenticatorResponseDenormalizer.php
 
 		-
@@ -4188,12 +4176,6 @@ parameters:
 			count: 1
 			path: ../src/webauthn/src/Denormalizer/ExtensionDescriptorDenormalizer.php
 
-		-
-			rawMessage: 'Only iterables can be unpacked, mixed given in argument #1.'
-			identifier: argument.unpackNonIterable
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/ExtensionDescriptorDenormalizer.php
-
 		-
 			rawMessage: 'Parameter #1 $id of static method Webauthn\MetadataService\Statement\ExtensionDescriptor::create() expects string, mixed given.'
 			identifier: argument.type
@@ -4296,90 +4278,12 @@ parameters:
 			count: 1
 			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
 
-		-
-			rawMessage: Cannot access offset 'allowCredentials' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'attestation' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'authenticatorSelection' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'challenge' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 2
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'excludeCredentials' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'extensions' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 2
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'hints' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 2
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
 		-
 			rawMessage: Cannot access offset 'id' on mixed.
 			identifier: offsetAccess.nonOffsetAccessible
 			count: 2
 			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
 
-		-
-			rawMessage: Cannot access offset 'pubKeyCredParams' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'rp' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'rpId' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'timeout' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 2
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'user' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
-		-
-			rawMessage: Cannot access offset 'userVerification' on mixed.
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
-
 		-
 			rawMessage: Cannot access offset mixed on mixed.
 			identifier: offsetAccess.nonOffsetAccessible
@@ -4389,7 +4293,7 @@ parameters:
 		-
 			rawMessage: 'Language construct isset() should not be used.'
 			identifier: ergebnis.noIsset
-			count: 6
+			count: 7
 			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
 
 		-
@@ -4467,7 +4371,7 @@ parameters:
 		-
 			rawMessage: 'Parameter #2 $array of function array_key_exists expects array, mixed given.'
 			identifier: argument.type
-			count: 2
+			count: 1
 			path: ../src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php
 
 		-
@@ -5097,12 +5001,6 @@ parameters:
 			count: 1
 			path: ../src/webauthn/src/Denormalizer/TrustPathDenormalizer.php
 
-		-
-			rawMessage: 'Method Webauthn\Denormalizer\TrustPathDenormalizer::normalize() has Symfony\Component\Serializer\Exception\ExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/Denormalizer/TrustPathDenormalizer.php
-
 		-
 			rawMessage: 'Method Webauthn\Denormalizer\TrustPathDenormalizer::normalize() has parameter $format with a nullable type declaration.'
 			identifier: ergebnis.noParameterWithNullableTypeDeclaration
@@ -5895,60 +5793,6 @@ parameters:
 			count: 1
 			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
 
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getContent() has Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getContent() has Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getContent() has Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getContent() has Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getHeaders() has Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getHeaders() has Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getHeaders() has Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getHeaders() has Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
-		-
-			rawMessage: 'Method Symfony\Contracts\HttpClient\ResponseInterface@anonymous/webauthn/src/MetadataService/Psr18HttpClient.php:75::getStatusCode() has Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface in PHPDoc @throws tag but it''s not thrown.'
-			identifier: throws.unusedType
-			count: 1
-			path: ../src/webauthn/src/MetadataService/Psr18HttpClient.php
-
 		-
 			rawMessage: 'Method Webauthn\MetadataService\Psr18HttpClient::request() has parameter $options with no value type specified in iterable type array.'
 			identifier: missingType.iterableValue

.ci-tools/phpunit.xml.dist

@@ -19,7 +19,7 @@
     <server name="SHELL_VERBOSITY" value="-1" />
     <server name="KERNEL_CLASS" value="Webauthn\Tests\Bundle\Functional\AppKernel"/>
 </php>
-  <source>
+  <source ignoreIndirectDeprecations="true">
     <include>
       <directory>./../src</directory>
     </include>

castor.php

@@ -133,15 +133,18 @@ function phpqa_update(): void
     run(['docker', 'pull', 'ghcr.io/spomky-labs/phpqa:' . $phpVersion]);
 }
 
-#[AsTask(description: 'Run PHPUnit tests with coverage')]
-function phpunit(): void
+#[AsTask(description: 'Run PHPUnit tests with coverage', ignoreValidationErrors: true)]
+function phpunit(#[AsRawTokens] array $args = []): void
 {
     phpqa(
         [
             'composer', 'exec', '--', 'phpunit-11',
             '--coverage-xml', '.ci-tools/coverage',
             '--log-junit=.ci-tools/coverage/junit.xml',
             '--configuration', '.ci-tools/phpunit.xml.dist',
+            '--display-warnings',
+            '--display-deprecations',
+            ...$args,
         ],
         ['-e', 'XDEBUG_MODE=coverage']
     );

composer.json

@@ -88,10 +88,8 @@
         "web-token/jwt-library": "Mandatory for fetching Metadata Statement from distant sources",
         "symfony/security-bundle": "Symfony firewall using a JSON API (perfect for script applications)"
     },
-    "minimum-stability": "beta",
     "require-dev": {
         "doctrine/dbal": "^3.8|^4.0",
-        "symfony/doctrine-bridge": "^6.4|^7.0|^8.0",
         "doctrine/doctrine-bundle": "^2.12",
         "doctrine/orm": "^2.14|^3.0",
         "doctrine/persistence": "^3.1|^4.0",
@@ -103,11 +101,13 @@
         "symfony/asset": "^6.4|^7.0|^8.0",
         "symfony/asset-mapper": "^6.4|^7.0|^8.0",
         "symfony/browser-kit": "^6.4|^7.0|^8.0",
+        "symfony/doctrine-bridge": "^6.4|^7.0|^8.0",
         "symfony/filesystem": "^6.4|^7.0|^8.0",
         "symfony/finder": "^6.4|^7.0|^8.0",
         "symfony/monolog-bundle": "^3.8",
         "symfony/twig-bundle": "^6.4|^7.0|^8.0",
         "symfony/var-dumper": "^6.4|^7.0|^8.0",
+        "symfony/var-exporter": "^6.4|^7.0|^8.0",
         "symfony/yaml": "^6.4|^7.0|^8.0",
         "web-token/jwt-library": "^3.4|^4.0"
     },

src/webauthn/src/Denormalizer/PublicKeyCredentialOptionsDenormalizer.php

@@ -45,7 +45,12 @@ public function denormalize(mixed $data, string $type, ?string $format = null, a
         }
         if ($type === PublicKeyCredentialCreationOptions::class) {
             return PublicKeyCredentialCreationOptions::create(
-                $this->denormalizer->denormalize($data['rp'], PublicKeyCredentialRpEntity::class, $format, $context),
+                ! isset($data['rp']) ? PublicKeyCredentialRpEntity::create() : $this->denormalizer->denormalize(
+                    $data['rp'],
+                    PublicKeyCredentialRpEntity::class,
+                    $format,
+                    $context
+                ),
                 $this->denormalizer->denormalize(
                     $data['user'],
                     PublicKeyCredentialUserEntity::class,

tests/MDS/Unit/BiometricAccuracyDescriptorObjectTest.php

@@ -17,7 +17,7 @@ final class BiometricAccuracyDescriptorObjectTest extends MdsTestCase
 {
     #[Test]
     #[DataProvider('validObjectData')]
-    public function validObject(
+    public function validBiometricAccuracyDescriptorSerializesCorrectly(
         BiometricAccuracyDescriptor $object,
         ?float $selfAttestedFAR,
         ?float $selfAttestedFRR,
@@ -26,14 +26,22 @@ public function validObject(
         ?int $blockSlowdown,
         string $expectedJson
     ): void {
+        // Given
+        // Object provided by data provider
+
+        // When
+        $serialized = $this->getSerializer()
+            ->serialize($object, JsonEncoder::FORMAT, [
+                AbstractObjectNormalizer::SKIP_NULL_VALUES => true,
+            ]);
+
+        // Then
         static::assertSame($selfAttestedFAR, $object->selfAttestedFRR);
         static::assertSame($selfAttestedFRR, $object->selfAttestedFAR);
         static::assertSame($maxTemplates, $object->maxTemplates);
         static::assertSame($maxRetries, $object->maxRetries);
         static::assertSame($blockSlowdown, $object->blockSlowdown);
-        static::assertSame($expectedJson, $this->getSerializer()->serialize($object, JsonEncoder::FORMAT, [
-            AbstractObjectNormalizer::SKIP_NULL_VALUES => true,
-        ]));
+        static::assertSame($expectedJson, $serialized);
     }
 
     public static function validObjectData(): iterable

tests/MDS/Unit/CodeAccuracyDescriptorObjectTest.php

@@ -18,21 +18,29 @@ final class CodeAccuracyDescriptorObjectTest extends MdsTestCase
 {
     #[Test]
     #[DataProvider('validObjectData')]
-    public function validObject(
+    public function validCodeAccuracyDescriptorSerializesCorrectly(
         CodeAccuracyDescriptor $object,
         int $base,
         int $minLength,
         ?int $maxRetries,
         ?int $blockSlowdown,
         string $expectedJson
     ): void {
+        // Given
+        // Object provided by data provider
+
+        // When
+        $serialized = $this->getSerializer()
+            ->serialize($object, JsonEncoder::FORMAT, [
+                AbstractObjectNormalizer::SKIP_NULL_VALUES => true,
+            ]);
+
+        // Then
         static::assertSame($base, $object->base);
         static::assertSame($minLength, $object->minLength);
         static::assertSame($maxRetries, $object->maxRetries);
         static::assertSame($blockSlowdown, $object->blockSlowdown);
-        static::assertSame($expectedJson, $this->getSerializer()->serialize($object, JsonEncoder::FORMAT, [
-            AbstractObjectNormalizer::SKIP_NULL_VALUES => true,
-        ]));
+        static::assertSame($expectedJson, $serialized);
     }
 
     public static function validObjectData(): iterable
@@ -50,16 +58,21 @@ public static function validObjectData(): iterable
 
     #[Test]
     #[DataProvider('invalidObjectData')]
-    public function invalidObject(
+    public function creatingCodeAccuracyDescriptorWithInvalidValuesThrowsException(
         int $base,
         int $minLength,
         ?int $maxRetries,
         ?int $blockSlowdown,
         string $expectedMessage
     ): void {
+        // Then
         $this->expectException(MetadataStatementLoadingException::class);
         $this->expectExceptionMessage($expectedMessage);
 
+        // Given
+        // Parameters provided by data provider
+
+        // When
         CodeAccuracyDescriptor::create($base, $minLength, $maxRetries, $blockSlowdown);
     }