Кращі практики тестування захищених методів за допомогою PHPUnit

Я знайшов дискусію на тестуванні ви тестуєте приватний метод інформативним.

Я вирішив, що в деяких класах я хочу мати захищені методи, але перевірити їх. Деякі з цих методів є статичними та короткими. Оскільки більшість публічних методів використовує їх, я, ймовірно, зможу безпечно зняти тести пізніше. Але для початку з підходу TDD та уникнення налагодження я дуже хочу перевірити їх.

Я подумав про наступне:

• Метод Об'єкт, про який йдеться у відповіді, здається для цього непосильним.
• Почніть з загальнодоступних методів, і коли покриття коду надається тестами вищого рівня, поверніть їх захищеними та видаліть тести.
• Успадкуйте клас із тестовим інтерфейсом, що робить захищені методи відкритими

Яка найкраща практика? Чи є ще щось?

Здається, що JUnit автоматично змінює захищені методи, щоб бути відкритими, але я не мав глибшого погляду на це. PHP не дозволяє цього через рефлексію .

Якщо ви використовуєте PHP5 (> = 5.3.2) з PHPUnit, ви можете протестувати ваші приватні та захищені методи, використовуючи відображення, щоб встановити їх для загального доступу до запуску тестів:

protected static function getMethod($name) {
  $class = new ReflectionClass('MyClass');
  $method = $class->getMethod($name);
  $method->setAccessible(true);
  return $method;
}

public function testFoo() {
  $foo = self::getMethod('foo');
  $obj = new MyClass();
  $foo->invokeArgs($obj, array(...));
  ...
}

Ви, здається, це вже знаєте, але я все одно переставлю його; Це погана ознака, якщо вам потрібно перевірити захищені методи. Метою одиничного тесту є тестування інтерфейсу класу, а захищені методи - це деталі реалізації. Однак, є випадки, коли це має сенс. Якщо ви використовуєте спадкування, ви можете бачити надклас як інтерфейс для підкласу. Тому тут вам доведеться протестувати захищений метод (але ніколи приватний ). Рішенням цього є створення підкласу для тестування і використовувати це для викриття методів. Напр .:

class Foo {
  protected function stuff() {
    // secret stuff, you want to test
  }
}

class SubFoo extends Foo {
  public function exposedStuff() {
    return $this->stuff();
  }
}

Зауважте, що завжди можна замінити спадщину складом. Під час тестування коду, як правило, набагато простіше мати справу з кодом, який використовує цю схему, тому ви можете розглянути цей варіант.

театральна опіка має правильний підхід. Ще простішим є виклик методу безпосередньо та повернення відповіді:

class PHPUnitUtil
{
  public static function callMethod($obj, $name, array $args) {
        $class = new \ReflectionClass($obj);
        $method = $class->getMethod($name);
        $method->setAccessible(true);
        return $method->invokeArgs($obj, $args);
    }
}

Ви можете назвати це просто у своїх тестах:

$returnVal = PHPUnitUtil::callMethod(
                $this->object,
                '_nameOfProtectedMethod', 
                array($arg1, $arg2)
             );

Я хотів би запропонувати невелику варіацію, щоб getMethod () визначений у відповіді uckelman .

Ця версія змінює getMethod (), видаляючи жорстко кодовані значення та трохи спрощуючи використання. Я рекомендую додати його до свого класу PHPUnitUtil, як у наведеному нижче прикладі, або до вашого класу, що розширює PHPUnit_Framework_TestCase (або, я вважаю, глобально у ваш файл PHPUnitUtil).

Оскільки MyClass все одно інстанціюється і ReflectionClass може приймати рядок або об'єкт ...

