Wie in CLI während der Ausführung von PHP Unit Tests ausgeben?

Wenn ich einen PHPUnit-Test durchführe, möchte ich in der Lage sein, die Ausgabe zu sichern, damit ich ein oder zwei Dinge debuggen kann.

Ich habe Folgendes versucht (ähnlich dem Beispiel im PHPUnit-Handbuch );

class theTest extends PHPUnit_Framework_TestCase
{
    /**
     * @outputBuffering disabled
     */
    public function testOutput() {
        print_r("Hello World");
        print "Ping";
        echo "Pong";
        $out = "Foo";
        var_dump($out);
    }   
}

Mit folgendem Ergebnis:

PHPUnit @package_version@ by Sebastian Bergmann.

.

Time: 0 seconds, Memory: 3.00Mb

OK (1 test, 0 assertions)

Beachten Sie, dass keine der erwarteten Ausgaben vorhanden ist.

Ich verwende die HEAD-Versionen der Git-Repos vom 19. September 2011.

Ausgabe von php -version:

$ php -version
PHP 5.2.9 (cli) (built: Dec  8 2010 11:36:37) 
Copyright (c) 1997-2009 The PHP Group
Zend Engine v2.2.0, Copyright (c) 1998-2009 Zend Technologies
    with Xdebug v2.1.0, Copyright (c) 2002-2010, by Derick Rethans

Gibt es irgendetwas, was ich falsch mache, oder ist dies möglicherweise ein PHPUnit-Fehler?

AKTUALISIEREN

Ich habe gerade eine andere Möglichkeit erkannt, die viel besser funktioniert als die --verboseBefehlszeilenoption:

class TestSomething extends PHPUnit_Framework_TestCase {
    function testSomething() {
        $myDebugVar = array(1, 2, 3);
        fwrite(STDERR, print_r($myDebugVar, TRUE));
    }
}

Auf diese Weise können Sie jederzeit alles auf Ihre Konsole kopieren, ohne die unerwünschte Ausgabe, die mit der --verboseCLI-Option einhergeht.

Wie andere Antworten festgestellt haben, ist es am besten, die Ausgabe mit den integrierten Methoden wie den folgenden zu testen:

$this->expectOutputString('foo');

Manchmal ist es jedoch hilfreich, ungezogen zu sein und einmalige / vorübergehende Debugging-Ausgaben in Ihren Testfällen zu sehen. Der var_dumpHack / Workaround ist jedoch nicht erforderlich . Dies kann leicht erreicht werden, indem Sie die --verboseBefehlszeilenoption festlegen, wenn Sie Ihre Testsuite ausführen. Beispielsweise:

$ phpunit --verbose -c phpunit.xml

Dadurch wird die Ausgabe innerhalb Ihrer Testmethoden angezeigt, wenn Sie in der CLI-Umgebung ausgeführt werden.

Siehe: Schreiben von Tests für PHPUnit - Testen der Ausgabe .

Update: Siehe das Update von rdlowrey unten bezüglich der Verwendung fwrite(STDERR, print_r($myDebugVar, TRUE));als viel einfachere Lösung

Dieses Verhalten ist beabsichtigt (wie jasonbar hat darauf hingewiesen ). Der widersprüchliche Status des Handbuchs wurde PHPUnit gemeldet .

Eine Problemumgehung besteht darin, dass PHPUnit bestätigt, dass die erwartete Ausgabe leer ist (wenn tatsächlich eine Ausgabe vorliegt), wodurch die unerwartete Ausgabe ausgelöst wird, die angezeigt wird.

class theTest extends PHPUnit_Framework_TestCase
{
    /**
     * @outputBuffering disabled
     */
    public function testOutput() {
        $this->expectOutputString(''); // tell PHPUnit to expect '' as output
        print_r("Hello World");
        print "Ping";
        echo "Pong";
        $out = "Foo";
        var_dump($out);
    }   
}

gibt:

PHPUnit @package_version@ by Sebastian Bergmann.

F

Time: 1 second, Memory: 3.50Mb

There was 1 failure:

1) theTest::testOutput
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-''
+'Hello WorldPingPongstring(4) "Foo"
+'

FAILURES!
Tests: 1, Assertions: 1, Failures: 1.

Deaktivieren Sie unbedingt alle anderen Assertions, die Sie für den Test haben, da diese möglicherweise fehlschlagen, bevor die Output-Assertion getestet wird (und Sie daher die Ausgabe nicht sehen).

Versuchen Sie es mit --debug

Nützlich, wenn Sie versuchen, den richtigen Pfad zu einer Include- oder Quelldatendatei zu finden.

Es ist kein Fehler, aber sehr beabsichtigt. Am besten schreiben Sie in eine Protokolldatei und verfolgen das Protokoll, um die Ausgabe zu überwachen.

