How to refer to environment variables in Cypress config files?

在 Cypress 中引用环境变量的方式主要有两种：通过配置文件直接引用和在命令行中设置。以下是详细步骤和示例：

1. 通过配置文件引用环境变量

Cypress 允许在其配置文件 cypress.json 中直接引用环境变量。这可以通过使用 env 键来实现。

示例 cypress.json:

json
{
  "env": {
    "login_url": "${LOGIN_URL}",
    "api_key": "${API_KEY}"
  }
}

在上面的例子中，${LOGIN_URL} 和 ${API_KEY} 是在环境中设置的变量。Cypress 会在运行测试时解析这些变量的值。

2. 在命令行中设置环境变量

您也可以在命令行中使用 --env 标志来传递环境变量，这在临时设置或 CI/CD 环境中非常有用。

命令行示例:

bash
cypress run --env HOST_URL=http://example.com,API_KEY=12345

这样做将在运行测试时将这些环境变量传递给 Cypress，而无需在配置文件中硬编码它们。

使用环境变量的好处

使用环境变量的主要好处是保持敏感信息的安全和配置的灵活性。例如，你可以在开发环境和生产环境之间切换不同的 API 密钥和服务端点，而无需更改代码。只需在不同的环境中设置相应的变量即可。

最佳实践

• 保密性：确保不在版本控制系统中暴露敏感的环境变量。
• 文档化：为使用的环境变量提供清晰的文档，以便团队成员了解每个变量的用途。
• 默认值：在代码中为环境变量提供默认值，以确保在环境变量未正确设置时应用程序的正常运行。

通过以上方式，你可以在 Cypress 中有效地管理和使用环境变量，以提高测试的灵活性和安全性。