PHP Birim testlerinin yürütülmesi sırasında CLI'de nasıl çıktı alınır?

Bir PHPUnit testi çalıştırırken, bir veya iki şeyde hata ayıklayabilmek için çıktıyı dökmek istiyorum.

Aşağıdakileri denedim ( PHPUnit Manual örneğine benzer );

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

Aşağıdaki sonuçla:

PHPUnit @package_version@ by Sebastian Bergmann.

.

Time: 0 seconds, Memory: 3.00Mb

OK (1 test, 0 assertions)

Beklenen çıktıların hiçbirinin olmadığına dikkat edin.

Git depolarının HEAD sürümlerini 19 Eylül 2011 itibarıyla kullanıyorum.

Çıktı 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

Yanlış yaptığım bir şey var mı, yoksa bu bir PHPUnit hatası mı?

GÜNCELLEME

Bunu yapmanın --verbosekomut satırı seçeneğinden çok daha iyi çalışan başka bir yolunu keşfettim:

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

Bu, --verboseCLI seçeneğiyle birlikte gelen tüm istenmeyen çıktılar olmadan herhangi bir zamanda konsolunuza her şeyi dökmenizi sağlar.

Diğer yanıtların da belirttiği gibi, en iyisi, aşağıdaki gibi yerleşik yöntemleri kullanarak çıktıyı test etmektir:

$this->expectOutputString('foo');

Bununla birlikte, bazen yaramaz olmak ve test senaryolarınızdan bir defalık / geçici hata ayıklama çıktısını görmek yararlı olabilir. Yine de, var_dumpkesmeye / geçici çözüme gerek yoktur . Bu, --verbosetest paketinizi çalıştırırken komut satırı seçeneğini ayarlayarak kolayca gerçekleştirilebilir . Örneğin:

$ phpunit --verbose -c phpunit.xml

Bu, CLI ortamında çalışırken test yöntemlerinizin içinden çıktıyı gösterecektir.

Bkz: PHPUnit için Testler Yazma - Çıktıyı Test Etme .

Güncelleme: Aşağıdaki rdlowrey güncellemesine bakın .fwrite(STDERR, print_r($myDebugVar, TRUE)); daha basit bir iş, etrafımızda olarak

Bu davranış kasıtlıdır ( jasonbar'ın da belirttiği gibi ). Kılavuzun çelişkili durumu rapor edildi PHPUnit'e .

Çözüm, PHPUnit'in beklenen çıktının boş olduğunu iddia etmesini sağlamaktır (infact çıktı olduğunda) ve bu, gösterilecek beklenmedik çıktıyı tetikler.

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);
    }   
}

verir:

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.

Test için sahip olduğunuz diğer tüm iddiaları devre dışı bıraktığınızdan emin olun, çünkü bunlar çıktı iddiası test edilmeden önce başarısız olabilir (ve dolayısıyla çıktıyı göremezsiniz).

Kullanmayı dene --debug

Dahil etme veya kaynak veri dosyasına giden doğru yolu bulmaya çalışıyorsanız kullanışlıdır.

Bu bir hata değil, çok kasıtlı. En iyisi, bir tür günlük dosyasına yazmak ve çıktıyı izlemek için günlüğü kuyruklamaktır.

Eğer TEST çıkışına çalışıyorsanız, kontrol bu dışarı.

Ayrıca:

Not : PHPUnit'in bir testin yürütülmesi sırasında gönderilen tüm çıktıları yutacağını lütfen unutmayın. Katı modda, çıktı yayan bir test başarısız olur.

VisualPHPUnit ile biraz şansım var ve diğer şeylerin yanı sıra çıktıyı faydalı bir şekilde gösteriyor.

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

Niyetinizi gerçekten düşünmelisiniz: Eğer testi düzeltmek için hata ayıklarken şimdi bilgiye ihtiyacınız varsa, gelecek hafta testler bittiğinde tekrar ihtiyacınız olacak.

Bu , test başarısız olduğunda her zaman bilgiye ihtiyaç duyacağınız anlamına gelir var_dumpve nedeni bulmak için a eklemek çok fazla çaba gerektirir. Bunun yerine, verileri iddialarınıza ekleyin.

Kodunuz bunun için çok karmaşıksa, bir iddianın (özel bir mesajla) nerede kırıldığını, neden ve nasıl düzeltileceğini bilmeniz için size yeterince bilgi verdiği bir düzeye ulaşıncaya kadar bölün.

Laravel 5'te dump () kullanabilirsiniz, içeriği son yanıttan boşaltın.

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

verir

