Tovább a tartalomhoz

PHPUnit WordPress-bővítményekhez és témákhoz

PHPUnit-tesztek írása és futtatása WordPress-bővítményhez vagy témához: a tesztkörnyezet felállítása, a WP_UnitTestCase, a PHPUnit Polyfills és a gyakori tesztek.

A PHPUnit a PHP szabványos tesztelőkeretrendszere, a WordPress maga is ezzel teszteli a PHP-kódját. A bővítményed vagy a témád tesztjeihez a WordPress tesztkönyvtárát (WP_UnitTestCase) használhatod, amely betölti a WordPresst, és minden teszt után visszaállítja az adatbázist.

Ez tulajdonképpen integrációs teszt: a kódod a WordPress magjával együtt fut. Ha csak egy önálló PHP-osztályt akarsz tesztelni, a WordPress betöltése nélkül is lehet (PHPUnit\Framework\TestCase).

A WordPress tesztkönyvtára nem a legújabb PHPUnit-tal dolgozik. Hogy melyik WordPress- és PHP-verzióhoz melyik PHPUnit tartozik, azt a PHPUnit-kompatibilitási táblázat mutatja. A WordPress a PHPUnit Polyfills csomagra támaszkodik, amely áthidalja a PHPUnit-verziók közti különbségeket. A polyfills kötelező: nélküle a tesztkönyvtár nem indul el.

Terminál
composer require --dev yoast/wp-test-utils

A yoast/wp-test-utils magával hozza a PHPUnitot, a PHPUnit Polyfillst és a Brain Monkey-t (függvények kiváltása tesztben). Ha csak a minimumot akarod, a yoast/phpunit-polyfills és a phpunit/phpunit is elég.

A tesztfájlokat a WP-CLI generálja a bővítményhez:

Terminál
wp scaffold plugin-tests a-te-bovitmenyed

Ez létrehozza a phpunit.xml.dist fájlt, a bin/install-wp-tests.sh szkriptet, a tests/bootstrap.php fájlt, egy minta tesztet és egy CI-konfigurációt (a --ci=github kapcsolóval GitHub Actionshöz). Utána telepítsd a teszt-WordPresst és az adatbázist:

Terminál
bash bin/install-wp-tests.sh wordpress_test root '' localhost latest

A szkript letölti a WordPresst és a tesztkönyvtárat a /tmp alá, és létrehozza a teszt-adatbázist. Használj külön adatbázist: a tesztek törlik a tartalmát.

A tests/bootstrap.php betölti a bővítményt a tesztkörnyezetbe. Ha a polyfills a bővítmény saját Composer-függőségeként van meg, a bootstrapnek meg kell mondania az útvonalát, még a WordPress-bootstrap betöltése előtt:

tests/bootstrap.php
<?php
$_tests_dir = getenv( 'WP_TESTS_DIR' ) ?: '/tmp/wordpress-tests-lib';
// A PHPUnit Polyfills helye (kötelező a WordPress tesztkönyvtárához).
define( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH', dirname( __DIR__ ) . '/vendor/yoast/phpunit-polyfills' );
require_once $_tests_dir . '/includes/functions.php';
tests_add_filter( 'muplugins_loaded', function () {
require dirname( __DIR__ ) . '/a-te-bovitmenyed.php';
} );
require $_tests_dir . '/includes/bootstrap.php';
tests/test-bovitmeny.php
<?php
class Bovitmeny_Test extends WP_UnitTestCase {
public function test_shortcode_letezik() {
$this->assertTrue( shortcode_exists( 'sajat_shortcode' ) );
}
public function test_bejegyzes_letrehozasa() {
$post_id = self::factory()->post->create( [
'post_title' => 'Teszt',
'post_status' => 'publish',
] );
$this->assertSame( 'Teszt', get_post( $post_id )->post_title );
}
}

A fixture-ök gyára self::factory() (post, user, term, comment stb.). A régi $this->factory elavult.

Futtatás:

Terminál
vendor/bin/phpunit
vendor/bin/phpunit --filter test_shortcode_letezik
vendor/bin/phpunit --testsuite unit
vendor/bin/phpunit --stop-on-failure

A WP_UnitTestCase-ben a setUp() és tearDown() helyett a polyfills set_up() és tear_down() metódusait használd, így a teszt több PHPUnit-verzión is fut:

public function set_up() {
parent::set_up();
$this->post_id = self::factory()->post->create();
}
public function tear_down() {
wp_delete_post( $this->post_id, true );
parent::tear_down();
}

Osztály szintű előkészítésre a set_up_before_class() és a tear_down_after_class() való.

Hook. Akció és szűrő:

public function test_szuro_hozzafuz() {
$eredmeny = apply_filters( 'the_content', 'Eredeti' );
$this->assertStringContainsString( 'Hozzáadva', $eredmeny );
}

REST-végpont. Kérés összeállítása és a válasz ellenőrzése:

public function test_vegpont() {
$kerees = new WP_REST_Request( 'GET', '/a-te-bovitmenyed/v1/adat' );
$valasz = rest_do_request( $kerees );
$this->assertSame( 200, $valasz->get_status() );
}

Jogosultság. Hozz létre felhasználót a szükséges szereppel, és állítsd be: wp_set_current_user( self::factory()->user->create( [ 'role' => 'editor' ] ) ).

AJAX. A WP_Ajax_UnitTestCase osztály _handleAjax() metódusa futtatja a kezelőt, és a _last_response mutatja a választ.

Adatszolgáltató. Több bemenet egy tesztmetódussal; a szolgáltató legyen static:

/**
* @dataProvider email_szolgaltato
*/
public function test_email( string $cim, bool $elvart ) {
$this->assertSame( $elvart, false !== is_email( $cim ) );
}
public static function email_szolgaltato(): array {
return [
'jó cím' => [ '[email protected]', true ],
'rossz' => [ 'nem-email', false ],
];
}

Ha egy osztály nem függ a WordPresstől, a Yoast\WPTestUtils\BrainMonkey\TestCase osztállyal a WordPress-függvényeket (get_option() stb.) kiválthatod a Brain Monkey-val, és nem kell adatbázis. Ez sokkal gyorsabb. Részletek a WP Test Utils oldalán.

A kódlefedettség méréséhez a PHP-nek Xdebug vagy PCOV kell:

Terminál
vendor/bin/phpunit --coverage-html coverage/
vendor/bin/phpunit --coverage-clover coverage.xml

A teszteket érdemes minden pushnál lefuttatni. A GitHub Actions munkafolyamatot a GitHub Actions oldalunk mutatja, a kódstílus ellenőrzése a PHPCS oldalon van.

Készült: Frissítve:

Tiszteletben tartjuk a magánszférádat

Sütiket használunk a böngészési élmény javítására és a forgalom elemzésére. Az analitika csak akkor indul, ha engeded. Adatvédelmi irányelvek, Sütitájékoztató.

Sütibeállítások