Wenn Sie versuchen, die Ausgabe zu testen, überprüfen Sie dies .

Ebenfalls:

Hinweis : Bitte beachten Sie, dass PHPUnit alle Ausgaben verschluckt, die während der Ausführung eines Tests ausgegeben werden. Im strengen Modus schlägt ein Test fehl, der eine Ausgabe ausgibt.

Ich habe etwas Glück mit VisualPHPUnit und es zeigt unter anderem die Ausgabe hilfreich an.

class TestHello extends PHPUnit_Framework_TestCase 
{
    public function test_Hello() 
    {
        print "hello world";
    }
}

Sie sollten wirklich über Ihre Absichten nachdenken: Wenn Sie die Informationen jetzt beim Debuggen benötigen, um den Test zu beheben, benötigen Sie sie nächste Woche erneut, wenn die Tests unterbrochen werden.

Dies bedeutet, dass Sie die Informationen immer dann benötigen, wenn der Test fehlschlägt - und das Hinzufügen eines var_dump, um die Ursache zu finden, ist einfach zu viel Arbeit. Setzen Sie die Daten lieber in Ihre Aussagen ein.

Wenn Ihr Code dafür zu komplex ist, teilen Sie ihn auf, bis Sie eine Ebene erreicht haben, in der eine Behauptung (mit einer benutzerdefinierten Nachricht) Ihnen genug sagt, um zu wissen, wo er gebrochen ist, warum und wie der Code repariert werden kann.

In Laravel 5 können Sie dump () verwenden. Speichern Sie den Inhalt der letzten Antwort.

class ExampleTest extends TestCase{
    public function test1()
    {
        $this->post('/user', ['name' => 'Gema']);
        $this->dump();
    }
}

gibt

Verwenden Sie einfach das Flag --verbose, wenn Sie phpunit ausführen .

$ phpunit --verbose -c phpunit.xml 

Der Vorteil dieser Methode ist, dass Sie den Testcode nicht ändern müssen, Sie können Zeichenfolgen drucken, var_dump's o alles, was Sie immer wünschen, und es wird in der Konsole nur angezeigt, wenn der ausführliche Modus eingestellt ist.

Ich hoffe das hilft.

In einigen Fällen könnte man so etwas verwenden, um etwas an die Konsole auszugeben

class yourTests extends PHPUnit_Framework_TestCase
{
    /* Add Warnings */
    protected function addWarning($msg, Exception $previous = null)
    {
        $add_warning = $this->getTestResultObject();
        $msg = new PHPUnit_Framework_Warning($msg, 0, $previous);
        $add_warning->addWarning($this, $msg, time());
        $this->setTestResultObject($add_warning);
    }

    /* Add errors */
    protected function addError($msg, Exception $previous = null)
    {
        $add_error = $this->getTestResultObject();
        $msg = new PHPUnit_Framework_AssertionFailedError($msg, 0, $previous);
        $add_error->addError($this, $msg, time());
        $this->setTestResultObject($add_error);
    }

    /* Add failures */
    protected function addFailure($msg, Exception $previous = null)
    {
        $add_failure = $this->getTestResultObject();
        $msg = new PHPUnit_Framework_AssertionFailedError($msg, 0, $previous);
        $add_failure->addFailure($this, $msg, time());
        $this->setTestResultObject($add_failure);
    }

    public function test_messages()
    {
        $this->addWarning("Your warning message!");
        $this->addError("Your error message!");
        $this->addFailure("Your Failure message");
    }

    /* Or just mark test states! */
    public function test_testMarking()
    {
        $this->markTestIncomplete();
        $this->markTestSkipped();
    }
}

Hackisch, funktioniert aber: Wirf eine Ausnahme mit der Debug-Ausgabe als Nachricht aus.

class theTest extends PHPUnit_Framework_TestCase
{
    public function testOutput() {
        throw new \Exception("hello");
    }   
}

Ausbeuten:

...
There was 1 error:

1) theTest::testOutput
Exception: hello

Dies wurde aus PHPUnit Docs about Fixtures übernommen .

Dies sollte es Ihnen ermöglichen, Informationen zu jedem Zeitpunkt während des Lebenszyklus des phpunit-Tests zu sichern.

Ersetzen __METHOD__Sie einfach den folgenden Code durch das, was Sie ausgeben möchten

Beispiel 4.2: Beispiel mit allen verfügbaren Vorlagenmethoden

