如何避免在pytest_jira插件的jira.cfg中硬编码用户名/密码

我刚好处理过类似的需求，给你几个实用的方案来解决这个问题，既安全又灵活：

方案1：通过环境变量覆盖配置 #

这是CI/CD环境中最常用的方式，你可以把用户名和密码存在环境变量里，然后在测试脚本启动时读取并覆盖默认配置。

在你的项目根目录创建conftest.py，添加以下代码：

import os
from pytest_jira.plugin import JiraConfig

def pytest_configure(config):
    # 加载默认的jira.cfg配置
    jira_config = JiraConfig.from_file(os.path.expanduser("~/jira.cfg"))
    
    # 从环境变量读取并覆盖用户名（如果环境变量存在）
    env_username = os.getenv("JIRA_USERNAME")
    if env_username:
        jira_config.username = env_username
    
    # 从环境变量读取并覆盖密码（如果环境变量存在）
    env_password = os.getenv("JIRA_PASSWORD")
    if env_password:
        jira_config.password = env_password
    
    # 将修改后的配置传递给pytest-jira插件
    config._jira_config = jira_config

使用时，只需要在运行pytest前设置环境变量：

# Linux/macOS
export JIRA_USERNAME="your_username"
export JIRA_PASSWORD="your_password"
pytest

# Windows（PowerShell）
$env:JIRA_USERNAME="your_username"
$env:JIRA_PASSWORD="your_password"
pytest

方案2：通过命令行参数传递 #

如果只是临时运行测试，命令行参数会更方便，不需要修改环境变量。

同样在conftest.py中添加：

from pytest_jira.plugin import JiraConfig

def pytest_addoption(parser):
    # 添加自定义命令行参数
    parser.addoption(
        "--jira-username",
        action="store",
        default=None,
        help="Jira authentication username"
    )
    parser.addoption(
        "--jira-password",
        action="store",
        default=None,
        help="Jira authentication password"
    )

def pytest_configure(config):
    jira_config = JiraConfig.from_file(os.path.expanduser("~/jira.cfg"))
    
    # 读取命令行参数并覆盖配置
    cli_username = config.getoption("--jira-username")
    if cli_username:
        jira_config.username = cli_username
    
    cli_password = config.getoption("--jira-password")
    if cli_password:
        jira_config.password = cli_password
    
    config._jira_config = jira_config

运行测试时直接传递参数：

pytest --jira-username your_username --jira-password your_password

方案3：使用系统密钥管理工具（本地开发推荐） #

如果是本地开发，不想每次都输入密码或设置环境变量，可以用系统自带的密钥管理工具（比如macOS的Keychain、Windows的Credential Manager、Linux的GNOME Keyring），搭配keyring库来安全存储和读取密码。

首先安装依赖：

pip install keyring

然后设置密钥（运行一次即可）：

# 设置指定用户名对应的Jira密码
keyring set "Jira API" your_username

之后在conftest.py中添加：

import os
import keyring
from pytest_jira.plugin import JiraConfig

def pytest_configure(config):
    jira_config = JiraConfig.from_file(os.path.expanduser("~/jira.cfg"))
    
    # 优先从环境变量读取用户名，没有则用配置文件中的值
    username = os.getenv("JIRA_USERNAME", jira_config.username)
    if username:
        jira_config.username = username
        # 从密钥管理工具获取密码
        jira_config.password = keyring.get_password("Jira API", username)
    
    config._jira_config = jira_config

这样每次运行测试时，脚本会自动从系统密钥库中读取密码，不需要手动输入或明文存储。

方案4：加密配置文件 #

如果必须要持久化配置，但又不想明文存储，可以用加密库对jira.cfg中的敏感字段加密，脚本启动时解密读取。比如使用cryptography库：

1. 安装依赖：

pip install cryptography

2. 编写加密/解密脚本，把用户名和密码加密后写入jira.cfg（比如存成encrypted_username和encrypted_password）。

3. 在conftest.py中解密并覆盖配置：

import os
from cryptography.fernet import Fernet
from pytest_jira.plugin import JiraConfig

# 注意：密钥要安全存储，不要硬编码在代码里，可以存在环境变量或密钥管理工具中
ENCRYPTION_KEY = os.getenv("JIRA_ENCRYPTION_KEY").encode()
cipher = Fernet(ENCRYPTION_KEY)

def pytest_configure(config):
    jira_config = JiraConfig.from_file(os.path.expanduser("~/jira.cfg"))
    
    # 解密用户名
    if hasattr(jira_config, 'encrypted_username') and jira_config.encrypted_username:
        jira_config.username = cipher.decrypt(jira_config.encrypted_username.encode()).decode()
    # 解密密码
    if hasattr(jira_config, 'encrypted_password') and jira_config.encrypted_password:
        jira_config.password = cipher.decrypt(jira_config.encrypted_password.encode()).decode()
    
    config._jira_config = jira_config

这个方案适合需要长期保存配置但又要保证安全的场景，但密钥的管理需要额外注意。

内容的提问来源于stack exchange，提问作者npatel