Cypress 之 環境配置

 

將項目添加到cypress時，cypress.json會在項目中創建一個文件，此文件用於存儲projectId，以及你提供的任何配置項。

 

{
  "projectId": "81jpyj"
}

 

可以通過以下提供的任何配置選項來修改賽普拉斯的默認行為。 

全局配置項

選項	默認	描述
baseUrl	null	用作命令cy.visit()或cy.request()的前綴URL。
env	{}	設置任意環境變量。
ignoreTestFiles	*.hot-update.js	用於忽略測試文件的字符串或數組的glob模式，否則這些測試文件將顯示在測試列表中。
numTestsKeptInMemory	50	快照和命令數據保存在內存中的測試數。
port	null	用於托管賽普拉斯的端口。
reporter	spec	該reporter中使用cypress run。
reporterOptions	null	使用的reporter選項，支持的選項取決於reporter。
testFiles	**/*.*	要加載的測試文件的String glob模式。
watchForFileChanges	true	賽普拉斯是否檢測並重新執行修改的測試文件。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

超時配置項

選項	默認	描述
defaultCommandTimeout	4000	基於默認DOM命令的超時時間（以毫秒為單位）
execTimeout	60000	基於cy.exec()命令的超時時間（以毫秒為單位）
taskTimeout	60000	基於cy.task()命令的超時時間（以毫秒為單位）
pageLoadTimeout	60000	等待頁面加載完成的超時時間（以毫秒為單位）。包括命令：cy.visit()，cy.go()，cy.reload()
requestTimeout	5000	等待請求完成的超時時間（以毫秒為單位）。包括命令：cy.wait()
responseTimeout	30000	等待響應完成的超時時間（以毫秒為單位）。包括命令： cy.request()，cy.wait()，cy.fixture()，cy.screenshot()， cy.getCookie()，cy.getCookies()，cy.setCookie()，cy.clearCookie()，cy.clearCookies()

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

文件路徑配置項

選項	默認	描述
fileServerFolder	cypress	根項目文件夾
fixturesFolder	cypress/fixtures	包含集成測試配置文件的路徑（通過false禁用）
integrationFolder	cypress/integration	包含集成測試文件的路徑
pluginsFile	cypress/plugins/index.js	插件文件的路徑（通過false禁用）
screenshotsFolder	cypress/screenshots	截圖文件的路徑，包含cy.screenshot()命令 和 cypress run測試失敗期間保存的屏幕截圖。
supportFile	cypress/support/index.js	在加載測試文件之前加載文件的路徑（通過false禁用）
videosFolder	cypress/videos	視頻文件的路徑，用於保存cypress run運行期間的視頻。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

截圖配置項

選項	默認	描述
screenshotsFolder	cypress/screenshots	截圖文件存放路徑，包含cy.screenshot()命令 和 cypress run測試失敗期間保存的屏幕截圖
trashAssetsBeforeRuns	true	在通過cypress run運行測試之前，賽普拉斯是否會清除creenshotsFolder和videosFolder。

 

 

 

 

 

 

 

 

錄制配置項

選項	默認	描述
trashAssetsBeforeRuns	true	在通過cypress run運行測試之前，賽普拉斯是否會清除creenshotsFolder和videosFolder。
videoCompression	32	視頻壓縮的質量設置。禁用壓縮或0到51之間的值可以為false，值越低質量越好。
videosFolder	cypress/videos	視頻文件的路徑，用於保存cypress run運行期間的視頻。
video	true	賽普拉斯是否捕捉通過cypress run運行測試的視頻。
videoUploadOnPasses	true	當spec文件中的所有測試都通過，賽普拉斯是否會處理、壓縮和上傳視頻到Dashboard。

 

 

 

 

 

 

 

 

 

瀏覽器配置項

選項	默認	描述
chromeWebSecurity	true	是否啟用Chrome網頁安全性中same-origin policy和insecure mixed content。
userAgent	null	瀏覽器在所有請求標頭中發送的默認用戶代理。
blacklistHosts	null	要阻止流量的字符串或主機陣列。
modifyObstructiveCode	true	賽普拉斯是否會在.js或.html文件中搜索和替換阻塞的JS代碼。

 

 

 

 

 

 

 

視窗配置項

選項	默認	描述
viewportHeight	660	測試視窗下應用程序的默認高度（以像素為單位，使用cy.viewport()命令覆蓋）。
viewportWidth	1000	測試視窗下應用程序的默認寬度（以像素為單位，使用cy.viewport()命令覆蓋）。

 

 

 

 

 

動畫配置項

選項	默認	描述
animationDistanceThreshold	5	元素必須超過的指定像素距離才能被視為動畫
waitForAnimations	true	是否在執行命令之前等待元素完成動畫

 

 

 

 

 

命令行設置

當從命令行運行賽普拉斯時你可以傳遞一個 --config標志。

cypress open --config watchForFileChanges=false,waitForAnimations=false
cypress run --config integrationFolder=tests,fixturesFolder=false
cypress run --record --config viewportWidth=1280,viewportHeight=720

 

 

環境變量設置

您還可以使用環境變量來覆蓋配置值。

這使您能夠在不修改任何代碼或構建腳本的情況下更改配置選項。默認情況下，與相應配置鍵匹配的任何環境變量都將覆蓋該cypress.json值。

我們自動規范化鍵和值，賽普拉斯將剝去CYPRESS_。確保為環境變量添加前綴CYPRESS_，否則將被忽略。且區分大小寫。

export CYPRESS_VIEWPORT_WIDTH=800
export CYPRESS_VIEWPORT_HEIGHT=600

 

 

初始配置：

 

 

 

Reference：https://docs.cypress.io/zh-cn/guides/references/configuration.html#blacklistHosts