在不访问 Secrets 的情况下在服务器上运行测试代码

如何解决在不访问 Secrets 的情况下在服务器上运行测试代码

所以，我正在做一个项目。该项目的一部分使用带有秘密 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 的人能够成功运行测试用例。这假设所有测试用例都不需要有效的 API_KEY 才能通过。

编辑 2：

目前，我已经改成这个了，好像可以用，但是有没有更好的方法？

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

解决方法

通用答案 - 使用 Mock/MagicMock。

---

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

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

参考：Mock examples

,

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

话虽如此，将加载配置的决定向下移动一层。该应用程序要求一个调试密钥，它得到一个作为回报，或者为空。使用它的服务将：

• 在生产/开发中抛出错误，因为它需要的 api 密钥不存在
• 在测试中正常工作，因为该服务可以使用空 api 密钥。

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

,

GitHub Actions docs 上有一节专门针对此问题。

编辑：

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