Простий вступ до тестової розробки за допомогою Python

Я початківець-самоучка, який вміє писати прості програми. Але мені слід зізнатися. Неможливо згадати, як все взаємопов’язано в моїй голові.

Ця ситуація погіршується, якщо я повернусь до коду, який я написав, через кілька днів. Виявляється, цю проблему можна було б подолати, дотримуючись методології тестового управління (TDD).

Що таке TDD і чому це важливо?

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

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

Тести також надають вам впевненості, коли ви починаєте переробляти код, оскільки ви частіше виявляєте помилки через миттєвий зворотний зв'язок при виконанні тестів.

Як розпочати?

Щоб почати писати тести на Python, ми будемо використовувати unittestмодуль, який постачається з Python. Для цього ми створюємо новий файл mytests.py, який буде містити всі наші тести.

Почнемо зі звичайного «привіт світу»:

import unittestfrom mycode import *
class MyFirstTests(unittest.TestCase):
def test_hello(self): self.assertEqual(hello_world(), 'hello world')

Зверніть увагу, що ми імпортуємо helloworld()функцію з mycodeфайлу. У файл mycode.pyми спочатку просто включимо код нижче, який створює функцію, але на цьому етапі нічого не повертає:

def hello_world(): pass

Запуск python mytests.pyбуде генерувати такий результат у командному рядку:

F
====================================================================
FAIL: test_hello (__main__.MyFirstTests)
--------------------------------------------------------------------
Traceback (most recent call last):
File "mytests.py", line 7, in test_hello
self.assertEqual(hello_world(), 'hello world')
AssertionError: None != 'hello world'
--------------------------------------------------------------------
Ran 1 test in 0.000s
FAILED (failures=1)

Це однозначно вказує на те, що тест провалився, що очікувалося. На щастя, ми вже написали тести, тому знаємо, що завжди буде поруч перевірити цю функцію, що дає нам впевненість у виявленні потенційних помилок у майбутньому.

Щоб переконатися, що код проходить, давайте перейдемо mycode.pyдо наступного:

def hello_world(): return 'hello world'

Запускаючи python mytests.pyзнову, ми отримуємо такий вивід у командному рядку:

.
--------------------------------------------------------------------
Ran 1 test in 0.000s
OK

Вітаємо! Ви щойно написали свій перший тест. Тепер перейдемо до дещо складнішого завдання. Ми створимо функцію, яка дозволить нам створити користувальницьке розуміння числового списку в Python.

Почнемо з написання тесту для функції, яка створить список певної довжини.

У файлі mytests.pyце буде метод test_custom_num_list:

import unittestfrom mycode import *
class MyFirstTests(unittest.TestCase):
def test_hello(self): self.assertEqual(hello_world(), 'hello world') def test_custom_num_list(self): self.assertEqual(len(create_num_list(10)), 10)

Це перевірить, чи функція create_num_listповертає список довжиною 10. Давайте створимо функцію create_num_listв mycode.py:

def hello_world(): return 'hello world'
def create_num_list(length): pass

Запуск python mytests.pyбуде генерувати такий результат у командному рядку:

E.
====================================================================
ERROR: test_custom_num_list (__main__.MyFirstTests)
--------------------------------------------------------------------
Traceback (most recent call last):
File "mytests.py", line 14, in test_custom_num_list
self.assertEqual(len(create_num_list(10)), 10)
TypeError: object of type 'NoneType' has no len()
--------------------------------------------------------------------
Ran 2 tests in 0.000s
FAILED (errors=1)

Це , як і слід було очікувати, так що давайте йти вперед і функція зміни create_num_listв mytest.pyдля того , щоб пройти тест:

def hello_world(): return 'hello world'
def create_num_list(length): return [x for x in range(length)]

Виконання python mytests.pyв командному рядку демонструє, що другий тест також пройшов тепер:

..
--------------------------------------------------------------------
Ran 2 tests in 0.000s
OK

Let’s now create a custom function that would transform each value in the list like this: const * ( X ) ^ power . First let’s write the test for this, using method test_custom_func_ that would take value 3 as X, take it to the power of 3, and multiply by a constant of 2, resulting in the value 54:

