运行无法访问 Secrets 在服务器上测试代码

Question

所以，我有一个正在做的项目。该项目的一部分使用带有秘密 API 密钥的 API，我将其存储在一个名为 config.py 的单独文件中，我在 .gitignore 中列出了该文件。这在我的电脑上运行良好，但在 GitHub 的自动测试中会中断。我的测试用例不需要这个 API 键来工作，因为它们使用保存的数据，所以我似乎可以做完最后一天就结束：

try:
    from config import API_KEY
except ImportError:
    LOG.debug("This is running without the secrets.")

但我想先询问社区，看看最佳做法是什么。我应该如何解决这个问题？

编辑：

我知道不同的平台有自己的管理机密的方式，但我想以一种独立于平台的方式来做到这一点。本质上，我有一个未存储在 git 上的 config.py 文件，但我希望 git 克隆了 repo 的人能够成功运行测试用例.这假设 none 个测试用例需要有效的 API_KEY 才能通过。

编辑2：

目前我已经改成这样了，好像还可以，请问有没有更好的办法呢？

API_KEY = 'debug'
try:
    from config import API_KEY
except:
    print("Could not import config.")

Answer 1

GitHub 操作中有一节 docs 专门针对此问题。

编辑：

以您的第二个代码片段为起点，我会将 except 子句的名称包含为 ImportError（以确保仅因缺少导入而引发异常），并修改错误引导用户查阅文档的消息。

Answer 2

通用答案 - 使用 Mock/MagicMock.

在您的情况下，将此添加到测试的开头：

import sys
from unittest import mock
sys.modules['config'] = mock.MagicMock()

参考：Mock examples

Answer 3

您应该统一对待所有不同的环境。也就是说，您的代码不应以不同方式处理 api 键的不同来源：项目需要一个 api 键，句点。这些信息的来源取决于环境，但应用程序总是以相同的方式获取它。

话虽如此，将加载配置的决定下移一层。该应用程序要求一个调试密钥，它在 return 中获得一个或 null。使用它的服务将：

在 production/development 中抛出一个错误，因为它需要的 api 键不存在
在测试中工作正常，因为该服务可以使用空 api 键。

或者，使用默认值创建示例配置并将其提交到您的存储库，并将其用作基本配置。如果环境定义了特定配置，则将其合并到基础配置之上。这种方法要求开发人员始终将密钥添加到基本配置中，但这是一个合理的要求，并且具有作为自记录配置文件的好处。

运行无法访问 Secrets 在服务器上测试代码

Running Test Code on Server without access to Secrets

secret-key

python-3.x

运行 无法访问 Secrets 在服务器上测试代码

Running Test Code on Server without access to Secrets

secret-key

python-3.x

运行无法访问 Secrets 在服务器上测试代码