mata teras

Mengintegrasikan pemerhati ujian gaya JavaScript ke dalam projek PHP, mengautomasikan pra-proses penukaran fail, dan ujian unit semula apabila fail berubah, dengan itu meningkatkan kecekapan pembangunan.
Sediakan ujian automatik dengan alat seperti phpUnit dan perhatikan pengubahsuaian fail menggunakan phpunit-watcher untuk memastikan pengesan maklum balas dan kesilapan segera semasa pembangunan.
Melaksanakan skrip pra -proses dalam projek PHP, yang membolehkan penukaran sintaks yang serupa dengan Babel JavaScript, dengan itu meningkatkan keserasian dan mengurangkan usaha pengekodan manual.
Konfigurasikan persekitaran ujian PHP untuk membina semula fail yang telah diproses secara automatik sebelum menguji, mengekalkan liputan kod yang tepat dan memudahkan proses ujian.
Terokai konfigurasi lanjutan menggunakan pemerhati fail untuk secara selektif membina semula fail yang diubahsuai, dengan ketara mempercepatkan kitaran ujian sejumlah besar fail dalam projek besar.

Artikel ini dikaji semula oleh Younes Rafie. Terima kasih kepada semua pengulas rakan sebaya untuk mendapatkan kandungan SitePoint dengan sebaik -baiknya!

Saya baru -baru ini mula bekerja pada beberapa projek JavaScript yang termasuk pemerhati ujian yang dibundel.

Di dunia JavaScript, ia bukan perkara biasa untuk kod sumber pra -proses. Di dunia JavaScript, pemaju menulis kod menggunakan sintaks yang tidak disokong dan kemudian menukar kod ke sintaks yang disokong secara meluas, sering menggunakan alat yang dipanggil Babel.

Untuk mengurangkan beban skrip penukaran memanggil, projek boilerplate telah mula memasukkan skrip yang secara automatik memantau perubahan fail;

Projek -projek yang saya kerjakan mengambil pendekatan yang sama dengan ujian unit rerun. Apabila saya menukar fail JavaScript, fail ditukar dan ujian unit adalah rerun. Dengan cara ini, saya dapat melihat dengan segera sama ada apa -apa yang rosak.

Tetapan Projek

Saya telah mula menubuhkan sesuatu yang serupa untuk phpunit sejak saya mula bekerja pada projek -projek ini. Malah, projek pertama saya menubuhkan skrip PHPUNIT Observer adalah projek PHP yang juga memproses fail.

Selepas saya menambah skrip pra -proses untuk projek saya, semuanya bermula:

composer require pre/short-closures

Skrip preprocessing khusus ini membolehkan saya menamakan semula kelas yang dimuatkan secara automatik PSR-4 (dari Path/to/file.php ? Path/to/file.pre) untuk memilih ke dalam fungsi yang mereka berikan. Jadi saya menambah perkara berikut ke fail komposer.json saya:

"autoload": {
    "psr-4": {
        "App\": "src"
    }
},
"autoload-dev": {
    "psr-4": {
        "App\Tests\": "tests"
    }
}

ini dari composer.json

Kemudian saya menambah kelas untuk menghasilkan fungsi yang mengandungi butiran sesi pengguna semasa:

namespace App;

use Closure;

class Session
{
    private $user;

    public function __construct(array $user)
    {
        $this->user = $user;
    }

    public function closureWithUser(Closure $closure)
    {
        return () => {
            $closure($this->user);
        };
    }
}

Ini berasal dari src/session.pre

Untuk memeriksa sama ada ini berfungsi, saya menyediakan skrip sampel kecil:

require_once __DIR__ . "/vendor/autoload.php";

$session = new App\Session(["id" => 1]);

$closure = ($user) => {
    print "user: " . $user["id"] . PHP_EOL;
};

$closureWithUser = $session->closureWithUser($closure);
$closureWithUser();

ini berasal dari contoh.pre

... dan kerana saya ingin menggunakan penutupan pendek dalam kelas bukan PSR-4, saya juga perlu menyediakan loader:

require_once __DIR__ . "/vendor/autoload.php";

Pre\Plugin\process(__DIR__ . "/example.pre");

ini berasal dari loader.php

Bahagian kod ini banyak untuk menggambarkan titik kecil. Kelas Sesi mempunyai kaedah ClosureWithuser yang menerima satu penutupan dan mengembalikan yang lain. Apabila dipanggil, penutupan baru ini akan memanggil penutupan asal, menyediakan array sesi pengguna sebagai parameter.

untuk menjalankan semua ini, taipkan terminal:

php loader.php

Sebagai nota sampingan, preprocessors ini menghasilkan sintaks PHP yang berkesan yang cantik. Nampaknya ini:

$closure = function ($user) {
   print "user: " . $user["id"] . PHP_EOL;
};

... dan

public function closureWithUser(Closure $closure)
{
   return [$closure = $closure ?? null, "fn" => function () use (&$closure) {
       $closure($this->user);
   }]["fn"];
}

