Boolean

Asserting Boolean Values

Assertions

All links point to https://pkg.go.dev/github.com/go-openapi/testify/v2

This domain exposes 4 functionalities. Generic assertions are marked with a .

False

False asserts that the specified value is false.

Examples

	assertions.False(t, myBool)
	success: 1 == 0
	failure: 1 == 1

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestFalse(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/assert"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestFalse(t *testing.T)
	success := assert.False(t, 1 == 0)
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestFalse(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestFalse(t *testing.T)
	require.False(t, 1 == 0)
	fmt.Println("passed")

}

Signature	Usage
`assert.False(t T, value bool, msgAndArgs ...any) bool`	package-level function
`assert.Falsef(t T, value bool, msg string, args ...any) bool`	formatted variant
`assert.(*Assertions).False(value bool) bool`	method variant
`assert.(*Assertions).Falsef(value bool, msg string, args ..any)`	method formatted variant

Signature	Usage
`require.False(t T, value bool, msgAndArgs ...any) bool`	package-level function
`require.Falsef(t T, value bool, msg string, args ...any) bool`	formatted variant
`require.(*Assertions).False(value bool) bool`	method variant
`require.(*Assertions).Falsef(value bool, msg string, args ..any)`	method formatted variant

Signature	Usage
`assertions.False(t T, value bool, msgAndArgs ...any) bool`	internal implementation

Source: github.com/go-openapi/testify/v2/internal/assertions#False

FalseT[B Boolean]

FalseT asserts that the specified value is false.

The type constraint Boolean accepts any type which underlying type is bool.

Examples

	type B bool
	var b B = true
	assertions.FalseT(t, b)
	success: 1 == 0
	failure: 1 == 1

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestFalseT(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/assert"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestFalseT(t *testing.T)
	success := assert.FalseT(t, 1 == 0)
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestFalseT(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestFalseT(t *testing.T)
	require.FalseT(t, 1 == 0)
	fmt.Println("passed")

}

Signature	Usage
`assert.FalseT[B Boolean](t T, value B, msgAndArgs ...any) bool`	package-level function
`assert.FalseTf[B Boolean](t T, value B, msg string, args ...any) bool`	formatted variant

Signature	Usage
`require.FalseT[B Boolean](t T, value B, msgAndArgs ...any) bool`	package-level function
`require.FalseTf[B Boolean](t T, value B, msg string, args ...any) bool`	formatted variant

Signature	Usage
`assertions.FalseT[B Boolean](t T, value B, msgAndArgs ...any) bool`	internal implementation

Source: github.com/go-openapi/testify/v2/internal/assertions#FalseT

True

True asserts that the specified value is true.

Examples

	assertions.True(t, myBool)
	success: 1 == 1
	failure: 1 == 0

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestTrue(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/assert"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestTrue(t *testing.T)
	success := assert.True(t, 1 == 1)
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestTrue(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestTrue(t *testing.T)
	require.True(t, 1 == 1)
	fmt.Println("passed")

}

Signature	Usage
`assert.True(t T, value bool, msgAndArgs ...any) bool`	package-level function
`assert.Truef(t T, value bool, msg string, args ...any) bool`	formatted variant
`assert.(*Assertions).True(value bool) bool`	method variant
`assert.(*Assertions).Truef(value bool, msg string, args ..any)`	method formatted variant

Signature	Usage
`require.True(t T, value bool, msgAndArgs ...any) bool`	package-level function
`require.Truef(t T, value bool, msg string, args ...any) bool`	formatted variant
`require.(*Assertions).True(value bool) bool`	method variant
`require.(*Assertions).Truef(value bool, msg string, args ..any)`	method formatted variant

Signature	Usage
`assertions.True(t T, value bool, msgAndArgs ...any) bool`	internal implementation

Source: github.com/go-openapi/testify/v2/internal/assertions#True

TrueT[B Boolean]

TrueT asserts that the specified value is true.

The type constraint Boolean accepts any type which underlying type is bool.

Examples

	type B bool
	var b B = true
	assertions.True(t, b)
	success: 1 == 1
	failure: 1 == 0

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestTrueT(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/assert"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestTrueT(t *testing.T)
	success := assert.TrueT(t, 1 == 1)
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestTrueT(t *testing.T)
package main

import (
	"fmt"
	"testing"

	"github.com/go-openapi/testify/v2/require"
)

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestTrueT(t *testing.T)
	require.TrueT(t, 1 == 1)
	fmt.Println("passed")

}

Signature	Usage
`assert.TrueT[B Boolean](t T, value B, msgAndArgs ...any) bool`	package-level function
`assert.TrueTf[B Boolean](t T, value B, msg string, args ...any) bool`	formatted variant

Signature	Usage
`require.TrueT[B Boolean](t T, value B, msgAndArgs ...any) bool`	package-level function
`require.TrueTf[B Boolean](t T, value B, msg string, args ...any) bool`	formatted variant

Signature	Usage
`assertions.TrueT[B Boolean](t T, value B, msgAndArgs ...any) bool`	internal implementation

Source: github.com/go-openapi/testify/v2/internal/assertions#TrueT

Generated with github.com/go-openapi/testify/codegen/v2