测试功能的正确方法

Correct way to test a function

是否可以在测试中调用 build_admins_message 以构建将在模拟断言中使用的预期结果?

实施:

@slack_messages.on_pattern('(?i)^admins$')
def handle_admins_message(event, body, match):
    team_id = event['team_id']
    user_id = body['user']

    message = build_admins_message(team_id, user_id)
    Slack(team_id).send_message(user_id, **message)

测试:

class TestAdminsMessageHandler(TestCase):
    def setUp(self):
        team = SlackTeam.objects.create(team_id='TEAMID')
        SlackUser.objects.create(team=team, user_id='USERID')

    def tearDown(self):
        SlackUser.objects.all().delete()
        SlackTeam.objects.all().delete()

    @mock.patch('slango.slack.Slack.send_message')
    def test_correct_text(self, send_message_mock):
        event = {
            'team_id': 'TEAMID',
            'event': {
                'text': 'admins',
                'user': 'USERID'
            }
        }

        handle_admins_message(event, event['event'])

        expected_message = build_admins_message('TEAMID', 'USERID')

        send_message_mock.assert_called_with('USERID', **expected_message)

实施build_admins_message

def build_admins_message(team_id, user_id):
    user = SlackUser.retrieve(team_id, user_id)
    admins = SlackUser.objects.filter(
        is_bot_admin=True, team__team_id=team_id).order_by(
            'real_name', 'display_name')

    attachments = []
    if user.is_bot_admin:
        attachments.append(build_admin_picker())

    for admin in admins:
        attachments.append(build_admin_item(user, admin))

    attachments.append(build_admin_more())

    return {
        'text': "Here is users with admin rights:",
        'attachments': attachments
    }

这取决于 build_admins_message 在您的程序中的作用。

由于程序的不同部分都需要以相同的方式构建消息,这可能没问题。考虑是否可以更明确地说明 build_admins_message 是这样使用的,例如依赖注入。确保您的辅助方法有自己的测试。 (我通常将 patch 视为一种设计味道,但请记住,这并不意味着一定有问题!)

如果 build_admins_message 仅作为 handle_admins_message 的辅助函数存在,那么在您的测试中使用它会违反封装并将您的测试过多地与实现联系起来。在那种情况下,我会在测试中手动写出预期的消息。