class PHPUnitUtil {
    /**
     * Get a private or protected method for testing/documentation purposes.
     * How to use for MyClass->foo():
     *      $cls = new MyClass();
     *      $foo = PHPUnitUtil::getPrivateMethod($cls, 'foo');
     *      $foo->invoke($cls, $...);
     * @param object $obj The instantiated instance of your class
     * @param string $name The name of your private/protected method
     * @return ReflectionMethod The method you asked for
     */
    public static function getPrivateMethod($obj, $name) {
      $class = new ReflectionClass($obj);
      $method = $class->getMethod($name);
      $method->setAccessible(true);
      return $method;
    }
    // ... some other functions
}

Я також створив функцію псевдоніму getProtectedMethod (), щоб пояснити, що очікується, але це залежить від вас.

Ура!

Я думаю, що troelskn близький. Я б це зробив замість цього:

class ClassToTest
{
   protected function testThisMethod()
   {
     // Implement stuff here
   }
}

Потім реалізуйте щось подібне:

class TestClassToTest extends ClassToTest
{
  public function testThisMethod()
  {
    return parent::testThisMethod();
  }
}

Потім ви запускаєте свої тести на TestClassToTest.

Потрібно мати можливість автоматично генерувати такі класи розширень шляхом розбору коду. Я не був би здивований, якщо PHPUnit вже пропонує такий механізм (хоча я ще не перевіряв).

Я збираюся сюди кинути шапку на ринг:

Я використовував хак-__call зі змішаним ступенем успіху. Альтернатива, яку я придумав, - це використовувати шаблон відвідувачів:

1: генерувати stdClass або спеціальний клас (для примусового використання типу)

2: першочергово, що потрібний метод та аргументи

3: переконайтесь, що ваш SUT має метод acceptVisitor, який буде виконувати метод з аргументами, вказаними в відвідувальному класі

4: введіть його в клас, який ви хочете протестувати

5: SUT вводить у відвідувач результат операції

6: застосуйте свої тестові умови до атрибута результату відвідувача

Ви дійсно можете використовувати __call () загальний спосіб доступу до захищених методів. Щоб мати можливість протестувати цей клас

class Example {
    protected function getMessage() {
        return 'hello';
    }
}

ви створюєте підклас у ExampleTest.php:

class ExampleExposed extends Example {
    public function __call($method, array $args = array()) {
        if (!method_exists($this, $method))
            throw new BadMethodCallException("method '$method' does not exist");
        return call_user_func_array(array($this, $method), $args);
    }
}

Зауважте, що метод __call () жодним чином не посилається на клас, тому ви можете скопіювати вищезазначені для кожного класу захищеними методами, які ви хочете перевірити, та просто змінити декларацію класу. Можливо, ви зможете розмістити цю функцію в загальному базовому класі, але я її не пробував.

Тепер сам тестовий випадок відрізняється лише тим, де ви побудуєте об'єкт, який підлягає тестуванню, замінивши його в ExampleExposed for Example.

class ExampleTest extends PHPUnit_Framework_TestCase {
    function testGetMessage() {
        $fixture = new ExampleExposed();
        self::assertEquals('hello', $fixture->getMessage());
    }
}

Я вважаю, що PHP 5.3 дозволяє використовувати роздуми, щоб безпосередньо змінити доступність методів, але я припускаю, що вам доведеться робити це для кожного методу окремо.

Я пропоную наступне рішення для вирішення / ідеї "Генріка Пола" :)

Ви знаєте назви приватних методів свого класу. Наприклад, вони схожі на _add (), _edit (), _delete () тощо.

Отже, коли ви хочете протестувати його з аспекту тестування одиниць, просто зателефонуйте до приватних методів за допомогою префіксації та / або суфіксації деяких загальних слова (наприклад, _addPhpunit), щоб при виклику методу __call () (оскільки метод _addPhpunit () не існує клас власника, ви просто введете необхідний код у метод __call (), щоб видалити префікс / суфікс слово / с (Phpunit), а потім викликати цей виведений приватний метод звідти. Це ще одне добре використання магічних методів.

Спробуй.