test

Documentation

Overview

Package test provides components or functions to help test and fuzz gnark circuits.

Index

• Constants
• Variables
• func IsSolved(circuit, witness frontend.Circuit, field *big.Int, opts ...TestEngineOption) (err error)
• type Assert
  • func NewAssert(t *testing.T) *Assert
  • func (assert *Assert) CheckCircuit(circuit frontend.Circuit, opts ...TestingOption)
  • func (assert *Assert) Fuzz(circuit frontend.Circuit, fuzzCount int, opts ...TestingOption)
  • func (assert *Assert) Log(v ...interface{})
  • func (assert *Assert) ProverFailed(circuit frontend.Circuit, invalidAssignment frontend.Circuit, ...)
  • func (assert *Assert) ProverSucceeded(circuit frontend.Circuit, validAssignment frontend.Circuit, ...)
  • func (a *Assert) Run(fn func(assert *Assert), descs ...string)
  • func (assert *Assert) SolvingFailed(circuit frontend.Circuit, invalidWitness frontend.Circuit, ...)
  • func (assert *Assert) SolvingSucceeded(circuit frontend.Circuit, validWitness frontend.Circuit, opts ...TestingOption)
• type TestEngineOption
  • func SetAllVariablesAsConstants() TestEngineOption
  • func WithBackendProverOptions(opts ...backend.ProverOption) TestEngineOption
• type TestingOption
  • func NoFuzzing() TestingOption
  • func NoProverChecks() TestingOption
  • func NoSerializationChecks() TestingOption
  • func NoSolidityChecks() TestingOption
  • func NoTestEngine() TestingOption
  • func WithBackends(b backend.ID, backends ...backend.ID) TestingOption
  • func WithCompileOpts(compileOpts ...frontend.CompileOption) TestingOption
  • func WithCurves(c ecc.ID, curves ...ecc.ID) TestingOption
  • func WithInvalidAssignment(invalidAssignment frontend.Circuit) TestingOption
  • func WithProverOpts(proverOpts ...backend.ProverOption) TestingOption
  • func WithSolverOpts(solverOpts ...solver.Option) TestingOption
  • func WithValidAssignment(validAssignment frontend.Circuit) TestingOption
  • func WithVerifierOpts(verifierOpts ...backend.VerifierOption) TestingOption

Constants

const SolcCheck = false

Variables

var (
	ErrCompilationNotDeterministic = errors.New("compilation is not deterministic")
	ErrInvalidWitnessSolvedCS      = errors.New("invalid witness solved the constraint system")
	ErrInvalidWitnessVerified      = errors.New("invalid witness resulted in a valid proof")
)

Functions

func IsSolved

func IsSolved(circuit, witness frontend.Circuit, field *big.Int, opts ...TestEngineOption) (err error)

IsSolved returns an error if the test execution engine failed to execute the given circuit with provided witness as input.

The test execution engine implements frontend.API using big.Int operations.

This is an experimental feature.

Types

type Assert

type Assert struct {
	*require.Assertions
	// contains filtered or unexported fields
}

Assert is a helper to test circuits

func NewAssert

func NewAssert(t *testing.T) *Assert

NewAssert returns an Assert helper embedding a testify/require object for convenience

The Assert object caches the compiled circuit:

the first call to assert.ProverSucceeded/Failed will compile the circuit for n curves, m backends and subsequent calls will re-use the result of the compilation, if available.

func (*Assert) CheckCircuit

func (assert *Assert) CheckCircuit(circuit frontend.Circuit, opts ...TestingOption)

CheckCircuit performs a series of check on the provided circuit.

go test -short                  --> testEngineChecks
go test                         --> testEngineChecks  + constraintSolverChecks
go test -tags=prover_checks     --> ... + proverChecks
go test -tags=release_checks    --> ... + releaseChecks (solidity, serialization, ...)

Depending on the above flags, the following checks are performed:

• the circuit compiles
• the circuit can be solved with the test engine
• the circuit can be solved with the constraint system solver
• the circuit can be solved with the prover
• the circuit can be verified with the verifier
• the circuit can be verified with gnark-solidity-checker
• the circuit, witness, proving and verifying keys can be serialized and deserialized

func (*Assert) Fuzz

func (assert *Assert) Fuzz(circuit frontend.Circuit, fuzzCount int, opts ...TestingOption)

Fuzz fuzzes the given circuit by instantiating "randomized" witnesses and cross checking execution result between constraint system solver and big.Int test execution engine

note: this is experimental and will be more tightly integrated with go1.18 built-in fuzzing

func (*Assert) Log

func (assert *Assert) Log(v ...interface{})

