Magium\Util\Api\Clairvoyant\Clairvoyant

Complexity

Total Complexity

37

Size/Duplication

Total Lines	332
Duplicated Lines	19.88 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes	3
Bugs	1	Features	0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	getEnabled()	0	4	1
A	setEnabled()	0	4	1
A	getProjectId()	0	4	1
A	setProjectId()	0	4	1
A	setApiRequest()	0	4	1
A	setTestRunId()	0	10	2
A	reset()	0	13	1
A	markKeyCheckpoint()	0	10	1
A	setSessionId()	0	4	1
A	setCapability()	0	4	1
A	setTestDescription()	0	4	1
A	setTestTitle()	0	4	1
A	addFilter()	0	4	1
A	setFormatter()	0	4	1
A	write()	0	12	4
A	shutdown()	0	4	1
A	addError()	11	11	1
A	addFailure()	11	11	1
A	addIncompleteTest()	11	11	1
A	addRiskyTest()	11	11	1
A	addSkippedTest()	11	11	1
A	startTestSuite()	0	4	1
A	endTestSuite()	0	4	1
A	startTest()	0	16	2
A	endTest()	11	11	1
B	send()	0	38	6

<?php

namespace Magium\Util\Api\Clairvoyant;

use Exception;
use Magium\AbstractConfigurableElement;
use Magium\AbstractTestCase;
use Magium\Util\Api\ApiConfiguration;
use Magium\Util\Api\Request;
use Magium\Util\Configuration\ConfigurationCollector\DefaultPropertyCollector;
use Magium\Util\Configuration\StandardConfigurationProvider;
use Magium\Util\Log\Logger;
use PHPUnit_Framework_AssertionFailedError;
use PHPUnit_Framework_Test;
use PHPUnit_Framework_TestSuite;
use RandomLib\Factory;
use SecurityLib\Strength;
use Zend\Log\Writer\WriterInterface;

class Clairvoyant extends AbstractConfigurableElement implements WriterInterface, \PHPUnit_Framework_TestListener
{
    const TYPE_TEST_RESULT = 'test-result';
    const TYPE_TEST_STATUS = 'test-status';
    const TYPE_TEST_CHECKPOINT = 'test-checkpoint';

    const TEST_RESULT_PASSED = 'passed';
    const TEST_RESULT_ERROR = 'error';
    const TEST_RESULT_FAILED = 'failed';
    const TEST_RESULT_SKIPPED = 'skipped';
    const TEST_RESULT_RISKY = 'risky';
    const TEST_RESULT_INCOMPLETE = 'incomplete';

    const TEST_STATUS_STARTED = 'started';
    const TEST_STATUS_COMPLETED = 'completed';

    /**
     * This provides the Clairvoyant-based project ID.  It must be retrieved from the MagiumLib.com website.  If 
     * Clairvoyant is enabled and this project ID is missing an exception will be thrown.
     *
     * @var string
     */

    public $projectId;
    public $enabled = null;

    protected $testName;
    protected $logger;
    protected $testTitle;
    protected $testDescription;
    protected $capability;
    protected $sessionId;
    /**
     * @var Request
     */
    protected $request;
    protected $testId;
    protected static $testRunId;
    protected $events = [];
    protected $apiConfiguration;
    protected $testResult;
    protected $characteristics = [];

    public function __construct(
        StandardConfigurationProvider $configurationProvider,
        DefaultPropertyCollector $collector,
        ApiConfiguration $apiConfiguration,
        Logger $logger)
    {
        parent::__construct($configurationProvider, $collector);
        $this->apiConfiguration = $apiConfiguration;
        $this->logger = $logger;
    }


    /**
     * @return bool
     */
    public function getEnabled()
    {
        return $this->enabled;
    }

    /**
     * @param bool $enabled
     */
    public function setEnabled($enabled)
    {
        $this->enabled = $enabled;
    }

    /**
     * @return mixed
     */
    public function getProjectId()
    {
        return $this->projectId;
    }

    /**
     * @param mixed $projectId
     */
    public function setProjectId($projectId)
    {
        $this->projectId = $projectId;
    }



    public function setApiRequest(Request $request)
    {
        $this->request = $request;
    }

    /**
     * Provide a test-run-wide ID that can be used to tie individual test runs together
     *
     * @param string $id
     */

    public static function setTestRunId($id = null)
    {
        if ($id === null) {

            $factory = new Factory();
            $generator = $factory->getGenerator(new Strength(Strength::MEDIUM));
            $id = $generator->generateString(64);
        }
        self::$testRunId = $id;
    }

    public function reset()
    {
        $this->testDescription
            = $this->testName
            = $this->testTitle = null;
        $this->testResult = self::TEST_RESULT_PASSED;
        $this->characteristics = [];
        $this->events = [];

        $factory = new Factory();
        $generator = $factory->getGenerator(new Strength(Strength::MEDIUM));
        $this->testId = $generator->generateString(64);
    }

