前一篇博客講到了如何編譯本地的Fabric Code成鏡像文件,那么如果我們想改Fabric源代碼,實現一些Fabric官方并沒有提供的功能,該怎么辦呢?這時我們除了改源碼,增加需要的功能外,還需要能夠跑通Fabric的測試。Fabric的測試主要包括單元測試和行為測試,下面分別介紹。
一、單元測試
單元測試是通過testenv這個鏡像來完成的,而這個鏡像的容器在啟動后實際執行的就是unit-test文件夾下面的run.sh腳本。我們使用make unit-test命令即可對整個Fabric的所有單元測試進行運行。
1.單元測試
因為Fabric是用Go寫的,所以Fabric的單元測試也是用Go的單元測試命令來完成,也就是go test命令。在Fabric的源代碼中,我們看到的所有*_test.go這些就是單元測試的代碼。這些代碼在正式編譯的時候是會被自動忽略的,只有在go test命令的時候才會去運行。
以bccsp為例,這是提供密碼學相關方法的接口文件,在bccsp文件夾下的bccsp.go文件,而他的單元測試文件自然就是bccsp_test.go文件。在該單元測試文件中,以Test開頭的函數,就是具體的測試用例。我們要跑具體的某一個測試用例,比如其中的TestKeyGenOpts,那么我們的可以使用命令:
go.exe test github.com\hyperledger\fabric\bccsp -run ^TestKeyGenOpts$
這里我們可以看到-run后面跟的是一個正則表達式,我們可以寫其他正則表達式來表示一批方法。當然我們也可以不加^$,直接寫方法名。
如果我們不指定具體的測試用例,而只指定包,那么就是測試整個包下面的所有用例。
go test -v -timeout 30s github.com\hyperledger\fabric\bccsp
這里我加了2個參數,這兩個參數都是在go test的時候很常用的,-v是輸出詳細信息。-timeout是設置跑完整個測試的時間限制,如果里面有死循環之類的就會超時而退出。
如果我們要測試不是某個包,而是整個文件夾下面的所有包,那么我們可以使用“…”來表示。比如:
go test -v -timeout 60s github.com\hyperledger\fabric\bccsp\…
2.性能測試
go test除了提供單元測試外,還有性能測試的功能。前面說到_test.go文件里面Test開頭的是單元測試的測試用例入口函數,而性能測試則是以Benchmark開頭。
Fabric本身并沒有寫什么性能測試的代碼,但是我們可以從vendor代碼中找到例子。比如:
github.com\hyperledger\fabric\vendor\github.com\docker\docker\pkg\stdcopy
這里有個BenchmarkWrite函數,用于測試NewStdWriter.Write的性能,我們使用go test命令帶上-bench參數就可以執行性能測試。性能測試不僅僅關心執行的時間,也關系內存的分配情況。再加上-benchmem參數,可以查看內存性能測試結果。
go test -benchmem github.com\hyperledger\fabric\vendor\github.com\docker\docker\pkg\stdcopy -bench ^BenchmarkWrite$
以下是我在本機執行的結果:
BenchmarkWrite-4 5000000 283 ns/op 15507.52 MB/s 0 B/op 0 allocs/op PASS ok github.com/hyperledger/fabric/vendor/github.com/docker/docker/pkg/stdcopy 2.406s Success: Benchmarks passed.
3.代碼覆蓋率
代碼覆蓋率是度量測試自身完整和有消息的一種手段。通過覆蓋率值,我們可以分析測試代碼的編寫質量。
在go test命令后跟上-cover參數,就可以提供代碼覆蓋率百分比的結果。
go test -cover github.com\hyperledger\fabric\bccsp
返回結果:
ok github.com/hyperledger/fabric/bccsp 2.828s coverage: 100.0% of statements
但是這里返回的結果太少了,我們如果希望得到更詳細的覆蓋率信息,可以指定covermode和converprofile參數。
go test -cover -covermode count -coverprofile c:\Temp\cover.out github.com\hyperledger\fabric\bccsp
這里是將覆蓋率的結果輸出到C:\Temp\cover.out這個文件中。同時使用count可以對函數的執行次數進行計數。執行完畢后,我們可以使用以下命令將cover.out轉換為html在瀏覽器中查看:
go tool cover -html=C:\Temp\cover.out
在瀏覽器中,用綠色表示覆蓋,而執行次數,是需要把鼠標放上去才會顯示。這是我瀏覽器顯示的覆蓋率結果:
二、行為測試
我這里翻譯成行為測試可能不一定很可取,英文是BDDTests,BDD是敏捷開發中的一個概念,英文是Behavior Driven Development,可以認為是TDD的升級版吧。所有行為測試的代碼都在Fabric文件夾下面的bddtests文件夾中。
要進行Fabric的行為測試,需要安裝相關的環境,Fabric主要用到的是Behave這個工具,https://github.com/behave/behave
官方給我們提供了安裝腳本,直接運行:
sudo ./scripts/install_behave.sh
這里需要安裝的包比較多,安裝完成后我們就可以進行BDD的測試了。
官方的make命令下就為我們提供了執行全部行為測試的命令:
make behave
系統就會按照配置的場景,啟動對應的Docker容器,進行行為測試。
如果我們想跑某一個行為測試,而不是全部,那么就需要進一步的設置,具體參考:https://github.com/hyperledger/fabric/tree/release/bddtests
依次執行以下代碼:
sudo pip install virtualenv sudo pip install virtualenvwrapper export WORKON_HOME=~/Envs source /usr/local/bin/virtualenvwrapper.sh mkvirtualenv -p /usr/bin/python2.7 behave_venv
執行完上面命令后,我們可以看到我們的命令行變成了:
(behave_venv) studyzy@ubuntu1:~/go/src/github.com/hyperledger/fabric/bddtests$
接下來再安裝以下工具:
pip install behave pip install grpcio-tools pip install "pysha3==1.0b1" pip install b3j0f.aop pip install jinja2 pip install pyopenssl pip install ecdsa pip install python-slugify pip install pyyaml
總的來說就是給behave的執行設置了一個虛擬環境,所有代碼的執行是在這個虛擬環境中執行,不會影響真實環境。
安裝完畢后,我們想要測試某一個BDDTest,那么可以執行:
cd bddtests
behave -k -D cache-deployment-spec features/bootstrap.feature
這里測試的就是在bddtests\features\bootstrap.feature的這個例子。
測試完成后,使用
deactivate
命令即可退出虛擬環境,回到我們傳統的命令行下。
三、總結
如果我們要動Fabric的源碼,那么首先保證能夠跑通Fabric的單元測試和行為測試,然后再改。如果是新功能模塊,那么也需要寫自己模塊的單元測試代碼。寫完之后用go test來測試,保證我們的代碼能夠通過單元測試,而且要注意代碼覆蓋率,保持較高的覆蓋率能夠發現很多代碼中隱藏的問題。
如果我們的功能涉及到一系列的步驟操作,那么就一定要寫行為測試了。行為測試可以保證整個功能串起來運行是正常的。
文章列表
留言列表