Sadece phpunit'i çalıştırırken --verbose bayrağını kullanın .

$ phpunit --verbose -c phpunit.xml 

Bu yöntemin avantajı, test kodunu değiştirmenize gerek olmaması, dizeleri yazdırabilmeniz, var_dump her zaman istediğiniz her şeyi ve konsolda yalnızca ayrıntılı mod ayarlandığında gösterilmesidir.

Umarım bu yardımcı olur.

Bazı durumlarda, konsola bir şey çıkarmak için böyle bir şey kullanılabilir.

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();
    }
}

Bu, Fikstürlerle ilgili PHPUnit Belgelerinden alınmıştır .

Bu, phpunit testi yaşam döngüsü boyunca herhangi bir noktada bilgileri dökmenize izin vermelidir.

__METHOD__Aşağıdaki kodu çıktı almak istediğiniz şeyle değiştirin

Örnek 4.2: Mevcut tüm şablon yöntemlerini gösteren örnek

<?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;
    }
}
?>

Hackish, ancak çalışıyor: Mesaj olarak hata ayıklama çıktısıyla bir istisna atın.

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

Getiri:

...
There was 1 error:

1) theTest::testOutput
Exception: hello

Testresults çıktımı HTML tabanlı olarak verdim, bu durumda içeriği temizlemek yardımcı oldu:

var_dump($array);
ob_flush();

İkinci bir PHP Yöntemi var

flush() 

ki denemedim.

PHPUnit çıktıyı ob_start(). Geçici olarak devre dışı bırakabiliriz.

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

Bu kodun çalışması için kaynak kodunu değiştirmem gerekiyordu, bu yüzden bu çatallı depoların URL'sini oluşturucuya eklemeniz gerekiyor, bunun çalışması için

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);
    }
}

PHPUnit 4.x'te hata ayıklama mesajlarını yazdırmak için yararlı birkaç yöntem şunlardır:

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

  Daha pratik bir örnek:

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

  Arama syslog(), bir sistem günlüğü mesajı oluşturacaktır (bakınız:) man syslog.conf.

  ^{Not: Olası seviyelerini: LOG_DEBUG, LOG_INFO, LOG_NOTICE, LOG_WARNING,LOG_ERR , vb}

  MacOS'ta, sistem günlüğü mesajlarını gerçek zamanlı olarak yayınlamak için şunu çalıştırın:

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

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

  ^{Not: STDERRPHP betiğini stdin'den okurken sabit kullanılamaz . İşte geçici çözüm .}

  ^{Not: Bunun yerine STDERRbir dosya adı da belirtebilirsiniz.}

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

  ^{Not: STDERRSabit tanımlı değilseniz bu yöntemi kullanın .}

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

  ^{Not: Testleri etkilemeden en sonunda bir şeyler yazdırmak istiyorsanız bu yöntemi kullanın.}

Değişkeni dökmek için var_export(), örneğin kullanın "Value: " . var_export($some_var, TRUE) . "\n".

Yukarıdaki iletileri yalnızca ayrıntılı veya hata ayıklama modunda yazdırmak için, bkz: Bir testte PHPUnit'e --debug veya --verbose'un geçip geçmediğini anlamanın bir yolu var mı?

Çıktının test edilmesi kendi kendini test etmenin bir parçası olsa da, şu göz atın : Çıktıyı Test Etme belgeleri sayfası.

Kısaca, phpunit STDOUT'u bastırır. --verboseVeya eklemediğiniz sürece, varsayılan olarak STDERR'ye yazar --debug. Bunlardan birini yapabilirsiniz:

• bunun yerine hata ayıklama çıktınızı STDERR'ye yazdırın
• var_dumpher zamanki gibi hata ayıklamanız ancak --verbosephpunit komut satırına ekleyin
• var_dumpher zamanki gibi hata ayıklamanız ancak ob_flush();altına bir satır ekleyin
• tam olarak burada test etmeye çalıştığınız şeyi test etmek için phpunit'te doğru komutları kullanın

Açıkçası, yapılacak en son şey yapılacak İyi Şeydir ve geri kalanı ise hızlı geçici kesmelerdir.

Testinizdeki değişkenlerinizin hatalarını ayıklamak için mesajların PHPunit varsayılan yolunu şu şekilde kullanabilirsiniz:

$this->assertTrue(false,$your_variable);

Laravel kullanıyorsanız, depolama / günlükler altındaki Laravel günlük dosyasına oturum açmak için info () gibi günlüğe kaydetme işlevlerini kullanabilirsiniz. Dolayısıyla, terminalinizde görünmeyecek, ancak günlük dosyasında görünecektir.