Log logs using the test instance logger.

func (*Assert) ProverFailed

func (assert *Assert) ProverFailed(circuit frontend.Circuit, invalidAssignment frontend.Circuit, opts ...TestingOption)

ProverSucceeded is deprecated use Assert.CheckCircuit instead

func (*Assert) ProverSucceeded

func (assert *Assert) ProverSucceeded(circuit frontend.Circuit, validAssignment frontend.Circuit, opts ...TestingOption)

ProverSucceeded is deprecated: use Assert.CheckCircuit instead

func (*Assert) Run

func (a *Assert) Run(fn func(assert *Assert), descs ...string)

Run runs the test function fn as a subtest. The subtest is parametrized by the description strings descs.

func (*Assert) SolvingFailed

func (assert *Assert) SolvingFailed(circuit frontend.Circuit, invalidWitness frontend.Circuit, opts ...TestingOption)

SolvingFailed is deprecated: use CheckCircuit instead

func (*Assert) SolvingSucceeded

func (assert *Assert) SolvingSucceeded(circuit frontend.Circuit, validWitness frontend.Circuit, opts ...TestingOption)

SolvingSucceeded is deprecated: use Assert.CheckCircuit instead

type TestEngineOption

type TestEngineOption func(e *engine) error

TestEngineOption defines an option for the test engine.

func SetAllVariablesAsConstants

func SetAllVariablesAsConstants() TestEngineOption

SetAllVariablesAsConstants is a test engine option which makes the calls to IsConstant() and ConstantValue() always return true. If this test engine option is not set, then all variables are considered as non-constant, regardless if it is constructed by a call to ConstantValue().

func WithBackendProverOptions

func WithBackendProverOptions(opts ...backend.ProverOption) TestEngineOption

WithBackendProverOptions is a test engine option which allows to define prover options. If not set, then default prover configuration is used.

type TestingOption

type TestingOption func(*testingConfig) error

TestingOption defines option for altering the behavior of Assert methods. See the descriptions of functions returning instances of this type for particular options.

func NoFuzzing

func NoFuzzing() TestingOption

NoFuzzing is a testing option which disables fuzzing tests, even when the build tag "release_checks" is set.

func NoProverChecks

func NoProverChecks() TestingOption

NoProverChecks is a testing option which disables prover checks, even when the build tag "prover_checks" or "release_checks" are set.

func NoSerializationChecks

func NoSerializationChecks() TestingOption

NoSerializationChecks is a testing option which disables serialization checks, even when the build tag "release_checks" is set.

func NoSolidityChecks

func NoSolidityChecks() TestingOption

NoSolidityChecks is a testing option which disables solidity checks, even when the build tags "solccheck" and "release_checks" are set.

When the tags are set; this requires gnark-solidity-checker to be installed, which in turns requires solc and abigen to be reachable in the PATH.

See https://github.com/ConsenSys/gnark-solidity-checker for more details.

func NoTestEngine

func NoTestEngine() TestingOption

NoTestEngine is a testing option which disables test engine checks

func WithBackends

func WithBackends(b backend.ID, backends ...backend.ID) TestingOption

WithBackends is testing option which restricts the backends the assertions are run. When not given, runs on all implemented backends.

func WithCompileOpts

func WithCompileOpts(compileOpts ...frontend.CompileOption) TestingOption

WithCompileOpts is a testing option which uses the given compileOpts when calling frontend.Compile in assertions.

func WithCurves

func WithCurves(c ecc.ID, curves ...ecc.ID) TestingOption

WithCurves is a testing option which restricts the curves the assertions are run. When not given, runs on all implemented curves.

func WithInvalidAssignment

func WithInvalidAssignment(invalidAssignment frontend.Circuit) TestingOption

WithInvalidAssignment is a testing option which adds an invalid assignment

func WithProverOpts

func WithProverOpts(proverOpts ...backend.ProverOption) TestingOption

WithProverOpts is a testing option which uses the given proverOpts when calling backend.Prover, backend.ReadAndProve and backend.IsSolved methods in assertions.

func WithSolverOpts

func WithSolverOpts(solverOpts ...solver.Option) TestingOption

WithSolverOpts is a testing option which uses the given solverOpts when calling constraint system solver.

func WithValidAssignment

func WithValidAssignment(validAssignment frontend.Circuit) TestingOption

WithValidAssignment is a testing option which adds a valid assignment

func WithVerifierOpts

func WithVerifierOpts(verifierOpts ...backend.VerifierOption) TestingOption

WithVerifierOpts is a testing option which uses the given verifierOpts when calling backend.Verify method.