package tester

import "github.com/Diarkis/diarkis/test/tester"

Package tester ▷

Tester - Unit test tools

Aids you to build uint tests.

Example

package main

import (
  "github.com/Diarkis/diarkis/test/tester"
)

func main() {

  // create a unit test container
  tests := tester.NewTests("Your unit test label")

  tests.Define("Can run some actions", func(next func(error)) {

    // we run some actions here
    // by calling next(), we tell the unit test container to move to the next test
    // if you pass an error to next(), the test fails and unit test terminates immediately
    next(nil)

  })

  // tests.Run() will start the tests
  tests.Run(func(err error) {
    // we are done!
  })

}

Index

Functions

func RunTests

func RunTests(list []*Tests)

RunTests executes multiple *Tests as a single continuous test.

Types

type Test

type Test struct {
	// contains filtered or unexported fields
}

Test represents a unit test

type Tests

type Tests struct {
	// contains filtered or unexported fields
}

Tests represents a set of unit tests

func NewTests

func NewTests(name string) *Tests

NewTests creates a new Tests instance

func (*Tests) Assert

func (ts *Tests) Assert(given interface{}, expected interface{})

Assert evaluates the two given values and if they are evaluated to be different values, the test fails immediately.

func (*Tests) AssertBoolArray

func (ts *Tests) AssertBoolArray(given []bool, expected []bool)

func (*Tests) AssertByteArray

func (ts *Tests) AssertByteArray(given []byte, expected []byte)

AssertByteArray evaluates the two given byte arrays and if they are evaluated to be different values, the test fails immediately.

func (*Tests) AssertBytesArray

func (ts *Tests) AssertBytesArray(given [][]byte, expected [][]byte)

func (*Tests) AssertFloat32Array

func (ts *Tests) AssertFloat32Array(given []float32, expected []float32)

func (*Tests) AssertFloat64Array

func (ts *Tests) AssertFloat64Array(given []float64, expected []float64)

func (*Tests) AssertInt16Array

func (ts *Tests) AssertInt16Array(given []int16, expected []int16)

func (*Tests) AssertInt32Array

func (ts *Tests) AssertInt32Array(given []int32, expected []int32)

func (*Tests) AssertInt64Array

func (ts *Tests) AssertInt64Array(given []int64, expected []int64)

func (*Tests) AssertInt8Array

func (ts *Tests) AssertInt8Array(given []int8, expected []int8)

func (*Tests) AssertIntArray

func (ts *Tests) AssertIntArray(given []int, expected []int)

func (*Tests) AssertNotEqual

func (ts *Tests) AssertNotEqual(given interface{}, expected interface{})

AssertNotEqual evaluates the two given values and if they are evaluated to be the same values, the test fails immediately.

func (*Tests) AssertStringArray

func (ts *Tests) AssertStringArray(given []string, expected []string)

func (*Tests) AssertUint16Array

func (ts *Tests) AssertUint16Array(given []uint16, expected []uint16)

func (*Tests) AssertUint32Array

func (ts *Tests) AssertUint32Array(given []uint32, expected []uint32)

func (*Tests) AssertUint64Array

func (ts *Tests) AssertUint64Array(given []uint64, expected []uint64)

func (*Tests) AssertUint8Array

func (ts *Tests) AssertUint8Array(given []uint8, expected []uint8)

func (*Tests) AssertUintArray

func (ts *Tests) AssertUintArray(given []uint, expected []uint)

func (*Tests) Async

func (ts *Tests) Async(cb func())

Async executes a given callback function asynchronously.

You must use this function instead of goroutine in your tests.

func (*Tests) Count

func (ts *Tests) Count() int

Count returns the number of tests.

func (*Tests) DebugLogging

func (ts *Tests) DebugLogging(d ...interface{})

DebugLogging outputs debug logging during the tests if the test process is started with --debug parameter.

func (*Tests) Define

func (ts *Tests) Define(label string, logic func(callback func(err error)))

Define creates a unit test. If you pass an error to the callback, the unit test fails. 

tests.Define("Can run some actions", func(next func(error)) {

  // we run some actions here
  // by calling next(), we tell the unit test container to move to the next test
  // if you pass an error to next(), the test fails and unit test terminates immediately
  next(nil)

})

func (*Tests) GetCurrentTest

func (ts *Tests) GetCurrentTest() *Test

GetCurrentTest returns the current test.

func (*Tests) OnEnd

func (ts *Tests) OnEnd(cb func())

OnEnd assigns a callback to be called at the end of all tests.

This is useful when you have to clean up such as database etc. after your tests

func (*Tests) Run

func (ts *Tests) Run(finished func(err error))

Run executes all unit tests in the order of the tests defined.

If a unit test fails, the entire Tests fail.