    public function markKeyCheckpoint($checkpoint)
    {
        $this->write([
            'message'   => $checkpoint,
            'extra'     => [
                'type'      => self::TYPE_TEST_CHECKPOINT,
                'value'    => $checkpoint
            ]
        ]);
    }

    public function setSessionId($sessionId)
    {
        $this->sessionId = $sessionId;
    }

    /**
     * @param mixed $capability
     */
    public function setCapability($capability)
    {
        $this->capability = $capability;
    }

    /**
     * @param mixed $testDescription
     */
    public function setTestDescription($testDescription)
    {
        $this->testDescription = $testDescription;
    }

    /**
     * @param mixed $testTitle
     */
    public function setTestTitle($testTitle)
    {
        $this->testTitle = $testTitle;
    }

    public function addFilter($filter)
    {
        // Ignore - The filter is on the server side
    }

    public function setFormatter($formatter)
    {
        // Ignore
    }

    public function write(array $event)
    {
        if (isset($event['extra']['type']) && $event['extra']['type'] == 'characteristic') {
            $this->characteristics[$event['extra']['characteristic']] = $event['extra']['value'];
            return;
        }
        if (isset($event['extra'][self::TYPE_TEST_RESULT])) {
            $this->testResult = $event['extra'][self::TYPE_TEST_RESULT];
        }
        $event['microtime'] = microtime(true);
        $this->events[] = $event;
    }

    public function shutdown()
    {
        // Ignored.  Test data is pushed at the end of each test run.
    }

    public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)

This method seems to be duplicated in your project.

    {
        $this->testResult = self::TEST_RESULT_ERROR;
        $this->write([
            'message'   => $e->getMessage(),
            'extra'     => [
                'type'      => self::TYPE_TEST_RESULT,
                'value'    => self::TEST_RESULT_ERROR
            ]
        ]);
    }

    public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time)

This method seems to be duplicated in your project.

    {
        $this->testResult = self::TEST_RESULT_FAILED;
        $this->write([
            'message'   => $e->getMessage(),
            'extra'     => [
                'type'      => self::TYPE_TEST_RESULT,
                'value'    => self::TEST_RESULT_FAILED
            ]
        ]);
    }

    public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)

This method seems to be duplicated in your project.

    {
        $this->testResult = self::TEST_RESULT_INCOMPLETE;
        $this->write([
            'message'   => $e->getMessage(),
            'extra'     => [
                'type'      => self::TYPE_TEST_RESULT,
                'value'    => self::TEST_RESULT_INCOMPLETE
            ]
        ]);
    }

    public function addRiskyTest(PHPUnit_Framework_Test $test, Exception $e, $time)

This method seems to be duplicated in your project.

    {
        $this->testResult = self::TEST_RESULT_RISKY;
        $this->write([
            'message'   => $e->getMessage(),
            'extra'     => [
                'type'      => self::TYPE_TEST_RESULT,
                'value'    => self::TEST_RESULT_RISKY
            ]
        ]);
    }

    public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time)

