zsturgess / overwatch

src/ServiceBundle/Expectation/ToRespondHttpExpectation.php

<?php

namespace Overwatch\ServiceBundle\Expectation;

use GuzzleHttp\Client;
use Overwatch\ExpectationBundle\Exception as Result;
use Overwatch\ExpectationBundle\Expectation\ExpectationInterface;
use Symfony\Component\HttpFoundation\Response;

/**
 * ToResolveToExpectation
 * Expectation classes are the actual runners of tests.
 * This is the runner for the "toRespondHttp" expectation.
 */
class ToRespondHttpExpectation implements ExpectationInterface
{
    private $config;
    private $client;
    
    public function __construct($config, $client_options = [])

The parameter $client_options is not named in camelCase.

    {
        $this->config = $config;
        $this->client = new Client($client_options);
    }
    
    public function run($actual, $expected = null)
    {
        $actual = filter_var($actual, FILTER_VALIDATE_URL, FILTER_FLAG_PATH_REQUIRED);
        
        if ($actual === false) {
            throw new \InvalidArgumentException('The actual value provided is not a valid URL');
        }

        try {
            $response = $this->client->get(
                $actual,
                [
                    'allow_redirects' => false,
                    'http_errors'     => false,
                    'timeout'         => $this->config['timeout']
                ]
            );
        } catch (\Exception $e) {
            //Transform exception under certain circumstances, else re-throw.
            if ($e instanceof \GuzzleHttp\Exception\RequestException && !$e->hasResponse()) {
                throw new Result\ExpectationFailedException("Expected $actual to respond HTTP $expected, actually failed to respond", 0, $e);

As per coding-style, please use concatenation or sprintf for the variable $actual instead of interpolation.

As per coding-style, please use concatenation or sprintf for the variable $expected instead of interpolation.

            }
            
            throw $e;
        }
        
        $result = $response->getStatusCode();
        
        if ($this->isValidStatusCode($expected)) {
            if ((int) $expected !== $result) {
                throw new Result\ExpectationFailedException("Expected $actual to respond HTTP $expected, actually responded HTTP $result");

As per coding-style, please use concatenation or sprintf for the variable $actual instead of interpolation.

As per coding-style, please use concatenation or sprintf for the variable $expected instead of interpolation.

As per coding-style, please use concatenation or sprintf for the variable $result instead of interpolation.

            }
        } else {
            if (in_array($result, $this->config['unsatisfactory_codes'])) {
                throw new Result\ExpectationUnsatisfactoryException("$actual responded HTTP $result, which is configured as unsatisfactory");

As per coding-style, please use concatenation or sprintf for the variable $actual instead of interpolation.

As per coding-style, please use concatenation or sprintf for the variable $result instead of interpolation.

            } elseif (!in_array($result, $this->config['allowable_codes'])) {
                throw new Result\ExpectationFailedException("$actual responded HTTP $result, which is configured as a failed result");

As per coding-style, please use concatenation or sprintf for the variable $actual instead of interpolation.

As per coding-style, please use concatenation or sprintf for the variable $result instead of interpolation.

            }
        }
        
        return "Responded HTTP $result " . $response->getReasonPhrase();

As per coding-style, please use concatenation or sprintf for the variable $result instead of interpolation.

    }
    
    private function isValidStatusCode($code)
    {
        return in_array($code, array_keys(Response::$statusTexts));
    }
}