Slide 1

Slide 1 text

Alexey Solodkiy · 16th of March Зачем и как писать качественные Unit-тесты

Slide 2

Slide 2 text

1. Что такое качественный unit-тест? 2. Как писать такие тесты? 3. Как сделать это на практике?

Slide 3

Slide 3 text

Что такое качественный unit-тест

Slide 4

Slide 4 text

Зачем нужны unit-тесты

Slide 5

Slide 5 text

1) Тесты помогают делать продакшен стабильным • регрессионное тестирование • фиксация контрактов

Slide 6

Slide 6 text

2) Тесты повышают удобство разработки • ускорение обратной связи • упрощение рефакторинга • тесты — это документация

Slide 7

Slide 7 text

3) Тесты организуют ваш код • делают ваш код контрактным • тесты заставляют вас думать о граничных условиях

Slide 8

Slide 8 text

Как выглядит качественный unit-тест

Slide 9

Slide 9 text

• стабильный • падает на багах • устойчивый к рефакторингу • быстрый • не зависит от окружения • понятный

Slide 10

Slide 10 text

• нестабильный • проходит на багах • ломкий • медленный • работает только в определённом окружении • сложный

Slide 11

Slide 11 text

Плохие тесты хуже, чем их отсутствие

Slide 12

Slide 12 text

Как писать хорошие тесты

Slide 13

Slide 13 text

Контракты

Slide 14

Slide 14 text

Контракт модуля — то, какие ожидания у вас есть от модуля, а у модуля — от вас

Slide 15

Slide 15 text

В контракт функции может входить: • диапазон входных параметров (предусловия) • ожидаемый результат (постусловия) • условия возникновения исключений • результат на граничных условиях

Slide 16

Slide 16 text

Методы фиксации контракта: • типизация • assert • unit-тесты! • комментарии • документация

Slide 17

Slide 17 text

Unit-тесты — это инструмент проверки контрактов

Slide 18

Slide 18 text

Код должен быть контрактным, если вы хотите тестировать его unit-тестами

Slide 19

Slide 19 text

Какие условия контракта нужно проверять: • полезную работу • граничные условия • исключения

Slide 20

Slide 20 text

Тестируйте контракт, а не реализацию

Slide 21

Slide 21 text

Чистая функция

Slide 22

Slide 22 text

Чистой называется функция, которая: • является детерминированной • не обладает побочными эффектами

Slide 23

Slide 23 text

Функция называется детерминированной, 
 когда для одного и того же набора входных значений она возвращает одинаковый результат.

Slide 24

Slide 24 text

Побочный эффект — любое взаимодействие с окружением (чтение и запись файлов, глобальных переменных, любая работа с сетью)

Slide 25

Slide 25 text

Чистая функция всегда однозначно преобразует входные параметры в выходные, никак при этом не взаимодействуя с окружением Input Output
 [2, 4, 5] => array_sum => 11

Slide 26

Slide 26 text

Процедура Чистая функция Не детерминирована 
 или есть побочный эффект Примеры:
 rand() date() file_get_contents() PDO::query() Детерминированность
 Отсутствие побочных эффектов Примеры: abs() array_sum() count()

Slide 27

Slide 27 text

Если ваш unit-тест будет чистой функцией, то он будет: • быстрым • стабильным • не зависимым от окружения

Slide 28

Slide 28 text

Unit-тесты подходят только для чистых функций

Slide 29

Slide 29 text

Тестирование процедур

Slide 30

Slide 30 text

userRegister

Slide 31

Slide 31 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 32

Slide 32 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 33

Slide 33 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 34

Slide 34 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 35

Slide 35 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 36

Slide 36 text

Контракт usersManager::userRegister: 1) При успешной регистрации пользователь будет добавлен в таблицу, и ему на почту будет отправлен сгенерированный пароль 2) Метод возвращает id пользователя в базе 3) Страна пользователя определяется по доменной зоне email 4) Если такой пользователь уже есть а базе — кидаем DuplicateUserException

Slide 37

Slide 37 text

Сведение процедуры к чистой функции

Slide 38

Slide 38 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций Входы

Slide 39

Slide 39 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 40

Slide 40 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций Выходы

Slide 41

Slide 41 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 42

Slide 42 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 43

Slide 43 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 44

Slide 44 text

No content

Slide 45

Slide 45 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 46

Slide 46 text

No content

Slide 47

Slide 47 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 50

Slide 50 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 51

Slide 51 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 52

Slide 52 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 53

Slide 53 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 54

Slide 54 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 55

Slide 55 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 56

Slide 56 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 57

Slide 57 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 58

Slide 58 text

Вынос чистой функции

Slide 59

Slide 59 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 60

Slide 60 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 61

Slide 61 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 62

Slide 62 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 63

Slide 63 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 64

Slide 64 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 65

Slide 65 text

Реализация альтернативных хранилищ

Slide 66

Slide 66 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 67

Slide 67 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 68

Slide 68 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 69

Slide 69 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 70

Slide 70 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 71

Slide 71 text

Function testAbs($number, $expected_result) {
 $actual_result = abs($number)
 $this->assertEquals($expected_result, $actual_result);
 } Function absProvider() {
 return [
 [1, 1],
 [-5, 5],
 [5, 5]
 ];
 } Тестирование чистых функций

Slide 72

Slide 72 text

Выводы

Slide 73

Slide 73 text

• плохие тесты хуже, чем их отсутствие • unit-тесты — это инструмент проверки контрактов • код должен быть контрактным, если вы хотите тестировать его unit-тестами • тестируйте контракт, а не реализацию • unit-тесты подходят только для чистых функций

Slide 74

Slide 74 text

Alexey Solodkiy email: [email protected] tg: @solodkiy CHEERS! [work@MacBook-Pro-Alexey ~/examples]# ./vendor/bin/phpunit tests/UsersManagerTest.php PHPUnit 7.5.6 by Sebastian Bergmann and contributors. ..... 5 / 5 (100%) Time: 88 ms, Memory: 4.00 MB OK (5 tests, 5 assertions)