Cypress系列（14）- 環境變數詳解

• 2020 年 6 月 8 日
• 筆記
• Cypress, 測試高級進階技能系列 - Cypress

如果想從頭學起Cypress，可以看下面的系列文章哦

//www.cnblogs.com/poloyy/category/1768839.html

前言

• 環境變數，其實就是根據環境的變化，變數會有不同的值
• 比如最常見的：開發環境、測試環境、生產環境的 URL 肯定不一樣，我們可以根據不同的環境選擇不同的環境變數
• 這就是為什麼我們要學習環境變數的原因

環境變數在以下情況會很有用

• 不同開發人員，對應的值也可能不同
• 不同環境下的值是不同的，入：dev、test、prod
• 某些值會頻繁變化，而且高度動態
• 環境變數很容易會更改，尤其是在持續集成（CI）中運行時

栗子

不要在測試中進行硬編碼（寫死，常量），需要改的時候需要動程式碼，比如：

cy.request('//api.acme.corp') // 這將在其他環境中無法使

使用環境變數後

cy.request(Cypress.env('EXTERNAL_API')) // 指向動態環境變數

當不同環境運行時，如果需要訪問不同的 URL 我們只需要改環境變數即可了，而不用動到程式碼

baseUrl

• 前面我們說到可以通過環境變數設置測試套件訪問的 URL，這是其中一種方式
• 而 Cypress 早就替我們想好了如何解決這問題，可以通過配置 baseUrl 來取代環境變數的方式
• 當你配置了 baseUrl ，測試套件中的 cy.visit() 、 cy.request() 都會自動以 baseUrl 的值作為前綴
• 並且，當你需要訪問某些網址或者發起介面請求時，在程式碼中就可以不用再指定請求的 host 或者 url 了

如何配置 baseUrl

• 細心的小夥伴已經知道，前面我講 Cypress 全局配置項的時候已經提到過 baseUrl 了
• 只需要在 cypress.json 文件進行配置就可以啦，如下

程式碼中調用

cy.visit("")

// 錯誤寫法  cy.visit()

記住調用 visit 或 request 時，再怎麼樣也要傳個空字元串 “” ，不能啥都不填哦

通過環境變數來覆蓋 baseUrl

即使配置了 baseUrl ，我們也可以通過環境變數來覆蓋它

CYPRESS_baseUrl=https://staging.app.com cypress run

設置環境變數

一共有五種方式

1. 在 cypress.json 文件中設置
2. 創建一個 cypress.env.json 文件
3. 導出為 CYPRESS_* 
4. 在 CLI 中傳遞為 –env （命令行運行中添加）
5. 在插件中設置一個環境變數

—————————–>>>>>>>>>>>>>>>>>>> 點擊右側目錄即可跳轉

最常見的做法

• 使用一種策略進行本地開發，但在 CI（持續集成）中運行時使用另一種策略
• 在測試運行時，可以使用 Cypress.env() 訪問環境變數的值

cypress.json 中設置

在 cypress.json 的 env 鍵下設置的任何 key:value 都是環境變數

cypress.json 程式碼

測試文件程式碼

// 列印所有環境變數
Cypress.env()

// 列印某個環境變數的值
Cypress.env("foor")

測試結果

優缺點

創建 cypress.env.json 文件

該文件的描述

• 可以創建自己的 cypress.env.json 文件，Cypress 將會自動檢查它
• 並且裡面的值會覆蓋 cypress.json 中重名的環境變數
• 它創建在 cypress.json 同級目錄下

用這個文件有啥用

如果將cypress.env.json 添加到.gitgnore文件中，那麼文件中的值對於每個開發人員的電腦都是不同的

cypress.env.json 文件程式碼

測試文件程式碼

測試結果

在 cypress.json 中也有一個 key 的環境變數，所以在 cypress.env.json 的 key 的值覆蓋了它的值

優缺點

CYPRESS_*

重點！

• 電腦中任何以 CYPRESS_ 或 cypress_ 開頭的環境變數都會自動被 Cypress 識別出來
• 會直接覆蓋 cypress.json 和 cypress.env.json 文件中重名的環境變數
• Cypress在添加環境變數時，會自動去掉 CYPRESS_ 前綴

在系統添加環境變數

總結

• 我測試過發現並沒有生效，也不知道為啥，需要後面再研究研究
• 其實並不推薦這種寫法，當環境變數無效時，再改起來就很麻煩了

–env

重點！

• 可以通過命令行將環境變數作為命令行參數傳進來
• 它的優先順序最高，會覆蓋其他地方設置的重名環境變數 
• 可以為 cypress open 或 cypress run 添加 –env 參數

cmd 命令

在 Cypress 安裝目錄下，cmd敲

yarn cypress:open --env host=poloyy.com,key=命令行參數環境變數

或

yarn cypress:run --env host=poloyy.com,key=命令行參數環境變數

測試文件程式碼

測試結果

優缺點