Come testare correttamente un metodo chiamato da un action hook

Question

Come testare correttamente un metodo chiamato da un action hook

- 2
- 1779 2014-09-08
Il costruttore dellamia classe aggiunge un'azione all'action hook "init":

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

Stavoprovando atestarloin uno unitteste allafine ho capito chenon c'eramotivoper cui l'action hook "init" si attivasse. C'è unmodoper verificare cheilmetodo register_my_type venga chiamatoe che venga registrato unnuovotipo dipost?

Modifica:

Laprincipalefonte dellamia confusione derivava dalnon comprendere la relazionetraphpunit,la suite ditest di WordPress,il codice dellamia classee ilmio codice ditest.

Quello che ora capisco è che congli strumentiper sviluppatori di WordPressinstallatinelmodoin cui è suggerito da questotutorial otramite WP-CLI ,un callto phpunit carica unfilebootstrap chepoi agganciailplugin all'action hook muplugins_loaded. Ilfilebootstrap carica quindi l'ambiente ditest di WordPress. Dopo che WordPress hafinito di caricare,vieneeseguito l'hook init. Il codice delplug-in che utilizza init dovrebbefunzionare comeprevisto.

Itest sonoper lopiù solo codicenormale chefa uso difunzioni o classi disponibili. Ciò che è diversoin loro è che sono scritti comemetodi di una classe cheestende WP_UnitTestCase cheestende PHPUnit_Framework_TestCase. Essereinclusiin questa classe dà aitest l'accesso alle asserzionie allefabbriche di oggettie eseguei metodi setUpe tearDownin modo che ognitest siaindipendente dagli altri.
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 risposta

voti

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

1

2014-09-08

Vorreiiniziare dicendo che l'azione init viene chiamata quando WordPress viene caricato,prima chei test venganoeseguiti. Quindi se stai caricandoiltuoplugin/tema con WordPress (collegandoti a muplugins_loaded,peresempio),ilmetodo register_my_type() dovrebbeessere chiamato,seiltuo costruttoreessere chiamatoprima di init. (Senon stai caricandoiltuopluginin questomodo,dai un'occhiata a questotutorial .)

Quindinei tuoi unittest dovrestiesserein grado difarlo:

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

Puoi anche usare get_post_type()per verificare cheiltipo dipost sia stato registrato congli argomenti corretti. (Questo è lo stessogenere di operazioni chefaccioper verificare chei miei codicibrevi siano registrati.)

Nonmi preoccuperei diprovare aprovare cheilmetodo è stato chiamato,sebbenetupossa controllare l'elenco delle azioniin $wp_actionsper vedere se è stato collegato correttamente. Potresti ancheimpostare unaproprietà di classe comeflag quando viene chiamata,mapenso davvero che siaeccessivo. Quando sitratta di cose legate ad azioni come init,specialmente unafunzione come questa che deveessereeseguita solo una volta,i testfunzionali sono la soluzionemigliore. Verifica che abbianofatto quello che dovrebberofare,piuttosto che concentrarsi sulprovare atestare una singola unità come seilmetodofosse stato chiamato.

Detto questo,puoi anche verificare cheilmetodo registriiltipo dipost annullando la registrazione deltipo diposte chiamandomanualmenteilmetodo. WordPressnon sembrafornire unafunzione deregister_post_type(),quindi dovrestifare confusione conilglobale $wp_post_types direttamente. Potresti cancellareiltuotipo dipost da quelloe poi chiamareiltuometodoe controllare se è registrato dinuovo.

fonte
J.D.

Grazie!Sono statoin grado di confermare che l'azione `init` è stata chiamata.Ho ancoraproblemi con l'inizializzazione delplug-inin untestin cui devofornire argomenti al costruttore. Queltutorial èmolto utile.Primanonmi era chiaro chei test caricassero un ambiente completamente separato.

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
Sono contento che abbia aiutato.A seconda di comefunzionailtuoplugin,potrestiesserein grado di reinizializzarlo semplicemente chiamandoil costruttore.Se questononfunziona davveroperte,potresti dovereseguire queitest separatamentee con unpo 'di codiceextraperinizializzarlo congli argomenti corretti.Puoi classificarei tuoitest aggiungendo l'annotazione `@groupmy_group_name`nei docblocks della classetestcase.Puoi quindiescludere ungrupponellatua configurazioneedeseguirlo separatamente con `phpunit --groupmy_group`.Quindi dovrai rilevare quando quelgruppo èin esecuzionee inizializzareilpluginin modo diverso.

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.
Per unesempio di come rilevare qualegruppo èin esecuzionepuoiguardare [questo codicenelbootstrap di WordPress] (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.