如何在命令行中转义管道符|传递给Cypress环境变量

核心原因 #

Cypress的--env参数默认会把逗号和管道符|当成多环境变量的分隔符，同时Windows命令行本身会解析管道符，导致传递的字符串被篡改。以下是几种可行的解决方案：

方案1：使用系统环境变量替代--env参数 #

绕过Cypress对--env的解析逻辑，直接通过系统环境变量传递，再让Cypress读取：

1. 本地Windows命令行

   set JIRA_PASS="my pass|word" && npx cypress run --spec .\cypress\e2e\tests\temp.cy.ts
   

2. 本地Linux/macOS命令行

   export JIRA_PASS="my pass|word" && npx cypress run --spec ./cypress/e2e/tests/temp.cy.ts
   

3. Docker环境
   通过-e参数传递系统环境变量给容器：

   docker run -e JIRA_PASS="my pass|word" cypress/included:latest npx cypress run --spec ./cypress/e2e/tests/temp.cy.ts
   

4. Cypress配置
   在cypress.config.js中配置读取系统环境变量：

   import { defineConfig } from 'cypress'
   
   export default defineConfig({
     env: {
       JIRA_PASS: process.env.JIRA_PASS
     }
   })
   

   之后直接用Cypress.env('JIRA_PASS')即可获取正确值。

方案2：用JSON格式传递--env参数 #

Cypress支持通过JSON字符串传递环境变量，特殊字符不会被解析成分隔符：

1. Windows CMD
   需转义双引号：

   npx cypress run --spec .\cypress\e2e\tests\temp.cy.ts --env "{\"JIRA_PASS\":\"my pass|word\"}"
   

2. Linux/macOS 或 Git Bash
   用单引号包裹JSON：

   npx cypress run --spec ./cypress/e2e/tests/temp.cy.ts --env '{"JIRA_PASS":"my pass|word"}'
   

3. Docker环境
   确保JSON字符串被正确传递给容器内的Cypress：

   docker run cypress/included:latest npx cypress run --spec ./cypress/e2e/tests/temp.cy.ts --env '{"JIRA_PASS":"my pass|word"}'
   

方案3：Jenkins + Docker场景优化 #

如果用Jenkins管理凭证，推荐通过Jenkins环境变量注入后传递给Docker：

1. Jenkins Pipeline示例

   pipeline {
       agent any
       environment {
           // 从Jenkins凭证库读取密码
           JIRA_PASS = credentials('jira-service-account-password')
       }
       stages {
           stage('Execute Cypress Tests') {
               steps {
                   sh '''
                       docker run -e JIRA_PASS="$JIRA_PASS" \\
                           cypress/included:latest \\
                           npx cypress run --spec ./cypress/e2e/tests/temp.cy.ts
                   '''
               }
           }
       }
   }
   

2. 优势
   • 避免在命令行明文暴露密码
   • 自动处理特殊字符，无需手动转义

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