stegol

README

STEGoL

Simple Testing Enhancements for the Go Language

Introduction

T.B.C.

Table of Contents

• Introduction
• Installation
• Components
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
    • Development/Testing Dependencies
  • Related projects
  • License

Installation

import stegol "github.com/synesissoftware/STEGoL"

Components

// CheckStringEqual() evaluates two strings for equality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison.
func CheckStringEqual(t *testing.T, expected, actual string, options any)

// CheckStringNotEqual() evaluates two strings for inequality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison.
func CheckStringNotEqual(t *testing.T, expected, actual string, options any)

// CheckStringEqualChomped() evaluates two strings for equality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison after chomping the actual value.
func CheckStringEqualChomped(t *testing.T, expected, actual string, options any)

// CheckStringNotEqualChomped() evaluates two strings for inequality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison after chomping the actual value.
func CheckStringNotEqualChomped(t *testing.T, expected, actual string, options any)

// CheckStringEqualTrimmed() evaluates two strings for equality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison after whitespace-trimming the actual value.
func CheckStringEqualTrimmed(t *testing.T, expected, actual string, options any)

// CheckStringNotEqualTrimmed() evaluates two strings for inequality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison after whitespace-trimming the actual value.
func CheckStringNotEqualTrimmed(t *testing.T, expected, actual string, options any)

// CheckStringEqualIgnoreCase() evaluates two strings for equality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison ignoring the case of the strings, via the
// strings.EqualFold() standard library function.
func CheckStringEqualIgnoreCase(t *testing.T, expected, actual string, options any)

// CheckStringEqualIgnoreCase() evaluates two strings for inequality, calling
// testing.T.Errorf() if the evaluation fails. The evaluation is done by
// equality comparison ignoring the case of the strings, via the
// strings.EqualFold() standard library function.
func CheckStringNotEqualIgnoreCase(t *testing.T, expected, actual string, options any)

func CheckStringByStringMatch(t *testing.T, pattern string, actual string, options any)

// CheckStringCompare() evaluates two strings, calling testing.T.Errorf()
// if the evaluation fails. The evaluation is done by the given
// caller-supplied comparison function, whose brief descriptor
// comparison_type, e.g. "regular expression" will be prefixed with the
// string "when compared by ".
func CheckStringCompare(t *testing.T, expected, actual string, fn StringCompareFunc, comparison_type string, options any)

// CheckStringEqualAny() evaluates a string for equality against an array of
// string values, calling testing.T.Errorf() if every evaluation fails. Each
// evaluation is done by equality comparison.
func CheckStringEqualAny(t *testing.T, expecteds []string, actual string, options any)

Examples

Examples are provided in the examples directory, along with a markdown description for each. A detailed list TOC of them is provided in EXAMPLES.md.

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/STEGoL.

Dependencies

• ver2go;

Development/Testing Dependencies

• require;

Related projects

T.B.C.

License

STEGoL is released under the 3-clause BSD license. See LICENSE for details.

Documentation

Index

• Constants
• func CheckStringByStringMatch(t *testing.T, pattern string, actual string, options ...any)
• func CheckStringCompare(t *testing.T, expected, actual string, fn StringCompareFunc, ...)
• func CheckStringEqual(t *testing.T, expected, actual string, options ...any)
• func CheckStringEqualAny(t *testing.T, expecteds []string, actual string, options ...any)
• func CheckStringEqualChomped(t *testing.T, expected, actual string, options ...any)
• func CheckStringEqualIgnoreCase(t *testing.T, expected, actual string, options ...any)
• func CheckStringEqualTrimmed(t *testing.T, expected, actual string, options ...any)
• func CheckStringNotEqual(t *testing.T, expected, actual string, options ...any)
• func CheckStringNotEqualChomped(t *testing.T, expected, actual string, options ...any)
• func CheckStringNotEqualIgnoreCase(t *testing.T, expected, actual string, options ...any)
• func CheckStringNotEqualTrimmed(t *testing.T, expected, actual string, options ...any)
• func VersionString() string
• type CheckStringFlag
• type StringCompareFunc

Constants

const (
	VersionMajor uint16 = 0
	VersionMinor uint16 = 2
	VersionPatch uint16 = 3
	VersionAB    uint16 = 0x8001
	Version      uint64 = (uint64(VersionMajor) << 48) + (uint64(VersionMinor) << 32) + (uint64(VersionPatch) << 16) + (uint64(VersionAB) << 0)
)

const (
	CheckStringFlag_None = 1 << iota
)

Functions

func CheckStringByStringMatch

func CheckStringByStringMatch(t *testing.T, pattern string, actual string, options ...any)

func CheckStringCompare

func CheckStringCompare(t *testing.T, expected, actual string, fn StringCompareFunc, comparison_type string, options ...any)

CheckStringCompare() evaluates two strings, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by the given caller-supplied comparison function, whose brief descriptor comparison_type, e.g. "regular expression" will be prefixed with the string "when compared by ".

func CheckStringEqual

func CheckStringEqual(t *testing.T, expected, actual string, options ...any)

CheckStringEqual() evaluates two strings for equality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison.

func CheckStringEqualAny

func CheckStringEqualAny(t *testing.T, expecteds []string, actual string, options ...any)

CheckStringEqualAny() evaluates a string for equality against an array of string values, calling testing.T.Errorf() if every evaluation fails. Each evaluation is done by equality comparison.

func CheckStringEqualChomped

func CheckStringEqualChomped(t *testing.T, expected, actual string, options ...any)

CheckStringEqualChomped() evaluates two strings for equality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison after chomping the actual value.

func CheckStringEqualIgnoreCase

func CheckStringEqualIgnoreCase(t *testing.T, expected, actual string, options ...any)

CheckStringEqualIgnoreCase() evaluates two strings for equality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison ignoring the case of the strings, via the strings.EqualFold() standard library function.

func CheckStringEqualTrimmed

func CheckStringEqualTrimmed(t *testing.T, expected, actual string, options ...any)

CheckStringEqualTrimmed() evaluates two strings for equality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison after whitespace-trimming the actual value.

func CheckStringNotEqual

func CheckStringNotEqual(t *testing.T, expected, actual string, options ...any)

CheckStringNotEqual() evaluates two strings for inequality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison.

func CheckStringNotEqualChomped

func CheckStringNotEqualChomped(t *testing.T, expected, actual string, options ...any)

CheckStringNotEqualChomped() evaluates two strings for inequality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison after chomping the actual value.

func CheckStringNotEqualIgnoreCase

func CheckStringNotEqualIgnoreCase(t *testing.T, expected, actual string, options ...any)

CheckStringEqualIgnoreCase() evaluates two strings for inequality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison ignoring the case of the strings, via the strings.EqualFold() standard library function.

func CheckStringNotEqualTrimmed

func CheckStringNotEqualTrimmed(t *testing.T, expected, actual string, options ...any)

CheckStringNotEqualTrimmed() evaluates two strings for inequality, calling testing.T.Errorf() if the evaluation fails. The evaluation is done by equality comparison after whitespace-trimming the actual value.

func VersionString

func VersionString() string

Types

type CheckStringFlag

type CheckStringFlag int

type StringCompareFunc

type StringCompareFunc func(expected, actual string) bool