quick

Documentation

Overview

quickパッケージは、ブラックボックステストを支援するためのユーティリティ関数を実装します。

testing/quickパッケージは凍結されており、新たな機能は受け入れられません。

Index

• func Check(f any, config *Config) error
• func CheckEqual(f, g any, config *Config) error
• func Value(t reflect.Type, rand *rand.Rand) (value reflect.Value, ok bool)
• type CheckEqualError
  • func (s *CheckEqualError) Error() string
• type CheckError
  • func (s *CheckError) Error() string
• type Config
• type Generator
• type SetupError
  • func (s SetupError) Error() string

Functions

func Check

func Check(f any, config *Config) error

Checkは、fがfalseを返すような入力を探します。fは、boolを返す任意の関数です。 fは、各引数に対して任意の値を使用して繰り返し呼び出されます。 もしfが特定の入力でfalseを返した場合、Checkはその入力を *CheckError として返します。 例えば：

func TestOddMultipleOfThree(t *testing.T) {
	f := func(x int) bool {
		y := OddMultipleOfThree(x)
		return y%2 == 1 && y%3 == 0
	}
	if err := quick.Check(f, nil); err != nil {
		t.Error(err)
	}
}

func CheckEqual

func CheckEqual(f, g any, config *Config) error

CheckEqualは、fとgが異なる結果を返す入力を探します。 fとgは、各引数に対して任意の値を使用して繰り返し呼び出されます。 もしfとgが異なる答えを返した場合、CheckEqualはその入力と出力を記述する *CheckEqualError を返します。

func Value

func Value(t reflect.Type, rand *rand.Rand) (value reflect.Value, ok bool)

Valueは、指定された型の任意の値を返します。 もし型が Generator インターフェースを実装しているなら、それが使用されます。 注意：構造体の任意の値を作成するためには、全てのフィールドがエクスポートされていなければなりません。

Types

type CheckEqualError

type CheckEqualError struct {
	CheckError
	Out1 []any
	Out2 []any
}

CheckEqualErrorは、CheckEqual がエラーを見つけた結果です。

func (*CheckEqualError) Error

func (s *CheckEqualError) Error() string

type CheckError

type CheckError struct {
	Count int
	In    []any
}

CheckErrorは、Checkがエラーを見つけた結果です。

func (*CheckError) Error

func (s *CheckError) Error() string

type Config

type Config struct {
	// MaxCountは、反復の最大回数を設定します。
	// もしゼロなら、MaxCountScaleが使用されます。
	MaxCount int
	// MaxCountScaleは、デフォルトの最大値に適用される非負のスケールファクターです。
	// カウントがゼロの場合、デフォルト（通常は100）が適用されますが、
	// -quickchecksフラグによって設定することもできます。
	MaxCountScale float64
	// Randは、乱数のソースを指定します。
	// もしnilなら、デフォルトの疑似乱数ソースが使用されます。
	Rand *rand.Rand
	// Valuesは、テスト対象の関数の引数と一致する任意のreflect.Valuesのスライスを生成する関数を指定します。
	// もしnilなら、トップレベルのValue関数がそれらを生成するために使用されます。
	Values func([]reflect.Value, *rand.Rand)
}

Config構造体は、テストの実行オプションを含みます。

type Generator

type Generator interface {
	Generate(rand *rand.Rand, size int) reflect.Value
}

Generatorは、自身の型のランダムな値を生成することができます。

type SetupError

type SetupError string

SetupErrorは、テストされる関数に関係なく、checkの使用方法に関するエラーの結果です。

func (SetupError) Error

func (s SetupError) Error() string