詳解在Go語言單元測試中如何解決文件依賴問題
現(xiàn)如今的 Web 應用程序往往采用 RESTful API 接口形式對外提供服務，后端接口直接向前端返回 HTML 文件的情況越來越少，所以在程序中操作文件的場景也變少了。不過有些時候還是需要對文件進行操作，比如某個 API 接口需要返回應用程序的 ChangeLog，那么這個接口就可以通過讀取項目的 CHANGELOG.md 文件內(nèi)容，將其發(fā)送給前端。
在編寫單元測試時，文件就成了被測試代碼的外部依賴，本文就來講解下測試過程中如何解決文件外部依賴問題。
獲取 ChangeLog 程序示例
假設我們有一個函數(shù)，可以讀取項目的 ChangeLog 信息并返回。
程序代碼實現(xiàn)如下：
package main
import (
"io"
"os"
)
var (
version = "dev"
commit = "none"
builtGoVersion = "unknown"
changeLogPath = "CHANGELOG.md"
)
type ChangeLogSpec struct {
Version string
Commit string
BuiltGoVersion string
ChangeLog string
}
func GetChangeLog() (ChangeLogSpec, error) {
data, err := os.ReadFile(changeLogPath)
if err != nil {
return ChangeLogSpec{}, err
}
return ChangeLogSpec{
Version: version,
Commit: commit,
BuiltGoVersion: builtGoVersion,
ChangeLog: string(data),
}, nil
}GetChangeLog 函數(shù)實現(xiàn)比較簡單，首先從 changeLogPath 文件路徑中讀取 ChangeLog 內(nèi)容，然后結合程序版本號、COMMIT 信息、Go 版本號一起組裝成 ChangeLogSpec 結構體，并返回。
使用臨時文件測試
現(xiàn)在，我們要對 GetChangeLog 函數(shù)進行單元測試。
可以發(fā)現(xiàn)，GetChangeLog 函數(shù)內(nèi)部依賴了 changeLogPath 文件路徑，然后從中讀取內(nèi)容。所以，在編寫測試時，我們要考慮 changeLogPath 文件如何指定。
我們最先想到的就是指定 changeLogPath 文件的真實路徑。但是，這可能會存在問題，比如本地環(huán)境和 CI 環(huán)境下 changeLogPath 文件路徑不同，那么在編寫測試代碼時，就要考慮根據(jù)不同的測試環(huán)境執(zhí)行不同邏輯。所以，這種方式不應該成為首選方案。
不過，我們可以換種思路，Go 語言提供了 os.CreateTemp 方法，可以創(chuàng)建一個臨時文件。那么，我們就可以考慮在測試函數(shù)開始時創(chuàng)建一個臨時文件來保存 ChangeLog，然后為 changeLogPath 變量賦值為臨時文件路徑，測試代碼執(zhí)行完成后刪除臨時文件，這樣就能夠解決單元測試中依賴外部文件的問題。
按照這個思路，編寫的單元測試代碼如下：
func TestGetChangeLog(t *testing.T) {
// 創(chuàng)建臨時文件
// 第一個參數(shù)傳 ""，表示在操作系統(tǒng)的臨時目錄下創(chuàng)建該文件
// 文件文件名會以第二個參數(shù)作為前綴，剩余的部分會自動生成，以確保并發(fā)調(diào)用時生成的文件名不重復
f, err := os.CreateTemp("", "TEST_CHANGELOG")
assert.NoError(t, err)
defer func() {
_ = f.Close()
// 盡管操作系統(tǒng)會在某個時間自動清理臨時文件，但主動清理是創(chuàng)建者的責任
_ = os.RemoveAll(f.Name())
}()
changeLogPath = f.Name()
data := `
# Changelog
All notable changes to this project will be documented in this file.
`
_, err = f.WriteString(data)
assert.NoError(t, err)
expected := ChangeLogSpec{
Version: "v0.1.1",
Commit: "1",
BuiltGoVersion: "1.20.1",
ChangeLog: `
# Changelog
All notable changes to this project will be documented in this file.
`,
}
actual, err := GetChangeLog()
assert.NoError(t, err)
assert.Equal(t, expected, actual)
}我們首先通過 os.CreateTemp("", "TEST_CHANGELOG") 創(chuàng)建了一個臨時文件，然后將 data 內(nèi)容寫入臨時文件作為 ChangeLog，再然后將臨時文件名稱 f.Name() 賦值給 changeLogPath，之后就可以調(diào)用 GetChangeLog 函數(shù)進行測試了。
對于程序版本號、COMMIT 信息、Go 版本號這幾個變量，因為都是全局變量，所以也屬于外部依賴。
對于全局變量的依賴，我們可以在 init 函數(shù)中對其進行初始化，這樣就相當于在測試環(huán)境中固定了這幾個變量的值，便于測試。
func init() {
version = "v0.1.1"
commit = "1"
builtGoVersion = "1.20.1"
}筆記：你也可以在 TestMain 函數(shù)中對其進行初始化。
使用 go test 來執(zhí)行測試函數(shù)：
$ go test -v -run="TestGetChangeLog$" === RUN TestGetChangeLog --- PASS: TestGetChangeLog (0.00s) PASS ok github.com/jianghushinian/blog-go-example/test/file 0.562s
測試通過。
使用 Go embed 測試
以上我們介紹了使用臨時文件的方式來解決被測試函數(shù)依賴外部文件的問題。
不過我們在測試中提供的 ChangeLog 內(nèi)容不多：
data := ` # Changelog All notable changes to this project will be documented in this file. `
為了讓單元測試更加可靠，你也許想測試 ChangeLog 內(nèi)容比較多的情況下，GetChangeLog 函數(shù)能否正常工作。
我們可以編寫一個真實的 CHANGELOG.md 文件，存放于 testdata/CHANGELOG.md 路徑下：
# Kubernetes v0.1.1 ## 主要特性和改進 - 添加了一些新的主要特性和改進。 ## 重要變更 - 這里列出了對現(xiàn)有功能的重要變更。 ## API 變更 - 在 API 中進行的重要變更和更新。 ## 已知問題 - 列出了已知的問題和限制。 ## Bug 修復 - 修復了以下已知 Bug。 ## 改進和優(yōu)化 - 對現(xiàn)有功能進行了改進和優(yōu)化。 ## 安全性更新 - 列出了安全性方面的更新和修復。 ## 已棄用功能 - 列出了已被棄用的功能。 ## 警告和提醒 - 列出了需要注意的警告和提醒事項。 ## 社區(qū)貢獻者 - 致謝并列出了為此版本做出貢獻的社區(qū)成員。 更詳細的信息可以查閱 Kubernetes 官方文檔和發(fā)布說明。
此時，我們可以使用 Go 提供的 embed 技術來將文件內(nèi)容嵌入到 Go 變量中。
embed []byte
embed 可以實現(xiàn)在 Go 程序編譯時，直接將文件內(nèi)容嵌入到 Go 變量。embed 目前支持嵌入兩種基礎類型的變量，分別是 []byte 和 strings。嵌入這兩種類型變量方式相同，本小節(jié)就像大家演示下如何通過將文件嵌入 []byte 變量的方式來編寫 GetChangeLog 函數(shù)的單元測試。
為 GetChangeLog 函數(shù)編寫的單元測試代碼如下：
package main
import (
_ "embed"
"os"
"testing"
"github.com/stretchr/testify/assert"
)
//go:embed testdata/CHANGELOG.md
var changelog []byte
func TestGetChangeLog_by_embed(t *testing.T) {
f, err := os.CreateTemp("", "TEST_CHANGELOG")
assert.NoError(t, err)
defer func() {
_ = f.Close()
_ = os.RemoveAll(f.Name())
}()
changeLogPath = f.Name()
_, err = f.Write(changelog)
assert.NoError(t, err)
expected := ChangeLogSpec{
Version: "v0.1.1",
Commit: "1",
BuiltGoVersion: "1.20.1",
ChangeLog: string(changelog),
}
actual, err := GetChangeLog()
assert.NoError(t, err)
assert.Equal(t, expected, actual)
}單元測試中，我們最需要關注的是這行代碼：
//go:embed testdata/CHANGELOG.md var changelog []byte
//go:embed 是一個指令注釋，用來標記嵌入指令，注意冒號 : 前后沒有空格，testdata/CHANGELOG.md 指明要嵌入的文件。
在嵌入指令下方，緊挨著我們定義了變量 var changelog []byte 用來接收被嵌入文件的內(nèi)容。
程序編譯后，變量 changelog 的值就是 testdata/CHANGELOG.md 文件中的內(nèi)容了。
注意，文件開頭的 import 中要導入 embed，嵌入指令才可以使用。
之后的單元測試代碼改動就比較小了，僅用 changelog 變量替換了原來代碼中的 data 變量。
使用 go test 來執(zhí)行測試函數(shù)：
$ go test -v -run="TestGetChangeLog_by_embed" === RUN TestGetChangeLog_by_embed --- PASS: TestGetChangeLog_by_embed (0.00s) PASS ok github.com/jianghushinian/blog-go-example/test/file 0.365s
單元測試仍能通過。
embed fs.FS
Go embed 技術不僅能夠嵌入文件到基礎類型變量，還能直接將文件嵌入為一個文件系統(tǒng)。
為了演示這一強大的功能，我們修改下 GetChangeLog 函數(shù)代碼，讓其接收一個 io.Reader 類型的參數(shù)，然后從這個參數(shù)中讀取 ChangeLog 內(nèi)容，而不再是通過讀取指定路徑下的 ChangeLog 內(nèi)容。
修改后程序代碼如下：
func GetChangeLogByIOReader(reader io.Reader) (ChangeLogSpec, error) {
data, err := io.ReadAll(reader)
if err != nil {
return ChangeLogSpec{}, err
}
return ChangeLogSpec{
Version: version,
Commit: commit,
BuiltGoVersion: builtGoVersion,
ChangeLog: string(data),
}, nil
}如下是為新的 GetChangeLogByIOReader 函數(shù)編寫的單元測試代碼：
//go:embed testdata/CHANGELOG.md
var fs embed.FS
func TestGetChangeLogByIOReader(t *testing.T) {
f, err := fs.Open("testdata/CHANGELOG.md")
assert.NoError(t, err)
data, err := io.ReadAll(f)
assert.NoError(t, err)
// 將數(shù)據(jù)的讀取位置重置到開頭
_, err = f.(io.ReadSeeker).Seek(0, 0)
assert.NoError(t, err)
expected := ChangeLogSpec{
Version: "v0.1.1",
Commit: "1",
BuiltGoVersion: "1.20.1",
ChangeLog: string(data),
}
actual, err := GetChangeLogByIOReader(f)
assert.NoError(t, err)
assert.Equal(t, expected, actual)
}我們同樣使用 //go:embed testdata/CHANGELOG.md 來指定嵌入的文件，不過，這次定義的變量 var fs embed.FS 是一個文件系統(tǒng)，里面包含了被嵌入的文件。
在測試代碼中，使用 fs.Open("testdata/CHANGELOG.md") 打開文件內(nèi)容，得到 fs.File 類型對象，之后就可以像其他 Go 文件對象一樣操作它。
使用 go test 來執(zhí)行測試函數(shù)：
$ go test -v -run="TestGetChangeLogByIOReader" === RUN TestGetChangeLogByIOReader --- PASS: TestGetChangeLogByIOReader (0.00s) PASS ok github.com/jianghushinian/blog-go-example/test/file 0.135s
測試通過。
總結
本文向大家介紹了在 Go 中編寫單元測試時，如何解決文件外部依賴的問題。
Go 語言提供了 os.CreateTemp 方法，可以創(chuàng)建一個臨時文件，我們可以利用這個方法來解決文件外部依賴。
此外，Go 語言還提供了 embed 技術，能夠在程序編譯時直接將文件內(nèi)容嵌入到 Go 變量中。這項技術雖然不是為單元測試而生的，但我們可以借此來解決文件外部依賴問題。本文為大家演示了如何將文件嵌入到 []byte 和文件系統(tǒng)，兩種方案用法差異不大，可以根據(jù)需求和喜好進行選擇。
本文完整代碼示例我放在了 GitHub 上，歡迎點擊查看。
希望此文能對你有所幫助。
以上就是詳解在Go語言單元測試中如何解決文件依賴問題的詳細內(nèi)容，更多關于Go單元測試解決文件依賴的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要為大家介紹了Go語言基礎單元測試與性能測試示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助祝大家多多進步2021-11-11
這篇文章介紹了Go語言包管理工具Godep的用法，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-07-07
本文介紹了在基于gin框架開發(fā)的項目中如何配置并使用zap來接收并記錄gin框架默認的日志和如何配置日志歸檔。有需要的朋友可以借鑒參考下，希望能夠有所幫助2022-04-04
本文主要介紹了Go實現(xiàn)set類型的示例代碼，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-01-01
剛開始接觸go就遇到了一個內(nèi)存問題,在進行內(nèi)存分析的時候發(fā)現(xiàn)了一下比較好的工具,在此留下記錄,下面這篇文章主要給大家介紹了關于go性能分析工具pprof的性能測試,需要的朋友可以參考下2023-04-04
這篇文章主要為大家詳細介紹了GO語言原生實現(xiàn)文件上傳功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-07-07
for循環(huán)問題，在面試中經(jīng)常都會被問到，并且在實際業(yè)務項目中也經(jīng)常用到for循環(huán)，要是沒用好，一不下心就掉坑，本文就來講講Go?for?range中容易踩的坑吧2023-03-03
Go?并發(fā)編程協(xié)程及調(diào)度機制詳情
這篇文章主要介紹了Go并發(fā)編程協(xié)程及調(diào)度機制詳情，協(xié)程是Go語言最大的特色之一，goroutine的實現(xiàn)其實是通過協(xié)程，更多相關內(nèi)容需要的朋友可以參考一下2022-09-09
這篇文章主要為大家介紹了Golang?中反射的應用實例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-08-08
Viper是一個輕量級的、易于使用的配置工具庫,它允許你在Go應用中方便地管理配置,Viper支持從多種來源讀取配置,如環(huán)境變量、命令行參數(shù)、文件、甚至是加密的數(shù)據(jù)存儲,本文給大家介紹了golang使用viper解析配置文件,需要的朋友可以參考下2024-08-08