如何在 Pytest 中為沒有返回語句的方法創建單元測試？

Question

我正在嘗試在 function 上執行 pytest 而在 class 中沒有返回值：

# app.py
from utils import DBConnection


class App:
  def add_ticket_watcher(self, ticket_key, watcher_name):
    if ticket_key is None:
      raise ValueError('Ticket key is empty')

    instance = DBConnection()
    instance.save(ticket_key, watcher_name)

從上面的代碼來看， add_ticket_watcher()是一個沒有返回語句的方法。 我從這篇文章中了解到，我們可以使用 mocks 來模擬這種方法的預期行為。

對於 mocking function 和 pytest，我發現我們可以使用monkeypatch 。

因此，我的方法是為add_ticket_watcher()執行 2 個測試用例：

• 測試有效票證密鑰
• 測試無效票證密鑰

我有類似的東西：

# test_app.py
import pytest
from src.app import App


@pytest.fixture
def app():
    app = App()
    return app


# Positive test case: Setup parameterize test for valid ticket key
add_valid_watcher_data = (
    ('func_name', 'ticket_key', 'watcher_name', 'expected_result', 'comment'),
    [
        ('add_ticket_watcher', 'TIC-13527', 'someone', None, 'add watcher at valid ticket key'),
    ]
)


@pytest.mark.parametrize(*add_valid_watcher_data)
def test_add_ticket_watcher(monkeypatch, app, func_name, ticket_key, watcher_name, expected_result, comment):

    def mock_add_ticket_watcher(ticket_key, watcher_name):
        # Since `add_ticket_watcher()` has no return statement, I'm mocking the result as None
        return None

    monkeypatch.setattr(app, "add_ticket_watcher", mock_add_ticket_watcher)

    # Run each input parameter from add_valid_watcher_data to `add_ticket_watcher()`
    watcher = getattr(app, func_name)(ticket_key, watcher_name)

    # If watcher has None value, then `add_ticket_watcher()` execution is successful.
    assert expected_result == watcher


# Negative test case: Setup parameterize test for invalid ticket key
add_invalid_watcher_data = (
    ('func_name', 'ticket_key', 'watcher_name', 'exception_message', 'comment'),
    [
        ('add_ticket_watcher', 'TIC-xx', 'someone', 'Ticket key is empty', 'add watcher at invalid ticket key'),
        ('add_ticket_watcher', None, 'someone', 'Ticket key is empty', 'ticket key has None value'),
    ]
)


@pytest.mark.parametrize(*add_invalid_watcher_data)
def test_exception_add_ticket_watcher(app, func_name, ticket_key, watcher_name, exception_message, comment):
    with pytest.raises(ValueError, match=exception_message):
      # Run each input parameter from add_invalid_watcher_data to `add_ticket_watcher()`
      getattr(app, func_name)(ticket_key, watcher_name)

在test_add_ticket_watcher()中，我不確定要斷言什么。 但是，由於App.add_ticket_watcher(ticket_key, watcher_name)沒有返回語句。 我創建了一個模擬 function 以返回None 。

有沒有更好的方法來達到同樣的目的？

如何在 Pytest 中為沒有返回語句的方法創建單元測試？

Answer 1

除了chepner提到的。 您可以測試是否使用 mock 調用了 logger.info。 為了測試負面情況，您可以使用模擬 side_effects 強制它引發異常，然后您可以測試是否調用了 logger.exception。

Answer 2

我不熟悉 pytest 但 unittest。 但是，我會為您的 function 編寫這 3 個測試（對您現有的 function 進行一些修改:)）

注意：測試方法名稱是描述性的，因此，我沒有添加額外的注釋。

應用程序.py

from utils import DBConnection
import cx_Oracle

class App:

  def add_ticket_watcher(self, ticket_key, watcher_name):
    if ticket_key is None:
      raise ValueError('Ticket key is empty')

    instance = DBConnection()

    try:
        instance.save(ticket_key, watcher_name)
    except Exception as e:
        raise cx_Oracle.DatabaseError('Database save failed')

test_app.py

import unittest
import app
import cx_Oracle
from mock import patch

class TestApp(unittest.TestCase):

    @classmethod
    def setUpClass(cls):
        cls.app = app.App()

    def test_if_exception_raised_when_ticket_value_is_none(self):
        with self.assertRaises(ValueError):
            self.app.add_ticket_watcher(None, 'dummyname')

    def test_if_dbconnection_save_is_called(self):
        with patch('app.DBConnection.save') as mock_dbconn_save:
            self.app.add_ticket_watcher(123, 'dummyname')
            self.assertTrue(mock_dbconn_save.called)

    def test_if_dbconnection_save_raises_error(self):
        with patch('app.DBConnection.save', side_effect = Exception) as mock_dbconn_save_exc:
            with self.assertRaises(cx_Oracle.DatabaseError):
                self.app.add_ticket_watcher(123, 'dummyname')

if __name__ == '__main__':
    unittest.main(verbosity=2)