This method seems to be duplicated in your project.

    {
        $this->testResult = self::TEST_RESULT_SKIPPED;
        $this->write([
            'message'   => $e->getMessage(),
            'extra'     => [
                'type'      => self::TYPE_TEST_RESULT,
                'value'    => self::TEST_RESULT_SKIPPED
            ]
        ]);
    }

    public function startTestSuite(PHPUnit_Framework_TestSuite $suite)
    {
        $this->reset();
    }

    public function endTestSuite(PHPUnit_Framework_TestSuite $suite)
    {
        $this->send(); // Just in case.
    }

    public function startTest(PHPUnit_Framework_Test $test)
    {
        $this->reset();
        if ($test instanceof AbstractTestCase) {
            $this->testName = $test->getName();
        }
        $this->write([
            'message'   => 'Test started',
            'extra'     => [
                'type'      => self::TYPE_TEST_STATUS,
                'value'    => self::TEST_STATUS_STARTED,
                'class'     => get_class($test),
                'name'      => $test->getName()

It seems like you code against a concrete implementation and not the interface PHPUnit_Framework_Test as the method getName() does only exist in the following implementations of said interface: AbstractTest, BankAccountTest, BankAccountWithCustomExtensionTest, BeforeAndAfterTest, BeforeClassAndAfterClassTest, ChangeCurrentWorkingDirectoryTest, ConcreteTest, ConcreteWithMyCustomExtensionTest, CountTest, CoverageClassExtendedTest, CoverageClassTest, CoverageFunctionParenthesesTest, CoverageFunctionParenthesesWhitespaceTest, CoverageFunctionTest, CoverageMethodOneLineAnnotationTest, CoverageMethodParenthesesTest, CoverageMethodParenthesesWhitespaceTest, CoverageMethodTest, CoverageNamespacedFunctionTest, CoverageNoneTest, CoverageNotPrivateTest, CoverageNotProtectedTest, CoverageNotPublicTest, CoverageNothingTest, CoveragePrivateTest, CoverageProtectedTest, CoveragePublicTest, DataProviderDebugTest, DataProviderFilterTest, DataProviderIncompleteTest, DataProviderSkippedTest, DataProviderTest, DependencyFailureTest, DependencySuccessTest, EmptyTestCaseTest, ExceptionInAssertPostConditionsTest, ExceptionInAssertPreConditionsTest, ExceptionInSetUpTest, ExceptionInTearDownTest, ExceptionInTest, ExceptionMessageRegExpTest, ExceptionMessageTest, ExceptionStackTest, ExceptionTest, Extensions_PhptTestCaseTest, Extensions_RepeatedTestTest, Failure, FailureTest, FatalTest, Foo_Bar_Issue684Test, Framework_AssertTest, Framework_BaseTestListenerTest, Framework_ConstraintTest, Framework_Constraint_JsonMatchesTest, Framework_Constraint_JsonMatches_ErrorMessageProviderTest, Framework_SuiteTest, Framework_TestCaseTest, Framework_TestFailureTest, Framework_TestImplementorTest, Framework_TestListenerTest, IncompleteTest, InheritanceA, InheritanceB, InheritedTestCase, IniTest, IsolationTest, Issue1021Test, Issue1149Test, Issue1216Test, Issue1265Test, Issue1330Test, Issue1335Test, Issue1337Test, Issue1348Test, Issue1351Test, Issue1374Test, Issue1437Test, Issue1468Test, Issue1471Test, Issue1472Test, Issue1570Test, Issue244Test, Issue322Test, Issue433Test, Issue445Test, Issue498Test, Issue503Test, Issue523Test, Issue578Test, Issue581Test, Issue74Test, Issue765Test, Issue797Test, Magium\AbstractCallbackTestCase, Magium\AbstractTestCase, Magium\Cli\Command\Test\TestSkeleton, MultiDependencyTest, My\Space\ExceptionNamespaceTest, NamespaceCoverageClassExtendedTest, NamespaceCoverageClassTest, NamespaceCoverageCoversClassPublicTest, NamespaceCoverageCoversClassTest, NamespaceCoverageMethodTest, NamespaceCoverageNotPrivateTest, NamespaceCoverageNotProtectedTest, NamespaceCoverageNotPublicTest, NamespaceCoveragePrivateTest, NamespaceCoverageProtectedTest, NamespaceCoveragePublicTest, NoArgTestCaseTest, NoTestCases, NotExistingCoveredElementTest, NotPublicTestCase, NotVoidTestCase, NothingTest, OneTest, OneTestCase, OutputTestCase, OverrideTestCase, PHPUnit_Extensions_GroupTestSuite, PHPUnit_Extensions_PhptTestCase, PHPUnit_Extensions_PhptTestSuite, PHPUnit_Framework_IncompleteTestCase, PHPUnit_Framework_SkippedTestCase, PHPUnit_Framework_TestCase, PHPUnit_Framework_TestSuite, PHPUnit_Framework_TestSuite_DataProvider, PHPUnit_Framework_Warning, PhpTestCaseProxy, RequirementsClassBeforeClassHookTest, RequirementsTest, Runner_BaseTestRunnerTest, StackTest, Success, TemplateMethodsTest, TestError, TestIncomplete, TestSkipped, TestWithTest, ThrowExceptionTestCase, ThrowNoExceptionTestCase, TwoTest, Util_ConfigurationTest, Util_GetoptTest, Util_GlobalStateTest, Util_RegexTest, Util_TestDox_NamePrettifierTest, Util_TestTest, Util_XMLTest, WasRun.

            ]
        ]);
    }

    public function endTest(PHPUnit_Framework_Test $test, $time)

This method seems to be duplicated in your project.

    {
        $this->write([
            'message'   => 'Test completed',
            'extra'     => [
                'type'      => self::TYPE_TEST_STATUS,
                'value'    => self::TEST_STATUS_COMPLETED,
            ]
        ]);
        $this->send();
    }

    public function send()
    {

        if (!$this->enabled === null) {
            $this->enabled = $this->apiConfiguration->getEnabled();
        }

        if (!empty($this->events) && $this->enabled) {
            if (!$this->getProjectId()) {
                throw new MissingProjectIdException('Missing the project ID.  You either need to disable Clairvoyant or get a project ID from http://magiumlib.com/');
            }

            $this->write([
                'message'   => 'Final test result',
                'extra'     => [
                    'type'      => self::TYPE_TEST_RESULT,
                    'value'    => $this->testResult,
                ]
            ]);
            $payload = [
                'title'             => $this->testTitle,
                'description'       => $this->testDescription,
                'id'                => $this->testId,
                'session_id'        => $this->sessionId,
                'events'            => $this->events,
                'version'           => '1',
                'project_id'        => $this->projectId,
                'invoked_test'      => $this->logger->getInvokedTest(),
                'characteristics'   => $this->characteristics
            ];

            if (self::$testRunId !== null) {
                $payload['test_run_id'] = self::$testRunId;
            }
            $this->request->push('/clairvoyant/api/ingest', $payload);
        }
        $this->events = [];
    }

}