skip

Documentation

Overview

Package skip provides functions for skipping based on a condition.

Index

• func If(t skipT, condition BoolOrCheckFunc, msgAndArgs ...interface{})
• func IfCondition(t skipT, condition bool, msgAndArgs ...interface{})
• type BoolOrCheckFunc

Examples

• If
• IfCondition

Functions

func If

func If(t skipT, condition BoolOrCheckFunc, msgAndArgs ...interface{})

If skips the test if the check function returns true. The skip message will contain the name of the check function. Extra message text can be passed as a format string with args

Example

package main

import (
	"testing"

	"github.com/gotestyourself/gotestyourself/skip"
)

func MissingFeature() bool { return false }

var t = &testing.T{}

func main() {
	//   --- SKIP: TestName (0.00s)
	//           skip.go:19: MissingFeature
	skip.If(t, MissingFeature)

	//   --- SKIP: TestName (0.00s)
	//           skip.go:19: MissingFeature: coming soon
	skip.If(t, MissingFeature, "coming soon")
}

func IfCondition

func IfCondition(t skipT, condition bool, msgAndArgs ...interface{})

IfCondition skips the test if the condition is true. The skip message will contain the source of the expression passed as the condition. Extra message text can be passed as a format string with args.

Deprecated: Use If() which now accepts bool arguments

Example

package main

import (
	"testing"

	"github.com/gotestyourself/gotestyourself/skip"
)

var apiVersion = ""

type env struct{}

func (e env) hasFeature(_ string) bool { return false }

var testEnv = env{}

var t = &testing.T{}

func main() {
	//   --- SKIP: TestName (0.00s)
	//           skip.go:19: apiVersion < version("v1.24")
	skip.IfCondition(t, apiVersion < version("v1.24"))

	//   --- SKIP: TestName (0.00s)
	//           skip.go:19: !textenv.hasFeature("build"): coming soon
	skip.IfCondition(t, !testEnv.hasFeature("build"), "coming soon")
}

func version(v string) string {
	return v
}

Types

type BoolOrCheckFunc

type BoolOrCheckFunc interface{}

BoolOrCheckFunc can be a bool or func() bool, other types will panic