Unittest.mock - 如何模拟从连接对象对 cursor.execute() 的调用？

Question

我正在尝试使用 mock 将以下代码中的 cursor.execute() 存根，以便我可以测试使用格式正确的查询调用执行：

// Module ABC

def buildAndExecuteQuery( tablesAndColumnsToSelect ):
   '''Build and execute a query.

   Args: tablesAndColumnsToSelect (dict)
         - keys are table names, values are columns

   '''
   query = ..... < logic to build query > ....

   from django.db import connections
   cursor = connections[ 'mydb' ].cursor()
   cursor.execute( query )

如何在python2.7中使用mock库完成这种类型的mock？

Answer 1

我将用示例扩展@G_M 答案，因为我有两个反对意见：

1. 在我看来，显式关闭数据库游标是一种很好的做法，更多信息请参见：Necessity of explicit cursor.close()。这可以通过将光标用作上下文管理器来完成，更多信息请参见 Django 文档：https://docs.djangoproject.com/en/dev/topics/db/sql/#connections-and-cursors。
2. 使用mock 时，我们不应在定义对象的位置修补对象：

基本原则是在查找对象的位置打补丁， 这不一定与定义它的地方相同。一种 几个例子将有助于澄清这一点。

参考：https://docs.python.org/3/library/unittest.mock.html#where-to-patch

示例：

我们要测试的函数：

# foooo_bar.py
from typing import Optional

from django.db import DEFAULT_DB_ALIAS, connections


def some_function(some_arg: str, db_alias: Optional[str] = DEFAULT_DB_ALIAS):
    with connections[db_alias].cursor() as cursor:
        cursor.execute('SOME SQL FROM %s;', [some_arg])

测试：

# test_foooo_bar.py
from unittest import mock

from django.db import DEFAULT_DB_ALIAS
from django.test import SimpleTestCase

from core.db_utils.xx import some_function


class ExampleSimpleTestCase(SimpleTestCase):
    @mock.patch('foooo_bar.connections')
    def test_some_function_executes_some_sql(self, mock_connections):
        mock_cursor = mock_connections.__getitem__(DEFAULT_DB_ALIAS).cursor.return_value.__enter__.return_value
        some_function('fooo')

        # Demonstrating assert_* options:
        mock_cursor.execute.assert_called_once()
        mock_cursor.execute.assert_called()
        mock_cursor.execute.assert_called_once_with('SOME SQL FROM %s;', ['fooo'])

Answer 2

由于我不知道您的查询逻辑是什么，我将query 修改为直接通过tables_and_columns_to_select 参数接受一个标记值。

# b_and_ex_q.py


def build_and_execute_query(tables_and_columns_to_select):
    """Build and execute a query.

    Args: tablesAndColumnsToSelect (dict)
          - keys are table names, values are columns

    """

    query = tables_and_columns_to_select  # ..... < logic to build query > ....

    from django.db import connections

    cursor = connections['mydb'].cursor()
    cursor.execute(query)

---

import unittest

from mock import patch, sentinel

from b_and_ex_q import build_and_execute_query


class TestCursorExecute(unittest.TestCase):
    @patch('django.db.connections')
    def test_build_and_execute_query(self, mock_connections):
        # Arrange
        mock_cursor = mock_connections.__getitem__('mydb').cursor.return_value

        # Act
        build_and_execute_query(sentinel.t_and_c)

        # Assert
        mock_cursor.execute.assert_called_once_with(sentinel.t_and_c)


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