Skip to content

Commit 69f4336

Browse files
delticsdeltics
committed
[initial release]
0 parents  commit 69f4336

File tree

8 files changed

+455
-0
lines changed

8 files changed

+455
-0
lines changed

‎.github/workflows/qa.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: QA
2+
3+
on: [ push, pull_request ]
4+
5+
jobs:
6+
build-test:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v3
10+
11+
- name: setup go
12+
uses: actions/setup-go@v3
13+
with:
14+
go-version: 1.18
15+
16+
- name: build
17+
run: go build -v ./...
18+
19+
- name: test
20+
run: go test -v -coverprofile=profile.cov ./...
21+
22+
- name: send coverage
23+
uses: shogo82148/actions-goveralls@v1
24+
with:
25+
path-to-profile: profile.cov
26+
27+
lint:
28+
name: lint
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v3
32+
33+
- name: setup go
34+
uses: actions/setup-go@v3
35+
with:
36+
go-version: 1.18
37+
38+
- name: lint
39+
uses: golangci/golangci-lint-action@v3
40+
with:
41+
version: latest

‎.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# macOS finder files
2+
**/.DS_Store
3+
4+
# Binaries for programs and plugins
5+
*.exe
6+
*.exe~
7+
*.dll
8+
*.so
9+
*.dylib
10+
11+
# Test binary, built with `go test -c`
12+
*.test
13+
14+
# Output of the go coverage tool, specifically when used with LiteIDE
15+
*.out
16+
17+
# Dependency directories (remove the comment below to include it)
18+
# vendor/

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Jolyon Direnko-Smith
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
<div align="center" style="margin-bottom:20px">
2+
<!-- <img src=".assets/banner.png" alt="go-logspy" /> -->
3+
<div align="center">
4+
<a href="https://github.com/blugnu/go-logspy/actions/workflows/qa.yml"><img alt="build-status" src="https://github.com/blugnu/go-logspy/actions/workflows/qa.yml/badge.svg?branch=master&style=flat-square"/></a>
5+
<a href="https://goreportcard.com/report/github.com/blugnu/go-logspy" ><img alt="go report" src="https://goreportcard.com/badge/github.com/blugnu/go-logspy"/></a>
6+
<a><img alt="go version >= 1.14" src="https://img.shields.io/github/go-mod/go-version/blugnu/go-logspy?style=flat-square"/></a>
7+
<a href="https://github.com/blugnu/go-logspy/blob/master/LICENSE"><img alt="MIT License" src="https://img.shields.io/github/license/blugnu/go-logspy?color=%234275f5&style=flat-square"/></a>
8+
<a href="https://coveralls.io/github/blugnu/go-logspy?branch=master"><img alt="coverage" src="https://img.shields.io/coveralls/github/blugnu/go-logspy?style=flat-square"/></a>
9+
<a href="https://pkg.go.dev/github.com/blugnu/go-logspy"><img alt="docs" src="https://pkg.go.dev/badge/github.com/blugnu/go-logspy"/></a>
10+
</div>
11+
</div>
12+
13+
<br>
14+
15+
# go-logspy
16+
17+
A truly trivial package for assisting in incorporating log output verification in `go` unit tests.
18+
19+
LogSpy works with any log package that provides a mechanism for redirecting log output to an `io.Writer`, such as the built-in `log` package or `logrus`.
20+
21+
## How LogSpy Works
22+
Log output is redirected into a `bytes.Buffer` (the "sink").
23+
24+
After code under test has been executed, the contents of the log are tested using either normal string testing techniques, or any of the various helper methods provided (intended to simplify common log tests).
25+
26+
That's it.
27+
28+
<br>
29+
<hr>
30+
<br>
31+
32+
## How to Use LogSpy
33+
LogSpy is as trivial to use as it is to understand:
34+
35+
1. Configure and sink the log
36+
2. `Reset()` LogSpy before each test
37+
3. Execute code to be tested
38+
4. Test log content with helpers (or your preferred string testing techniques)
39+
40+
<br>
41+
42+
### **1. Configure and Sink the Log**
43+
In your tests, redirect log output to the `logspy.Sink()`.
44+
45+
When using a package such as `logrus`, this is typically combined with configuring your log package for test runs in the same way that it is configured for normal execution of the code under test.
46+
47+
If using `go test`, a good place for this could be a `TestMain`:
48+
49+
```golang
50+
func TestMain(m *testing.M) {
51+
// Confgure the log formatter
52+
// (TIP: Use a common func to ensure identical formatting
53+
// in both test and application logging)
54+
logrus.SetFormatter(&logrus.JSONFormatter{})
55+
56+
// Redirect log output to the logspy sink
57+
logrus.SetOutput(logspy.Sink())
58+
59+
// Run the tests and set the exit value to the result
60+
os.Exit(m.Run())
61+
}
62+
```
63+
64+
**NOTE:** *Since `go test` runs tests at the package level, it is necessary to configure and sink the log in each package; a common func called from `TestMain()` in each package might be one way to achieve this.*
65+
66+
<br>
67+
68+
### **2. `Reset()` Logs Before Each Test (ARRANGE)**
69+
With log formatting and sink in place, you then need to ensure you `Reset()` LogSpy at the beginning of each test:
70+
71+
```golang
72+
func TestThatSomeFunctionEmitsExpectedLogs(t *testing.T) {
73+
// ARRANGE
74+
logspy.Reset()
75+
76+
// ACT
77+
SomeFunction()
78+
79+
// ASSERT
80+
...
81+
}
82+
```
83+
84+
This is important as it ensures that log output captured in one test does not "pollute" the log in others.
85+
86+
<br>
87+
88+
### **3. Execute Code Under Test (ACT)**
89+
This doesn't need any explanation, right?
90+
91+
<br>
92+
93+
### **4. Test Log Content (ASSERT)**
94+
The raw log output captured by LogSpy is available using the `logspy.String()` function. Using this, the log content can be tested using whatever techniques you prefer when testing string values.
95+
96+
However, LogSpy also provides a number of helper functions to simplify common tests of log content.
97+
98+
For example, to test that an expected number of log entries have been emitted, the `NumEntries()` function can be used, which returns the number of non-empty log entries (since the most recent `Reset()`).
99+
100+
An example showing this in use:
101+
102+
```golang
103+
func TestThatNumEntriesReturnsTheNumberOfLogEntries(t *testing.T) {
104+
// ARRANGE
105+
logspy.Reset()
106+
107+
// ACT
108+
log.Println("output 1")
109+
log.Println("output 2")
110+
log.Println("output 3")
111+
112+
// ASSERT
113+
wanted := 3
114+
got := logspy.NumEntries()
115+
if wanted != got {
116+
t.Errorf("Wanted %d log entries, got %d", wanted, got)
117+
}
118+
}
119+
```

