Как в тестах сделать mock статичного метода в yii2?

Question

[vism]

В тестируемом методе вызывается статичный метод другого класса (FileHelper::createDirectory($path);).
Как в yii2 сделать mock этого метода?

protected function _generateFolders()
    {
        $folders = str_split($this->hash, self::FOLDER_TITLE_LENGTH);
        $folders = array_slice($folders, 0, $this->foldersDepth);
        $folders = implode('/', $folders) .
            ($this->accessDir ? '/' . $this->accessDir : '');

        $path = self::getPathToFiles() . '/' . $folders;
        FileHelper::createDirectory($path);

        return $folders;
    }

Просто статичные методы можно подменить с помощью https://github.com/Codeception/AspectMock
Но в yii он как-то глючит..

Answer 1

[He11ion]

В phpunit - никак.

Comments

[vism]

https://github.com/Codeception/AspectMock
с его помощью можно.
Но в yii2 не работает нормально

Answer 2

[D']

Посмотрел в код Yii, оказывается они действительно используют статик методы для хелперов...

Не пишу на Yii, но могу посоветовать отказаться от прямого использования их статичных классов, и работать через свою обертку.

Т.е сделать класс MySuperHelpers, в который инкапсулировать всю работу со статикой, и уже свой класс использовать везде. Т.е:

<?php

class MyHelpers {

	public function makeDirectory($path)
	{
		return FileHelper::createDirectory($path);
	}

}

А свой класс уже можно без проблем мокать где нужно.

Comments

[matperez]

Подскажите, а как потом использовать этот мок в тесте? Вот сделал я как вы предлагаете, теперь вместо FileHelper::createDirectory($path) у меня что-то вроде (new MyHelper)->makeDirectory($path). Как подсунуть вместо этого класса mock?

[D']

Я не знаю чем и как вы мокаете, но дальше все просто.
В том же Mockery просто создаем мок нужного класса, например:
$mock = Mockery::mock('MyHelpers');
$mock->shouldReceive('makeDirectory')->andReturn(true);
И дальше везде подсовываем $mock и радуемся.
Естесственно нужно чтобы была возможность подменить оригинальный класс на $mock. Как вы это реализуете (DI или передача через конструктор) это ваша задача.

[D']

matperez: в том же Laravel я просто подменяю реализацию интерфейс на $mock, и все классы которые использовали MyHelperInterface - начинают использовать $mock.

Answer 3

[matperez]

Кстати, еще вариант. Если у вас в классе есть метод, который использует статику или, допустим, должен обращаться к файловой системе, что вам не хочется делать в тестах, можно явно вынести эту функциональность в отдельный приватный метод и его уже замокать. Получится что-то вроде

class Actor
{
    public function generateFolders()
    {
        $folders = str_split($this->hash, self::FOLDER_TITLE_LENGTH);
        $folders = array_slice($folders, 0, $this->foldersDepth);
        $folders = implode('/', $folders) .
            ($this->accessDir ? '/' . $this->accessDir : '');

        $path = self::getPathToFiles() . '/' . $folders;
        $this->createDirectory($path);
        return $folders;
    }
    
    protected function createDirectory($path)
    {
        return  FileHelper::createDirectory($path);
    }
}

В этом коде уже довольно легко замокать явное обращение к статическому методу. Остальные методы при этом будут работать как обычно.

$actor = $this->getMock('Actor', ['createDirectory']);
        $actor->expects($this->any())->method('createDirectory')->willReturn(true);

Это проще чем реализовывать полноценный DI с подменой реализации интерфейсов.