Failpoints are getting executed while running tests using `go test -v`
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- go
- 領域
- testing-qa
調査の方向性
samplestruct.go、main.go、sample_test.goを使用して、go test -vとビルド済みの./modv1実行ファイルを比較し、報告を再現します。TestFailpoint中にGO_FAILPOINTSがどのように設定され、使用されるかを調査し、テストバイナリ内でfailpointが実行されるかどうかを確認します。完了とは、動作が説明され、テスト時に期待される動作が再現可能なテストまたは明確なドキュメントによってカバーされていることを意味します。
索引モデルが issue の本文から書いたものです。
説明
Bug Report
- What did you do? If possible, provide a recipe for reproducing the error.
I have the following setup (all in the same directory):
go.mod
module example.com/modv1
go 1.20
require (
github.com/pingcap/failpoint v0.0.0-20220801062533-2eaa32854a6c
github.com/stretchr/testify v1.8.4
)
require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/pingcap/errors v0.11.4 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
samplestruct.go
package main
import (
"log"
"github.com/pingcap/failpoint"
)
type SampleStruct struct {
cnt int
}
func (s *SampleStruct) increment() {
if _, _err_ := failpoint.Eval(_curpkg_("testPanic")); _err_ == nil {
log.Printf("[SampleStruct] SUCCESS!!! Executed testPanic FP: The count for s is %v", s.cnt)
}
s.cnt++
}
func (s *SampleStruct) decrement() {
s.cnt--
}
func (s *SampleStruct) incrementFP() string {
log.Printf("[SampleStruct] Executing incrementFP with old cnt %v", s.cnt)
s.cnt++
log.Printf("[SampleStruct] Executing incrementFP with new cnt %v", s.cnt)
if _, _err_ := failpoint.Eval(_curpkg_("doubleIncrement")); _err_ == nil {
s.cnt++
log.Printf("[SampleStruct] SUCCESS!!! Executed doubleIncrement FP. The count for s is %v", s.cnt)
}
return "single"
}
main.go
package main
import (
"fmt"
"log"
"os"
)
func main() {
log.Printf(fmt.Sprintf("[main] This is main function being executed in an executable at path %v", os.Args[0]))
//os.Setenv("Go_FAILPOINTS", "main/doubleIncrement=return(true);main/testPanic=return(true)")
log.Printf(fmt.Sprintf("[main] After FP code in main function"))
sampleStruct := SampleStruct{cnt: 1}
log.Printf("[main] sampleStruct cnt before increment is %v", sampleStruct.cnt)
sampleStruct.increment()
log.Printf("[main] sampleStruct cnt after increment is %v", sampleStruct.cnt)
log.Printf("[main] sampleStruct cnt before double increment is %v", sampleStruct.cnt)
sampleStruct.incrementFP()
log.Printf("[main] sampleStruct cnt after double increment is %v", sampleStruct.cnt)
}
sample_test.go
package main
import (
"log"
"testing"
"os/exec"
"os"
"fmt"
"bytes"
"github.com/stretchr/testify/assert"
)
func TestFailpoint(t *testing.T) {
log.Printf("[TestFailpoint] Executing TestFailpoint")
mySampleStruct := SampleStruct{cnt: 2}
assert.Equal(t, mySampleStruct.cnt, 2)
// fpsToEnable := map[string]struct{}{
// "doubleIncrement": {},
// }
// cmd := exec.Command("export", "GO_FAILPOINTS='main/doubleIncrement=return(true);main/testPanic=return(true)'")
// if err := cmd.Run(); err != nil {
// log.Fatal(fmt.Sprintf("Encountered error while setting up the GO_FAILPOINTS environment variable. Error: %v", err))
// } else {
// log.Printf("Successfully set up the GO_FAILPOINTS environment variable")
// }
os.Setenv("GO_FAILPOINTS","'main/doubleIncrement=return(true);main/testPanic=return(true)'")
log.Printf("[TestFailpoint] Successfully set up the GO_FAILPOINTS environment variable")
cmd := exec.Command("./modv1")
var out bytes.Buffer
var stderr bytes.Buffer
cmd.Stdout = &out
cmd.Stderr = &stderr
if err := cmd.Start(); err != nil {
log.Printf(fmt.Sprintf("[TestFailpoint] Error while starting modv1 executable. Error: %v", err))
log.Printf("[TestFailpoint] Command error is: " + stderr.String())
} else {
log.Printf("[TestFailpoint] Successfully started modv1 executable")
log.Printf("[TestFailpoint] Result: " + out.String() + ",Error: " + stderr.String())
}
if err := cmd.Wait(); err != nil {
log.Printf(fmt.Sprintf("[TestFailpoint] Error while waiting for modv1 executable. Error: %v", err))
log.Printf("[TestFailpoint] Command error is: " + stderr.String())
} else {
log.Printf("[TestFailpoint] Successfully waited for modv1 executable")
log.Printf("[TestFailpoint] Result: " + out.String() + ",Error: " + stderr.String())
}
//failpoint.Enable("doubleIncrement", "return(1)")
log.Printf("[TestFailpoint] Calling increment")
mySampleStruct.increment()
log.Printf("[TestFailpoint] Called increment")
log.Printf("[TestFailpoint] Calling incrementFP")
result := mySampleStruct.incrementFP()
log.Printf("[TestFailpoint] Called incrementFP")
assert.Equal(t, mySampleStruct.cnt, 4)
assert.Equal(t, result, "single")
os.Unsetenv("GO_FAILPOINTS")
log.Printf("[TestFailpoint] Successfully unset the GO_FAILPOINTS environment variable")
}
-
What did you expect to see?
When I rungo buildand set the environment variableexport GO_FAILPOINTS=main/doubleIncrement=return(true);main/testPanic=return(true)and then execute the./modv1executable I see that the failpoints insamplestruct.goare hit and the failpoint closure is executed. I expected same behavior when I rungo test -vi.e. when theTestFailpointtest is executed. -
What did you see instead?
I did not see the failpoints insamplestruct.gogetting executed while running the testTestFalipoint. Is this expected behavior? Is the failpoint code executed only in the compiled binarymodv1and not during test execution even though the environment variableGO_FAILPOINTSis kept around (and additionally also set/unset during) test execution? -
Versions of the failpoint
$ ./failpoint-ctl -V
ReleaseVersion ed9079f
BuildTS 2023-09-01 02:53:58
GitHash ed9079f47f3761cbbeadaded49d48e3264c23427
GitBranch fp-testing
GoVersion go version go1.21.0 darwin/arm64
- 主要言語
- Go
- スター
- 896
- フォーク
- 69
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pingcap/failpoint のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
-
expect `Enable()` inTerm:'off' does not trigger failpoint code, but it's not as expect対応中かも @1fanwang が 27 日前に担当しました。 オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
-
question
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
pingcap/failpoint の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
cloudflare/terraform-provider-cloudflare#7423 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
router-for-me/CLIProxyAPI#6746 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
ViewData can pair the in-flight proposal with the prepared flag of another proposal対応中かも @HagarMeir が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
hyperledger/SmartBFT#710 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100