finished Xml, Tag, Type, Server and ServerVariable

cebe · cebe · commit d6d2c6fa95a1 · 2018-11-07T21:57:01.000+01:00
diff --git a/README.md b/README.md
@@ -76,7 +76,7 @@ This library is currently work in progress, the following list tracks completene
   - [x] Link Object
     - [ ] [Runtime Expressions](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#runtime-expressions)
   - [ ] Header Object
-  - [ ] Tag Object
+  - [x] Tag Object
   - [ ] Reference Object
   - [x] Schema Object
     - [x] load/read
diff --git a/src/SpecBaseObject.php b/src/SpecBaseObject.php
@@ -117,6 +117,12 @@ public function validate(): bool
         foreach ($this->_properties as $v) {
             if ($v instanceof self) {
                 $v->validate();
+            } elseif (is_array($v)) {
+                foreach($v as $item) {
+                    if ($item instanceof self) {
+                        $item->validate();
+                    }
+                }
             }
         }
         $this->performValidation();
@@ -133,6 +139,12 @@ public function getErrors(): array
         foreach ($this->_properties as $v) {
             if ($v instanceof self) {
                 $errors[] = $v->getErrors();
+            } elseif (is_array($v)) {
+                foreach($v as $item) {
+                    if ($item instanceof self) {
+                        $errors[] = $item->getErrors();
+                    }
+                }
             }
         }
         return array_merge(...$errors);
diff --git a/src/spec/Components.php b/src/spec/Components.php
@@ -51,8 +51,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Contact.php b/src/spec/Contact.php
@@ -35,8 +35,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Discriminator.php b/src/spec/Discriminator.php
@@ -33,8 +33,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/ExternalDocumentation.php b/src/spec/ExternalDocumentation.php
@@ -33,8 +33,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Info.php b/src/spec/Info.php
@@ -43,8 +43,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/License.php b/src/spec/License.php
@@ -33,8 +33,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Link.php b/src/spec/Link.php
@@ -41,8 +41,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/OpenApi.php b/src/spec/OpenApi.php
@@ -45,8 +45,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     public function performValidation()
     {
diff --git a/src/spec/PathItem.php b/src/spec/PathItem.php
@@ -56,8 +56,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/RequestBody.php b/src/spec/RequestBody.php
@@ -38,8 +38,6 @@ protected function attributes(): array
     }
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Schema.php b/src/spec/Schema.php
@@ -93,8 +93,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Server.php b/src/spec/Server.php
@@ -35,8 +35,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/ServerVariable.php b/src/spec/ServerVariable.php
@@ -35,8 +35,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Tag.php b/src/spec/Tag.php
@@ -16,7 +16,7 @@
  *
  * @property-read string $name
  * @property-read string $description
- * @property-read ExternalDocumentation $externalDocs
+ * @property-read ExternalDocumentation|null $externalDocs
  *
  */
 class Tag extends SpecBaseObject
@@ -35,8 +35,6 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
diff --git a/src/spec/Type.php b/src/spec/Type.php
@@ -7,11 +7,17 @@
 
 namespace cebe\openapi\spec;
 
+/**
+ * Data Types
+ *
+ * @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#dataTypes
+ */
 class Type
 {
     const ANY = 'any';
-    const STRING = 'string';
     const INTEGER = 'integer';
+    const NUMBER = 'number';
+    const STRING = 'string';
     const BOOLEAN = 'boolean';
     const OBJECT = 'object';
 }
diff --git a/src/spec/Xml.php b/src/spec/Xml.php
@@ -14,6 +14,11 @@
  *
  * @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#xmlObject
  *
+ * @property-read string $name
+ * @property-read string $namespace
+ * @property-read string $prefix
+ * @property-read boolean $attribute
+ * @property-read boolean $wrapped
  */
 class Xml extends SpecBaseObject
 {
@@ -33,11 +38,8 @@ protected function attributes(): array
 
     /**
      * Perform validation on this object, check data against OpenAPI Specification rules.
-     *
-     * Call `addError()` in case of validation errors.
      */
     protected function performValidation()
     {
-        // TODO: Implement performValidation() method.
     }
 }
diff --git a/tests/ReaderTest.php b/tests/ReaderTest.php
@@ -53,4 +53,7 @@ private function assertApiContent(\cebe\openapi\spec\OpenApi $openapi)
         $this->assertEquals("1.0.0", $openapi->info->version);
     }
 