import unittestfrom mycode import *
class MyFirstTests(unittest.TestCase):
def test_hello(self): self.assertEqual(hello_world(), 'hello world')
def test_custom_num_list(self): self.assertEqual(len(create_num_list(10)), 10) def test_custom_func_x(self): self.assertEqual(custom_func_x(3,2,3), 54)

Let’s create the function custom_func_x in the file mycode.py:

def hello_world(): return 'hello world'
def create_num_list(length): return [x for x in range(length)]
def custom_func_x(x, const, power): pass

As expected, we get a fail:

F..
====================================================================
FAIL: test_custom_func_x (__main__.MyFirstTests)
--------------------------------------------------------------------
Traceback (most recent call last):
File "mytests.py", line 17, in test_custom_func_x
self.assertEqual(custom_func_x(3,2,3), 54)
AssertionError: None != 54
--------------------------------------------------------------------
Ran 3 tests in 0.000s
FAILED (failures=1)

Updating function custom_func_x to pass the test, we have the following:

def hello_world(): return 'hello world'
def create_num_list(length): return [x for x in range(length)]
def custom_func_x(x, const, power): return const * (x) ** power

Running the tests again we get a pass:

...
--------------------------------------------------------------------
Ran 3 tests in 0.000s
OK

Finally, let’s create a new function that would incorporate custom_func_x function into the list comprehension. As usual, let’s begin by writing the test. Note that just to be certain, we include two different cases:

import unittestfrom mycode import *
class MyFirstTests(unittest.TestCase):
def test_hello(self): self.assertEqual(hello_world(), 'hello world')
def test_custom_num_list(self): self.assertEqual(len(create_num_list(10)), 10)
def test_custom_func_x(self): self.assertEqual(custom_func_x(3,2,3), 54)
def test_custom_non_lin_num_list(self): self.assertEqual(custom_non_lin_num_list(5,2,3)[2], 16) self.assertEqual(custom_non_lin_num_list(5,3,2)[4], 48)

Now let’s create the function custom_non_lin_num_list in mycode.py:

def hello_world(): return 'hello world'
def create_num_list(length): return [x for x in range(length)]
def custom_func_x(x, const, power): return const * (x) ** power
def custom_non_lin_num_list(length, const, power): pass

As before, we get a fail:

.E..
====================================================================
ERROR: test_custom_non_lin_num_list (__main__.MyFirstTests)
--------------------------------------------------------------------
Traceback (most recent call last):
File "mytests.py", line 20, in test_custom_non_lin_num_list
self.assertEqual(custom_non_lin_num_list(5,2,3)[2], 16)
TypeError: 'NoneType' object has no attribute '__getitem__'
--------------------------------------------------------------------
Ran 4 tests in 0.000s
FAILED (errors=1)

In order to pass the test, let’s update the mycode.py file to the following:

def hello_world(): return 'hello world'
def create_num_list(length): return [x for x in range(length)]
def custom_func_x(x, const, power): return const * (x) ** power
def custom_non_lin_num_list(length, const, power): return [custom_func_x(x, const, power) for x in range(length)]

Running the tests for the final time, we pass all of them!

....
--------------------------------------------------------------------
Ran 4 tests in 0.000s
OK

Congrats! This concludes this introduction to testing in Python. Make sure you check out the resources below for more information on testing in general.

The code is available here on GitHub.

Useful resources for further learning!

Web resources

Below are links to some of the libraries focusing on testing in Python

25.3. unittest - Unit testing framework - Python 2.7.14 documentation

The Python unit testing framework, sometimes referred to as "PyUnit," is a Python language version of JUnit, by Kent…docs.python.orgpytest: helps you write better programs - pytest documentation

The framework makes it easy to write small tests, yet scales to support complex functional testing for applications and…docs.pytest.orgWelcome to Hypothesis! - Hypothesis 3.45.2 documentation

It works by generating random data matching your specification and checking that your guarantee still holds in that…hypothesis.readthedocs.iounittest2 1.1.0 : Python Package Index

The new features in unittest backported to Python 2.4+.pypi.python.org

YouTube videos

If you prefer not to read, I recommend watching the following videos on YouTube.