Merge pull request #1 from membrane-php/add-infection

Add infection/infection

Author: charjr

composer.json

@@ -17,6 +17,12 @@
     "phpunit/phpunit": "^10.1",
     "phpstan/phpstan": "^1.10.19",
     "squizlabs/php_codesniffer": "^3.7",
-    "mikey179/vfsstream": "^1.6.7"
+    "mikey179/vfsstream": "^1.6.7",
+    "infection/infection": "^0.27.0"
+  },
+  "config": {
+    "allow-plugins": {
+      "infection/extension-installer": true
+    }
   }
 }

infection.json5

@@ -0,0 +1,13 @@
+{
+    "$schema": "vendor/infection/infection/resources/schema.json",
+    "source": {
+        "directories": [
+            "src"
+        ]
+    },
+    minCoveredMsi: 90,
+    minMsi: 80,
+    "mutators": {
+        "@default": true,
+    },
+}

src/Exception/CannotSupport.php

@@ -17,12 +17,10 @@ final class CannotSupport extends RuntimeException
 
     public static function unsupportedMethod(string $pathUrl, string $method): self
     {
-        $message = sprintf(
-            "Membrane does not currently support the method: '%s'\n" .
-            'Found on Path: "%s"',
-            $method,
-            $pathUrl
-        );
+        $message = <<<TEXT
+            Membrane does not currently support the method: '$method'.
+            Found on Path: '$pathUrl'
+            TEXT;
         return new self($message, self::UNSUPPORTED_METHOD);
     }
 
@@ -40,14 +38,12 @@ public static function unsupportedVersion(string $version): self
 
     public static function missingOperationId(string $pathUrl, string $method): self
     {
-        $message = sprintf(
-            "Membrane requires an operationId on all operations.\n" .
-            "operationId is missing for the following operation:\n" .
-            "\tPath: '%s'\n" .
-            "\tMethod: '%s'",
-            $pathUrl,
-            $method
-        );
+        $message = <<<TEXT
+            Membrane requires an operationId on all operations.
+            operationId is missing for the following operation:
+            Path: '$pathUrl'
+            Method: '$method'
+            TEXT;
         return new self($message, self::MISSING_OPERATION_ID);
     }
 }

src/Exception/InvalidOpenAPI.php

@@ -20,17 +20,12 @@ public static function duplicateOperationIds(
         string $secondPath,
         string $secondMethod
     ): self {
-        $message = sprintf(
-            "A valid OpenAPI must contain unique operationIds across the API.\n" .
-            "The operationId: '%s' is duplicated between the following operations:\n" .
-            "\tPath: '%s', Method: '%s'\n" .
-            "\tPath: '%s', Method: '%s'\n",
-            $operationId,
-            $firstPath,
-            $firstMethod,
-            $secondPath,
-            $secondMethod
-        );
+        $message = <<<TEXT
+            A valid OpenAPI must contain unique operationIds across the API.
+            The operationId: '$operationId' is duplicated between the following operations:
+            Path: '$firstPath', Method: '$firstMethod'.
+            Path: '$secondPath', Method: '$secondMethod'.
+            TEXT;
 
         return new self($message, self::INVALID_OPEN_API);
     }

src/Reader.php

@@ -59,11 +59,9 @@ public function readFromString(string $openAPI, FileFormat $fileFormat): CebeSpe
             throw CannotRead::invalidFormatting($e);
         }
 
-        $this->validate($openAPI);
-
-
         $openAPI->resolveReferences(new Cebe\ReferenceContext($openAPI, '/tmp'));
 
+        $this->validate($openAPI);
 
         return $openAPI;
     }

tests/FileFormatTest.php

@@ -18,8 +18,11 @@ class FileFormatTest extends TestCase
     public static function provideSupportedFileExtensions(): Generator
     {
         yield 'json' => [FileFormat::Json, 'json'];
+        yield 'JSON' => [FileFormat::Json, 'JSON'];
         yield 'yaml' => [FileFormat::Yaml, 'yaml'];
+        yield 'YAML' => [FileFormat::Yaml, 'YAML'];
         yield 'yml' => [FileFormat::Yaml, 'yml'];
+        yield 'YML' => [FileFormat::Yaml, 'YML'];
     }
 
     #[Test, TestDox('it supports file extensions used for OpenAPI')]

tests/ReaderTest.php

