ByJG\ApiTools\AssertRequestAgainstSchema

Complexity

Total Complexity

6

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setSchema()	0	4	1
A	makeRequest()	0	30	1
A	assertRequest()	0	21	2
A	checkSchema()	0	6	2

<?php

namespace ByJG\ApiTools;

use ByJG\ApiTools\Base\Schema;
use ByJG\ApiTools\Exception\DefinitionNotFoundException;
use ByJG\ApiTools\Exception\GenericSwaggerException;
use ByJG\ApiTools\Exception\HttpMethodNotFoundException;
use ByJG\ApiTools\Exception\InvalidDefinitionException;
use ByJG\ApiTools\Exception\NotMatchedException;
use ByJG\ApiTools\Exception\PathNotFoundException;
use ByJG\ApiTools\Exception\StatusCodeNotMatchedException;
use PHPUnit\Framework\TestCase;

trait AssertRequestAgainstSchema
{
    /**
     * @var Schema
     */
    protected $schema;

    /**
     * configure the schema to use for requests
     *
     * When set, all requests without an own schema use this one instead.
     *
     * @param Schema|null $schema
     */
    public function setSchema($schema)
    {
        $this->schema = $schema;
    }

    /**
     * @param string $method The HTTP Method: GET, PUT, DELETE, POST, etc
     * @param string $path The REST path call
     * @param int $statusExpected
     * @param array|null $query
     * @param array|null $requestBody
     * @param array $requestHeader
     * @return mixed
     * @throws DefinitionNotFoundException
     * @throws GenericSwaggerException
     * @throws HttpMethodNotFoundException
     * @throws InvalidDefinitionException
     * @throws NotMatchedException
     * @throws PathNotFoundException
     * @throws StatusCodeNotMatchedException
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @deprecated Use assertRequest instead
     */
    protected function makeRequest(
        $method,
        $path,
        $statusExpected = 200,
        $query = null,
        $requestBody = null,
        $requestHeader = []
    ) {
        assert($this instanceof TestCase);

        $this->checkSchema();

It seems like you code against a specific sub-type and not the parent class PHPUnit\Framework\TestCase as the method checkSchema() does only exist in the following sub-classes of PHPUnit\Framework\TestCase: ByJG\ApiTools\ApiTestCase. Maybe you want to instanceof check for one of these explicitly?

        $requester = new ApiRequester();
        $body = $requester
            ->withSchema($this->schema)

The property schema does not seem to exist in PHPUnit\Framework\TestCase.

            ->withMethod($method)
            ->withPath($path)
            ->withQuery($query)

It seems like $query defined by parameter $query on line 56 can also be of type null; however, ByJG\ApiTools\AbstractRequester::withQuery() does only seem to accept array, maybe add an additional type check?

            ->withRequestBody($requestBody)

It seems like $requestBody defined by parameter $requestBody on line 57 can also be of type array; however, ByJG\ApiTools\AbstractRequester::withRequestBody() does only seem to accept null, maybe add an additional type check?

            ->withRequestHeader($requestHeader)
            ->assertResponseCode($statusExpected)
            ->send();

        // Note:
        // This code is only reached if the send is successful and
        // all matches are satisfied. Otherwise an error is throwed before
        // reach this
        $this->assertTrue(true);

        return $body;
    }

    /**
     * @param AbstractRequester $request
     * @return mixed
     * @throws DefinitionNotFoundException
     * @throws GenericSwaggerException
     * @throws HttpMethodNotFoundException
     * @throws InvalidDefinitionException
     * @throws NotMatchedException
     * @throws PathNotFoundException
     * @throws StatusCodeNotMatchedException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function assertRequest(AbstractRequester $request)
    {
        assert($this instanceof TestCase);

        // Add own schema if nothing is passed.
        if (!$request->hasSchema()) {
            $this->checkSchema();

It seems like you code against a specific sub-type and not the parent class PHPUnit\Framework\TestCase as the method checkSchema() does only exist in the following sub-classes of PHPUnit\Framework\TestCase: ByJG\ApiTools\ApiTestCase. Maybe you want to instanceof check for one of these explicitly?

            $request->withSchema($this->schema);

The property schema does not seem to exist in PHPUnit\Framework\TestCase.

        }

        // Request based on the Swagger Request definitios
        $body = $request->send();

        // Note:
        // This code is only reached if the send is successful and
        // all matches are satisfied. Otherwise an error is throwed before
        // reach this
        $this->assertTrue(true);

        return $body;
    }

    /**
     * @throws GenericSwaggerException
     */
    protected function checkSchema()
    {
        if (!$this->schema) {
            throw new GenericSwaggerException('You have to configure a schema for either the request or the testcase');
        }
    }
}