Gerrie\Check\APIConnectionCheck

Complexity

Total Complexity

7

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	2

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	check()	0	18	3
A	getSuccessMessage()	0	7	1
A	getFailureMessage()	0	8	1
A	isOptional()	0	4	1

<?php
/**
 * This file is part of the Gerrie package.
 *
 * (c) Andreas Grunwald <andygrunwald@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gerrie\Check;

use Gerrie\API\DataService\DataServiceInterface;

/**
 * Checks if the API connection via SSH or REST works as expected.
 *
 * @author Andreas Grunwald <andygrunwald@gmail.com>
 */
class APIConnectionCheck implements CheckInterface
{

    /**
     * DataService object
     *
     * @var DataServiceInterface
     */
    protected $dataService;

    /**
     * Version of Gerrit instance
     *
     * @var string
     */
    protected $version;

    public function __construct(DataServiceInterface $dataService)
    {
        $this->dataService = $dataService;
    }

    /**
     * Executes the check itselfs
     *
     * @return boolean
     */
    public function check()
    {
        $result = false;

        $version = $this->dataService->getVersion();

        // Check the version. If this is > 0 then it seems to be a version number like 1.2.3
        // Because the getVersion method can return an error like
        //      Warning: Identity file /Users/agrunwald/.ssh/id_rsa_config not accessible: No such file or directory.
        //      Permission denied (publickey).
        //
        if ($version && version_compare($version, 0, '>')) {
            $this->version = $version;
            $result = true;
        }

        return $result;
    }

    /**
     * Returns the message, if the check succeeded
     *
     * @return string
     */
    public function getSuccessMessage()
    {
        $message = 'Connection to Gerrit "%s" (v%s) via %s-DataService was successful and works as expected.';
        $message = sprintf($message, $this->dataService->getHost(), $this->version, $this->dataService->getName());

        return $message;
    }

    /**
     * Returns the message, if the check fails
     *
     * @return string
     */
    public function getFailureMessage()
    {
        $message  = 'Connection to Gerrit "%s" via %s-DataService was not successful. ';
        $message .= 'Please check your credentials or setup.';
        $message = sprintf($message, $this->dataService->getHost(), $this->dataService->getName());

        return $message;
    }

    /**
     * Returns if this check is optional or required.
     *
     * @return bool
     */
    public function isOptional()
    {
        return false;
    }
}