ParameterTest.php

<?php

use cebe\openapi\Reader;
use cebe\openapi\spec\Parameter;

/**
 * @covers \cebe\openapi\spec\Parameter
 */
class ParameterTest extends \PHPUnit\Framework\TestCase
{
    public function testRead()
    {
        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: header
description: token to be passed as a header
required: true
schema:
  type: array
  items:
    type: integer
    format: int64
style: simple
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals([], $parameter->getErrors());
        $this->assertTrue($result);

        $this->assertEquals('token', $parameter->name);
        $this->assertEquals('header', $parameter->in);
        $this->assertEquals('token to be passed as a header', $parameter->description);
        $this->assertTrue($parameter->required);

        $this->assertInstanceOf(\cebe\openapi\spec\Schema::class, $parameter->schema);
        $this->assertEquals('array', $parameter->schema->type);

        $this->assertEquals('simple', $parameter->style);

        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
in: query
name: coordinates
content:
  application/json:
    schema:
      type: object
      required:
        - lat
        - long
      properties:
        lat:
          type: number
        long:
          type: number
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals([], $parameter->getErrors());
        $this->assertTrue($result);

        $this->assertEquals('coordinates', $parameter->name);
        $this->assertEquals('query', $parameter->in);
        // required default value is false.
        $this->assertFalse($parameter->required);
        // deprecated default value is false.
        $this->assertFalse($parameter->deprecated);
        // allowEmptyValue default value is false.
        $this->assertFalse($parameter->allowEmptyValue);

        $this->assertInstanceOf(\cebe\openapi\spec\MediaType::class, $parameter->content['application/json']);
        $this->assertInstanceOf(\cebe\openapi\spec\Schema::class, $parameter->content['application/json']->schema);
    }

    public function testDefaultValuesQuery()
    {
        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: query
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals([], $parameter->getErrors());
        $this->assertTrue($result);

        // default value for style parameter in query param
        $this->assertEquals('form', $parameter->style);
        $this->assertTrue($parameter->explode);
        $this->assertFalse($parameter->allowReserved);
    }

    public function testDefaultValuesPath()
    {
        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: path
required: true
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals([], $parameter->getErrors());
        $this->assertTrue($result);

        // default value for style parameter in query param
        $this->assertEquals('simple', $parameter->style);
        $this->assertFalse($parameter->explode);
    }

    public function testDefaultValuesHeader()
    {
        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: header
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals([], $parameter->getErrors());
        $this->assertTrue($result);

        // default value for style parameter in query param
        $this->assertEquals('simple', $parameter->style);
        $this->assertFalse($parameter->explode);
    }

    public function testDefaultValuesCookie()
    {
        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: cookie
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals([], $parameter->getErrors());
        $this->assertTrue($result);

        // default value for style parameter in query param
        $this->assertEquals('form', $parameter->style);
        $this->assertTrue($parameter->explode);
    }

    public function testItValidatesSchemaAndContentCombination()
    {
        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: cookie
schema:
  type: object
content:
  application/json:
    schema:
      type: object
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals(['A Parameter Object MUST contain either a schema property, or a content property, but not both.'], $parameter->getErrors());
        $this->assertFalse($result);
    }

    public function testItValidatesContentCanHaveOnlySingleKey()
    {
        /** @var $parameter Parameter */
        $parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: cookie
content:
  application/json:
    schema:
      type: object
  application/xml:
    schema:
      type: object
YAML
            , Parameter::class);

        $result = $parameter->validate();
        $this->assertEquals(['A Parameter Object with Content property MUST have A SINGLE content type.'], $parameter->getErrors());
        $this->assertFalse($result);
    }


    public function testItValidatesSupportedSerializationStyles()
    {
        // 1. Prepare test inputs
        $specTemplate = <<<YAML
name: token
required: true
in: %s
style: %s
YAML;
        $goodCombinations = [
            'path' => ['simple', 'label', 'matrix'],
            'query' => ['form', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
            'header' => ['simple'],
            'cookie' => ['form'],
        ];
        $badCombinations = [
            'path' => ['unknown', 'form', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
            'query' => ['unknown', 'simple', 'label', 'matrix'],
            'header' => ['unknown', 'form', 'spaceDelimited', 'pipeDelimited', 'deepObject', 'matrix'],
            'cookie' => ['unknown', 'spaceDelimited', 'pipeDelimited', 'deepObject', 'matrix', 'label', 'matrix'],
        ];

        // 2. Run tests for valid input
        foreach($goodCombinations as $in=>$styles) {
            foreach($styles as $style) {
                /** @var $parameter Parameter */
                $parameter = Reader::readFromYaml(sprintf($specTemplate, $in, $style) , Parameter::class);
                $result = $parameter->validate();
                $this->assertEquals([], $parameter->getErrors());
                $this->assertTrue($result);
            }
        }

        // 2. Run tests for invalid input
        foreach($badCombinations as $in=>$styles) {
            foreach($styles as $style) {
                /** @var $parameter Parameter */
                $parameter = Reader::readFromYaml(sprintf($specTemplate, $in, $style) , Parameter::class);
                $result = $parameter->validate();
                $this->assertEquals(['A Parameter Object DOES NOT support this serialization style.'], $parameter->getErrors());
                $this->assertFalse($result);
            }
        }
    }
}