Модульный тест для проверки метода, вызванного новым объектом класса

Question

Я пишу модульный тест для существующего кода, подобного этому

class someClass {
    public function __construct() { ... }

    public function someFoo($var) {
        ...
        $var = "something";
        ...
        $model = new someClass();
        model->someOtherFoo($var);
    }

    public someOtherFoo($var){
         // some code which has to be mocked
    }
}

Вот как я должен иметь возможность смоделировать вызов функции "someOtherFoo" так, чтобы он не выполнялся "some code "внутри someOtherFoo?

class someClassTest {
   public function someFoo() {
      $fixture = $this->getMock('someClass ', array('someOtherFoo'));
      $var = "something";
      ....
      // How to mock the call to someOtherFoo() here
   }

}

Можно ли смоделировать конструктор так, чтобы он возвращал мою собственную созданную функцию или переменную?

Спасибо

Answer 1

Везде, где у вас есть new XXX(...) в тестируемом методе, вы обречены. Извлеките экземпляр в новый метод - createSomeClass(...) - того же класса. Это позволяет вам создать частичный макет тестируемого класса, который возвращает значение заглушки или макета из нового метода.

class someClass {
    public function someFoo($var) {
        $model = $this->createSomeClass();  // call method instead of using new
        model->someOtherFoo($var);
    }

    public function createSomeClass() {  // now you can mock this method in the test
        return new someClass();
    }

    public function someOtherFoo($var){
         // some code which has to be mocked
    }
}

В тесте макет createSomeClass() в экземпляре, для которого вы вызываете someFoo(), и макет someOtherFoo() в экземпляре, который вы возвращаете из первого смоделированного вызова.

function testSomeFoo() {
    // mock someOtherFoo() to ensure it gets the correct value for $arg
    $created = $this->getMock('someClass', array('someOtherFoo'));
    $created->expects($this->once())
            ->method('someOtherFoo')
            ->with('foo');

    // mock createSomeClass() to return the mock above
    $creator = $this->getMock('someClass', array('createSomeClass'));
    $creator->expects($this->once())
            ->method('createSomeClass')
            ->will($this->returnValue($created));

    // call someFoo() with the correct $arg
    $creator->someFoo('foo');
}

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

function testSomeFoo() {
    $fixture = $this->getMock('someClass', array('createSomeClass', 'someOtherFoo'));

    // mock createSomeClass() to return the mock
    $fixture->expects($this->once())
            ->method('createSomeClass')
            ->will($this->returnValue($fixture));

    // mock someOtherFoo() to ensure it gets the correct value for $arg
    $fixture->expects($this->once())
            ->method('someOtherFoo')
            ->with('foo');

    // call someFoo() with the correct $arg
    $fixture->someFoo('foo');
}

Answer 2

Вы можете добавить префикс к имени псевдонима к классу overload:

Ознакомьтесь с документами по Злоупотребление жесткими зависимостями .

Ваш пример будет выглядеть примерно так:

/**
 * @runTestsInSeparateProcesses
 * @preserveGlobalState disabled
 */
class SomeClassTest extends \PHPUnit\Framework\TestCase
{
    public function test_some_foo()
    {
        $someOtherClassMock = \Mockery::mock('overload:SomeOtherClass');
        $someOtherClassMock->shouldReceive('someOtherFoo')
            ->once()
            ->with('something')
            ->andReturn();

        $systemUnderTest = new SomeClass();

        $systemUnderTest->someFoo('something');
    }

}

Я добавил аннотацию @runTestsInSeparateProcesses, потому что обычно проверяемый класс будет использоваться и в других тестах.Без аннотации произойдет сбой автозагрузчика из-за ошибки class already exists.

Если это единственное место, где макетируемый класс используется в вашем наборе тестов, то вы должны удалить аннотацию.

Answer 3

Я нашел здесь свой путь, пытаясь протестировать класс __constructor в «белом ящике», чтобы убедиться, что он сам вызывает метод класса, а некоторые данные передаются в __constructor.

В случае, если кто-то еще находится здесь по той же причине, я подумал, что поделюсь методом, который я использовал в конечном итоге (без использования метода createSomeClass () в заводском стиле, используемого в этом вопросе).

<?php
class someClass {

  public function __constructor($param1) {
    // here is the method in the constructor we want to call
    $this->someOtherFoo($param1);
  }

  public function someOtherFoo($var){  }

}

Теперь тест PHPUnit:

<?php
$paramData = 'someData';

// set up the mock class here
$model = $this->getMock('someClass', 
  array('someOtherFoo'), // override the method we want to check
  array($paramData) // we need to pass in a parameter to the __constructor
);

// test that someOtherFoo() is called once, with out test data
$model->expects($this->once())
      ->with($paramData)
      ->method('someOtherFoo');

// directly call the constructor, instead of doing "new someClass" like normal
$model->__construct($paramData);