单元测试写入加密钱包文件的函数或方法的正确方法是什么?

时间:2017-06-07 07:22:15

标签: python unit-testing wallet

我的代码看起来有点像这样:

def write_wallet_file_entry(name, value, wallet_file, wallet_password):
    some_code
    some_more_code_to_write_to_the_wallet
    ...

我正在使用Python(2.6)并使用unittest模块对此代码进行单元测试。代码创建钱包文件(如果它不存在),然后将一堆键值对写入其中。

一旦我写入钱包,就没有文本解析我可以做以确认写入是干净的。

澄清:说明不明显:我不能使用“unittest.mock”或“mock”模块,这会使问题更容易解决。我的环境停留在python 2.6上,没有“virtualenv”,没有“mock”模块,也不允许在系统上安装外部模块。

任何建议都会非常有用。

1 个答案:

答案 0 :(得分:1)

一些假设

这些假设不会改变我的答案的要点,但是它们意味着我们可以清楚明确术语,因为你还没有发布Minimum, Complete and Verifiable Example

  • '钱包文件'实际上是一个类似文件的对象。它遵循与文件流对象相同的语义,Python的open()是直接包装器。

  • 只有wallet_filewallet_password是特定于钱包文件的。 namevalue是您要传递给文件的键值对。

问题

您的问题在于能够测试您的写入是否“干净”。

但是,需要检查文件是否写得正确或是否已创建 -  你只是用这种方式测试Python的file对象,这已经过非常强大的测试了。

单元测试的目的是测试您编写的代码,外部服务。它应始终始终假设外部服务在单元测试中完成其工作 - 您只在集成测试中测试外部服务。

需要的是一种确保您发送的值被正确接收而不会出现乱码的方法,并且您创建文件的请求是以您希望的格式接收的。测试消息,而不是收件人

方法

一种技术是将输入抽象为类,并将其子类化为具有虚拟方法。然后,您可以将子类用作美化模拟,用于所有意图和目的。

换句话说,改变

def write_wallet_file_entry(name, value, wallet_file, wallet_password):
    ...

class Wallet(object):

    def __init__(self, wallet_file, wallet_password):
        self.file = wallet_file
        self.password = wallet_password

    def exists(self):            
        # code to check if file exists in filesystem

    def write(self, name, value):
        # code to write name, value

def write_wallet_file_entry(name, value, WalletObject):
    assert isinstance(WalletObject, Wallet), "Only Wallets allowed" 
    if WalletObject.exists():
        WalletObject.write(name, value)

要进行测试,您现在可以创建MockWallet

class MockWallet(Wallet):

    def __init__(self, wallet_file, wallet_password):
        super(MockWallet, self).__init__(wallet, wallet_password)
        self.didCheckExists = False
        self.didAttemptWrite = False
        self.didReceiveCorrectly = False

    def exists(self):
        super(MockWallet, self).exists()
        self.didCheckExists = True

    def write(self, name, value):
        # ... some code to validate correct arguments were pass
        self.didReceiveCorrectly = True
        if super(MockWallet, self).write(name, value):
            self.didAttemptWrite = True

现在你可以在生产中使用相同的功能(只需传递一个Wallet!)并在测试中(只需传递MockWallet并检查该对象的属性!):

import unittest
from ... import MockWallet, write_wallet_file_entry

class Test(unittest.TestCase):

    def testWriteFlow(self):
        mock = MockWallet()
        name, value = 'random', 'more random'
        write_wallet_file_entry(name, value, mock)

        self.assertTrue(mock.didCheckExists)
        self.assertTrue(mock.didAttemptWrite)
        self.assertTrue(mock.didReceiveCorrectly)

瞧!您现在拥有一个经过测试的写入流程,其中只使用dependency injection而不是任意函数参数进行简单的即兴模拟。