‎go.mod

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module github.com/blugnu/go-logspy
2+
3+
go 1.14

‎go.sum

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
2+
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
3+
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
4+
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
5+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
6+
github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
7+
github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
8+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
9+
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
10+
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
11+
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
12+
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
13+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
14+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
15+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
16+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

‎sink.go

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
package logspy
2+
3+
import (
4+
"bytes"
5+
"encoding/json"
6+
"fmt"
7+
"io"
8+
"strings"
9+
)
10+
11+
var (
12+
sink bytes.Buffer
13+
)
14+
15+
func Sink() *bytes.Buffer {
16+
return &sink
17+
}
18+
19+
func Contains(ss string) bool {
20+
return strings.Contains(sink.String(), ss)
21+
}
22+
23+
func ContainsJsonMember(f string) bool {
24+
return strings.Contains(String(), fmt.Sprintf("%q:", f))
25+
}
26+
27+
// NumEntries() returns the number of non-empty entries in the log
28+
func NumEntries() int {
29+
n := 0
30+
for _, e := range strings.Split(String(), "\n") {
31+
if len(strings.TrimSpace(e)) > 0 {
32+
n++
33+
}
34+
}
35+
return n
36+
}
37+
38+
// NumJsonEntries() returns the number of Json objects in the log
39+
func NumJsonEntries() (int, error) {
40+
n := 0
41+
r := strings.NewReader(sink.String())
42+
d := json.NewDecoder(r)
43+
for {
44+
var o interface{}
45+
if err := d.Decode(&o); err == io.EOF {
46+
break
47+
} else if err != nil {
48+
return n, err
49+
}
50+
n++
51+
}
52+
return n, nil
53+
}
54+
55+
// Reset() clears captured logs, preparing the sink to capture new logs.
56+
func Reset() {
57+
sink = bytes.Buffer{}
58+
}
59+
60+
// String() returns a string containing the contents of the
61+
// logs captured since the most recent Reset().
62+
func String() string {
63+
return sink.String()
64+
}

0 commit comments

Comments
 (0)