Bruno CLI 如何同時(shí)輸出 JSON、JUnit 與 HTML 測試報(bào)告并用 --reporter-skip-headers 控制報(bào)告頭【免費(fèi)下載鏈接】brunoOpensource IDE For Exploring and Testing APIs (lightweight alternative to Postman/Insomnia)項(xiàng)目地址: https://gitcode.com/GitHub_Trending/br/bruno在 CI 或本地跑 Bruno API 集合時(shí)常見的需求是同一次bru run既要產(chǎn)出機(jī)器可解析的 JSON 報(bào)告又要給 CI 流水線如 Jenkins、GitLab CI提供 JUnit XML還要一份 HTML 報(bào)告供團(tuán)隊(duì)在瀏覽器里查看同時(shí)報(bào)告里不能留下Authorization這類敏感請求頭。Bruno CLI 的run命令支持在同一次執(zhí)行中通過--reporter-json、--reporter-junit、--reporter-html三個(gè)選項(xiàng)各寫一個(gè)報(bào)告文件并用--reporter-skip-headers指定要從報(bào)告輸出中剔除的報(bào)頭無需跑多次。準(zhǔn)備條件全局安裝 Bruno CLI使用任意 Node 包管理器以 NPM 為例npm install -g usebruno/cli進(jìn)入 API 集合所在目錄再執(zhí)行bru run。Bruno CLI 的退出狀態(tài)碼文檔中明確列出了4 -- bru was called outside of a collection root directory即命令必須在集合根目錄下調(diào)用否則直接報(bào)錯(cuò)退出。一次運(yùn)行同時(shí)輸出三種格式的報(bào)告bru run為每種報(bào)告格式提供了獨(dú)立選項(xiàng)三者可以在同一條命令中疊加使用選項(xiàng)作用--reporter-json string指定生成 JSON 報(bào)告的路徑--reporter-junit string指定生成 JUnit 報(bào)告的路徑--reporter-html string指定生成 HTML 報(bào)告的路徑執(zhí)行示例在當(dāng)前集合根目錄下運(yùn)行遞歸處理時(shí)加-rbru run folder -r \ --reporter-json reports/report.json \ --reporter-junit reports/report.xml \ --reporter-html reports/report.htmlrun命令的內(nèi)部實(shí)現(xiàn)run.js 中formats的收集邏輯會把每個(gè)有值的 reporter 選項(xiàng)登記為一個(gè)格式運(yùn)行結(jié)束后統(tǒng)一寫出各報(bào)告文件因此三個(gè)選項(xiàng)互不沖突指向的路徑建議先創(chuàng)建好所在目錄——退出碼2表示 the specified output directory does not exist。如果只需要單一格式文檔給出的替代路徑是--output配合--format可用格式為json默認(rèn)或junitbru run request.bru --output results.json bru run request.bru --output results.xml --format junit注意--output只能寫一個(gè)文件與--reporter-*系列定位不同多格式需求用--reporter-*疊加即可。用 --reporter-skip-headers 控制報(bào)告中的請求頭--reporter-skip-headers是一個(gè)數(shù)組類型選項(xiàng)可重復(fù)傳入每個(gè)值表示要從報(bào)告輸出中跳過的一個(gè)報(bào)頭名bru run --reporter-skip-headers Authorization其處理邏輯在 sanitize-results.js對每個(gè)結(jié)果分別遍歷result.request.headers與result.response.headers按大小寫不敏感的方式匹配并刪除命中的報(bào)頭所以--reporter-skip-headers authorization與Authorization效果一致。幾個(gè)關(guān)鍵邊界該選項(xiàng)只影響報(bào)告輸出run.js 中的描述是 Skip specific headers from the reporter output請求本身仍會照常攜帶并發(fā)送這些報(bào)頭不會改變線上行為如果不想在報(bào)告中保留任何報(bào)頭直接用布爾選項(xiàng)--reporter-skip-all-headersOmit headers from the reporter output它會把請求和響應(yīng)頭整體置空同類還有--reporter-skip-request-body、--reporter-skip-response-body和同時(shí)省略兩者的--reporter-skip-body與報(bào)頭過濾可自由組合。組合完整場景的命令如下bru run folder -r \ --env Local \ --reporter-json reports/report.json \ --reporter-junit reports/report.xml \ --reporter-html reports/report.html \ --reporter-skip-headers Authorization \ --reporter-skip-headers Set-Cookie說明--env Local為可選分支僅當(dāng)集合需要指定環(huán)境時(shí)使用--reporter-skip-headers重復(fù)書寫一次即跳過一個(gè)報(bào)頭。驗(yàn)證結(jié)果退出碼0表示執(zhí)行成功1表示集合中存在失敗的請求、測試或斷言完整退出碼表見 readme.md 的 Scripting 一節(jié)。CI 中可用退出碼判斷本次集合是否全部通過。報(bào)告文件確認(rèn)reports/report.json、reports/report.xml、reports/report.html三個(gè)文件按指定路徑生成。JSON 報(bào)告的內(nèi)容是一個(gè)包含summarytotalRequests、passedRequests、failedRequests、totalAssertions 等統(tǒng)計(jì)字段與results每個(gè)請求的明細(xì)的對象結(jié)構(gòu)可在瀏覽器或jq中直接查看。報(bào)頭是否被剔除檢查 JSON 報(bào)告中對應(yīng)請求的request.headers與response.headers其中不應(yīng)再出現(xiàn)Authorization、Set-Cookie字段其余報(bào)頭保留。JUnit 報(bào)告中的用例結(jié)構(gòu)testsuite/testcase、name、status、failure 節(jié)點(diǎn)可參考 junit.spec.js 中的斷言HTML 報(bào)告則在瀏覽器中打開確認(rèn)請求頭展示區(qū)域已不包含被跳過的項(xiàng)。限制與注意事項(xiàng)報(bào)告路徑所在目錄必須已存在退出碼2--output使用--format傳入了不支持的格式時(shí)退出碼為9。--reporter-skip-headers只做報(bào)告層面的過濾被跳過的報(bào)頭仍會隨真實(shí)請求發(fā)送如果目標(biāo)是減少網(wǎng)絡(luò)上傳輸?shù)膱?bào)頭該選項(xiàng)不解決該問題?？蛇x配合項(xiàng)--tests-only只跑帶測試/斷言的請求--bail在首個(gè)失敗后停止執(zhí)行兩者都會改變最終報(bào)告內(nèi)容按需使用。更完整的選項(xiàng)說明見 packages/bruno-cli/readme.md 的 Command Line Options 表格以及run命令實(shí)現(xiàn) packages/bruno-cli/src/commands/run.js。【免費(fèi)下載鏈接】brunoOpensource IDE For Exploring and Testing APIs (lightweight alternative to Postman/Insomnia)項(xiàng)目地址: https://gitcode.com/GitHub_Trending/br/bruno創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考