HtaccessCapabilityTester\Testers\AbstractTester

Complexity

Total Complexity

18

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Test Coverage

Coverage

82.98%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getHtaccessCapabilityTester()	0	12	4
A	prepareForRun()	0	7	1
A	setTestFilesLineUpper()	0	5	2
A	__construct()	0	3	1
A	setHttpRequester()	0	5	2
A	registerTestFile()	0	3	1
A	getCacheKey()	0	3	1
A	lineUpTestFiles()	0	6	2
A	makeHttpRequest()	0	7	2
A	getBaseUrl()	0	3	1
A	getBaseDir()	0	3	1

<?php

namespace HtaccessCapabilityTester\Testers;

use \HtaccessCapabilityTester\HtaccessCapabilityTester;
use \HtaccessCapabilityTester\HttpRequesterInterface;
use \HtaccessCapabilityTester\HttpResponse;
use \HtaccessCapabilityTester\SimpleHttpRequester;
use \HtaccessCapabilityTester\SimpleTestFileLineUpper;
use \HtaccessCapabilityTester\TestFilesLineUpperInterface;
use \HtaccessCapabilityTester\TestResult;

abstract class AbstractTester
{
    /** @var string  The dir where the test files should be put */
    protected $baseDir;

    /** @var string  The base url that the tests can be run from (corresponds to $baseDir) */
    protected $baseUrl;

    /** @var string  Subdir to put .htaccess files in */
    protected $subDir;

    /** @var array  Test files for the test */
    protected $testFiles;

    /** @var HttpRequesterInterface  An object for making the HTTP request */
    protected $httpRequester;

    /** @var HttpResponse  The response of the previous HTTP request (if any) */
    public $lastHttpResponse;

    /** @var TestFilesLineUpperInterface  An object for lining up the test-files */
    protected $testFilesLineUpper;

    /** @var HtaccessCapabilityTester  The HtaccessCapabilityTester to use for subtests */
    private $hct;

    /**
     * Register the test files using the "registerTestFile" method
     *
     * @return  void
     */
    abstract protected function registerTestFiles();

    /**
     * Child classes must implement this method, which tells which subdir the
     * test files are to be put.
     *
     * @return  string  A subdir for the test files
     */
    abstract protected function getSubDir();

    /**
     * Get key for caching purposes.
     *
     * Return a unique key. The default is to use the subdir. However, if a concrete Tester class
     * can test different things, it must override this method and make sure to return a different
     * key per thing it can test
     *
     * @return  string  A key it can be cached under
     */
    public function getCacheKey()
    {
        return $this->getSubDir();
    }

    public function getBaseDir()
    {
        return $this->baseDir;
    }

    public function getBaseUrl()
    {
        return $this->baseUrl;
    }

    /**
     * Child classes must that implement the registerTestFiles method must call
     * this method to register each test file.
     *
     * @return  void
     */
    protected function registerTestFile($filename, $content)
    {
        $this->testFiles[] = [$this->baseDir . '/' . $filename, $content];
    }

    /**
     * Last moment preparations before running the test
     *
     * @param  string  $baseDir  Directory on the server where the test files can be put
     * @param  string  $baseUrl  The base URL of the test files
     *
     * @throws \Exception  In case the test cannot be prepared due to serious issues
     */
    protected function prepareForRun($baseDir, $baseUrl)
    {
        $this->baseDir = $baseDir;
        $this->baseUrl = $baseUrl;
        $this->testFiles = [];
        $this->registerTestFiles();
        $this->lineUpTestFiles();
    }

    abstract public function run($baseDir, $baseUrl);

    /**
     * Constructor.
     *
     * @return void
     */
    public function __construct()
    {
        $this->subDir = $this->getSubDir();
    }

    /**
     * Make a HTTP request to a URL.
     *
     * @param  string  $url  The URL to make the HTTP request to
     *
     * @return  HttpResponse  A HttpResponse object, which simply contains body and status code.
     */
    protected function makeHttpRequest($url)
    {
        if (!isset($this->httpRequester)) {
            $this->httpRequester = new SimpleHttpRequester();
        }
        $this->lastHttpResponse = $this->httpRequester->makeHttpRequest($url);
        return $this->lastHttpResponse;
    }

    /**
     * Set HTTP requester object, which handles making HTTP requests.
     *
     * @param  HttpRequesterInterface  $httpRequester  The HTTPRequester to use
     * @return void
     */
    public function setHttpRequester($httpRequester)
    {
        $this->httpRequester = $httpRequester;
        if (isset($this->hct)) {
            $this->hct->setHttpRequester($this->httpRequester);
        }
    }

    public function lineUpTestFiles()
    {
        if (!isset($this->testFilesLineUpper)) {
            $this->testFilesLineUpper = new SimpleTestFileLineUpper();
        }
        $this->testFilesLineUpper->lineUp($this->testFiles);
    }

    /**
     * Set object responsible for lining up the test files.
     *
     * @param  TestFilesLineUpperInterface  $testFilesLineUpper
     * @return void
     */
    public function setTestFilesLineUpper($testFilesLineUpper)
    {
        $this->testFilesLineUpper = $testFilesLineUpper;
        if (isset($this->hct)) {
            $this->hct->setTestFilesLineUpper($this->testFilesLineUpper);
        }
    }

    /**
     * Get HtaccessCapabilityTester.
     *
     * Some tests use HtaccessCapabilityTester to run other tests.
     * This gets such object with baseDir and baseUrl set up
     *
     * @return HtaccessCapabilityTester
     */
    public function getHtaccessCapabilityTester()
    {
        if (!isset($this->hct)) {
            $this->hct = new HtaccessCapabilityTester($this->baseDir, $this->baseUrl);
            if (isset($this->testFilesLineUpper)) {
                $this->hct->setTestFilesLineUpper($this->testFilesLineUpper);
            }
            if (isset($this->httpRequester)) {
                $this->hct->setHttpRequester($this->httpRequester);
            }
        }
        return $this->hct;
    }
}