So testen Sie eine Methode, die von einem Aktions-Hook aufgerufen wird

Question

So testen Sie eine Methode, die von einem Aktions-Hook aufgerufen wird

- 2
- 1779 2014-09-08
Der Konstruktorin meiner Klassefügt dem Aktionshaken 'init'eine Aktion hinzu:

class My_Custom_Post_Type { function __construct( $type ) { $this->type = $type; add_action( 'init', array( $this, 'register_my_type' ); } function register_my_type() { register_post_type( $this->type); } }

Ich habe versucht,diesin einem Komponententest zutesten,und schließlichfestgestellt,dasses keinen Grundgab,den Aktionshaken 'init' auszulösen. Gibteseine Möglichkeit zutesten,ob die Methode register_my_type aufgerufen wird und obein neuer Beitragstyp registriert wird?

Bearbeiten:

Die Hauptursachefürmeine Verwirrung war,dassich die Beziehung zwischenphpunit,der WordPress-Testsuite,meinem Klassencode undmeinem Testcodenicht verstanden habe.

Wasichjetzt verstehe,ist,dassmit den WordPress-Entwicklertools,die soinstalliert sind,wiees von dieses Tutorial oder über WP-CLI ,a callto phpunit lädteine Bootstrap-Datei,die das Plugin dannin den Aktionshaken muplugins_loadedeinbindet. Die Bootstrap-Datei lädt dann die WordPress-Testumgebung. Nachdem WordPress das Ladenbeendet hat,wird der init -Hook ausgeführt. Plugin-Code,der init verwendet,sollte wieerwartetfunktionieren.

Tests sindmeistnurnormaler Code,der verfügbare Funktionen oder Klassen verwendet. Das Besondere anihnenist,dass sie als Methodeneiner Klassegeschrieben sind,die WP_UnitTestCaseerweitert und PHPUnit_Framework_TestCaseerweitert. Wenn diese Testsin diese Klasseeingeschlossen werden,erhalten sie Zugriff auf Zusicherungen und Objektfabriken undführen die Methoden setUp und tearDown aus,sodassjeder Test unabhängig von den anderenist.
The constructor in my class adds an action to the 'init' action hook:

class My_Custom_Post_Type { function __construct( $type ) { $this->type = $type; add_action( 'init', array( $this, 'register_my_type' ); } function register_my_type() { register_post_type( $this->type); } }

I was trying to test this in a unit test and finally realized that there was no reason for the 'init' action hook to fire. Is there any way to test that the register_my_type method is being called and that a new post type is being registered?

Edit:

The main source of my confusion came from not understanding the relationship between phpunit, the WordPress test suite, my class code, and my test code.

What I now understand is that with the WordPress developer tools installed in the way the is suggested by this tutorial or through WP-CLI, a call to phpunit loads a bootstrap file which then hooks the plugin into the muplugins_loaded action hook. The bootstrap file then loads the WordPress test environment. After WordPress has finished loading the init hook is run. Plugin code that makes use of init should work as expected.

Tests are mostly just normal code that is making use of available functions or classes. What is different about them is that they are written as methods of a class that extends WP_UnitTestCase which extends PHPUnit_Framework_TestCase. Being wrapped in this class gives the tests access to assertions and object factories, and runs setUp and tearDown methods so that each test is independent of the others.
hooks testing unit-tests

1 Antworten

Stimmen

J.D. · Accepted Answer · 2014-09-08

1

2014-09-08

Lassen Siemich zunächst sagen,dass die Aktion init aufgerufen wird,wenn WordPressgeladen wird,bevor die Tests ausgeführt werden. Wenn Sie also Ihr Plugin/Thememit WordPressgeladen haben (z. B. durch Einbindenin muplugins_loaded),sollte die Methode register_my_type() aufgerufen werden,wenn Ihr Konstruktor diesist wird vor init aufgerufen. (Wenn Sie Ihr Pluginnicht auf diese Weise laden,lesen Sie dieses Tutorial .)

In Ihren Unit-Tests sollten Sie alsoin der Lage sein,Folgendes zutun:

$this->assertTrue( post_type_exists( 'my_post_type' ) );

Sie können auch get_post_type() verwenden,um zu überprüfen,ob der Beitragstypmit den richtigen Argumenten registriert wurde. (Diesist dasgleiche,wasichmache,um zu überprüfen,obmeine Shortcodes registriert sind.)

Ich würdemir keine Sorgenmachen,wennich versuchen würde zutesten,ob die Methode aufgerufen wurde,obwohl Sie die Liste der Aktionenin $wp_actions überprüfen können,umfestzustellen,ob sie ordnungsgemäß angeschlossen wurde. Sie könnten aucheine Klasseneigenschaft als Flag setzen,wenn sie aufgerufen wird,aberich denke wirklich,dass das alles übertriebenist. Wennes um Dinge wie initgeht,insbesondere umeine Funktion wie diese,dienureinmal ausgeführt werdenmuss,sind Funktionstests diebeste Wahl. Überprüfen Sie,ob sie dasgetan haben,was sietun sollen,anstatt sich darauf zu konzentrieren,eine einzelne Einheit zutesten,z. B. ob die Methode aufgerufen wurde.

Sie könnenjedoch auchtesten,ob die Methode den Beitragstyp registriert,indem Sie den Beitragstyp abmelden und die Methodemanuell aufrufen. WordPress scheint keine deregister_post_type() -Funktionbereitzustellen,sodass Sie sich direktmit dem $wp_post_typesglobal herumschlagenmüssen. Sie können Ihren Beitragstyp daraus löschen und dann Ihre Methode aufrufen undprüfen,ob sieerneut registriertist.

Quelle
J.D.

Vielen Dank!Ich konntebestätigen,dass die Aktion "init" aufgerufen wird.Ich habeimmernoch Problememit der Initialisierung des Pluginsin einem Test,in demich dem Konstruktor Argumente liefernmuss. Dieses Tutorialist sehr hilfreich.Mir war vorhernicht klar,dass die Testseine völlig separate Umgebung laden.

Thanks! I've been able to confirm that the `init` action is being called. I'm still having problems with initializing the plugin in a test where I need to supply arguments to the constructor. That tutorial is very helpful. It wasn't clear to me before that the tests are loading a completely separate environment.
- 0
- 2014-09-08
- Simon Cossar
Ichbin froh,dassesgeholfen hat.Abhängig davon,wie Ihr Pluginfunktioniert,können Sieesmöglicherweiseeinfachneuinitialisieren,indem Sie den Konstruktor aufrufen.Wenn diesfür Sienicht wirklichfunktioniert,müssen Sie diese Testsmöglicherweise separat undmit zusätzlichem Code ausführen,um siemit den richtigen Argumenten zuinitialisieren.Sie können Ihre Tests kategorisieren,indem Sie die Annotation "@groupmy_group_name"in den Dokumentblöcken der Testfallklasse hinzufügen.Sie können danneine Gruppein Ihrer Konfiguration ausschließen und separatmit "phpunit --groupmy_group" ausführen.Dannmüssen Sieerkennen,wann diese Gruppe ausgeführt wird,und das Plugin andersinitialisieren.

I'm glad it helped. Depending on how your plugin works, you may be able to just reinitialize it by calling the constructor. If that won't really work for you, you may have to run those tests separately and with some extra code to initialize it with the correct arguments. You can categorize your tests by adding the `@group my_group_name` annotation in the testcase class docblocks. You can then exclude a group in your config, and run it separately with `phpunit --group my_group`. Then you'll need to detect when that group is being run and initialize the plugin differently.
- 0
- 2014-09-08
- J.D.
Ein Beispiel dafür,wie Siefeststellen können,welche Gruppe ausgeführt wird,finden Sie unter [diesen Codein WordPress 'Bootstrap] (https://core.trac.wordpress.org/browser/trunk/tests/phpunit/includes/bootstrap.php)rev=28910 # L108).

For an example of how to detect what group is being run you can look at [this code in WordPress' bootstrap](https://core.trac.wordpress.org/browser/trunk/tests/phpunit/includes/bootstrap.php?rev=28910#L108).
- 0
- 2014-09-08
- J.D.