usure

README

Usure

A tiny and simple testing library

Example

Output

Install

import "github.com/stelmanjones/termtools/usure"

Features

• Nil Check: Checks if the provided value is nil.

result := usure.Nil(value)

• Not Nil Check: Checks if the provided value is not nil.

result := usure.NotNil(value)

• Instance Check: Checks if the two provided values are of the same type.

result := usure.IsInstance(value1, value2)

• Equality Check: Checks if the two provided values are equal.

result := usure.Equal(value1, value2)

• Inequality Check: Checks if the two provided values are not equal.

result := usure.NotEqual(value1, value2)

• Expect Equality: Logs an error message if the two provided values are not equal.

usure.ExpectEqual("Values should be equal", value1, value2)

Documentation

Overview

Package usure provides a few assertions.

Package usure provides a few assertions.

Index

• func Assert(comparison func() (success bool), msg string) bool
• func Equal[T any](a, b T) bool
• func Expect[T comparable](value T) *expectedValue[T]
• func ExpectEqual[T any](msg string, a, b T) bool
• func IsInstance[T any](a T) bool
• func Nil(a any) bool
• func NotEqual[T any](a, b T) bool
• func NotNil(a any) bool

Functions

func Assert

func Assert(comparison func() (success bool), msg string) bool

func Equal

func Equal[T any](a, b T) bool

Equal checks if a and b are equal.

func Expect

func Expect[T comparable](value T) *expectedValue[T]

func ExpectEqual

func ExpectEqual[T any](msg string, a, b T) bool

ExpectEqual checks if a and b are equal and prints a message if the condition is false.

func IsInstance

func IsInstance[T any](a T) bool

IsInstance checks if a is an instance of T.

func Nil

func Nil(a any) bool

Nil checks if a is nil.

func NotEqual

func NotEqual[T any](a, b T) bool

NotEqual checks if a and b are not equal.

func NotNil

func NotNil(a any) bool

NotNil checks if a is not nil.