gore

package module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2025 License: MIT Imports: 1 Imported by: 0

README

gore

gore is a simple Go package that provides a set of testing utilities that integrate with the Go testing framework.


Features

  • Simple Assertions - Straightforward helpers for common test conditions.
  • Fluent Interface - Write readable, chainable assertions.
  • Fail-Fast Option - Includes a stricter vital mode for critical assertions.

Installation

gore is available on GitHub and can be installed using Go modules:

go get github.com/chriso345/gore

Usage

Basic Assertions

Import and use the assert package to perform standard test assertions:

import "github.com/chriso345/gore/assert"

func TestExample(t *testing.T) {
    result := 1 + 1
    assert.Equal(t, result, 2)
}
Fluent Interface

Use a fluent API for more expressive and concise assertions:

import "github.com/chriso345/gore/assert"

func TestExample(t *testing.T) {
    a := assert.That(t)
    a.Equal(1+1, 2)
}
Vital Mode (Fail-Fast)

Use the vital package for assertions that halt execution immediately on failure (t.Fatalf):

import "github.com/chriso345/gore/vital"

func TestCritical(t *testing.T) {
    vital.Equal(t, 1+1, 2)
}

Fluent Assertions are also available in vital:

import "github.com/chriso345/gore/vital"

func TestCriticalFluent(t *testing.T) {
    v := vital.That(t)
    v.Equal(1+1, 2)
}

License

This project is licensed under the MIT License. See the LICENSE file for details.

Documentation

Overview

gore is a simple Go package that provides a set of testing utilities that integrate with the Go testing framework.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Version

func Version() string

Version returns the version of the golumn module, if available.

Types

This section is empty.

Directories

Path Synopsis
Package assert provides a collection of helper functions to simplify writing tests by offering expressive and readable assertions.
Package assert provides a collection of helper functions to simplify writing tests by offering expressive and readable assertions.
Package vital provides a strict set of assertion helpers for testing, built on top of the assert package but designed to fail fast.
Package vital provides a strict set of assertion helpers for testing, built on top of the assert package but designed to fail fast.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL