--- /dev/null
+<?php
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Base class for test listeners that interact with an issue tracker.
+ *
+ * @since Class available since Release 3.4.0
+ */
+abstract class PHPUnit_Extensions_TicketListener implements PHPUnit_Framework_TestListener
+{
+ /**
+ * @var array
+ */
+ protected $ticketCounts = array();
+
+ /**
+ * @var bool
+ */
+ protected $ran = false;
+
+ /**
+ * An error occurred.
+ *
+ * @param PHPUnit_Framework_Test $test
+ * @param Exception $e
+ * @param float $time
+ */
+ public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)
+ {
+ }
+
+ /**
+ * A failure occurred.
+ *
+ * @param PHPUnit_Framework_Test $test
+ * @param PHPUnit_Framework_AssertionFailedError $e
+ * @param float $time
+ */
+ public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time)
+ {
+ }
+
+ /**
+ * Incomplete test.
+ *
+ * @param PHPUnit_Framework_Test $test
+ * @param Exception $e
+ * @param float $time
+ */
+ public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)
+ {
+ }
+
+ /**
+ * Risky test.
+ *
+ * @param PHPUnit_Framework_Test $test
+ * @param Exception $e
+ * @param float $time
+ *
+ * @since Method available since Release 4.0.0
+ */
+ public function addRiskyTest(PHPUnit_Framework_Test $test, Exception $e, $time)
+ {
+ }
+
+ /**
+ * Skipped test.
+ *
+ * @param PHPUnit_Framework_Test $test
+ * @param Exception $e
+ * @param float $time
+ *
+ * @since Method available since Release 3.0.0
+ */
+ public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time)
+ {
+ }
+
+ /**
+ * A test suite started.
+ *
+ * @param PHPUnit_Framework_TestSuite $suite
+ *
+ * @since Method available since Release 2.2.0
+ */
+ public function startTestSuite(PHPUnit_Framework_TestSuite $suite)
+ {
+ }
+
+ /**
+ * A test suite ended.
+ *
+ * @param PHPUnit_Framework_TestSuite $suite
+ *
+ * @since Method available since Release 2.2.0
+ */
+ public function endTestSuite(PHPUnit_Framework_TestSuite $suite)
+ {
+ }
+
+ /**
+ * A test started.
+ *
+ * @param PHPUnit_Framework_Test $test
+ */
+ public function startTest(PHPUnit_Framework_Test $test)
+ {
+ if (!$test instanceof PHPUnit_Framework_Warning) {
+ if ($this->ran) {
+ return;
+ }
+
+ $name = $test->getName(false);
+ $tickets = PHPUnit_Util_Test::getTickets(get_class($test), $name);
+
+ foreach ($tickets as $ticket) {
+ $this->ticketCounts[$ticket][$name] = 1;
+ }
+
+ $this->ran = true;
+ }
+ }
+
+ /**
+ * A test ended.
+ *
+ * @param PHPUnit_Framework_Test $test
+ * @param float $time
+ */
+ public function endTest(PHPUnit_Framework_Test $test, $time)
+ {
+ if (!$test instanceof PHPUnit_Framework_Warning) {
+ if ($test->getStatus() == PHPUnit_Runner_BaseTestRunner::STATUS_PASSED) {
+ $ifStatus = array('assigned', 'new', 'reopened');
+ $newStatus = 'closed';
+ $message = 'Automatically closed by PHPUnit (test passed).';
+ $resolution = 'fixed';
+ $cumulative = true;
+ } elseif ($test->getStatus() == PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE) {
+ $ifStatus = array('closed');
+ $newStatus = 'reopened';
+ $message = 'Automatically reopened by PHPUnit (test failed).';
+ $resolution = '';
+ $cumulative = false;
+ } else {
+ return;
+ }
+
+ $name = $test->getName(false);
+ $tickets = PHPUnit_Util_Test::getTickets(get_class($test), $name);
+
+ foreach ($tickets as $ticket) {
+ // Remove this test from the totals (if it passed).
+ if ($test->getStatus() == PHPUnit_Runner_BaseTestRunner::STATUS_PASSED) {
+ unset($this->ticketCounts[$ticket][$name]);
+ }
+
+ // Only close tickets if ALL referenced cases pass
+ // but reopen tickets if a single test fails.
+ if ($cumulative) {
+ // Determine number of to-pass tests:
+ if (count($this->ticketCounts[$ticket]) > 0) {
+ // There exist remaining test cases with this reference.
+ $adjustTicket = false;
+ } else {
+ // No remaining tickets, go ahead and adjust.
+ $adjustTicket = true;
+ }
+ } else {
+ $adjustTicket = true;
+ }
+
+ $ticketInfo = $this->getTicketInfo($ticket);
+
+ if ($adjustTicket && in_array($ticketInfo['status'], $ifStatus)) {
+ $this->updateTicket($ticket, $newStatus, $message, $resolution);
+ }
+ }
+ }
+ }
+
+ /**
+ * @param mixed $ticketId
+ *
+ * @return mixed
+ */
+ abstract protected function getTicketInfo($ticketId = null);
+
+ /**
+ * @param string $ticketId
+ * @param string $newStatus
+ * @param string $message
+ * @param string $resolution
+ */
+ abstract protected function updateTicket($ticketId, $newStatus, $message, $resolution);
+}