Anda mungkin tidak mahu mengemukakan kedua -dua PHP dan pra fail ke repositori. Untuk melakukan ini, saya telah menambah apl/**/*. Php dan contoh.php ke .gitignore.

Menetapkan ujian

Jadi bagaimana kita menguji ini? Mari mulakan dengan memasang phpunit:

composer require --dev phpunit/phpunit

Kemudian, kita harus membuat fail konfigurasi:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit
    backupGlobals="false"
    backupStaticAttributes="false"
    bootstrap="vendor/autoload.php"
    colors="true"
    convertErrorsToExceptions="true"
    convertNoticesToExceptions="true"
    convertWarningsToExceptions="false"
    processIsolation="false"
    stopOnFailure="false"
    syntaxCheck="false"
>
    <testsuites>
        <testsuite>
            <directory suffix="Test.php">tests</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist addUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">src</directory>
        </whitelist>
    </filter>
</phpunit>

ini dari phpunit.xml

Jika kita menjalankan vendor/bin/phpunit, ia akan berfungsi. Tetapi kami belum menguji apa -apa lagi. Mari buat satu:

namespace App\Tests;

use App\Session;
use PHPUnit\Framework\TestCase;

class SessionTest extends TestCase
{
    public function testClosureIsDecorated()
    {
        $user = ["id" => 1];
        $session = new Session($user);

        $expected = null;

        $closure = function($user) use (&$expected) {
            $expected = "user: " . $user["id"];
        };

        $closureWithUser = $session
            ->closureWithUser($closure);

        $closureWithUser();

        $this->assertEquals("user: 1", $expected);
    }
}

Ini berasal dari ujian/sessiontest.php

Apabila kita menjalankan vendor/bin/phpunit, satu ujian berlalu. Ya!

Apa yang kita hilang?

Setakat ini, semuanya berjalan lancar. Kami menulis sekeping kecil kod dan ujian kod ini. Kami tidak perlu bimbang tentang bagaimana kerja pra -proses (langkah ke atas projek JavaScript).

Masalahnya bermula apabila kita cuba menyemak liputan kod:

vendor/bin/phpunit --coverage-html coverage

Semasa kami menguji sesi, liputan akan dilaporkan. Ia adalah kelas yang mudah, jadi kami telah mencapai liputan 100% di atasnya. Tetapi jika kita menambah kelas lain:

namespace App;

class BlackBox
{
    public function get($key)
    {
        return $GLOBALS[$key];
    }
}

Ini berasal dari src/blackbox.pre

Apa yang berlaku apabila kita memeriksa liputan? Masih 100%.

Ini berlaku kerana kita tidak mempunyai sebarang ujian yang memuatkan Blackbox.pre, yang bermaksud ia tidak pernah disusun. Oleh itu, apabila PHPUnit mencari fail PHP yang ditimpa, ia tidak dapat melihat fail pra -proses ini.

Bina semua fail sebelum ujian

mari buat skrip baru untuk membina semua fail pra sebelum cuba menjalankan ujian:

composer require pre/short-closures

Ini berasal dari ujian/bootstrap.php

di sini, kami membuat 3 fungsi;

kita perlu menggantikan fail bootstrap semasa dalam phpunit.xml:

"autoload": {
    "psr-4": {
        "App\": "src"
    }
},
"autoload-dev": {
    "psr-4": {
        "App\Tests\": "tests"
    }
}

ini dari phpunit.xml

Sekarang, setiap kali kita menjalankan ujian, skrip ini akan terlebih dahulu membersihkan dan membina semula semua fail pra ke fail PHP. Liputan dilaporkan dengan betul dan kami dapat meneruskan perjalanan gembira kami ...

selain ini ...

namespace App;

use Closure;

class Session
{
    private $user;

    public function __construct(array $user)
    {
        $this->user = $user;
    }

    public function closureWithUser(Closure $closure)
    {
        return () => {
            $closure($this->user);
        };
    }
}

require_once __DIR__ . "/vendor/autoload.php";

$session = new App\Session(["id" => 1]);

$closure = ($user) => {
    print "user: " . $user["id"] . PHP_EOL;
};

$closureWithUser = $session->closureWithUser($closure);
$closureWithUser();

ini berasal dari skrip/test-test

require_once __DIR__ . "/vendor/autoload.php";

Pre\Plugin\process(__DIR__ . "/example.pre");

ini berasal dari skrip/test-test

php loader.php

ini berasal dari skrip/test-test

$closure = function ($user) {
   print "user: " . $user["id"] . PHP_EOL;
};

ini dari composer.json

public function closureWithUser(Closure $closure)
{
   return [$closure = $closure ?? null, "fn" => function () use (&$closure) {
       $closure($this->user);
   }]["fn"];
}

Ini berasal dari ujian/bootstrap.php

composer require --dev phpunit/phpunit

ini berasal dari skrip/test-test

Sekarang kita harus dapat memulakannya dan menjalankan ujian kita setiap kali perubahan fail pra -diproses ...

composer require pre/short-closures

"autoload": {
    "psr-4": {
        "App\": "src"
    }
},
"autoload-dev": {
    "psr-4": {
        "App\Tests\": "tests"
    }
}