Phpunit mocking options

mauricehh · April 14, 2022, 8:24am

Hello,

I am still going through all my plugins increasing the test coverage. I was wondering if there is a good way to alter/mock plugin settings.

As the behavior of some of my plugins can change quite a lot depending on the options, I would like to test different combinations. It would cool if I could just set those options within my phpunit tests, is this possible?

An alternative way would be to hand in needed options as a param to the functions which use them, but I’d like to avoid that.

bnomei · April 14, 2022, 9:04am

this is what i do at my plugins.

have options array property inside class with that default to kirby options

github.com

bnomei/kirby3-fingerprint/blob/2b62b2ea552bd275a7a5989ebc730115611a5ba7/classes/Fingerprint.php#L26

      
        
             * @var array
             */
            private $options;
            
            
/**
             * Fingerprint constructor.
             * @param array $options
             */
            public function __construct(array $options = [])
            {
                $defaults = [
                    'debug' => option('debug'),
                    'query' => option('bnomei.fingerprint.query'),
                    'hash' => option('bnomei.fingerprint.hash'),
                    'integrity' => option('bnomei.fingerprint.integrity'),
                    'https' => option('bnomei.fingerprint.https'),
                ];
                $this->options = array_merge($defaults, $options);
            
            
    foreach ($this->options as $key => $call) {
                    if (is_callable($call) && !in_array($key, ['hash', 'integrity'])) {

this way i can mock them in tests and test my class instance.

github.com

bnomei/kirby3-fingerprint/blob/2b62b2ea552bd275a7a5989ebc730115611a5ba7/tests/FingerprintTest.php#L41

      
        
                $this->assetPath = 'assets/asset.png';
                $this->invalidPath = 'invalid/file.jpg';
            }
            
            
public function testConstruct()
            {
                $fipr = new Fingerprint();
                $this->assertInstanceOf(Fingerprint::class, $fipr);
            }
            
            
public function testOptions()
            {
                $fipr = new Fingerprint([
                    'https' => false,
                    'debug' => function () {
                        return false;
                    },
                ]);
                $this->assertFalse($fipr->option('https'));
                $this->assertFalse($fipr->option('debug'));
                $this->assertIsArray($fipr->option());

it gets a bit tedious if you have multiple classes but most of the time i found it easy enough to manage.

mauricehh · April 14, 2022, 11:18am

That’s a good idea, this way I wouldn’t have to hand the options to every method. Thank you, I will give this a try

Topic		Replies	Views
Phpunit mocking pages Questions 🤔 plugin	3	307	January 13, 2021
How to write tests for plugins that use Kirby methods? Questions 🤔	3	413	August 29, 2023
Unit Testing Kirby Questions 🤔	3	591	September 10, 2016
Utility for testing plugins Kirby 3 plugin 🧩	1	360	September 3, 2019
Custom cache in plugin? Solved ✅	5	341	February 11, 2019

Phpunit mocking options

Related Topics