@@ -40,7 +40,7 @@ public function itMustHaveAnArrayContainingOnlyOpenAPIVersions(): void
     #[Test]
     public function itCannotReadFilesItCannotFind(): void
     {
-        $filePath = vfsStream::setup()->url() . '/open-api';
+        $filePath = vfsStream::setup()->url() . '/openapi';
 
         self::assertFalse(file_exists($filePath));
 
@@ -72,7 +72,21 @@ public static function provideMinimalOpenAPIAsArray(): Generator
 
     #[Test]
     #[DataProvider('provideMinimalOpenAPIAsArray')]
-    public function itCannotSupportUnspecifiedOpenAPIVersions(array $openAPIArray): void
+    public function itCannotSupportUnspecifiedOpenAPIVersionsFromAbsoluteFilePath(array $openAPIArray): void
+    {
+
+        $filePath = vfsStream::setup()->url() . '/openapi';
+        file_put_contents($filePath, json_encode($openAPIArray));
+
+        self::expectExceptionObject(CannotSupport::unsupportedVersion($openAPIArray['openapi']));
+
+        (new Reader([OpenAPIVersion::Version_3_1]))
+            ->readFromAbsoluteFilePath($filePath, FileFormat::Json);
+    }
+
+    #[Test]
+    #[DataProvider('provideMinimalOpenAPIAsArray')]
+    public function itCannotSupportUnspecifiedOpenAPIVersionsFromString(array $openAPIArray): void
     {
         self::expectExceptionObject(CannotSupport::unsupportedVersion($openAPIArray['openapi']));
 
@@ -82,7 +96,20 @@ public function itCannotSupportUnspecifiedOpenAPIVersions(array $openAPIArray):
 
     #[Test]
     #[DataProvider('provideMinimalOpenAPIAsArray')]
-    public function itCanSupportSpecifiedOpenAPIVersions(array $openAPIArray): void
+    public function itCanSupportSpecifiedOpenAPIVersionsFromAbsoluteFilePath(array $openAPIArray): void
+    {
+        $filePath = vfsStream::setup()->url() . '/openapi';
+        file_put_contents($filePath, json_encode($openAPIArray));
+
+        $openAPIObject = (new Reader([OpenAPIVersion::Version_3_0]))
+            ->readFromAbsoluteFilePath($filePath, FileFormat::Json);
+
+        self::assertInstanceOf(CebeSpec\OpenApi::class, $openAPIObject);
+    }
+
+    #[Test]
+    #[DataProvider('provideMinimalOpenAPIAsArray')]
+    public function itCanSupportSpecifiedOpenAPIVersionsFromString(array $openAPIArray): void
     {
         $openAPIObject = (new Reader([OpenAPIVersion::Version_3_0]))
             ->readFromString(json_encode($openAPIArray), FileFormat::Json);
@@ -107,6 +134,10 @@ public static function provideInvalidFormatting(): Generator
         yield 'Empty string to be interpreted as yaml' => ['', FileFormat::Yaml];
         yield 'Invalid json format' => ['{openapi: ",', FileFormat::Json];
         yield 'Invalid yaml format' => ['---openapi: ",- title: "invalid"', FileFormat::Yaml];
+        yield 'info is a string rather than an array' => [
+            json_encode(['openapi' => '3.0.0', 'info' => 'hold on what is this?', 'paths' => []]),
+            FileFormat::Json
+        ];
     }
 
     #[Test]
@@ -179,7 +210,22 @@ public static function provideInvalidOpenAPIs(): Generator
 
     #[Test]
     #[DataProvider('provideInvalidOpenAPIs')]
-    public function itWillNotProcessInvalidOpenAPI(string $openAPIString, InvalidOpenAPI $expectedException): void
+    public function itWillNotProcessInvalidOpenAPIFromAbsoluteFilePath(
+        string $openAPIString,
+        InvalidOpenAPI $expectedException
+    ): void {
+        $filePath = vfsStream::setup()->url() . '/openapi.json';
+        file_put_contents($filePath, $openAPIString);
+
+        self::expectExceptionObject($expectedException);
+
+        (new Reader([OpenAPIVersion::Version_3_0]))
+            ->readFromAbsoluteFilePath($filePath, FileFormat::Json);
+    }
+
+    #[Test]
+    #[DataProvider('provideInvalidOpenAPIs')]
+    public function itWillNotProcessInvalidOpenAPIFromString(string $openAPIString, InvalidOpenAPI $expectedException): void
     {
         self::expectExceptionObject($expectedException);