-
Notifications
You must be signed in to change notification settings - Fork 18
/
doc.go
31 lines (29 loc) · 1.11 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
// Tideland Go Library - Audit
//
// Copyright (C) 2012-2017 Frank Mueller / Tideland / Oldenburg / Germany
//
// All rights reserved. Use of this source code is governed
// by the new BSD license.
// Package audit of the Tideland Go Library helps writing convenient and
// powerful unit tests. One part of it are assertions to compare expected
// and obtained values. Additional text output for failing tests can be
// added.
//
// In the beginning of a test function a new assertion instance is created with:
//
// assert := audit.NewTestingAssertion(t, shallFail)
//
// Inside the test an assert looks like:
//
// assert.Equal(obtained, expected, "obtained value has to be like expected")
//
// If shallFail is set to true a failing assert also lets fail the Go test.
// Otherwise the failing is printed but the tests continue. Other functions
// help with temporary directories, environment variables, and the generating
// of test data.
//
// Additional helpers support in generating test data or work with the
// environment, like temporary directories or environment variables, in
// a safe and convenient way.
package audit
// EOF