<?php
class TemplateMethodsTest extends PHPUnit_Framework_TestCase
{
    public static function setUpBeforeClass()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function setUp()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function assertPreConditions()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    public function testOne()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
        $this->assertTrue(TRUE);
    }

    public function testTwo()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
        $this->assertTrue(FALSE);
    }

    protected function assertPostConditions()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function tearDown()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    public static function tearDownAfterClass()
    {
        fwrite(STDOUT, __METHOD__ . "\n");
    }

    protected function onNotSuccessfulTest(Exception $e)
    {
        fwrite(STDOUT, __METHOD__ . "\n");
        throw $e;
    }
}
?>

Ich gebe meine Testergebnisse HTML-basiert aus. In diesem Fall war es hilfreich, den Inhalt zu leeren:

var_dump($array);
ob_flush();

Es gibt eine zweite PHP-Methode

flush() 

was ich nicht versucht habe.

PHPUnit versteckt die Ausgabe mit ob_start(). Wir können es vorübergehend deaktivieren.

    public function log($something = null)
    {
        ob_end_clean();
        var_dump($something);
        ob_start();
    }

Ich musste den Quellcode ändern, damit dieser Code funktioniert, sodass Sie dem Composer eine URL für diese gegabelten Repos hinzufügen müssen, damit dies funktioniert

class TestCase extends \PHPUnit_Framework_TestCase
{
    /**
     *  Save last response
     * @var Response|null A Response instance
     */
    static $lastResponse;
    /**
     *  Modify to save response
     *
     * @param  string $method
     * @param  string $uri
     * @param  array $parameters
     * @param  array $files
     * @param  array $server
     * @param  string $content
     * @param  bool $changeHistory
     * @return \Illuminate\Http\Response
     */
    final public function call(
        $method,
        $uri,
        $parameters = [],
        $files = [],
        $server = [],
        $content = null,
        $changeHistory = true
    ) {

        $response = parent::call($method, $uri, $parameters, $files, $server, $content, $changeHistory);
        static::$lastResponse = $this->client->getResponse();
        return $response;
    }


    /**
     * Modify message to add response text
     *
     * @param mixed $value
     * @param PHPUnit_Framework_Constraint $constraint
     * @param string $message
     * @since  Method available since Release 3.0.0
     */
    final public static function assertThat($value, PHPUnit_Framework_Constraint $constraint, $message = '')
    {
        $message .= PHP_EOL . static::$lastResponse . PHP_EOL;
        parent::assertThat($value, $constraint, $message);
    }
}

Hier sind einige Methoden zum Drucken von Debug-Meldungen in PHPUnit 4.x:

• syslog(LOG_DEBUG, "Debug: Message 1!");

  Praktischeres Beispiel:

  syslog(LOG_DEBUG, sprintf("%s: Value: %s", __METHOD__, var_export($_GET, TRUE)));

  Beim Aufruf syslog()wird eine Systemprotokollnachricht generiert (siehe :) man syslog.conf.

  ^{Hinweis: Mögliche Ebene: LOG_DEBUG, LOG_INFO, LOG_NOTICE, LOG_WARNING, LOG_ERR, usw.}

  Führen Sie unter macOS Folgendes aus, um die Syslog-Nachrichten in Echtzeit zu streamen:

  log stream --level debug --predicate 'processImagePath contains "php"'

• fwrite(STDERR, "LOG: Message 2!\n");

  ^{Hinweis: Die STDERRKonstante ist nicht verfügbar, wenn Sie das PHP-Skript von stdin lesen . Hier ist die Problemumgehung .}

  ^{Hinweis: Stattdessen STDERRkönnen Sie auch einen Dateinamen angeben.}

• file_put_contents('php://stderr', "LOG: Message 3!\n", FILE_APPEND);

  ^{Hinweis: Verwenden Sie diese Methode, wenn Sie keine STDERRKonstante definiert haben.}

• register_shutdown_function('file_put_contents', 'php://stderr', "LOG: Message 4!\n", FILE_APPEND);

  ^{Hinweis: Verwenden Sie diese Methode, wenn Sie ganz am Ende etwas drucken möchten, ohne die Tests zu beeinträchtigen.}

Verwenden Sie zum Speichern der Variablen var_export()z "Value: " . var_export($some_var, TRUE) . "\n".

Informationen zum Drucken der obigen Nachrichten nur im ausführlichen oder Debug-Modus finden Sie unter: Gibt es eine Möglichkeit, festzustellen, ob --debug oder --verbose in einem Test an PHPUnit übergeben wurde?

Wenn das Testen der Ausgabe Teil des Selbsttests ist, lesen Sie Folgendes : Testen der Seite " Ausgabedokumente testen" .

Wenn Sie Laravel verwenden, können Sie Protokollierungsfunktionen wie info () verwenden, um sich in der Laravel-Protokolldatei unter storage / logs anzumelden. Es wird also nicht in Ihrem Terminal, sondern in der Protokolldatei angezeigt.