Peridot\Core\TestResult

Complexity

Total Complexity

16

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getSummary()	0	9	2
A	failTest()	0	5	1
A	pendTest()	0	5	1
A	passTest()	0	4	1
A	startTest()	0	5	1
A	endTest()	0	4	1
A	getFailureCount()	0	4	1
A	setFailureCount()	0	5	1
A	getTestCount()	0	4	1
A	setTestCount()	0	5	1
A	getPendingCount()	0	4	1
A	setPendingCount()	0	5	1
A	isFocusedByDsl()	0	4	1
A	setIsFocusedByDsl()	0	5	1

<?php

namespace Peridot\Core;

use Evenement\EventEmitterInterface;

/**
 * TestResults tracks passing, pending, and failing tests.
 *
 * @package Peridot\Core
 */
class TestResult
{
    use HasEventEmitterTrait;

    /**
     * Tracks total tests run against this result
     *
     * @var int
     */
    protected $testCount = 0;

    /**
     * Tracks total number of failed tests run against this result
     *
     * @var int
     */
    protected $failureCount = 0;

    /**
     * Tracks total number of pending tests run against this result
     *
     * @var int
     */
    protected $pendingCount = 0;

    /**
     * True if focused specs were configured via DSL functions
     *
     * @var bool
     */
    protected $isFocusedByDsl = false;

    /**
     * @param EventEmitterInterface $eventEmitter
     */
    public function __construct(EventEmitterInterface $eventEmitter)
    {
        $this->eventEmitter = $eventEmitter;
    }

    /**
     * Returns a summary string containing total tests run and total tests
     * failed
     *
     * @return string
     */
    public function getSummary()
    {
        $summary = sprintf('%d run, %d failed', $this->testCount, $this->failureCount);
        if ($this->pendingCount > 0) {
            $summary .= sprintf(', %d pending', $this->pendingCount);
        }

        return $summary;
    }

    /**
     * Fail the given test.
     *
     * @param TestInterface $test
     * @param mixed $exception
     */
    public function failTest(TestInterface $test, $exception)
    {
        $this->failureCount++;
        $this->eventEmitter->emit('test.failed', [$test, $exception]);
    }

    /**
     * Notify result that test is pending
     *
     * @param TestInterface $test
     */
    public function pendTest(TestInterface $test)
    {
        $this->pendingCount++;
        $this->eventEmitter->emit('test.pending', [$test]);
    }

    /**
     * Pass the given test.
     *
     * @param TestInterface $test
     */
    public function passTest(TestInterface $test)
    {
        $this->eventEmitter->emit('test.passed', [$test]);
    }

    /**
     * Increment test count and emit start event
     *
     * @param TestInterface $test
     */
    public function startTest(TestInterface $test)
    {
        $this->testCount++;
        $this->eventEmitter->emit('test.start', [$test]);
    }

    /**
     * Emit end event for a test
     *
     * @param TestInterface $test
     */
    public function endTest(TestInterface $test)
    {
        $this->eventEmitter->emit('test.end', [$test]);
    }

    /**
     * Get the number of failures tracked by this result.
     *
     * @return int
     */
    public function getFailureCount()
    {
        return $this->failureCount;
    }

    /**
     * Set the number of failures tracked by this result.
     *
     * @param int $failureCount
     */
    public function setFailureCount($failureCount)
    {
        $this->failureCount = $failureCount;
        return $this;
    }

    /**
     * Get the number of tests tracked by this
     * result.
     *
     * @return int
     */
    public function getTestCount()
    {
        return $this->testCount;
    }

    /**
     * Set the number of tests tracked by this
     * result.
     *
     * @param int $testCount
     */
    public function setTestCount($testCount)
    {
        $this->testCount = $testCount;
        return $this;
    }

    /**
     * Get the number of pending tests tracked
     * by this test result.
     *
     * @return int
     */
    public function getPendingCount()
    {
        return $this->pendingCount;
    }

    /**
     * Set the number of pending tests tracked
     * by this test result.
     *
     * @param int $pendingCount
     */
    public function setPendingCount($pendingCount)
    {
        $this->pendingCount = $pendingCount;
        return $this;
    }

    /**
     * Returns true if focused specs were configured via DSL functions
     *
     * @return bool
     */
    public function isFocusedByDsl()
    {
        return $this->isFocusedByDsl;
    }

    /**
     * Mark this result as having focused specs configured via DSL functions
     *
     * @param bool $isFocusedByDsl
     */
    public function setIsFocusedByDsl($isFocusedByDsl)
    {
        $this->isFocusedByDsl = $isFocusedByDsl;
        return $this;
    }
}