Panic

Asserting A Panic Behavior

Assertions

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

This domain exposes 4 functionalities.

NotPanics

NotPanics asserts that the code inside the specified function does NOT panic.

Examples

	assertions.NotPanics(t, func(){ RemainCalm() })
	success: func() { }
	failure: func() { panic("panicking") }

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestNotPanics(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 TestNotPanics(t *testing.T)
	success := assert.NotPanics(t, func() {
	})
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestNotPanics(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 TestNotPanics(t *testing.T)
	require.NotPanics(t, func() {
	})
	fmt.Println("passed")

}

Signature	Usage
`assert.NotPanics(t T, f func(), msgAndArgs ...any) bool`	package-level function
`assert.NotPanicsf(t T, f func(), msg string, args ...any) bool`	formatted variant
`assert.(*Assertions).NotPanics(f func()) bool`	method variant
`assert.(*Assertions).NotPanicsf(f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`require.NotPanics(t T, f func(), msgAndArgs ...any) bool`	package-level function
`require.NotPanicsf(t T, f func(), msg string, args ...any) bool`	formatted variant
`require.(*Assertions).NotPanics(f func()) bool`	method variant
`require.(*Assertions).NotPanicsf(f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`assertions.NotPanics(t T, f func(), msgAndArgs ...any) bool`	internal implementation

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

Panics

Panics asserts that the code inside the specified function panics.

Examples

	assertions.Panics(t, func(){ GoCrazy() })
	success: func() { panic("panicking") }
	failure: func() { }

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestPanics(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 TestPanics(t *testing.T)
	success := assert.Panics(t, func() {
		panic("panicking")
	})
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestPanics(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 TestPanics(t *testing.T)
	require.Panics(t, func() {
		panic("panicking")
	})
	fmt.Println("passed")

}

Signature	Usage
`assert.Panics(t T, f func(), msgAndArgs ...any) bool`	package-level function
`assert.Panicsf(t T, f func(), msg string, args ...any) bool`	formatted variant
`assert.(*Assertions).Panics(f func()) bool`	method variant
`assert.(*Assertions).Panicsf(f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`require.Panics(t T, f func(), msgAndArgs ...any) bool`	package-level function
`require.Panicsf(t T, f func(), msg string, args ...any) bool`	formatted variant
`require.(*Assertions).Panics(f func()) bool`	method variant
`require.(*Assertions).Panicsf(f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`assertions.Panics(t T, f func(), msgAndArgs ...any) bool`	internal implementation

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

PanicsWithError

PanicsWithError asserts that the code inside the specified function panics, and that the recovered panic value is an error that satisfies the EqualError comparison.

Examples

	assertions.PanicsWithError(t, "crazy error", func(){ GoCrazy() })
	success: ErrTest.Error(), func() { panic(ErrTest) }
	failure: ErrTest.Error(), func() { }

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestPanicsWithError(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 TestPanicsWithError(t *testing.T)
	success := assert.PanicsWithError(t, assert.ErrTest.Error(), func() {
		panic(assert.ErrTest)
	})
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

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

import (
	"fmt"
	"testing"

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

func main() {
	t := new(testing.T) // should come from testing, e.g. func TestPanicsWithError(t *testing.T)
	require.PanicsWithError(t, assert.ErrTest.Error(), func() {
		panic(assert.ErrTest)
	})
	fmt.Println("passed")

}

Signature	Usage
`assert.PanicsWithError(t T, errString string, f func(), msgAndArgs ...any) bool`	package-level function
`assert.PanicsWithErrorf(t T, errString string, f func(), msg string, args ...any) bool`	formatted variant
`assert.(*Assertions).PanicsWithError(errString string, f func()) bool`	method variant
`assert.(*Assertions).PanicsWithErrorf(errString string, f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`require.PanicsWithError(t T, errString string, f func(), msgAndArgs ...any) bool`	package-level function
`require.PanicsWithErrorf(t T, errString string, f func(), msg string, args ...any) bool`	formatted variant
`require.(*Assertions).PanicsWithError(errString string, f func()) bool`	method variant
`require.(*Assertions).PanicsWithErrorf(errString string, f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`assertions.PanicsWithError(t T, errString string, f func(), msgAndArgs ...any) bool`	internal implementation

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

PanicsWithValue

PanicsWithValue asserts that the code inside the specified function panics, and that the recovered panic value equals the expected panic value.

Examples

	assertions.PanicsWithValue(t, "crazy error", func(){ GoCrazy() })
	success: "panicking", func() { panic("panicking") }
	failure: "panicking", func() { }

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestPanicsWithValue(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 TestPanicsWithValue(t *testing.T)
	success := assert.PanicsWithValue(t, "panicking", func() {
		panic("panicking")
	})
	fmt.Printf("success: %t\n", success)

}

Copy and click to open Go Playground

// real-world test would inject *testing.T from TestPanicsWithValue(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 TestPanicsWithValue(t *testing.T)
	require.PanicsWithValue(t, "panicking", func() {
		panic("panicking")
	})
	fmt.Println("passed")

}

Signature	Usage
`assert.PanicsWithValue(t T, expected any, f func(), msgAndArgs ...any) bool`	package-level function
`assert.PanicsWithValuef(t T, expected any, f func(), msg string, args ...any) bool`	formatted variant
`assert.(*Assertions).PanicsWithValue(expected any, f func()) bool`	method variant
`assert.(*Assertions).PanicsWithValuef(expected any, f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`require.PanicsWithValue(t T, expected any, f func(), msgAndArgs ...any) bool`	package-level function
`require.PanicsWithValuef(t T, expected any, f func(), msg string, args ...any) bool`	formatted variant
`require.(*Assertions).PanicsWithValue(expected any, f func()) bool`	method variant
`require.(*Assertions).PanicsWithValuef(expected any, f func(), msg string, args ..any)`	method formatted variant

Signature	Usage
`assertions.PanicsWithValue(t T, expected any, f func(), msgAndArgs ...any) bool`	internal implementation

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

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