test: Validate Command tests

Author: danielebarbaro

tests/Feature/ValidateCommandTest.php

@@ -0,0 +1,54 @@
+<?php
+
+beforeEach(function () {
+    $this->fixturesPath = dirname(__DIR__, ).'/Fixtures';
+});
+
+it('validates correct specification', function () {
+    $this->artisan('validate', [
+        'spec' => "{$this->fixturesPath}/valid-petstore.yaml"
+    ])
+        ->expectsOutput('🔍 Validating your magical scroll...')
+        ->expectsOutput('✨ Your magical scroll OpenAPI specification is valid!')
+        ->assertExitCode(0);
+});
+
+it('fails for non existent file', function () {
+    $nonExistentPath = "{$this->fixturesPath}/non-existent.yaml'";
+
+    $this->artisan('validate', ['spec' => $nonExistentPath])
+        ->expectsOutput('🔍 Validating your magical scroll...')
+        ->expectsOutput('🌋 The magical scroll does not exist: ' . $nonExistentPath)
+        ->assertExitCode(1);
+});
+
+it('fails for invalid yaml', function () {
+    $this->artisan('validate', [
+        'spec' => "{$this->fixturesPath}/invalid-yaml.yaml"
+    ])
+        ->expectsOutput('🔍 Validating your magical scroll...')
+        ->expectsOutput('🌋 Your magical scroll has some imperfections:')
+        ->assertExitCode(1);
+});
+
+it('shows summary for valid specification', function () {
+    $this->artisan('validate', [
+        'spec' => "{$this->fixturesPath}/valid-petstore.yaml"
+    ])
+        ->expectsOutput('📖 Specification Summary:')
+        ->expectsOutput('🛣️  Available Paths:')
+        ->expectsOutput('  /pet [PUT, POST]')
+        ->assertExitCode(0);
+});
+
+it('loads custom config when provided', function () {
+    $configPath = "{$this->fixturesPath}/config.php";
+    file_put_contents($configPath, '<?php return ["openapi" => ["version" => "3.0"]];');
+
+    $this->artisan('validate', [
+        'spec' => "{$this->fixturesPath}/valid-petstore.yaml",
+        '--config' => $configPath
+    ])->assertExitCode(0);
+
+    unlink($configPath);
+});

tests/Fixtures/invalid-yaml.yaml

@@ -0,0 +1,11 @@
+openapi: 3.0.2
+info:
+    title: Invalid YAML
+    version: 1.0.0
+paths:
+    /pet:
+        post
+        summary: Invalid YAML structure
+        responses:
+            '200':
+                description: OK

tests/Fixtures/valid-petstore.json

@@ -0,0 +1,42 @@
+{
+    "openapi": "3.0.2",
+    "info": {
+        "title": "Test Pet Store",
+        "version": "1.0.0"
+    },
+    "paths": {
+        "/pet": {
+            "post": {
+                "summary": "Add a pet",
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            },
+            "put": {
+                "summary": "Update a pet",
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
+            }
+        }
+    },
+    "components": {
+        "schemas": {
+            "Pet": {
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "integer"
+                    },
+                    "name": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    }
+}

tests/Fixtures/valid-petstore.yaml

@@ -0,0 +1,25 @@
+openapi: 3.0.2
+info:
+    title: Test Pet Store
+    version: 1.0.0
+paths:
+    /pet:
+        post:
+            summary: Add a pet
+            responses:
+                '200':
+                    description: OK
+        put:
+            summary: Update a pet
+            responses:
+                '200':
+                    description: OK
+components:
+    schemas:
+        Pet:
+            type: object
+            properties:
+                id:
+                    type: integer
+                name:
+                    type: string

tests/Unit/SpecificationReaderTest.php

@@ -0,0 +1,46 @@
+<?php
+
+use App\Config\ApiSwookeryConfig;
+use App\OpenApi\SpecificationReader;
+use cebe\openapi\spec\OpenApi;
+
+beforeEach(function () {
+    $this->reader = new SpecificationReader(ApiSwookeryConfig::defaults());
+    $this->fixturesPath = __DIR__ .'/../Fixtures';
+});
+
+it('can read valid yaml specification', function () {
+    $spec = $this->reader->read("{$this->fixturesPath}/valid-petstore.yaml");
+
+    expect($spec)
+        ->toBeInstanceOf(OpenApi::class)
+        ->and($spec->openapi)
+        ->toBe('3.0.2');
+});
+
+it('can read valid json specification', function () {
+    $spec = $this->reader->read("{$this->fixturesPath}/valid-petstore.json");
+
+    expect($spec)
+        ->toBeInstanceOf(OpenApi::class)
+        ->and($spec->openapi)
+        ->toBe('3.0.2');
+});
+
+it('throws exception for invalid yaml', function () {
+    $this->reader->read("{$this->fixturesPath}/invalid-yaml.yaml");
+})->throws(RuntimeException::class);
+
+it('validates openapi version', function () {
+    $spec = $this->reader->read("{$this->fixturesPath}/valid-petstore.yaml");
+
+    expect($this->reader->validate($spec))->toBeTrue();
+});
+
+it('throws exception for unsupported version', function () {
+    $config = ApiSwookeryConfig::fromArray(['openapi' => ['version' => '3.1.0']]);
+    $reader = new SpecificationReader($config);
+
+    $spec = $reader->read("{$this->fixturesPath}/valid-petstore.yaml");
+    $reader->validate($spec);
+})->throws(RuntimeException::class, 'OpenAPI version 3.0.2 is not supported');