+    
+    // TODO test invalid JSON
+    // TODO test invalid YAML
 }
diff --git a/tests/spec/LinkTest.php b/tests/spec/LinkTest.php
@@ -3,11 +3,6 @@
 use cebe\openapi\Reader;
 use cebe\openapi\spec\Link;
 
-/**
- *
- *
- * @author Alexander Makarov <sam@rmcreative.ru>
- */
 class LinkTest extends \PHPUnit\Framework\TestCase
 {
     public function testRead()
diff --git a/tests/spec/OpenApiTest.php b/tests/spec/OpenApiTest.php
@@ -3,11 +3,6 @@
 use cebe\openapi\spec\OpenApi;
 use Symfony\Component\Yaml\Yaml;
 
-/**
- *
- *
- * @author Carsten Brandt <mail@cebe.cc>
- */
 class OpenApiTest extends \PHPUnit\Framework\TestCase
 {
     public function testEmpty()
diff --git a/tests/spec/SchemaTest.php b/tests/spec/SchemaTest.php
@@ -3,12 +3,6 @@
 use cebe\openapi\Reader;
 use cebe\openapi\spec\Type;
 
-
-/**
- *
- *
- * @author Carsten Brandt <mail@cebe.cc>
- */
 class SchemaTest extends \PHPUnit\Framework\TestCase
 {
     public function testRead()
diff --git a/tests/spec/ServerTest.php b/tests/spec/ServerTest.php
@@ -2,11 +2,11 @@
 
 use cebe\openapi\Reader;
 use cebe\openapi\spec\Server;
+use cebe\openapi\spec\ServerVariable;
 
 /**
- *
- *
- * @author Carsten Brandt <mail@cebe.cc>
+ * @covers Server
+ * @covers ServerVariable
  */
 class ServerTest extends \PHPUnit\Framework\TestCase
 {
@@ -47,6 +47,37 @@ public function testRead()
         $this->assertEquals('demo', $server->variables['username']->default);
         $this->assertEquals('this value is assigned by the service provider, in this example `gigantic-server.com`', $server->variables['username']->description);
         $this->assertEquals('8443', $server->variables['port']->default);
+
+        /** @var $server Server */
+        $server = Reader::readFromJson(<<<JSON
+{
+  "description": "The production API server"
+}
+JSON
+            , Server::class);
+
+        $result = $server->validate();
+        $this->assertEquals(['Missing required property: url'], $server->getErrors());
+        $this->assertFalse($result);
+
+
+        /** @var $server Server */
+        $server = Reader::readFromJson(<<<JSON
+{
+  "url": "https://{username}.gigantic-server.com:{port}/{basePath}",
+  "description": "The production API server",
+  "variables": {
+    "username": {
+      "description": "this value is assigned by the service provider, in this example `gigantic-server.com`"
+    }
+  }
+}
+JSON
+        , Server::class);
+
+        $result = $server->validate();
+        $this->assertEquals(['Missing required property: default'], $server->getErrors());
+        $this->assertFalse($result);
     }
 
 }
diff --git a/tests/spec/TagTest.php b/tests/spec/TagTest.php
@@ -0,0 +1,43 @@
+<?php
+
+use cebe\openapi\Reader;
+use cebe\openapi\spec\ExternalDocumentation;
+use cebe\openapi\spec\Tag;
+
+/**
+ * @covers Tag
+ */
+class TagTest extends \PHPUnit\Framework\TestCase
+{
+    public function testRead()
+    {
+        /** @var $tag Tag */
+        $tag = Reader::readFromYaml(<<<YAML
+name: pet
+description: Pets operations
+YAML
+        , Tag::class);
+
+        $result = $tag->validate();
+        $this->assertEquals([], $tag->getErrors());
+        $this->assertTrue($result);
+
+        $this->assertEquals('pet', $tag->name);
+        $this->assertEquals('Pets operations', $tag->description);
+        $this->assertNull($tag->externalDocs);
+
+        /** @var $tag Tag */
+        $tag = Reader::readFromYaml(<<<YAML
+description: Pets operations
+externalDocs:
+  url: https://example.com
+YAML
+        , Tag::class);
+
+        $result = $tag->validate();
+        $this->assertEquals(['Missing required property: name'], $tag->getErrors());
+        $this->assertFalse($result);
+
+        $this->assertInstanceOf(ExternalDocumentation::class, $tag->externalDocs);
+    }
+}
diff --git a/tests/spec/XmlTest.php b/tests/spec/XmlTest.php
@@ -0,0 +1,33 @@
+<?php
+
+use cebe\openapi\Reader;
+use cebe\openapi\spec\Xml;
+
+/**
+ * @covers Xml
+ */
+class XmlTest extends \PHPUnit\Framework\TestCase
+{
+    public function testRead()
+    {
+        /** @var $xml Xml */
+        $xml = Reader::readFromYaml(<<<YAML
+name: animal
+attribute: true
+namespace: http://example.com/schema/sample
+prefix: sample
+wrapped: false
+YAML
+        , Xml::class);
+
+        $result = $xml->validate();
+        $this->assertEquals([], $xml->getErrors());
+        $this->assertTrue($result);
+
+        $this->assertEquals('animal', $xml->name);
+        $this->assertTrue($xml->attribute);
+        $this->assertEquals('http://example.com/schema/sample', $xml->namespace);
+        $this->assertEquals('sample', $xml->prefix);
+        $this->assertFalse($xml->wrapped);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,6 @@ protected function attributes(): array`
`51`	`51`
`52`	`52`	`/**`
`53`	`53`	`* Perform validation on this object, check data against OpenAPI Specification rules.`
`54`		`- *`
`55`		- * Call `addError()` in case of validation errors.
`56`	`54`	`*/`
`57`	`55`	`protected function performValidation()`
`58`	`56`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,6 @@ protected function attributes(): array`
`35`	`35`
`36`	`36`	`/**`
`37`	`37`	`* Perform validation on this object, check data against OpenAPI Specification rules.`
`38`		`- *`
`39`		- * Call `addError()` in case of validation errors.
`40`	`38`	`*/`
`41`	`39`	`protected function performValidation()`
`42`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,8 +33,6 @@ protected function attributes(): array`
`33`	`33`
`34`	`34`	`/**`
`35`	`35`	`* Perform validation on this object, check data against OpenAPI Specification rules.`
`36`		`- *`
`37`		- * Call `addError()` in case of validation errors.
`38`	`36`	`*/`
`39`	`37`	`protected function performValidation()`
`40`	`38`	`{`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,6 @@ protected function attributes(): array`
`43`	`43`
`44`	`44`	`/**`
`45`	`45`	`* Perform validation on this object, check data against OpenAPI Specification rules.`
`46`		`- *`
`47`		- * Call `addError()` in case of validation errors.
`48`	`46`	`*/`
`49`	`47`	`protected function performValidation()`
`50`	`48`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,6 @@ protected function attributes(): array`
`41`	`41`
`42`	`42`	`/**`
`43`	`43`	`* Perform validation on this object, check data against OpenAPI Specification rules.`
`44`		`- *`
`45`		- * Call `addError()` in case of validation errors.
`46`	`44`	`*/`
`47`	`45`	`protected function performValidation()`
`48`	`46`	`{`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,6 @@ protected function attributes(): array`
`45`	`45`
`46`	`46`	`/**`
`47`	`47`	`* Perform validation on this object, check data against OpenAPI Specification rules.`
`48`		`- *`
`49`		- * Call `addError()` in case of validation errors.
`50`	`48`	`*/`
`51`	`49`	`public function performValidation()`
`52`	`50`	`{`