mirror of https://github.com/stretchr/testify.git
Compare commits
298 Commits
Author | SHA1 | Date |
---|---|---|
|
5ac6528bff | |
|
d0e0f4961b | |
|
b561f16e87 | |
|
a948a8c402 | |
|
c3915e850a | |
|
16020e8cbc | |
|
75df9d50d4 | |
|
33be8f984a | |
|
a9e8aed155 | |
|
3b8bd9bf7d | |
|
1e7fb5865a | |
|
c6ac9bb91d | |
|
65f73866c0 | |
|
b1c9368f81 | |
|
5a5ac85551 | |
|
53e0c918d4 | |
|
89086b0757 | |
|
098128fd10 | |
|
f784abc221 | |
|
dfda68b86f | |
|
3cf0926564 | |
|
c60c3bd7fb | |
|
1c717c00c1 | |
|
ccb5e7f656 | |
|
ca6698b8a1 | |
|
7c367bb7bc | |
|
e6a990c21d | |
|
cfee2346d7 | |
|
f8c628e5a1 | |
|
014ae9a7a4 | |
|
30f3cef5ad | |
|
d57bac8721 | |
|
89cbdd9e7b | |
|
07bac606be | |
|
716de8dff4 | |
|
118fb83466 | |
|
7d99b2b43d | |
|
05f87c0160 | |
|
ea7129e006 | |
|
a1b9c9efe3 | |
|
8302de98b1 | |
|
89352f7958 | |
|
2780579e15 | |
|
8f049b0122 | |
|
be992afabf | |
|
fb67df6392 | |
|
55bac84354 | |
|
822223ec34 | |
|
22d3bd5def | |
|
9c174eb41c | |
|
7efaf15f33 | |
|
dce9e58ee3 | |
|
75a239b2fd | |
|
f9ccf14f6f | |
|
6555fd4da6 | |
|
a012e45d18 | |
|
3b2754b72f | |
|
2fc4e39394 | |
|
f2227519d6 | |
|
50d5b7e695 | |
|
55ebaca027 | |
|
ba3e7c34d5 | |
|
2063e81696 | |
|
7f489726a5 | |
|
f844b269df | |
|
dc100b1be3 | |
|
aade8450b3 | |
|
3380867632 | |
|
95d1f9c2ad | |
|
fed9ee68dc | |
|
5dc934f9aa | |
|
c4b8421a1f | |
|
85a526818c | |
|
16a09b7086 | |
|
f3f7181b01 | |
|
d62ca68bf5 | |
|
428847e363 | |
|
72e3b61028 | |
|
ea6964c2e9 | |
|
f17409f81f | |
|
bdb1271ed8 | |
|
e943930404 | |
|
7268a5bc0b | |
|
da63673a11 | |
|
52df55490e | |
|
7f10816c93 | |
|
176474a4c9 | |
|
28e0be5092 | |
|
4a90eff4ae | |
|
3ca01f4bc3 | |
|
bc04bb85a2 | |
|
b074924938 | |
|
f71de4a756 | |
|
592e4e3c00 | |
|
044c46a89f | |
|
84619f5c3c | |
|
9326036bf5 | |
|
1b4fca7679 | |
|
cb4e70cf8d | |
|
7af3ed34c2 | |
|
df81388b27 | |
|
6b275adbf7 | |
|
b661f0ade2 | |
|
109f4286cf | |
|
3c0c0e6443 | |
|
32766084e4 | |
|
8d4dcbbccb | |
|
8c324a0bbd | |
|
f32ff5b3cb | |
|
e33bd6fdd1 | |
|
d4a63f5b89 | |
|
a9e6121b1c | |
|
a61e9e59d6 | |
|
4ec7678c61 | |
|
42d887f28b | |
|
0e5b59666a | |
|
352d2438b9 | |
|
726249eca2 | |
|
d3dbb19355 | |
|
17b83c52e4 | |
|
a2fbbfe71b | |
|
be3fbeb943 | |
|
edd74b24a1 | |
|
740a5e83fa | |
|
404159f5fa | |
|
a155d2a49d | |
|
39442a4e4e | |
|
74e1cbebab | |
|
a71299064b | |
|
da1e1476cb | |
|
3c302f75ae | |
|
1dedc83b8f | |
|
aca1890ec1 | |
|
bfa3ee96e3 | |
|
f1b5324b90 | |
|
632a26080f | |
|
cab2acc70f | |
|
edb801534f | |
|
89ffab03a5 | |
|
8585d8de96 | |
|
e5e71998af | |
|
85fabe7c5c | |
|
bb548d0473 | |
|
814075f391 | |
|
e045612245 | |
|
5b6926d686 | |
|
9f97d67703 | |
|
bcb0d3fe49 | |
|
fb770f8238 | |
|
85d8bb6eea | |
|
e2741fa4e9 | |
|
6e59f20c0d | |
|
840f800f1a | |
|
e65c014fc9 | |
|
135b468c5a | |
|
ecdde720b4 | |
|
9f0ad86b78 | |
|
7c847e2503 | |
|
898b77d0bb | |
|
7caada5a3b | |
|
e099480d59 | |
|
4b9af26649 | |
|
a5087d7793 | |
|
bd22f81c8f | |
|
28efcd1170 | |
|
fef12e7dc3 | |
|
5ed61202ae | |
|
7b3de08425 | |
|
14ffa908e6 | |
|
c41592ba5f | |
|
c719de3088 | |
|
0e75f9941b | |
|
89c0872acd | |
|
f6ed021e60 | |
|
f7fedd9f85 | |
|
5911e38e09 | |
|
4c4d0118a6 | |
|
d25ac14e7d | |
|
d3b6816104 | |
|
a67cee3a98 | |
|
c3b0c9b4f5 | |
|
2be68b5e9e | |
|
b139300e7e | |
|
c86e139511 | |
|
9b9a3b48b1 | |
|
0feb1d9baf | |
|
648a7937c5 | |
|
24e57f1a77 | |
|
12f05f76ab | |
|
14d4b9bcc6 | |
|
92533fad9b | |
|
1f53b4e175 | |
|
74a35d55d5 | |
|
cbcc423cdf | |
|
858080fbab | |
|
db8608ed63 | |
|
331c520966 | |
|
5f48c62606 | |
|
b7c378d6bd | |
|
002647e9f8 | |
|
5105b61304 | |
|
43b2ef12b3 | |
|
056e9e6bfa | |
|
1837f62a5f | |
|
21ba5d23bb | |
|
7df1a82a31 | |
|
a4a54a4597 | |
|
65318c364a | |
|
130d340262 | |
|
855d1c6784 | |
|
82022eeb0d | |
|
4526456fa4 | |
|
737a765d89 | |
|
351d2776c6 | |
|
375474cd3c | |
|
fc1dee9921 | |
|
7f962d56e4 | |
|
f8dcfd6618 | |
|
7d383ba732 | |
|
f7fbc7da15 | |
|
8fd5aae061 | |
|
f728d3c50f | |
|
b5dec80529 | |
|
ab3b9743a7 | |
|
5dca985ff4 | |
|
e8837d5396 | |
|
f19cdfc9fe | |
|
4e56e1ee06 | |
|
307c9344b8 | |
|
413628c0f4 | |
|
4ae48e988c | |
|
2f7efa2451 | |
|
ce5c2b684b | |
|
89920137cd | |
|
4ed68e1bca | |
|
11a6452626 | |
|
c1ca192909 | |
|
34763e0df3 | |
|
1ee798c140 | |
|
838caeaac1 | |
|
975128c5e6 | |
|
882382d845 | |
|
f24f3ba986 | |
|
0e90845e22 | |
|
9e58631a03 | |
|
7a796b8f87 | |
|
a23f5db224 | |
|
a392378178 | |
|
81667ad920 | |
|
c740480fc1 | |
|
862e41010c | |
|
486eb6f08c | |
|
af4d8a66cf | |
|
78aedbf433 | |
|
95683d1a6c | |
|
0a3163c6c4 | |
|
37814a1755 | |
|
34b86428f4 | |
|
4f6e609334 | |
|
204612911e | |
|
6bfed73816 | |
|
c6ffad3f5c | |
|
b247874fc3 | |
|
945f91b9b9 | |
|
68bbf7ae46 | |
|
5ca0755b51 | |
|
b5eddf779a | |
|
e18a70d446 | |
|
f97607b898 | |
|
9f0f17fe64 | |
|
4c93d8f201 | |
|
4b2f4d2bcf | |
|
b3106d772c | |
|
437071b948 | |
|
02647d3471 | |
|
c5fc9d6b6b | |
|
75b9b6dfff | |
|
d099934742 | |
|
f36bfe3c33 | |
|
0291ba6dc2 | |
|
d2db48976a | |
|
f7b49d3ed7 | |
|
0ab3ce1249 | |
|
2b00d33aec | |
|
c029f419b8 | |
|
9acc22213e | |
|
1333b5d3bd | |
|
b747d7c5f8 | |
|
afd76b48e3 | |
|
181cea6eab | |
|
cf1284f8dd | |
|
66eef0ef3a | |
|
2fab6dffcf | |
|
b5ce165710 | |
|
c206b2e823 | |
|
1b73601ae8 | |
|
ba1076d8b3 | |
|
c31ea0312f |
|
@ -0,0 +1,12 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Verify that the code snippets in README.md are formatted.
|
||||||
|
# The tool https://github.com/hougesen/mdsf is used.
|
||||||
|
|
||||||
|
if [ -n "$(mdsf verify --config .mdsf.json --log-level error README.md 2>&1)" ]; then
|
||||||
|
echo "Go code in the README.md is not formatted."
|
||||||
|
echo "Did you forget to run 'mdsf format --config .mdsf.json README.md'?"
|
||||||
|
mdsf format --config .mdsf.json README.md
|
||||||
|
git diff
|
||||||
|
exit 1
|
||||||
|
fi
|
|
@ -0,0 +1,23 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Format to report a bug
|
||||||
|
title: ''
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- If this is a question, consider using the discussion section of this repo -->
|
||||||
|
<!-- Here: https://github.com/stretchr/testify/discussions/new?category=q-a -->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
<!-- A detailed description of the bug -->
|
||||||
|
|
||||||
|
## Step To Reproduce
|
||||||
|
<!-- Steps or code snippet to reproduce the behavior -->
|
||||||
|
|
||||||
|
## Expected behavior
|
||||||
|
<!-- A clear and concise description of what you expected to happen -->
|
||||||
|
|
||||||
|
## Actual behavior
|
||||||
|
<!-- What testify does -->
|
|
@ -0,0 +1,20 @@
|
||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Propose a new feature
|
||||||
|
title: ''
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- If this is a question, consider using the discussion section of this repo -->
|
||||||
|
<!-- Here: https://github.com/stretchr/testify/discussions/new?category=q-a -->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
<!-- A clear and concise description of what feature you are proposing -->
|
||||||
|
|
||||||
|
## Proposed solution
|
||||||
|
<!-- Optionally a suggested implementation -->
|
||||||
|
|
||||||
|
## Use case
|
||||||
|
<!-- What is the motivation? What workarounds have you used? -->
|
|
@ -6,14 +6,36 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
go_version: ["1.18.1", "1.17.6", "1.16.5"]
|
go_version:
|
||||||
|
- stable
|
||||||
|
- oldstable
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
- name: Setup Go
|
- name: Setup Go
|
||||||
uses: actions/setup-go@v3.2.0
|
uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: ${{ matrix.go_version }}
|
go-version: ${{ matrix.go_version }}
|
||||||
- run: ./.ci.gogenerate.sh
|
- run: npm install -g mdsf-cli
|
||||||
|
- run: ./.ci.gogenerate.sh
|
||||||
- run: ./.ci.gofmt.sh
|
- run: ./.ci.gofmt.sh
|
||||||
|
- run: ./.ci.readme.fmt.sh
|
||||||
- run: ./.ci.govet.sh
|
- run: ./.ci.govet.sh
|
||||||
- run: go test -v -race ./...
|
- run: go test -v -race ./...
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
go_version:
|
||||||
|
- "1.17"
|
||||||
|
- "1.18"
|
||||||
|
- "1.19"
|
||||||
|
- "1.20"
|
||||||
|
- "1.21"
|
||||||
|
- "1.22"
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Setup Go
|
||||||
|
uses: actions/setup-go@v5
|
||||||
|
with:
|
||||||
|
go-version: ${{ matrix.go_version }}
|
||||||
|
- run: go test -v -race ./...
|
||||||
|
|
|
@ -0,0 +1,21 @@
|
||||||
|
name: Create release from new tag
|
||||||
|
|
||||||
|
# this flow will be run only when new tags are pushed that match our pattern
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v[0-9]+.[0-9]+.[0-9]+"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Create GitHub release from tag
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
generate_release_notes: true
|
|
@ -22,3 +22,9 @@ _testmain.go
|
||||||
*.exe
|
*.exe
|
||||||
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|
||||||
|
# Output of "go test -c"
|
||||||
|
/assert/assert.test
|
||||||
|
/require/require.test
|
||||||
|
/suite/suite.test
|
||||||
|
/mock/mock.test
|
||||||
|
|
|
@ -0,0 +1,12 @@
|
||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/hougesen/mdsf/main/schemas/v0.8.2/mdsf.schema.json",
|
||||||
|
"format_finished_document": false,
|
||||||
|
"languages": {
|
||||||
|
"go": [
|
||||||
|
[
|
||||||
|
"gofmt",
|
||||||
|
"goimports"
|
||||||
|
]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,12 @@
|
||||||
|
# Emeritus
|
||||||
|
|
||||||
|
We would like to acknowledge previous testify maintainers and their huge contributions to our collective success:
|
||||||
|
|
||||||
|
* @matryer
|
||||||
|
* @glesica
|
||||||
|
* @ernesto-jimenez
|
||||||
|
* @mvdkleijn
|
||||||
|
* @georgelesica-wf
|
||||||
|
* @bencampbell-wf
|
||||||
|
|
||||||
|
We thank these members for their service to this community.
|
|
@ -3,7 +3,15 @@
|
||||||
The individuals listed below are active in the project and have the ability to approve and merge
|
The individuals listed below are active in the project and have the ability to approve and merge
|
||||||
pull requests.
|
pull requests.
|
||||||
|
|
||||||
* @glesica
|
|
||||||
* @boyan-soubachov
|
* @boyan-soubachov
|
||||||
* @mvdkleijn
|
* @dolmen
|
||||||
|
* @MovieStoreGuy
|
||||||
|
* @brackendawson
|
||||||
|
|
||||||
|
## Approvers
|
||||||
|
|
||||||
|
The individuals listed below are active in the project and have the ability to approve pull
|
||||||
|
requests.
|
||||||
|
|
||||||
|
* @arjunmahishi
|
||||||
|
* @ccoVeille
|
||||||
|
|
222
README.md
222
README.md
|
@ -1,9 +1,11 @@
|
||||||
Testify - Thou Shalt Write Tests
|
Testify - Thou Shalt Write Tests
|
||||||
================================
|
================================
|
||||||
|
|
||||||
ℹ️ We are working on testify v2 and would love to hear what you'd like to see in it, have your say here: https://cutt.ly/testify
|
> [!NOTE]
|
||||||
|
> Testify is being maintained at v1, no breaking changes will be accepted in this repo.
|
||||||
|
> [See discussion about v2](https://github.com/stretchr/testify/discussions/1560).
|
||||||
|
|
||||||
[](https://travis-ci.org/stretchr/testify) [](https://goreportcard.com/report/github.com/stretchr/testify) [](https://pkg.go.dev/github.com/stretchr/testify)
|
[](https://github.com/stretchr/testify/actions/workflows/main.yml) [](https://goreportcard.com/report/github.com/stretchr/testify) [](https://pkg.go.dev/github.com/stretchr/testify)
|
||||||
|
|
||||||
Go code (golang) set of packages that provide many tools for testifying that your code will behave as you intend.
|
Go code (golang) set of packages that provide many tools for testifying that your code will behave as you intend.
|
||||||
|
|
||||||
|
@ -16,14 +18,12 @@ Features include:
|
||||||
Get started:
|
Get started:
|
||||||
|
|
||||||
* Install testify with [one line of code](#installation), or [update it with another](#staying-up-to-date)
|
* Install testify with [one line of code](#installation), or [update it with another](#staying-up-to-date)
|
||||||
* For an introduction to writing test code in Go, see http://golang.org/doc/code.html#Testing
|
* For an introduction to writing test code in Go, see https://go.dev/doc/code#Testing
|
||||||
* Check out the API Documentation http://godoc.org/github.com/stretchr/testify
|
* Check out the API Documentation https://pkg.go.dev/github.com/stretchr/testify
|
||||||
* To make your testing life easier, check out our other project, [gorc](http://github.com/stretchr/gorc)
|
* Use [testifylint](https://github.com/Antonboom/testifylint) (via [golangci-lint](https://golangci-lint.run/)) to avoid common mistakes
|
||||||
* A little about [Test-Driven Development (TDD)](http://en.wikipedia.org/wiki/Test-driven_development)
|
* A little about [Test-Driven Development (TDD)](https://en.wikipedia.org/wiki/Test-driven_development)
|
||||||
|
|
||||||
|
[`assert`](https://pkg.go.dev/github.com/stretchr/testify/assert "API documentation") package
|
||||||
|
|
||||||
[`assert`](http://godoc.org/github.com/stretchr/testify/assert "API documentation") package
|
|
||||||
-------------------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
The `assert` package provides some helpful methods that allow you to write better test code in Go.
|
The `assert` package provides some helpful methods that allow you to write better test code in Go.
|
||||||
|
@ -38,30 +38,27 @@ See it in action:
|
||||||
package yours
|
package yours
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestSomething(t *testing.T) {
|
func TestSomething(t *testing.T) {
|
||||||
|
// assert equality
|
||||||
|
assert.Equal(t, 123, 123, "they should be equal")
|
||||||
|
|
||||||
// assert equality
|
// assert inequality
|
||||||
assert.Equal(t, 123, 123, "they should be equal")
|
assert.NotEqual(t, 123, 456, "they should not be equal")
|
||||||
|
|
||||||
// assert inequality
|
// assert for nil (good for errors)
|
||||||
assert.NotEqual(t, 123, 456, "they should not be equal")
|
assert.Nil(t, object)
|
||||||
|
|
||||||
// assert for nil (good for errors)
|
|
||||||
assert.Nil(t, object)
|
|
||||||
|
|
||||||
// assert for not nil (good when you expect something)
|
|
||||||
if assert.NotNil(t, object) {
|
|
||||||
|
|
||||||
// now we know that object isn't nil, we are safe to make
|
|
||||||
// further assertions without causing any errors
|
|
||||||
assert.Equal(t, "Something", object.Value)
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
|
// assert for not nil (good when you expect something)
|
||||||
|
if assert.NotNil(t, object) {
|
||||||
|
// now we know that object isn't nil, we are safe to make
|
||||||
|
// further assertions without causing any errors
|
||||||
|
assert.Equal(t, "Something", object.Value)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -74,52 +71,55 @@ if you assert many times, use the below:
|
||||||
package yours
|
package yours
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestSomething(t *testing.T) {
|
func TestSomething(t *testing.T) {
|
||||||
assert := assert.New(t)
|
assert := assert.New(t)
|
||||||
|
|
||||||
// assert equality
|
// assert equality
|
||||||
assert.Equal(123, 123, "they should be equal")
|
assert.Equal(123, 123, "they should be equal")
|
||||||
|
|
||||||
// assert inequality
|
// assert inequality
|
||||||
assert.NotEqual(123, 456, "they should not be equal")
|
assert.NotEqual(123, 456, "they should not be equal")
|
||||||
|
|
||||||
// assert for nil (good for errors)
|
// assert for nil (good for errors)
|
||||||
assert.Nil(object)
|
assert.Nil(object)
|
||||||
|
|
||||||
// assert for not nil (good when you expect something)
|
// assert for not nil (good when you expect something)
|
||||||
if assert.NotNil(object) {
|
if assert.NotNil(object) {
|
||||||
|
// now we know that object isn't nil, we are safe to make
|
||||||
// now we know that object isn't nil, we are safe to make
|
// further assertions without causing any errors
|
||||||
// further assertions without causing any errors
|
assert.Equal("Something", object.Value)
|
||||||
assert.Equal("Something", object.Value)
|
}
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
[`require`](http://godoc.org/github.com/stretchr/testify/require "API documentation") package
|
[`require`](https://pkg.go.dev/github.com/stretchr/testify/require "API documentation") package
|
||||||
---------------------------------------------------------------------------------------------
|
---------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
The `require` package provides same global functions as the `assert` package, but instead of returning a boolean result they terminate current test.
|
The `require` package provides same global functions as the `assert` package, but instead of returning a boolean result they terminate current test.
|
||||||
|
These functions must be called from the goroutine running the test or benchmark function, not from other goroutines created during the test.
|
||||||
|
Otherwise race conditions may occur.
|
||||||
|
|
||||||
See [t.FailNow](http://golang.org/pkg/testing/#T.FailNow) for details.
|
See [t.FailNow](https://pkg.go.dev/testing#T.FailNow) for details.
|
||||||
|
|
||||||
[`mock`](http://godoc.org/github.com/stretchr/testify/mock "API documentation") package
|
[`mock`](https://pkg.go.dev/github.com/stretchr/testify/mock "API documentation") package
|
||||||
----------------------------------------------------------------------------------------
|
----------------------------------------------------------------------------------------
|
||||||
|
|
||||||
The `mock` package provides a mechanism for easily writing mock objects that can be used in place of real objects when writing test code.
|
The `mock` package provides a mechanism for easily writing mock objects that can be used in place of real objects when writing test code.
|
||||||
|
|
||||||
An example test function that tests a piece of code that relies on an external object `testObj`, can setup expectations (testify) and assert that they indeed happened:
|
An example test function that tests a piece of code that relies on an external object `testObj`, can set up expectations (testify) and assert that they indeed happened:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package yours
|
package yours
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
"github.com/stretchr/testify/mock"
|
|
||||||
|
"github.com/stretchr/testify/mock"
|
||||||
)
|
)
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
@ -128,8 +128,8 @@ import (
|
||||||
|
|
||||||
// MyMockedObject is a mocked object that implements an interface
|
// MyMockedObject is a mocked object that implements an interface
|
||||||
// that describes an object that the code I am testing relies on.
|
// that describes an object that the code I am testing relies on.
|
||||||
type MyMockedObject struct{
|
type MyMockedObject struct {
|
||||||
mock.Mock
|
mock.Mock
|
||||||
}
|
}
|
||||||
|
|
||||||
// DoSomething is a method on MyMockedObject that implements some interface
|
// DoSomething is a method on MyMockedObject that implements some interface
|
||||||
|
@ -140,10 +140,8 @@ type MyMockedObject struct{
|
||||||
//
|
//
|
||||||
// NOTE: This method is not being tested here, code that uses this object is.
|
// NOTE: This method is not being tested here, code that uses this object is.
|
||||||
func (m *MyMockedObject) DoSomething(number int) (bool, error) {
|
func (m *MyMockedObject) DoSomething(number int) (bool, error) {
|
||||||
|
args := m.Called(number)
|
||||||
args := m.Called(number)
|
return args.Bool(0), args.Error(1)
|
||||||
return args.Bool(0), args.Error(1)
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
@ -153,20 +151,17 @@ func (m *MyMockedObject) DoSomething(number int) (bool, error) {
|
||||||
// TestSomething is an example of how to use our test object to
|
// TestSomething is an example of how to use our test object to
|
||||||
// make assertions about some target code we are testing.
|
// make assertions about some target code we are testing.
|
||||||
func TestSomething(t *testing.T) {
|
func TestSomething(t *testing.T) {
|
||||||
|
// create an instance of our test object
|
||||||
|
testObj := new(MyMockedObject)
|
||||||
|
|
||||||
// create an instance of our test object
|
// set up expectations
|
||||||
testObj := new(MyMockedObject)
|
testObj.On("DoSomething", 123).Return(true, nil)
|
||||||
|
|
||||||
// setup expectations
|
|
||||||
testObj.On("DoSomething", 123).Return(true, nil)
|
|
||||||
|
|
||||||
// call the code we are testing
|
|
||||||
targetFuncThatDoesSomethingWithObj(testObj)
|
|
||||||
|
|
||||||
// assert that the expectations were met
|
|
||||||
testObj.AssertExpectations(t)
|
|
||||||
|
|
||||||
|
// call the code we are testing
|
||||||
|
targetFuncThatDoesSomethingWithObj(testObj)
|
||||||
|
|
||||||
|
// assert that the expectations were met
|
||||||
|
testObj.AssertExpectations(t)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestSomethingWithPlaceholder is a second example of how to use our test object to
|
// TestSomethingWithPlaceholder is a second example of how to use our test object to
|
||||||
|
@ -175,105 +170,131 @@ func TestSomething(t *testing.T) {
|
||||||
// data being passed in is normally dynamically generated and cannot be
|
// data being passed in is normally dynamically generated and cannot be
|
||||||
// predicted beforehand (eg. containing hashes that are time sensitive)
|
// predicted beforehand (eg. containing hashes that are time sensitive)
|
||||||
func TestSomethingWithPlaceholder(t *testing.T) {
|
func TestSomethingWithPlaceholder(t *testing.T) {
|
||||||
|
// create an instance of our test object
|
||||||
|
testObj := new(MyMockedObject)
|
||||||
|
|
||||||
// create an instance of our test object
|
// set up expectations with a placeholder in the argument list
|
||||||
testObj := new(MyMockedObject)
|
testObj.On("DoSomething", mock.Anything).Return(true, nil)
|
||||||
|
|
||||||
// setup expectations with a placeholder in the argument list
|
// call the code we are testing
|
||||||
testObj.On("DoSomething", mock.Anything).Return(true, nil)
|
targetFuncThatDoesSomethingWithObj(testObj)
|
||||||
|
|
||||||
// call the code we are testing
|
// assert that the expectations were met
|
||||||
targetFuncThatDoesSomethingWithObj(testObj)
|
testObj.AssertExpectations(t)
|
||||||
|
|
||||||
// assert that the expectations were met
|
}
|
||||||
testObj.AssertExpectations(t)
|
|
||||||
|
|
||||||
|
// TestSomethingElse2 is a third example that shows how you can use
|
||||||
|
// the Unset method to cleanup handlers and then add new ones.
|
||||||
|
func TestSomethingElse2(t *testing.T) {
|
||||||
|
// create an instance of our test object
|
||||||
|
testObj := new(MyMockedObject)
|
||||||
|
|
||||||
|
// set up expectations with a placeholder in the argument list
|
||||||
|
mockCall := testObj.On("DoSomething", mock.Anything).Return(true, nil)
|
||||||
|
|
||||||
|
// call the code we are testing
|
||||||
|
targetFuncThatDoesSomethingWithObj(testObj)
|
||||||
|
|
||||||
|
// assert that the expectations were met
|
||||||
|
testObj.AssertExpectations(t)
|
||||||
|
|
||||||
|
// remove the handler now so we can add another one that takes precedence
|
||||||
|
mockCall.Unset()
|
||||||
|
|
||||||
|
// return false now instead of true
|
||||||
|
testObj.On("DoSomething", mock.Anything).Return(false, nil)
|
||||||
|
|
||||||
|
testObj.AssertExpectations(t)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information on how to write mock code, check out the [API documentation for the `mock` package](http://godoc.org/github.com/stretchr/testify/mock).
|
For more information on how to write mock code, check out the [API documentation for the `mock` package](https://pkg.go.dev/github.com/stretchr/testify/mock).
|
||||||
|
|
||||||
You can use the [mockery tool](http://github.com/vektra/mockery) to autogenerate the mock code against an interface as well, making using mocks much quicker.
|
You can use the [mockery tool](https://vektra.github.io/mockery/latest/) to autogenerate the mock code against an interface as well, making using mocks much quicker.
|
||||||
|
|
||||||
[`suite`](http://godoc.org/github.com/stretchr/testify/suite "API documentation") package
|
[`suite`](https://pkg.go.dev/github.com/stretchr/testify/suite "API documentation") package
|
||||||
-----------------------------------------------------------------------------------------
|
-----------------------------------------------------------------------------------------
|
||||||
|
> [!WARNING]
|
||||||
|
> The suite package does not support parallel tests. See [#934](https://github.com/stretchr/testify/issues/934).
|
||||||
|
|
||||||
The `suite` package provides functionality that you might be used to from more common object oriented languages. With it, you can build a testing suite as a struct, build setup/teardown methods and testing methods on your struct, and run them with 'go test' as per normal.
|
The `suite` package provides functionality that you might be used to from more common object-oriented languages. With it, you can build a testing suite as a struct, build setup/teardown methods and testing methods on your struct, and run them with 'go test' as per normal.
|
||||||
|
|
||||||
An example suite is shown below:
|
An example suite is shown below:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// Basic imports
|
// Basic imports
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/suite"
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/suite"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Define the suite, and absorb the built-in basic suite
|
// Define the suite, and absorb the built-in basic suite
|
||||||
// functionality from testify - including a T() method which
|
// functionality from testify - including a T() method which
|
||||||
// returns the current testing context
|
// returns the current testing context
|
||||||
type ExampleTestSuite struct {
|
type ExampleTestSuite struct {
|
||||||
suite.Suite
|
suite.Suite
|
||||||
VariableThatShouldStartAtFive int
|
VariableThatShouldStartAtFive int
|
||||||
}
|
}
|
||||||
|
|
||||||
// Make sure that VariableThatShouldStartAtFive is set to five
|
// Make sure that VariableThatShouldStartAtFive is set to five
|
||||||
// before each test
|
// before each test
|
||||||
func (suite *ExampleTestSuite) SetupTest() {
|
func (suite *ExampleTestSuite) SetupTest() {
|
||||||
suite.VariableThatShouldStartAtFive = 5
|
suite.VariableThatShouldStartAtFive = 5
|
||||||
}
|
}
|
||||||
|
|
||||||
// All methods that begin with "Test" are run as tests within a
|
// All methods that begin with "Test" are run as tests within a
|
||||||
// suite.
|
// suite.
|
||||||
func (suite *ExampleTestSuite) TestExample() {
|
func (suite *ExampleTestSuite) TestExample() {
|
||||||
assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
|
assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
|
||||||
}
|
}
|
||||||
|
|
||||||
// In order for 'go test' to run this suite, we need to create
|
// In order for 'go test' to run this suite, we need to create
|
||||||
// a normal test function and pass our suite to suite.Run
|
// a normal test function and pass our suite to suite.Run
|
||||||
func TestExampleTestSuite(t *testing.T) {
|
func TestExampleTestSuite(t *testing.T) {
|
||||||
suite.Run(t, new(ExampleTestSuite))
|
suite.Run(t, new(ExampleTestSuite))
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
For a more complete example, using all of the functionality provided by the suite package, look at our [example testing suite](https://github.com/stretchr/testify/blob/master/suite/suite_test.go)
|
For a more complete example, using all of the functionality provided by the suite package, look at our [example testing suite](https://github.com/stretchr/testify/blob/master/suite/suite_test.go)
|
||||||
|
|
||||||
For more information on writing suites, check out the [API documentation for the `suite` package](http://godoc.org/github.com/stretchr/testify/suite).
|
For more information on writing suites, check out the [API documentation for the `suite` package](https://pkg.go.dev/github.com/stretchr/testify/suite).
|
||||||
|
|
||||||
`Suite` object has assertion methods:
|
`Suite` object has assertion methods:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// Basic imports
|
// Basic imports
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
"github.com/stretchr/testify/suite"
|
|
||||||
|
"github.com/stretchr/testify/suite"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Define the suite, and absorb the built-in basic suite
|
// Define the suite, and absorb the built-in basic suite
|
||||||
// functionality from testify - including assertion methods.
|
// functionality from testify - including assertion methods.
|
||||||
type ExampleTestSuite struct {
|
type ExampleTestSuite struct {
|
||||||
suite.Suite
|
suite.Suite
|
||||||
VariableThatShouldStartAtFive int
|
VariableThatShouldStartAtFive int
|
||||||
}
|
}
|
||||||
|
|
||||||
// Make sure that VariableThatShouldStartAtFive is set to five
|
// Make sure that VariableThatShouldStartAtFive is set to five
|
||||||
// before each test
|
// before each test
|
||||||
func (suite *ExampleTestSuite) SetupTest() {
|
func (suite *ExampleTestSuite) SetupTest() {
|
||||||
suite.VariableThatShouldStartAtFive = 5
|
suite.VariableThatShouldStartAtFive = 5
|
||||||
}
|
}
|
||||||
|
|
||||||
// All methods that begin with "Test" are run as tests within a
|
// All methods that begin with "Test" are run as tests within a
|
||||||
// suite.
|
// suite.
|
||||||
func (suite *ExampleTestSuite) TestExample() {
|
func (suite *ExampleTestSuite) TestExample() {
|
||||||
suite.Equal(suite.VariableThatShouldStartAtFive, 5)
|
suite.Equal(suite.VariableThatShouldStartAtFive, 5)
|
||||||
}
|
}
|
||||||
|
|
||||||
// In order for 'go test' to run this suite, we need to create
|
// In order for 'go test' to run this suite, we need to create
|
||||||
// a normal test function and pass our suite to suite.Run
|
// a normal test function and pass our suite to suite.Run
|
||||||
func TestExampleTestSuite(t *testing.T) {
|
func TestExampleTestSuite(t *testing.T) {
|
||||||
suite.Run(t, new(ExampleTestSuite))
|
suite.Run(t, new(ExampleTestSuite))
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -300,14 +321,13 @@ Import the `testify/assert` package into your code using this template:
|
||||||
package yours
|
package yours
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"testing"
|
"testing"
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestSomething(t *testing.T) {
|
func TestSomething(t *testing.T) {
|
||||||
|
assert.True(t, true, "True is true!")
|
||||||
assert.True(t, true, "True is true!")
|
|
||||||
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -323,7 +343,7 @@ To update Testify to the latest version, use `go get -u github.com/stretchr/test
|
||||||
Supported go versions
|
Supported go versions
|
||||||
==================
|
==================
|
||||||
|
|
||||||
We currently support the most recent major Go versions from 1.13 onward.
|
We currently support the most recent major Go versions from 1.19 onward.
|
||||||
|
|
||||||
------
|
------
|
||||||
|
|
||||||
|
@ -334,7 +354,7 @@ Please feel free to submit issues, fork the repository and send pull requests!
|
||||||
|
|
||||||
When submitting an issue, we ask that you please include a complete test function that demonstrates the issue. Extra credit for those using Testify to write the test code that demonstrates it.
|
When submitting an issue, we ask that you please include a complete test function that demonstrates the issue. Extra credit for those using Testify to write the test code that demonstrates it.
|
||||||
|
|
||||||
Code generation is used. Look for `CODE GENERATED AUTOMATICALLY` at the top of some files. Run `go generate ./...` to update generated files.
|
Code generation is used. [Look for `Code generated with`](https://github.com/search?q=repo%3Astretchr%2Ftestify%20%22Code%20generated%20with%22&type=code) at the top of some files. Run `go generate ./...` to update generated files.
|
||||||
|
|
||||||
We also chat on the [Gophers Slack](https://gophers.slack.com) group in the `#testify` and `#testify-dev` channels.
|
We also chat on the [Gophers Slack](https://gophers.slack.com) group in the `#testify` and `#testify-dev` channels.
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,6 @@ import (
|
||||||
"go/token"
|
"go/token"
|
||||||
"go/types"
|
"go/types"
|
||||||
"io"
|
"io"
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
|
@ -101,13 +100,15 @@ func parseTemplates() (*template.Template, *template.Template, error) {
|
||||||
return nil, nil, err
|
return nil, nil, err
|
||||||
}
|
}
|
||||||
if *tmplFile != "" {
|
if *tmplFile != "" {
|
||||||
f, err := ioutil.ReadFile(*tmplFile)
|
f, err := os.ReadFile(*tmplFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, nil, err
|
return nil, nil, err
|
||||||
}
|
}
|
||||||
funcTemplate = string(f)
|
funcTemplate = string(f)
|
||||||
}
|
}
|
||||||
tmpl, err := template.New("function").Parse(funcTemplate)
|
tmpl, err := template.New("function").Funcs(template.FuncMap{
|
||||||
|
"replace": strings.ReplaceAll,
|
||||||
|
}).Parse(funcTemplate)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, nil, err
|
return nil, nil, err
|
||||||
}
|
}
|
||||||
|
@ -181,7 +182,7 @@ func parsePackageSource(pkg string) (*types.Scope, *doc.Package, error) {
|
||||||
files := make(map[string]*ast.File)
|
files := make(map[string]*ast.File)
|
||||||
fileList := make([]*ast.File, len(pd.GoFiles))
|
fileList := make([]*ast.File, len(pd.GoFiles))
|
||||||
for i, fname := range pd.GoFiles {
|
for i, fname := range pd.GoFiles {
|
||||||
src, err := ioutil.ReadFile(path.Join(pd.Dir, fname))
|
src, err := os.ReadFile(path.Join(pd.Dir, fname))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, nil, err
|
return nil, nil, err
|
||||||
}
|
}
|
||||||
|
@ -297,10 +298,8 @@ func (f *testFunc) CommentWithoutT(receiver string) string {
|
||||||
return strings.Replace(f.Comment(), search, replace, -1)
|
return strings.Replace(f.Comment(), search, replace, -1)
|
||||||
}
|
}
|
||||||
|
|
||||||
var headerTemplate = `/*
|
// Standard header https://go.dev/s/generatedcode.
|
||||||
* CODE GENERATED AUTOMATICALLY WITH github.com/stretchr/testify/_codegen
|
var headerTemplate = `// Code generated with github.com/stretchr/testify/_codegen; DO NOT EDIT.
|
||||||
* THIS FILE MUST NOT BE EDITED BY HAND
|
|
||||||
*/
|
|
||||||
|
|
||||||
package {{.Name}}
|
package {{.Name}}
|
||||||
|
|
||||||
|
|
|
@ -1,15 +1,19 @@
|
||||||
package assert
|
package assert
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"fmt"
|
"fmt"
|
||||||
"reflect"
|
"reflect"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
type CompareType int
|
// Deprecated: CompareType has only ever been for internal use and has accidentally been published since v1.6.0. Do not use it.
|
||||||
|
type CompareType = compareResult
|
||||||
|
|
||||||
|
type compareResult int
|
||||||
|
|
||||||
const (
|
const (
|
||||||
compareLess CompareType = iota - 1
|
compareLess compareResult = iota - 1
|
||||||
compareEqual
|
compareEqual
|
||||||
compareGreater
|
compareGreater
|
||||||
)
|
)
|
||||||
|
@ -27,15 +31,18 @@ var (
|
||||||
uint32Type = reflect.TypeOf(uint32(1))
|
uint32Type = reflect.TypeOf(uint32(1))
|
||||||
uint64Type = reflect.TypeOf(uint64(1))
|
uint64Type = reflect.TypeOf(uint64(1))
|
||||||
|
|
||||||
|
uintptrType = reflect.TypeOf(uintptr(1))
|
||||||
|
|
||||||
float32Type = reflect.TypeOf(float32(1))
|
float32Type = reflect.TypeOf(float32(1))
|
||||||
float64Type = reflect.TypeOf(float64(1))
|
float64Type = reflect.TypeOf(float64(1))
|
||||||
|
|
||||||
stringType = reflect.TypeOf("")
|
stringType = reflect.TypeOf("")
|
||||||
|
|
||||||
timeType = reflect.TypeOf(time.Time{})
|
timeType = reflect.TypeOf(time.Time{})
|
||||||
|
bytesType = reflect.TypeOf([]byte{})
|
||||||
)
|
)
|
||||||
|
|
||||||
func compare(obj1, obj2 interface{}, kind reflect.Kind) (CompareType, bool) {
|
func compare(obj1, obj2 interface{}, kind reflect.Kind) (compareResult, bool) {
|
||||||
obj1Value := reflect.ValueOf(obj1)
|
obj1Value := reflect.ValueOf(obj1)
|
||||||
obj2Value := reflect.ValueOf(obj2)
|
obj2Value := reflect.ValueOf(obj2)
|
||||||
|
|
||||||
|
@ -306,11 +313,11 @@ func compare(obj1, obj2 interface{}, kind reflect.Kind) (CompareType, bool) {
|
||||||
case reflect.Struct:
|
case reflect.Struct:
|
||||||
{
|
{
|
||||||
// All structs enter here. We're not interested in most types.
|
// All structs enter here. We're not interested in most types.
|
||||||
if !canConvert(obj1Value, timeType) {
|
if !obj1Value.CanConvert(timeType) {
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
// time.Time can compared!
|
// time.Time can be compared!
|
||||||
timeObj1, ok := obj1.(time.Time)
|
timeObj1, ok := obj1.(time.Time)
|
||||||
if !ok {
|
if !ok {
|
||||||
timeObj1 = obj1Value.Convert(timeType).Interface().(time.Time)
|
timeObj1 = obj1Value.Convert(timeType).Interface().(time.Time)
|
||||||
|
@ -321,7 +328,53 @@ func compare(obj1, obj2 interface{}, kind reflect.Kind) (CompareType, bool) {
|
||||||
timeObj2 = obj2Value.Convert(timeType).Interface().(time.Time)
|
timeObj2 = obj2Value.Convert(timeType).Interface().(time.Time)
|
||||||
}
|
}
|
||||||
|
|
||||||
return compare(timeObj1.UnixNano(), timeObj2.UnixNano(), reflect.Int64)
|
if timeObj1.Before(timeObj2) {
|
||||||
|
return compareLess, true
|
||||||
|
}
|
||||||
|
if timeObj1.Equal(timeObj2) {
|
||||||
|
return compareEqual, true
|
||||||
|
}
|
||||||
|
return compareGreater, true
|
||||||
|
}
|
||||||
|
case reflect.Slice:
|
||||||
|
{
|
||||||
|
// We only care about the []byte type.
|
||||||
|
if !obj1Value.CanConvert(bytesType) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
// []byte can be compared!
|
||||||
|
bytesObj1, ok := obj1.([]byte)
|
||||||
|
if !ok {
|
||||||
|
bytesObj1 = obj1Value.Convert(bytesType).Interface().([]byte)
|
||||||
|
|
||||||
|
}
|
||||||
|
bytesObj2, ok := obj2.([]byte)
|
||||||
|
if !ok {
|
||||||
|
bytesObj2 = obj2Value.Convert(bytesType).Interface().([]byte)
|
||||||
|
}
|
||||||
|
|
||||||
|
return compareResult(bytes.Compare(bytesObj1, bytesObj2)), true
|
||||||
|
}
|
||||||
|
case reflect.Uintptr:
|
||||||
|
{
|
||||||
|
uintptrObj1, ok := obj1.(uintptr)
|
||||||
|
if !ok {
|
||||||
|
uintptrObj1 = obj1Value.Convert(uintptrType).Interface().(uintptr)
|
||||||
|
}
|
||||||
|
uintptrObj2, ok := obj2.(uintptr)
|
||||||
|
if !ok {
|
||||||
|
uintptrObj2 = obj2Value.Convert(uintptrType).Interface().(uintptr)
|
||||||
|
}
|
||||||
|
if uintptrObj1 > uintptrObj2 {
|
||||||
|
return compareGreater, true
|
||||||
|
}
|
||||||
|
if uintptrObj1 == uintptrObj2 {
|
||||||
|
return compareEqual, true
|
||||||
|
}
|
||||||
|
if uintptrObj1 < uintptrObj2 {
|
||||||
|
return compareLess, true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -330,79 +383,85 @@ func compare(obj1, obj2 interface{}, kind reflect.Kind) (CompareType, bool) {
|
||||||
|
|
||||||
// Greater asserts that the first element is greater than the second
|
// Greater asserts that the first element is greater than the second
|
||||||
//
|
//
|
||||||
// assert.Greater(t, 2, 1)
|
// assert.Greater(t, 2, 1)
|
||||||
// assert.Greater(t, float64(2), float64(1))
|
// assert.Greater(t, float64(2), float64(1))
|
||||||
// assert.Greater(t, "b", "a")
|
// assert.Greater(t, "b", "a")
|
||||||
func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
func Greater(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
return compareTwoValues(t, e1, e2, []CompareType{compareGreater}, "\"%v\" is not greater than \"%v\"", msgAndArgs...)
|
failMessage := fmt.Sprintf("\"%v\" is not greater than \"%v\"", e1, e2)
|
||||||
|
return compareTwoValues(t, e1, e2, []compareResult{compareGreater}, failMessage, msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// GreaterOrEqual asserts that the first element is greater than or equal to the second
|
// GreaterOrEqual asserts that the first element is greater than or equal to the second
|
||||||
//
|
//
|
||||||
// assert.GreaterOrEqual(t, 2, 1)
|
// assert.GreaterOrEqual(t, 2, 1)
|
||||||
// assert.GreaterOrEqual(t, 2, 2)
|
// assert.GreaterOrEqual(t, 2, 2)
|
||||||
// assert.GreaterOrEqual(t, "b", "a")
|
// assert.GreaterOrEqual(t, "b", "a")
|
||||||
// assert.GreaterOrEqual(t, "b", "b")
|
// assert.GreaterOrEqual(t, "b", "b")
|
||||||
func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
func GreaterOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
return compareTwoValues(t, e1, e2, []CompareType{compareGreater, compareEqual}, "\"%v\" is not greater than or equal to \"%v\"", msgAndArgs...)
|
failMessage := fmt.Sprintf("\"%v\" is not greater than or equal to \"%v\"", e1, e2)
|
||||||
|
return compareTwoValues(t, e1, e2, []compareResult{compareGreater, compareEqual}, failMessage, msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Less asserts that the first element is less than the second
|
// Less asserts that the first element is less than the second
|
||||||
//
|
//
|
||||||
// assert.Less(t, 1, 2)
|
// assert.Less(t, 1, 2)
|
||||||
// assert.Less(t, float64(1), float64(2))
|
// assert.Less(t, float64(1), float64(2))
|
||||||
// assert.Less(t, "a", "b")
|
// assert.Less(t, "a", "b")
|
||||||
func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
func Less(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
return compareTwoValues(t, e1, e2, []CompareType{compareLess}, "\"%v\" is not less than \"%v\"", msgAndArgs...)
|
failMessage := fmt.Sprintf("\"%v\" is not less than \"%v\"", e1, e2)
|
||||||
|
return compareTwoValues(t, e1, e2, []compareResult{compareLess}, failMessage, msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// LessOrEqual asserts that the first element is less than or equal to the second
|
// LessOrEqual asserts that the first element is less than or equal to the second
|
||||||
//
|
//
|
||||||
// assert.LessOrEqual(t, 1, 2)
|
// assert.LessOrEqual(t, 1, 2)
|
||||||
// assert.LessOrEqual(t, 2, 2)
|
// assert.LessOrEqual(t, 2, 2)
|
||||||
// assert.LessOrEqual(t, "a", "b")
|
// assert.LessOrEqual(t, "a", "b")
|
||||||
// assert.LessOrEqual(t, "b", "b")
|
// assert.LessOrEqual(t, "b", "b")
|
||||||
func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
func LessOrEqual(t TestingT, e1 interface{}, e2 interface{}, msgAndArgs ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
return compareTwoValues(t, e1, e2, []CompareType{compareLess, compareEqual}, "\"%v\" is not less than or equal to \"%v\"", msgAndArgs...)
|
failMessage := fmt.Sprintf("\"%v\" is not less than or equal to \"%v\"", e1, e2)
|
||||||
|
return compareTwoValues(t, e1, e2, []compareResult{compareLess, compareEqual}, failMessage, msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Positive asserts that the specified element is positive
|
// Positive asserts that the specified element is positive
|
||||||
//
|
//
|
||||||
// assert.Positive(t, 1)
|
// assert.Positive(t, 1)
|
||||||
// assert.Positive(t, 1.23)
|
// assert.Positive(t, 1.23)
|
||||||
func Positive(t TestingT, e interface{}, msgAndArgs ...interface{}) bool {
|
func Positive(t TestingT, e interface{}, msgAndArgs ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
zero := reflect.Zero(reflect.TypeOf(e))
|
zero := reflect.Zero(reflect.TypeOf(e))
|
||||||
return compareTwoValues(t, e, zero.Interface(), []CompareType{compareGreater}, "\"%v\" is not positive", msgAndArgs...)
|
failMessage := fmt.Sprintf("\"%v\" is not positive", e)
|
||||||
|
return compareTwoValues(t, e, zero.Interface(), []compareResult{compareGreater}, failMessage, msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Negative asserts that the specified element is negative
|
// Negative asserts that the specified element is negative
|
||||||
//
|
//
|
||||||
// assert.Negative(t, -1)
|
// assert.Negative(t, -1)
|
||||||
// assert.Negative(t, -1.23)
|
// assert.Negative(t, -1.23)
|
||||||
func Negative(t TestingT, e interface{}, msgAndArgs ...interface{}) bool {
|
func Negative(t TestingT, e interface{}, msgAndArgs ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
zero := reflect.Zero(reflect.TypeOf(e))
|
zero := reflect.Zero(reflect.TypeOf(e))
|
||||||
return compareTwoValues(t, e, zero.Interface(), []CompareType{compareLess}, "\"%v\" is not negative", msgAndArgs...)
|
failMessage := fmt.Sprintf("\"%v\" is not negative", e)
|
||||||
|
return compareTwoValues(t, e, zero.Interface(), []compareResult{compareLess}, failMessage, msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func compareTwoValues(t TestingT, e1 interface{}, e2 interface{}, allowedComparesResults []CompareType, failMessage string, msgAndArgs ...interface{}) bool {
|
func compareTwoValues(t TestingT, e1 interface{}, e2 interface{}, allowedComparesResults []compareResult, failMessage string, msgAndArgs ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
|
@ -415,17 +474,17 @@ func compareTwoValues(t TestingT, e1 interface{}, e2 interface{}, allowedCompare
|
||||||
|
|
||||||
compareResult, isComparable := compare(e1, e2, e1Kind)
|
compareResult, isComparable := compare(e1, e2, e1Kind)
|
||||||
if !isComparable {
|
if !isComparable {
|
||||||
return Fail(t, fmt.Sprintf("Can not compare type \"%s\"", reflect.TypeOf(e1)), msgAndArgs...)
|
return Fail(t, fmt.Sprintf(`Can not compare type "%T"`, e1), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !containsValue(allowedComparesResults, compareResult) {
|
if !containsValue(allowedComparesResults, compareResult) {
|
||||||
return Fail(t, fmt.Sprintf(failMessage, e1, e2), msgAndArgs...)
|
return Fail(t, failMessage, msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func containsValue(values []CompareType, value CompareType) bool {
|
func containsValue(values []compareResult, value compareResult) bool {
|
||||||
for _, v := range values {
|
for _, v := range values {
|
||||||
if v == value {
|
if v == value {
|
||||||
return true
|
return true
|
||||||
|
|
|
@ -1,16 +0,0 @@
|
||||||
//go:build go1.17
|
|
||||||
// +build go1.17
|
|
||||||
|
|
||||||
// TODO: once support for Go 1.16 is dropped, this file can be
|
|
||||||
// merged/removed with assertion_compare_go1.17_test.go and
|
|
||||||
// assertion_compare_legacy.go
|
|
||||||
|
|
||||||
package assert
|
|
||||||
|
|
||||||
import "reflect"
|
|
||||||
|
|
||||||
// Wrapper around reflect.Value.CanConvert, for compatibility
|
|
||||||
// reasons.
|
|
||||||
func canConvert(value reflect.Value, to reflect.Type) bool {
|
|
||||||
return value.CanConvert(to)
|
|
||||||
}
|
|
|
@ -1,54 +0,0 @@
|
||||||
//go:build go1.17
|
|
||||||
// +build go1.17
|
|
||||||
|
|
||||||
// TODO: once support for Go 1.16 is dropped, this file can be
|
|
||||||
// merged/removed with assertion_compare_can_convert.go and
|
|
||||||
// assertion_compare_legacy.go
|
|
||||||
|
|
||||||
package assert
|
|
||||||
|
|
||||||
import (
|
|
||||||
"reflect"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestCompare17(t *testing.T) {
|
|
||||||
type customTime time.Time
|
|
||||||
for _, currCase := range []struct {
|
|
||||||
less interface{}
|
|
||||||
greater interface{}
|
|
||||||
cType string
|
|
||||||
}{
|
|
||||||
{less: time.Now(), greater: time.Now().Add(time.Hour), cType: "time.Time"},
|
|
||||||
{less: customTime(time.Now()), greater: customTime(time.Now().Add(time.Hour)), cType: "time.Time"},
|
|
||||||
} {
|
|
||||||
resLess, isComparable := compare(currCase.less, currCase.greater, reflect.ValueOf(currCase.less).Kind())
|
|
||||||
if !isComparable {
|
|
||||||
t.Error("object should be comparable for type " + currCase.cType)
|
|
||||||
}
|
|
||||||
|
|
||||||
if resLess != compareLess {
|
|
||||||
t.Errorf("object less (%v) should be less than greater (%v) for type "+currCase.cType,
|
|
||||||
currCase.less, currCase.greater)
|
|
||||||
}
|
|
||||||
|
|
||||||
resGreater, isComparable := compare(currCase.greater, currCase.less, reflect.ValueOf(currCase.less).Kind())
|
|
||||||
if !isComparable {
|
|
||||||
t.Error("object are comparable for type " + currCase.cType)
|
|
||||||
}
|
|
||||||
|
|
||||||
if resGreater != compareGreater {
|
|
||||||
t.Errorf("object greater should be greater than less for type " + currCase.cType)
|
|
||||||
}
|
|
||||||
|
|
||||||
resEqual, isComparable := compare(currCase.less, currCase.less, reflect.ValueOf(currCase.less).Kind())
|
|
||||||
if !isComparable {
|
|
||||||
t.Error("object are comparable for type " + currCase.cType)
|
|
||||||
}
|
|
||||||
|
|
||||||
if resEqual != 0 {
|
|
||||||
t.Errorf("objects should be equal for type " + currCase.cType)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
|
@ -1,16 +0,0 @@
|
||||||
//go:build !go1.17
|
|
||||||
// +build !go1.17
|
|
||||||
|
|
||||||
// TODO: once support for Go 1.16 is dropped, this file can be
|
|
||||||
// merged/removed with assertion_compare_go1.17_test.go and
|
|
||||||
// assertion_compare_can_convert.go
|
|
||||||
|
|
||||||
package assert
|
|
||||||
|
|
||||||
import "reflect"
|
|
||||||
|
|
||||||
// Older versions of Go does not have the reflect.Value.CanConvert
|
|
||||||
// method.
|
|
||||||
func canConvert(value reflect.Value, to reflect.Type) bool {
|
|
||||||
return false
|
|
||||||
}
|
|
|
@ -6,9 +6,11 @@ import (
|
||||||
"reflect"
|
"reflect"
|
||||||
"runtime"
|
"runtime"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestCompare(t *testing.T) {
|
func TestCompare(t *testing.T) {
|
||||||
|
type customString string
|
||||||
type customInt int
|
type customInt int
|
||||||
type customInt8 int8
|
type customInt8 int8
|
||||||
type customInt16 int16
|
type customInt16 int16
|
||||||
|
@ -21,7 +23,9 @@ func TestCompare(t *testing.T) {
|
||||||
type customUInt64 uint64
|
type customUInt64 uint64
|
||||||
type customFloat32 float32
|
type customFloat32 float32
|
||||||
type customFloat64 float64
|
type customFloat64 float64
|
||||||
type customString string
|
type customUintptr uintptr
|
||||||
|
type customTime time.Time
|
||||||
|
type customBytes []byte
|
||||||
for _, currCase := range []struct {
|
for _, currCase := range []struct {
|
||||||
less interface{}
|
less interface{}
|
||||||
greater interface{}
|
greater interface{}
|
||||||
|
@ -52,6 +56,13 @@ func TestCompare(t *testing.T) {
|
||||||
{less: customFloat32(1.23), greater: customFloat32(2.23), cType: "float32"},
|
{less: customFloat32(1.23), greater: customFloat32(2.23), cType: "float32"},
|
||||||
{less: float64(1.23), greater: float64(2.34), cType: "float64"},
|
{less: float64(1.23), greater: float64(2.34), cType: "float64"},
|
||||||
{less: customFloat64(1.23), greater: customFloat64(2.34), cType: "float64"},
|
{less: customFloat64(1.23), greater: customFloat64(2.34), cType: "float64"},
|
||||||
|
{less: uintptr(1), greater: uintptr(2), cType: "uintptr"},
|
||||||
|
{less: customUintptr(1), greater: customUintptr(2), cType: "uint64"},
|
||||||
|
{less: time.Now(), greater: time.Now().Add(time.Hour), cType: "time.Time"},
|
||||||
|
{less: time.Date(2024, 0, 0, 0, 0, 0, 0, time.Local), greater: time.Date(2263, 0, 0, 0, 0, 0, 0, time.Local), cType: "time.Time"},
|
||||||
|
{less: customTime(time.Now()), greater: customTime(time.Now().Add(time.Hour)), cType: "time.Time"},
|
||||||
|
{less: []byte{1, 1}, greater: []byte{1, 2}, cType: "[]byte"},
|
||||||
|
{less: customBytes([]byte{1, 1}), greater: customBytes([]byte{1, 2}), cType: "[]byte"},
|
||||||
} {
|
} {
|
||||||
resLess, isComparable := compare(currCase.less, currCase.greater, reflect.ValueOf(currCase.less).Kind())
|
resLess, isComparable := compare(currCase.less, currCase.greater, reflect.ValueOf(currCase.less).Kind())
|
||||||
if !isComparable {
|
if !isComparable {
|
||||||
|
@ -148,6 +159,9 @@ func TestGreater(t *testing.T) {
|
||||||
{less: uint64(1), greater: uint64(2), msg: `"1" is not greater than "2"`},
|
{less: uint64(1), greater: uint64(2), msg: `"1" is not greater than "2"`},
|
||||||
{less: float32(1.23), greater: float32(2.34), msg: `"1.23" is not greater than "2.34"`},
|
{less: float32(1.23), greater: float32(2.34), msg: `"1.23" is not greater than "2.34"`},
|
||||||
{less: float64(1.23), greater: float64(2.34), msg: `"1.23" is not greater than "2.34"`},
|
{less: float64(1.23), greater: float64(2.34), msg: `"1.23" is not greater than "2.34"`},
|
||||||
|
{less: uintptr(1), greater: uintptr(2), msg: `"1" is not greater than "2"`},
|
||||||
|
{less: time.Time{}, greater: time.Time{}.Add(time.Hour), msg: `"0001-01-01 00:00:00 +0000 UTC" is not greater than "0001-01-01 01:00:00 +0000 UTC"`},
|
||||||
|
{less: []byte{1, 1}, greater: []byte{1, 2}, msg: `"[1 1]" is not greater than "[1 2]"`},
|
||||||
} {
|
} {
|
||||||
out := &outputT{buf: bytes.NewBuffer(nil)}
|
out := &outputT{buf: bytes.NewBuffer(nil)}
|
||||||
False(t, Greater(out, currCase.less, currCase.greater))
|
False(t, Greater(out, currCase.less, currCase.greater))
|
||||||
|
@ -189,6 +203,9 @@ func TestGreaterOrEqual(t *testing.T) {
|
||||||
{less: uint64(1), greater: uint64(2), msg: `"1" is not greater than or equal to "2"`},
|
{less: uint64(1), greater: uint64(2), msg: `"1" is not greater than or equal to "2"`},
|
||||||
{less: float32(1.23), greater: float32(2.34), msg: `"1.23" is not greater than or equal to "2.34"`},
|
{less: float32(1.23), greater: float32(2.34), msg: `"1.23" is not greater than or equal to "2.34"`},
|
||||||
{less: float64(1.23), greater: float64(2.34), msg: `"1.23" is not greater than or equal to "2.34"`},
|
{less: float64(1.23), greater: float64(2.34), msg: `"1.23" is not greater than or equal to "2.34"`},
|
||||||
|
{less: uintptr(1), greater: uintptr(2), msg: `"1" is not greater than or equal to "2"`},
|
||||||
|
{less: time.Time{}, greater: time.Time{}.Add(time.Hour), msg: `"0001-01-01 00:00:00 +0000 UTC" is not greater than or equal to "0001-01-01 01:00:00 +0000 UTC"`},
|
||||||
|
{less: []byte{1, 1}, greater: []byte{1, 2}, msg: `"[1 1]" is not greater than or equal to "[1 2]"`},
|
||||||
} {
|
} {
|
||||||
out := &outputT{buf: bytes.NewBuffer(nil)}
|
out := &outputT{buf: bytes.NewBuffer(nil)}
|
||||||
False(t, GreaterOrEqual(out, currCase.less, currCase.greater))
|
False(t, GreaterOrEqual(out, currCase.less, currCase.greater))
|
||||||
|
@ -230,6 +247,9 @@ func TestLess(t *testing.T) {
|
||||||
{less: uint64(1), greater: uint64(2), msg: `"2" is not less than "1"`},
|
{less: uint64(1), greater: uint64(2), msg: `"2" is not less than "1"`},
|
||||||
{less: float32(1.23), greater: float32(2.34), msg: `"2.34" is not less than "1.23"`},
|
{less: float32(1.23), greater: float32(2.34), msg: `"2.34" is not less than "1.23"`},
|
||||||
{less: float64(1.23), greater: float64(2.34), msg: `"2.34" is not less than "1.23"`},
|
{less: float64(1.23), greater: float64(2.34), msg: `"2.34" is not less than "1.23"`},
|
||||||
|
{less: uintptr(1), greater: uintptr(2), msg: `"2" is not less than "1"`},
|
||||||
|
{less: time.Time{}, greater: time.Time{}.Add(time.Hour), msg: `"0001-01-01 01:00:00 +0000 UTC" is not less than "0001-01-01 00:00:00 +0000 UTC"`},
|
||||||
|
{less: []byte{1, 1}, greater: []byte{1, 2}, msg: `"[1 2]" is not less than "[1 1]"`},
|
||||||
} {
|
} {
|
||||||
out := &outputT{buf: bytes.NewBuffer(nil)}
|
out := &outputT{buf: bytes.NewBuffer(nil)}
|
||||||
False(t, Less(out, currCase.greater, currCase.less))
|
False(t, Less(out, currCase.greater, currCase.less))
|
||||||
|
@ -271,6 +291,9 @@ func TestLessOrEqual(t *testing.T) {
|
||||||
{less: uint64(1), greater: uint64(2), msg: `"2" is not less than or equal to "1"`},
|
{less: uint64(1), greater: uint64(2), msg: `"2" is not less than or equal to "1"`},
|
||||||
{less: float32(1.23), greater: float32(2.34), msg: `"2.34" is not less than or equal to "1.23"`},
|
{less: float32(1.23), greater: float32(2.34), msg: `"2.34" is not less than or equal to "1.23"`},
|
||||||
{less: float64(1.23), greater: float64(2.34), msg: `"2.34" is not less than or equal to "1.23"`},
|
{less: float64(1.23), greater: float64(2.34), msg: `"2.34" is not less than or equal to "1.23"`},
|
||||||
|
{less: uintptr(1), greater: uintptr(2), msg: `"2" is not less than or equal to "1"`},
|
||||||
|
{less: time.Time{}, greater: time.Time{}.Add(time.Hour), msg: `"0001-01-01 01:00:00 +0000 UTC" is not less than or equal to "0001-01-01 00:00:00 +0000 UTC"`},
|
||||||
|
{less: []byte{1, 1}, greater: []byte{1, 2}, msg: `"[1 2]" is not less than or equal to "[1 1]"`},
|
||||||
} {
|
} {
|
||||||
out := &outputT{buf: bytes.NewBuffer(nil)}
|
out := &outputT{buf: bytes.NewBuffer(nil)}
|
||||||
False(t, LessOrEqual(out, currCase.greater, currCase.less))
|
False(t, LessOrEqual(out, currCase.greater, currCase.less))
|
||||||
|
@ -370,8 +393,8 @@ func Test_compareTwoValuesDifferentValuesTypes(t *testing.T) {
|
||||||
{v1: float64(12), v2: "123"},
|
{v1: float64(12), v2: "123"},
|
||||||
{v1: "float(12)", v2: float64(1)},
|
{v1: "float(12)", v2: float64(1)},
|
||||||
} {
|
} {
|
||||||
compareResult := compareTwoValues(mockT, currCase.v1, currCase.v2, []CompareType{compareLess, compareEqual, compareGreater}, "testFailMessage")
|
result := compareTwoValues(mockT, currCase.v1, currCase.v2, []compareResult{compareLess, compareEqual, compareGreater}, "testFailMessage")
|
||||||
False(t, compareResult)
|
False(t, result)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -389,8 +412,8 @@ func Test_compareTwoValuesNotComparableValues(t *testing.T) {
|
||||||
{v1: map[string]int{}, v2: map[string]int{}},
|
{v1: map[string]int{}, v2: map[string]int{}},
|
||||||
{v1: make([]int, 5), v2: make([]int, 5)},
|
{v1: make([]int, 5), v2: make([]int, 5)},
|
||||||
} {
|
} {
|
||||||
compareResult := compareTwoValues(mockT, currCase.v1, currCase.v2, []CompareType{compareLess, compareEqual, compareGreater}, "testFailMessage")
|
result := compareTwoValues(mockT, currCase.v1, currCase.v2, []compareResult{compareLess, compareEqual, compareGreater}, "testFailMessage")
|
||||||
False(t, compareResult)
|
False(t, result)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -398,35 +421,35 @@ func Test_compareTwoValuesCorrectCompareResult(t *testing.T) {
|
||||||
mockT := new(testing.T)
|
mockT := new(testing.T)
|
||||||
|
|
||||||
for _, currCase := range []struct {
|
for _, currCase := range []struct {
|
||||||
v1 interface{}
|
v1 interface{}
|
||||||
v2 interface{}
|
v2 interface{}
|
||||||
compareTypes []CompareType
|
allowedResults []compareResult
|
||||||
}{
|
}{
|
||||||
{v1: 1, v2: 2, compareTypes: []CompareType{compareLess}},
|
{v1: 1, v2: 2, allowedResults: []compareResult{compareLess}},
|
||||||
{v1: 1, v2: 2, compareTypes: []CompareType{compareLess, compareEqual}},
|
{v1: 1, v2: 2, allowedResults: []compareResult{compareLess, compareEqual}},
|
||||||
{v1: 2, v2: 2, compareTypes: []CompareType{compareGreater, compareEqual}},
|
{v1: 2, v2: 2, allowedResults: []compareResult{compareGreater, compareEqual}},
|
||||||
{v1: 2, v2: 2, compareTypes: []CompareType{compareEqual}},
|
{v1: 2, v2: 2, allowedResults: []compareResult{compareEqual}},
|
||||||
{v1: 2, v2: 1, compareTypes: []CompareType{compareEqual, compareGreater}},
|
{v1: 2, v2: 1, allowedResults: []compareResult{compareEqual, compareGreater}},
|
||||||
{v1: 2, v2: 1, compareTypes: []CompareType{compareGreater}},
|
{v1: 2, v2: 1, allowedResults: []compareResult{compareGreater}},
|
||||||
} {
|
} {
|
||||||
compareResult := compareTwoValues(mockT, currCase.v1, currCase.v2, currCase.compareTypes, "testFailMessage")
|
result := compareTwoValues(mockT, currCase.v1, currCase.v2, currCase.allowedResults, "testFailMessage")
|
||||||
True(t, compareResult)
|
True(t, result)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func Test_containsValue(t *testing.T) {
|
func Test_containsValue(t *testing.T) {
|
||||||
for _, currCase := range []struct {
|
for _, currCase := range []struct {
|
||||||
values []CompareType
|
values []compareResult
|
||||||
value CompareType
|
value compareResult
|
||||||
result bool
|
result bool
|
||||||
}{
|
}{
|
||||||
{values: []CompareType{compareGreater}, value: compareGreater, result: true},
|
{values: []compareResult{compareGreater}, value: compareGreater, result: true},
|
||||||
{values: []CompareType{compareGreater, compareLess}, value: compareGreater, result: true},
|
{values: []compareResult{compareGreater, compareLess}, value: compareGreater, result: true},
|
||||||
{values: []CompareType{compareGreater, compareLess}, value: compareLess, result: true},
|
{values: []compareResult{compareGreater, compareLess}, value: compareLess, result: true},
|
||||||
{values: []CompareType{compareGreater, compareLess}, value: compareEqual, result: false},
|
{values: []compareResult{compareGreater, compareLess}, value: compareEqual, result: false},
|
||||||
} {
|
} {
|
||||||
compareResult := containsValue(currCase.values, currCase.value)
|
result := containsValue(currCase.values, currCase.value)
|
||||||
Equal(t, currCase.result, compareResult)
|
Equal(t, currCase.result, result)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,4 @@
|
||||||
/*
|
// Code generated with github.com/stretchr/testify/_codegen; DO NOT EDIT.
|
||||||
* CODE GENERATED AUTOMATICALLY WITH github.com/stretchr/testify/_codegen
|
|
||||||
* THIS FILE MUST NOT BE EDITED BY HAND
|
|
||||||
*/
|
|
||||||
|
|
||||||
package assert
|
package assert
|
||||||
|
|
||||||
|
@ -22,9 +19,9 @@ func Conditionf(t TestingT, comp Comparison, msg string, args ...interface{}) bo
|
||||||
// Containsf asserts that the specified string, list(array, slice...) or map contains the
|
// Containsf asserts that the specified string, list(array, slice...) or map contains the
|
||||||
// specified substring or element.
|
// specified substring or element.
|
||||||
//
|
//
|
||||||
// assert.Containsf(t, "Hello World", "World", "error message %s", "formatted")
|
// assert.Containsf(t, "Hello World", "World", "error message %s", "formatted")
|
||||||
// assert.Containsf(t, ["Hello", "World"], "World", "error message %s", "formatted")
|
// assert.Containsf(t, ["Hello", "World"], "World", "error message %s", "formatted")
|
||||||
// assert.Containsf(t, {"Hello": "World"}, "Hello", "error message %s", "formatted")
|
// assert.Containsf(t, {"Hello": "World"}, "Hello", "error message %s", "formatted")
|
||||||
func Containsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool {
|
func Containsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -56,7 +53,7 @@ func ElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string
|
||||||
// Emptyf asserts that the specified object is empty. I.e. nil, "", false, 0 or either
|
// Emptyf asserts that the specified object is empty. I.e. nil, "", false, 0 or either
|
||||||
// a slice or a channel with len == 0.
|
// a slice or a channel with len == 0.
|
||||||
//
|
//
|
||||||
// assert.Emptyf(t, obj, "error message %s", "formatted")
|
// assert.Emptyf(t, obj, "error message %s", "formatted")
|
||||||
func Emptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func Emptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -66,7 +63,7 @@ func Emptyf(t TestingT, object interface{}, msg string, args ...interface{}) boo
|
||||||
|
|
||||||
// Equalf asserts that two objects are equal.
|
// Equalf asserts that two objects are equal.
|
||||||
//
|
//
|
||||||
// assert.Equalf(t, 123, 123, "error message %s", "formatted")
|
// assert.Equalf(t, 123, 123, "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Pointer variable equality is determined based on the equality of the
|
// Pointer variable equality is determined based on the equality of the
|
||||||
// referenced values (as opposed to the memory addresses). Function equality
|
// referenced values (as opposed to the memory addresses). Function equality
|
||||||
|
@ -81,8 +78,8 @@ func Equalf(t TestingT, expected interface{}, actual interface{}, msg string, ar
|
||||||
// EqualErrorf asserts that a function returned an error (i.e. not `nil`)
|
// EqualErrorf asserts that a function returned an error (i.e. not `nil`)
|
||||||
// and that it is equal to the provided error.
|
// and that it is equal to the provided error.
|
||||||
//
|
//
|
||||||
// actualObj, err := SomeFunction()
|
// actualObj, err := SomeFunction()
|
||||||
// assert.EqualErrorf(t, err, expectedErrorString, "error message %s", "formatted")
|
// assert.EqualErrorf(t, err, expectedErrorString, "error message %s", "formatted")
|
||||||
func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...interface{}) bool {
|
func EqualErrorf(t TestingT, theError error, errString string, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -90,10 +87,27 @@ func EqualErrorf(t TestingT, theError error, errString string, msg string, args
|
||||||
return EqualError(t, theError, errString, append([]interface{}{msg}, args...)...)
|
return EqualError(t, theError, errString, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// EqualValuesf asserts that two objects are equal or convertable to the same types
|
// EqualExportedValuesf asserts that the types of two objects are equal and their public
|
||||||
// and equal.
|
// fields are also equal. This is useful for comparing structs that have private fields
|
||||||
|
// that could potentially differ.
|
||||||
//
|
//
|
||||||
// assert.EqualValuesf(t, uint32(123), int32(123), "error message %s", "formatted")
|
// type S struct {
|
||||||
|
// Exported int
|
||||||
|
// notExported int
|
||||||
|
// }
|
||||||
|
// assert.EqualExportedValuesf(t, S{1, 2}, S{1, 3}, "error message %s", "formatted") => true
|
||||||
|
// assert.EqualExportedValuesf(t, S{1, 2}, S{2, 3}, "error message %s", "formatted") => false
|
||||||
|
func EqualExportedValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool {
|
||||||
|
if h, ok := t.(tHelper); ok {
|
||||||
|
h.Helper()
|
||||||
|
}
|
||||||
|
return EqualExportedValues(t, expected, actual, append([]interface{}{msg}, args...)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EqualValuesf asserts that two objects are equal or convertible to the larger
|
||||||
|
// type and equal.
|
||||||
|
//
|
||||||
|
// assert.EqualValuesf(t, uint32(123), int32(123), "error message %s", "formatted")
|
||||||
func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool {
|
func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -103,10 +117,10 @@ func EqualValuesf(t TestingT, expected interface{}, actual interface{}, msg stri
|
||||||
|
|
||||||
// Errorf asserts that a function returned an error (i.e. not `nil`).
|
// Errorf asserts that a function returned an error (i.e. not `nil`).
|
||||||
//
|
//
|
||||||
// actualObj, err := SomeFunction()
|
// actualObj, err := SomeFunction()
|
||||||
// if assert.Errorf(t, err, "error message %s", "formatted") {
|
// if assert.Errorf(t, err, "error message %s", "formatted") {
|
||||||
// assert.Equal(t, expectedErrorf, err)
|
// assert.Equal(t, expectedErrorf, err)
|
||||||
// }
|
// }
|
||||||
func Errorf(t TestingT, err error, msg string, args ...interface{}) bool {
|
func Errorf(t TestingT, err error, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -126,8 +140,8 @@ func ErrorAsf(t TestingT, err error, target interface{}, msg string, args ...int
|
||||||
// ErrorContainsf asserts that a function returned an error (i.e. not `nil`)
|
// ErrorContainsf asserts that a function returned an error (i.e. not `nil`)
|
||||||
// and that the error contains the specified substring.
|
// and that the error contains the specified substring.
|
||||||
//
|
//
|
||||||
// actualObj, err := SomeFunction()
|
// actualObj, err := SomeFunction()
|
||||||
// assert.ErrorContainsf(t, err, expectedErrorSubString, "error message %s", "formatted")
|
// assert.ErrorContainsf(t, err, expectedErrorSubString, "error message %s", "formatted")
|
||||||
func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...interface{}) bool {
|
func ErrorContainsf(t TestingT, theError error, contains string, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -147,7 +161,7 @@ func ErrorIsf(t TestingT, err error, target error, msg string, args ...interface
|
||||||
// Eventuallyf asserts that given condition will be met in waitFor time,
|
// Eventuallyf asserts that given condition will be met in waitFor time,
|
||||||
// periodically checking target function each tick.
|
// periodically checking target function each tick.
|
||||||
//
|
//
|
||||||
// assert.Eventuallyf(t, func() bool { return true; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")
|
// assert.Eventuallyf(t, func() bool { return true; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")
|
||||||
func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool {
|
func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -155,9 +169,34 @@ func Eventuallyf(t TestingT, condition func() bool, waitFor time.Duration, tick
|
||||||
return Eventually(t, condition, waitFor, tick, append([]interface{}{msg}, args...)...)
|
return Eventually(t, condition, waitFor, tick, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// EventuallyWithTf asserts that given condition will be met in waitFor time,
|
||||||
|
// periodically checking target function each tick. In contrast to Eventually,
|
||||||
|
// it supplies a CollectT to the condition function, so that the condition
|
||||||
|
// function can use the CollectT to call other assertions.
|
||||||
|
// The condition is considered "met" if no errors are raised in a tick.
|
||||||
|
// The supplied CollectT collects all errors from one tick (if there are any).
|
||||||
|
// If the condition is not met before waitFor, the collected errors of
|
||||||
|
// the last tick are copied to t.
|
||||||
|
//
|
||||||
|
// externalValue := false
|
||||||
|
// go func() {
|
||||||
|
// time.Sleep(8*time.Second)
|
||||||
|
// externalValue = true
|
||||||
|
// }()
|
||||||
|
// assert.EventuallyWithTf(t, func(c *assert.CollectT, "error message %s", "formatted") {
|
||||||
|
// // add assertions as needed; any assertion failure will fail the current tick
|
||||||
|
// assert.True(c, externalValue, "expected 'externalValue' to be true")
|
||||||
|
// }, 10*time.Second, 1*time.Second, "external state has not changed to 'true'; still false")
|
||||||
|
func EventuallyWithTf(t TestingT, condition func(collect *CollectT), waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool {
|
||||||
|
if h, ok := t.(tHelper); ok {
|
||||||
|
h.Helper()
|
||||||
|
}
|
||||||
|
return EventuallyWithT(t, condition, waitFor, tick, append([]interface{}{msg}, args...)...)
|
||||||
|
}
|
||||||
|
|
||||||
// Exactlyf asserts that two objects are equal in value and type.
|
// Exactlyf asserts that two objects are equal in value and type.
|
||||||
//
|
//
|
||||||
// assert.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted")
|
// assert.Exactlyf(t, int32(123), int64(123), "error message %s", "formatted")
|
||||||
func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool {
|
func Exactlyf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -183,7 +222,7 @@ func FailNowf(t TestingT, failureMessage string, msg string, args ...interface{}
|
||||||
|
|
||||||
// Falsef asserts that the specified value is false.
|
// Falsef asserts that the specified value is false.
|
||||||
//
|
//
|
||||||
// assert.Falsef(t, myBool, "error message %s", "formatted")
|
// assert.Falsef(t, myBool, "error message %s", "formatted")
|
||||||
func Falsef(t TestingT, value bool, msg string, args ...interface{}) bool {
|
func Falsef(t TestingT, value bool, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -202,9 +241,9 @@ func FileExistsf(t TestingT, path string, msg string, args ...interface{}) bool
|
||||||
|
|
||||||
// Greaterf asserts that the first element is greater than the second
|
// Greaterf asserts that the first element is greater than the second
|
||||||
//
|
//
|
||||||
// assert.Greaterf(t, 2, 1, "error message %s", "formatted")
|
// assert.Greaterf(t, 2, 1, "error message %s", "formatted")
|
||||||
// assert.Greaterf(t, float64(2), float64(1), "error message %s", "formatted")
|
// assert.Greaterf(t, float64(2), float64(1), "error message %s", "formatted")
|
||||||
// assert.Greaterf(t, "b", "a", "error message %s", "formatted")
|
// assert.Greaterf(t, "b", "a", "error message %s", "formatted")
|
||||||
func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -214,10 +253,10 @@ func Greaterf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...in
|
||||||
|
|
||||||
// GreaterOrEqualf asserts that the first element is greater than or equal to the second
|
// GreaterOrEqualf asserts that the first element is greater than or equal to the second
|
||||||
//
|
//
|
||||||
// assert.GreaterOrEqualf(t, 2, 1, "error message %s", "formatted")
|
// assert.GreaterOrEqualf(t, 2, 1, "error message %s", "formatted")
|
||||||
// assert.GreaterOrEqualf(t, 2, 2, "error message %s", "formatted")
|
// assert.GreaterOrEqualf(t, 2, 2, "error message %s", "formatted")
|
||||||
// assert.GreaterOrEqualf(t, "b", "a", "error message %s", "formatted")
|
// assert.GreaterOrEqualf(t, "b", "a", "error message %s", "formatted")
|
||||||
// assert.GreaterOrEqualf(t, "b", "b", "error message %s", "formatted")
|
// assert.GreaterOrEqualf(t, "b", "b", "error message %s", "formatted")
|
||||||
func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -228,7 +267,7 @@ func GreaterOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, arg
|
||||||
// HTTPBodyContainsf asserts that a specified handler returns a
|
// HTTPBodyContainsf asserts that a specified handler returns a
|
||||||
// body that contains a string.
|
// body that contains a string.
|
||||||
//
|
//
|
||||||
// assert.HTTPBodyContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")
|
// assert.HTTPBodyContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool {
|
func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool {
|
||||||
|
@ -241,7 +280,7 @@ func HTTPBodyContainsf(t TestingT, handler http.HandlerFunc, method string, url
|
||||||
// HTTPBodyNotContainsf asserts that a specified handler returns a
|
// HTTPBodyNotContainsf asserts that a specified handler returns a
|
||||||
// body that does not contain a string.
|
// body that does not contain a string.
|
||||||
//
|
//
|
||||||
// assert.HTTPBodyNotContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")
|
// assert.HTTPBodyNotContainsf(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky", "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool {
|
func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, str interface{}, msg string, args ...interface{}) bool {
|
||||||
|
@ -253,7 +292,7 @@ func HTTPBodyNotContainsf(t TestingT, handler http.HandlerFunc, method string, u
|
||||||
|
|
||||||
// HTTPErrorf asserts that a specified handler returns an error status code.
|
// HTTPErrorf asserts that a specified handler returns an error status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPErrorf(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
// assert.HTTPErrorf(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool {
|
func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool {
|
||||||
|
@ -265,7 +304,7 @@ func HTTPErrorf(t TestingT, handler http.HandlerFunc, method string, url string,
|
||||||
|
|
||||||
// HTTPRedirectf asserts that a specified handler returns a redirect status code.
|
// HTTPRedirectf asserts that a specified handler returns a redirect status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPRedirectf(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
// assert.HTTPRedirectf(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool {
|
func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool {
|
||||||
|
@ -277,7 +316,7 @@ func HTTPRedirectf(t TestingT, handler http.HandlerFunc, method string, url stri
|
||||||
|
|
||||||
// HTTPStatusCodef asserts that a specified handler returns a specified status code.
|
// HTTPStatusCodef asserts that a specified handler returns a specified status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPStatusCodef(t, myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted")
|
// assert.HTTPStatusCodef(t, myHandler, "GET", "/notImplemented", nil, 501, "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) bool {
|
func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, statuscode int, msg string, args ...interface{}) bool {
|
||||||
|
@ -289,7 +328,7 @@ func HTTPStatusCodef(t TestingT, handler http.HandlerFunc, method string, url st
|
||||||
|
|
||||||
// HTTPSuccessf asserts that a specified handler returns a success status code.
|
// HTTPSuccessf asserts that a specified handler returns a success status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPSuccessf(t, myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted")
|
// assert.HTTPSuccessf(t, myHandler, "POST", "http://www.google.com", nil, "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool {
|
func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url string, values url.Values, msg string, args ...interface{}) bool {
|
||||||
|
@ -301,7 +340,7 @@ func HTTPSuccessf(t TestingT, handler http.HandlerFunc, method string, url strin
|
||||||
|
|
||||||
// Implementsf asserts that an object is implemented by the specified interface.
|
// Implementsf asserts that an object is implemented by the specified interface.
|
||||||
//
|
//
|
||||||
// assert.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
|
// assert.Implementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
|
||||||
func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool {
|
func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -311,7 +350,7 @@ func Implementsf(t TestingT, interfaceObject interface{}, object interface{}, ms
|
||||||
|
|
||||||
// InDeltaf asserts that the two numerals are within delta of each other.
|
// InDeltaf asserts that the two numerals are within delta of each other.
|
||||||
//
|
//
|
||||||
// assert.InDeltaf(t, math.Pi, 22/7.0, 0.01, "error message %s", "formatted")
|
// assert.InDeltaf(t, math.Pi, 22/7.0, 0.01, "error message %s", "formatted")
|
||||||
func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool {
|
func InDeltaf(t TestingT, expected interface{}, actual interface{}, delta float64, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -353,9 +392,9 @@ func InEpsilonSlicef(t TestingT, expected interface{}, actual interface{}, epsil
|
||||||
|
|
||||||
// IsDecreasingf asserts that the collection is decreasing
|
// IsDecreasingf asserts that the collection is decreasing
|
||||||
//
|
//
|
||||||
// assert.IsDecreasingf(t, []int{2, 1, 0}, "error message %s", "formatted")
|
// assert.IsDecreasingf(t, []int{2, 1, 0}, "error message %s", "formatted")
|
||||||
// assert.IsDecreasingf(t, []float{2, 1}, "error message %s", "formatted")
|
// assert.IsDecreasingf(t, []float{2, 1}, "error message %s", "formatted")
|
||||||
// assert.IsDecreasingf(t, []string{"b", "a"}, "error message %s", "formatted")
|
// assert.IsDecreasingf(t, []string{"b", "a"}, "error message %s", "formatted")
|
||||||
func IsDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func IsDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -365,9 +404,9 @@ func IsDecreasingf(t TestingT, object interface{}, msg string, args ...interface
|
||||||
|
|
||||||
// IsIncreasingf asserts that the collection is increasing
|
// IsIncreasingf asserts that the collection is increasing
|
||||||
//
|
//
|
||||||
// assert.IsIncreasingf(t, []int{1, 2, 3}, "error message %s", "formatted")
|
// assert.IsIncreasingf(t, []int{1, 2, 3}, "error message %s", "formatted")
|
||||||
// assert.IsIncreasingf(t, []float{1, 2}, "error message %s", "formatted")
|
// assert.IsIncreasingf(t, []float{1, 2}, "error message %s", "formatted")
|
||||||
// assert.IsIncreasingf(t, []string{"a", "b"}, "error message %s", "formatted")
|
// assert.IsIncreasingf(t, []string{"a", "b"}, "error message %s", "formatted")
|
||||||
func IsIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func IsIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -377,9 +416,9 @@ func IsIncreasingf(t TestingT, object interface{}, msg string, args ...interface
|
||||||
|
|
||||||
// IsNonDecreasingf asserts that the collection is not decreasing
|
// IsNonDecreasingf asserts that the collection is not decreasing
|
||||||
//
|
//
|
||||||
// assert.IsNonDecreasingf(t, []int{1, 1, 2}, "error message %s", "formatted")
|
// assert.IsNonDecreasingf(t, []int{1, 1, 2}, "error message %s", "formatted")
|
||||||
// assert.IsNonDecreasingf(t, []float{1, 2}, "error message %s", "formatted")
|
// assert.IsNonDecreasingf(t, []float{1, 2}, "error message %s", "formatted")
|
||||||
// assert.IsNonDecreasingf(t, []string{"a", "b"}, "error message %s", "formatted")
|
// assert.IsNonDecreasingf(t, []string{"a", "b"}, "error message %s", "formatted")
|
||||||
func IsNonDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func IsNonDecreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -389,9 +428,9 @@ func IsNonDecreasingf(t TestingT, object interface{}, msg string, args ...interf
|
||||||
|
|
||||||
// IsNonIncreasingf asserts that the collection is not increasing
|
// IsNonIncreasingf asserts that the collection is not increasing
|
||||||
//
|
//
|
||||||
// assert.IsNonIncreasingf(t, []int{2, 1, 1}, "error message %s", "formatted")
|
// assert.IsNonIncreasingf(t, []int{2, 1, 1}, "error message %s", "formatted")
|
||||||
// assert.IsNonIncreasingf(t, []float{2, 1}, "error message %s", "formatted")
|
// assert.IsNonIncreasingf(t, []float{2, 1}, "error message %s", "formatted")
|
||||||
// assert.IsNonIncreasingf(t, []string{"b", "a"}, "error message %s", "formatted")
|
// assert.IsNonIncreasingf(t, []string{"b", "a"}, "error message %s", "formatted")
|
||||||
func IsNonIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func IsNonIncreasingf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -409,7 +448,7 @@ func IsTypef(t TestingT, expectedType interface{}, object interface{}, msg strin
|
||||||
|
|
||||||
// JSONEqf asserts that two JSON strings are equivalent.
|
// JSONEqf asserts that two JSON strings are equivalent.
|
||||||
//
|
//
|
||||||
// assert.JSONEqf(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted")
|
// assert.JSONEqf(t, `{"hello": "world", "foo": "bar"}`, `{"foo": "bar", "hello": "world"}`, "error message %s", "formatted")
|
||||||
func JSONEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool {
|
func JSONEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -420,7 +459,7 @@ func JSONEqf(t TestingT, expected string, actual string, msg string, args ...int
|
||||||
// Lenf asserts that the specified object has specific length.
|
// Lenf asserts that the specified object has specific length.
|
||||||
// Lenf also fails if the object has a type that len() not accept.
|
// Lenf also fails if the object has a type that len() not accept.
|
||||||
//
|
//
|
||||||
// assert.Lenf(t, mySlice, 3, "error message %s", "formatted")
|
// assert.Lenf(t, mySlice, 3, "error message %s", "formatted")
|
||||||
func Lenf(t TestingT, object interface{}, length int, msg string, args ...interface{}) bool {
|
func Lenf(t TestingT, object interface{}, length int, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -430,9 +469,9 @@ func Lenf(t TestingT, object interface{}, length int, msg string, args ...interf
|
||||||
|
|
||||||
// Lessf asserts that the first element is less than the second
|
// Lessf asserts that the first element is less than the second
|
||||||
//
|
//
|
||||||
// assert.Lessf(t, 1, 2, "error message %s", "formatted")
|
// assert.Lessf(t, 1, 2, "error message %s", "formatted")
|
||||||
// assert.Lessf(t, float64(1), float64(2), "error message %s", "formatted")
|
// assert.Lessf(t, float64(1), float64(2), "error message %s", "formatted")
|
||||||
// assert.Lessf(t, "a", "b", "error message %s", "formatted")
|
// assert.Lessf(t, "a", "b", "error message %s", "formatted")
|
||||||
func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -442,10 +481,10 @@ func Lessf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...inter
|
||||||
|
|
||||||
// LessOrEqualf asserts that the first element is less than or equal to the second
|
// LessOrEqualf asserts that the first element is less than or equal to the second
|
||||||
//
|
//
|
||||||
// assert.LessOrEqualf(t, 1, 2, "error message %s", "formatted")
|
// assert.LessOrEqualf(t, 1, 2, "error message %s", "formatted")
|
||||||
// assert.LessOrEqualf(t, 2, 2, "error message %s", "formatted")
|
// assert.LessOrEqualf(t, 2, 2, "error message %s", "formatted")
|
||||||
// assert.LessOrEqualf(t, "a", "b", "error message %s", "formatted")
|
// assert.LessOrEqualf(t, "a", "b", "error message %s", "formatted")
|
||||||
// assert.LessOrEqualf(t, "b", "b", "error message %s", "formatted")
|
// assert.LessOrEqualf(t, "b", "b", "error message %s", "formatted")
|
||||||
func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -455,8 +494,8 @@ func LessOrEqualf(t TestingT, e1 interface{}, e2 interface{}, msg string, args .
|
||||||
|
|
||||||
// Negativef asserts that the specified element is negative
|
// Negativef asserts that the specified element is negative
|
||||||
//
|
//
|
||||||
// assert.Negativef(t, -1, "error message %s", "formatted")
|
// assert.Negativef(t, -1, "error message %s", "formatted")
|
||||||
// assert.Negativef(t, -1.23, "error message %s", "formatted")
|
// assert.Negativef(t, -1.23, "error message %s", "formatted")
|
||||||
func Negativef(t TestingT, e interface{}, msg string, args ...interface{}) bool {
|
func Negativef(t TestingT, e interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -467,7 +506,7 @@ func Negativef(t TestingT, e interface{}, msg string, args ...interface{}) bool
|
||||||
// Neverf asserts that the given condition doesn't satisfy in waitFor time,
|
// Neverf asserts that the given condition doesn't satisfy in waitFor time,
|
||||||
// periodically checking the target function each tick.
|
// periodically checking the target function each tick.
|
||||||
//
|
//
|
||||||
// assert.Neverf(t, func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")
|
// assert.Neverf(t, func() bool { return false; }, time.Second, 10*time.Millisecond, "error message %s", "formatted")
|
||||||
func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool {
|
func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.Duration, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -477,7 +516,7 @@ func Neverf(t TestingT, condition func() bool, waitFor time.Duration, tick time.
|
||||||
|
|
||||||
// Nilf asserts that the specified object is nil.
|
// Nilf asserts that the specified object is nil.
|
||||||
//
|
//
|
||||||
// assert.Nilf(t, err, "error message %s", "formatted")
|
// assert.Nilf(t, err, "error message %s", "formatted")
|
||||||
func Nilf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func Nilf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -496,10 +535,10 @@ func NoDirExistsf(t TestingT, path string, msg string, args ...interface{}) bool
|
||||||
|
|
||||||
// NoErrorf asserts that a function returned no error (i.e. `nil`).
|
// NoErrorf asserts that a function returned no error (i.e. `nil`).
|
||||||
//
|
//
|
||||||
// actualObj, err := SomeFunction()
|
// actualObj, err := SomeFunction()
|
||||||
// if assert.NoErrorf(t, err, "error message %s", "formatted") {
|
// if assert.NoErrorf(t, err, "error message %s", "formatted") {
|
||||||
// assert.Equal(t, expectedObj, actualObj)
|
// assert.Equal(t, expectedObj, actualObj)
|
||||||
// }
|
// }
|
||||||
func NoErrorf(t TestingT, err error, msg string, args ...interface{}) bool {
|
func NoErrorf(t TestingT, err error, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -519,9 +558,9 @@ func NoFileExistsf(t TestingT, path string, msg string, args ...interface{}) boo
|
||||||
// NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the
|
// NotContainsf asserts that the specified string, list(array, slice...) or map does NOT contain the
|
||||||
// specified substring or element.
|
// specified substring or element.
|
||||||
//
|
//
|
||||||
// assert.NotContainsf(t, "Hello World", "Earth", "error message %s", "formatted")
|
// assert.NotContainsf(t, "Hello World", "Earth", "error message %s", "formatted")
|
||||||
// assert.NotContainsf(t, ["Hello", "World"], "Earth", "error message %s", "formatted")
|
// assert.NotContainsf(t, ["Hello", "World"], "Earth", "error message %s", "formatted")
|
||||||
// assert.NotContainsf(t, {"Hello": "World"}, "Earth", "error message %s", "formatted")
|
// assert.NotContainsf(t, {"Hello": "World"}, "Earth", "error message %s", "formatted")
|
||||||
func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool {
|
func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -529,12 +568,29 @@ func NotContainsf(t TestingT, s interface{}, contains interface{}, msg string, a
|
||||||
return NotContains(t, s, contains, append([]interface{}{msg}, args...)...)
|
return NotContains(t, s, contains, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NotElementsMatchf asserts that the specified listA(array, slice...) is NOT equal to specified
|
||||||
|
// listB(array, slice...) ignoring the order of the elements. If there are duplicate elements,
|
||||||
|
// the number of appearances of each of them in both lists should not match.
|
||||||
|
// This is an inverse of ElementsMatch.
|
||||||
|
//
|
||||||
|
// assert.NotElementsMatchf(t, [1, 1, 2, 3], [1, 1, 2, 3], "error message %s", "formatted") -> false
|
||||||
|
//
|
||||||
|
// assert.NotElementsMatchf(t, [1, 1, 2, 3], [1, 2, 3], "error message %s", "formatted") -> true
|
||||||
|
//
|
||||||
|
// assert.NotElementsMatchf(t, [1, 2, 3], [1, 2, 4], "error message %s", "formatted") -> true
|
||||||
|
func NotElementsMatchf(t TestingT, listA interface{}, listB interface{}, msg string, args ...interface{}) bool {
|
||||||
|
if h, ok := t.(tHelper); ok {
|
||||||
|
h.Helper()
|
||||||
|
}
|
||||||
|
return NotElementsMatch(t, listA, listB, append([]interface{}{msg}, args...)...)
|
||||||
|
}
|
||||||
|
|
||||||
// NotEmptyf asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either
|
// NotEmptyf asserts that the specified object is NOT empty. I.e. not nil, "", false, 0 or either
|
||||||
// a slice or a channel with len == 0.
|
// a slice or a channel with len == 0.
|
||||||
//
|
//
|
||||||
// if assert.NotEmptyf(t, obj, "error message %s", "formatted") {
|
// if assert.NotEmptyf(t, obj, "error message %s", "formatted") {
|
||||||
// assert.Equal(t, "two", obj[1])
|
// assert.Equal(t, "two", obj[1])
|
||||||
// }
|
// }
|
||||||
func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -544,7 +600,7 @@ func NotEmptyf(t TestingT, object interface{}, msg string, args ...interface{})
|
||||||
|
|
||||||
// NotEqualf asserts that the specified values are NOT equal.
|
// NotEqualf asserts that the specified values are NOT equal.
|
||||||
//
|
//
|
||||||
// assert.NotEqualf(t, obj1, obj2, "error message %s", "formatted")
|
// assert.NotEqualf(t, obj1, obj2, "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Pointer variable equality is determined based on the equality of the
|
// Pointer variable equality is determined based on the equality of the
|
||||||
// referenced values (as opposed to the memory addresses).
|
// referenced values (as opposed to the memory addresses).
|
||||||
|
@ -557,7 +613,7 @@ func NotEqualf(t TestingT, expected interface{}, actual interface{}, msg string,
|
||||||
|
|
||||||
// NotEqualValuesf asserts that two objects are not equal even when converted to the same type
|
// NotEqualValuesf asserts that two objects are not equal even when converted to the same type
|
||||||
//
|
//
|
||||||
// assert.NotEqualValuesf(t, obj1, obj2, "error message %s", "formatted")
|
// assert.NotEqualValuesf(t, obj1, obj2, "error message %s", "formatted")
|
||||||
func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool {
|
func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -565,7 +621,16 @@ func NotEqualValuesf(t TestingT, expected interface{}, actual interface{}, msg s
|
||||||
return NotEqualValues(t, expected, actual, append([]interface{}{msg}, args...)...)
|
return NotEqualValues(t, expected, actual, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// NotErrorIsf asserts that at none of the errors in err's chain matches target.
|
// NotErrorAsf asserts that none of the errors in err's chain matches target,
|
||||||
|
// but if so, sets target to that error value.
|
||||||
|
func NotErrorAsf(t TestingT, err error, target interface{}, msg string, args ...interface{}) bool {
|
||||||
|
if h, ok := t.(tHelper); ok {
|
||||||
|
h.Helper()
|
||||||
|
}
|
||||||
|
return NotErrorAs(t, err, target, append([]interface{}{msg}, args...)...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotErrorIsf asserts that none of the errors in err's chain matches target.
|
||||||
// This is a wrapper for errors.Is.
|
// This is a wrapper for errors.Is.
|
||||||
func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interface{}) bool {
|
func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
|
@ -574,9 +639,19 @@ func NotErrorIsf(t TestingT, err error, target error, msg string, args ...interf
|
||||||
return NotErrorIs(t, err, target, append([]interface{}{msg}, args...)...)
|
return NotErrorIs(t, err, target, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NotImplementsf asserts that an object does not implement the specified interface.
|
||||||
|
//
|
||||||
|
// assert.NotImplementsf(t, (*MyInterface)(nil), new(MyObject), "error message %s", "formatted")
|
||||||
|
func NotImplementsf(t TestingT, interfaceObject interface{}, object interface{}, msg string, args ...interface{}) bool {
|
||||||
|
if h, ok := t.(tHelper); ok {
|
||||||
|
h.Helper()
|
||||||
|
}
|
||||||
|
return NotImplements(t, interfaceObject, object, append([]interface{}{msg}, args...)...)
|
||||||
|
}
|
||||||
|
|
||||||
// NotNilf asserts that the specified object is not nil.
|
// NotNilf asserts that the specified object is not nil.
|
||||||
//
|
//
|
||||||
// assert.NotNilf(t, err, "error message %s", "formatted")
|
// assert.NotNilf(t, err, "error message %s", "formatted")
|
||||||
func NotNilf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
func NotNilf(t TestingT, object interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -586,7 +661,7 @@ func NotNilf(t TestingT, object interface{}, msg string, args ...interface{}) bo
|
||||||
|
|
||||||
// NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.
|
// NotPanicsf asserts that the code inside the specified PanicTestFunc does NOT panic.
|
||||||
//
|
//
|
||||||
// assert.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted")
|
// assert.NotPanicsf(t, func(){ RemainCalm() }, "error message %s", "formatted")
|
||||||
func NotPanicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool {
|
func NotPanicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -596,8 +671,8 @@ func NotPanicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bo
|
||||||
|
|
||||||
// NotRegexpf asserts that a specified regexp does not match a string.
|
// NotRegexpf asserts that a specified regexp does not match a string.
|
||||||
//
|
//
|
||||||
// assert.NotRegexpf(t, regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted")
|
// assert.NotRegexpf(t, regexp.MustCompile("starts"), "it's starting", "error message %s", "formatted")
|
||||||
// assert.NotRegexpf(t, "^start", "it's not starting", "error message %s", "formatted")
|
// assert.NotRegexpf(t, "^start", "it's not starting", "error message %s", "formatted")
|
||||||
func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool {
|
func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -607,7 +682,7 @@ func NotRegexpf(t TestingT, rx interface{}, str interface{}, msg string, args ..
|
||||||
|
|
||||||
// NotSamef asserts that two pointers do not reference the same object.
|
// NotSamef asserts that two pointers do not reference the same object.
|
||||||
//
|
//
|
||||||
// assert.NotSamef(t, ptr1, ptr2, "error message %s", "formatted")
|
// assert.NotSamef(t, ptr1, ptr2, "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Both arguments must be pointer variables. Pointer variable sameness is
|
// Both arguments must be pointer variables. Pointer variable sameness is
|
||||||
// determined based on the equality of both type and value.
|
// determined based on the equality of both type and value.
|
||||||
|
@ -618,10 +693,12 @@ func NotSamef(t TestingT, expected interface{}, actual interface{}, msg string,
|
||||||
return NotSame(t, expected, actual, append([]interface{}{msg}, args...)...)
|
return NotSame(t, expected, actual, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// NotSubsetf asserts that the specified list(array, slice...) contains not all
|
// NotSubsetf asserts that the specified list(array, slice...) or map does NOT
|
||||||
// elements given in the specified subset(array, slice...).
|
// contain all elements given in the specified subset list(array, slice...) or
|
||||||
|
// map.
|
||||||
//
|
//
|
||||||
// assert.NotSubsetf(t, [1, 3, 4], [1, 2], "But [1, 3, 4] does not contain [1, 2]", "error message %s", "formatted")
|
// assert.NotSubsetf(t, [1, 3, 4], [1, 2], "error message %s", "formatted")
|
||||||
|
// assert.NotSubsetf(t, {"x": 1, "y": 2}, {"z": 3}, "error message %s", "formatted")
|
||||||
func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool {
|
func NotSubsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -639,7 +716,7 @@ func NotZerof(t TestingT, i interface{}, msg string, args ...interface{}) bool {
|
||||||
|
|
||||||
// Panicsf asserts that the code inside the specified PanicTestFunc panics.
|
// Panicsf asserts that the code inside the specified PanicTestFunc panics.
|
||||||
//
|
//
|
||||||
// assert.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted")
|
// assert.Panicsf(t, func(){ GoCrazy() }, "error message %s", "formatted")
|
||||||
func Panicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool {
|
func Panicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -651,7 +728,7 @@ func Panicsf(t TestingT, f PanicTestFunc, msg string, args ...interface{}) bool
|
||||||
// panics, and that the recovered panic value is an error that satisfies the
|
// panics, and that the recovered panic value is an error that satisfies the
|
||||||
// EqualError comparison.
|
// EqualError comparison.
|
||||||
//
|
//
|
||||||
// assert.PanicsWithErrorf(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")
|
// assert.PanicsWithErrorf(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")
|
||||||
func PanicsWithErrorf(t TestingT, errString string, f PanicTestFunc, msg string, args ...interface{}) bool {
|
func PanicsWithErrorf(t TestingT, errString string, f PanicTestFunc, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -662,7 +739,7 @@ func PanicsWithErrorf(t TestingT, errString string, f PanicTestFunc, msg string,
|
||||||
// PanicsWithValuef asserts that the code inside the specified PanicTestFunc panics, and that
|
// PanicsWithValuef asserts that the code inside the specified PanicTestFunc panics, and that
|
||||||
// the recovered panic value equals the expected panic value.
|
// the recovered panic value equals the expected panic value.
|
||||||
//
|
//
|
||||||
// assert.PanicsWithValuef(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")
|
// assert.PanicsWithValuef(t, "crazy error", func(){ GoCrazy() }, "error message %s", "formatted")
|
||||||
func PanicsWithValuef(t TestingT, expected interface{}, f PanicTestFunc, msg string, args ...interface{}) bool {
|
func PanicsWithValuef(t TestingT, expected interface{}, f PanicTestFunc, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -672,8 +749,8 @@ func PanicsWithValuef(t TestingT, expected interface{}, f PanicTestFunc, msg str
|
||||||
|
|
||||||
// Positivef asserts that the specified element is positive
|
// Positivef asserts that the specified element is positive
|
||||||
//
|
//
|
||||||
// assert.Positivef(t, 1, "error message %s", "formatted")
|
// assert.Positivef(t, 1, "error message %s", "formatted")
|
||||||
// assert.Positivef(t, 1.23, "error message %s", "formatted")
|
// assert.Positivef(t, 1.23, "error message %s", "formatted")
|
||||||
func Positivef(t TestingT, e interface{}, msg string, args ...interface{}) bool {
|
func Positivef(t TestingT, e interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -683,8 +760,8 @@ func Positivef(t TestingT, e interface{}, msg string, args ...interface{}) bool
|
||||||
|
|
||||||
// Regexpf asserts that a specified regexp matches a string.
|
// Regexpf asserts that a specified regexp matches a string.
|
||||||
//
|
//
|
||||||
// assert.Regexpf(t, regexp.MustCompile("start"), "it's starting", "error message %s", "formatted")
|
// assert.Regexpf(t, regexp.MustCompile("start"), "it's starting", "error message %s", "formatted")
|
||||||
// assert.Regexpf(t, "start...$", "it's not starting", "error message %s", "formatted")
|
// assert.Regexpf(t, "start...$", "it's not starting", "error message %s", "formatted")
|
||||||
func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool {
|
func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -694,7 +771,7 @@ func Regexpf(t TestingT, rx interface{}, str interface{}, msg string, args ...in
|
||||||
|
|
||||||
// Samef asserts that two pointers reference the same object.
|
// Samef asserts that two pointers reference the same object.
|
||||||
//
|
//
|
||||||
// assert.Samef(t, ptr1, ptr2, "error message %s", "formatted")
|
// assert.Samef(t, ptr1, ptr2, "error message %s", "formatted")
|
||||||
//
|
//
|
||||||
// Both arguments must be pointer variables. Pointer variable sameness is
|
// Both arguments must be pointer variables. Pointer variable sameness is
|
||||||
// determined based on the equality of both type and value.
|
// determined based on the equality of both type and value.
|
||||||
|
@ -705,10 +782,11 @@ func Samef(t TestingT, expected interface{}, actual interface{}, msg string, arg
|
||||||
return Same(t, expected, actual, append([]interface{}{msg}, args...)...)
|
return Same(t, expected, actual, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Subsetf asserts that the specified list(array, slice...) contains all
|
// Subsetf asserts that the specified list(array, slice...) or map contains all
|
||||||
// elements given in the specified subset(array, slice...).
|
// elements given in the specified subset list(array, slice...) or map.
|
||||||
//
|
//
|
||||||
// assert.Subsetf(t, [1, 2, 3], [1, 2], "But [1, 2, 3] does contain [1, 2]", "error message %s", "formatted")
|
// assert.Subsetf(t, [1, 2, 3], [1, 2], "error message %s", "formatted")
|
||||||
|
// assert.Subsetf(t, {"x": 1, "y": 2}, {"x": 1}, "error message %s", "formatted")
|
||||||
func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool {
|
func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -718,7 +796,7 @@ func Subsetf(t TestingT, list interface{}, subset interface{}, msg string, args
|
||||||
|
|
||||||
// Truef asserts that the specified value is true.
|
// Truef asserts that the specified value is true.
|
||||||
//
|
//
|
||||||
// assert.Truef(t, myBool, "error message %s", "formatted")
|
// assert.Truef(t, myBool, "error message %s", "formatted")
|
||||||
func Truef(t TestingT, value bool, msg string, args ...interface{}) bool {
|
func Truef(t TestingT, value bool, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -728,7 +806,7 @@ func Truef(t TestingT, value bool, msg string, args ...interface{}) bool {
|
||||||
|
|
||||||
// WithinDurationf asserts that the two times are within duration delta of each other.
|
// WithinDurationf asserts that the two times are within duration delta of each other.
|
||||||
//
|
//
|
||||||
// assert.WithinDurationf(t, time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted")
|
// assert.WithinDurationf(t, time.Now(), time.Now(), 10*time.Second, "error message %s", "formatted")
|
||||||
func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) bool {
|
func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta time.Duration, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
|
@ -736,6 +814,16 @@ func WithinDurationf(t TestingT, expected time.Time, actual time.Time, delta tim
|
||||||
return WithinDuration(t, expected, actual, delta, append([]interface{}{msg}, args...)...)
|
return WithinDuration(t, expected, actual, delta, append([]interface{}{msg}, args...)...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WithinRangef asserts that a time is within a time range (inclusive).
|
||||||
|
//
|
||||||
|
// assert.WithinRangef(t, time.Now(), time.Now().Add(-time.Second), time.Now().Add(time.Second), "error message %s", "formatted")
|
||||||
|
func WithinRangef(t TestingT, actual time.Time, start time.Time, end time.Time, msg string, args ...interface{}) bool {
|
||||||
|
if h, ok := t.(tHelper); ok {
|
||||||
|
h.Helper()
|
||||||
|
}
|
||||||
|
return WithinRange(t, actual, start, end, append([]interface{}{msg}, args...)...)
|
||||||
|
}
|
||||||
|
|
||||||
// YAMLEqf asserts that two YAML strings are equivalent.
|
// YAMLEqf asserts that two YAML strings are equivalent.
|
||||||
func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool {
|
func YAMLEqf(t TestingT, expected string, actual string, msg string, args ...interface{}) bool {
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -6,7 +6,7 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
// isOrdered checks that collection contains orderable elements.
|
// isOrdered checks that collection contains orderable elements.
|
||||||
func isOrdered(t TestingT, object interface{}, allowedComparesResults []CompareType, failMessage string, msgAndArgs ...interface{}) bool {
|
func isOrdered(t TestingT, object interface{}, allowedComparesResults []compareResult, failMessage string, msgAndArgs ...interface{}) bool {
|
||||||
objKind := reflect.TypeOf(object).Kind()
|
objKind := reflect.TypeOf(object).Kind()
|
||||||
if objKind != reflect.Slice && objKind != reflect.Array {
|
if objKind != reflect.Slice && objKind != reflect.Array {
|
||||||
return false
|
return false
|
||||||
|
@ -33,7 +33,7 @@ func isOrdered(t TestingT, object interface{}, allowedComparesResults []CompareT
|
||||||
compareResult, isComparable := compare(prevValueInterface, valueInterface, firstValueKind)
|
compareResult, isComparable := compare(prevValueInterface, valueInterface, firstValueKind)
|
||||||
|
|
||||||
if !isComparable {
|
if !isComparable {
|
||||||
return Fail(t, fmt.Sprintf("Can not compare type \"%s\" and \"%s\"", reflect.TypeOf(value), reflect.TypeOf(prevValue)), msgAndArgs...)
|
return Fail(t, fmt.Sprintf(`Can not compare type "%T" and "%T"`, value, prevValue), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !containsValue(allowedComparesResults, compareResult) {
|
if !containsValue(allowedComparesResults, compareResult) {
|
||||||
|
@ -46,36 +46,36 @@ func isOrdered(t TestingT, object interface{}, allowedComparesResults []CompareT
|
||||||
|
|
||||||
// IsIncreasing asserts that the collection is increasing
|
// IsIncreasing asserts that the collection is increasing
|
||||||
//
|
//
|
||||||
// assert.IsIncreasing(t, []int{1, 2, 3})
|
// assert.IsIncreasing(t, []int{1, 2, 3})
|
||||||
// assert.IsIncreasing(t, []float{1, 2})
|
// assert.IsIncreasing(t, []float{1, 2})
|
||||||
// assert.IsIncreasing(t, []string{"a", "b"})
|
// assert.IsIncreasing(t, []string{"a", "b"})
|
||||||
func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
func IsIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
return isOrdered(t, object, []CompareType{compareLess}, "\"%v\" is not less than \"%v\"", msgAndArgs...)
|
return isOrdered(t, object, []compareResult{compareLess}, "\"%v\" is not less than \"%v\"", msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsNonIncreasing asserts that the collection is not increasing
|
// IsNonIncreasing asserts that the collection is not increasing
|
||||||
//
|
//
|
||||||
// assert.IsNonIncreasing(t, []int{2, 1, 1})
|
// assert.IsNonIncreasing(t, []int{2, 1, 1})
|
||||||
// assert.IsNonIncreasing(t, []float{2, 1})
|
// assert.IsNonIncreasing(t, []float{2, 1})
|
||||||
// assert.IsNonIncreasing(t, []string{"b", "a"})
|
// assert.IsNonIncreasing(t, []string{"b", "a"})
|
||||||
func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
func IsNonIncreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
return isOrdered(t, object, []CompareType{compareEqual, compareGreater}, "\"%v\" is not greater than or equal to \"%v\"", msgAndArgs...)
|
return isOrdered(t, object, []compareResult{compareEqual, compareGreater}, "\"%v\" is not greater than or equal to \"%v\"", msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsDecreasing asserts that the collection is decreasing
|
// IsDecreasing asserts that the collection is decreasing
|
||||||
//
|
//
|
||||||
// assert.IsDecreasing(t, []int{2, 1, 0})
|
// assert.IsDecreasing(t, []int{2, 1, 0})
|
||||||
// assert.IsDecreasing(t, []float{2, 1})
|
// assert.IsDecreasing(t, []float{2, 1})
|
||||||
// assert.IsDecreasing(t, []string{"b", "a"})
|
// assert.IsDecreasing(t, []string{"b", "a"})
|
||||||
func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
func IsDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
return isOrdered(t, object, []CompareType{compareGreater}, "\"%v\" is not greater than \"%v\"", msgAndArgs...)
|
return isOrdered(t, object, []compareResult{compareGreater}, "\"%v\" is not greater than \"%v\"", msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsNonDecreasing asserts that the collection is not decreasing
|
// IsNonDecreasing asserts that the collection is not decreasing
|
||||||
//
|
//
|
||||||
// assert.IsNonDecreasing(t, []int{1, 1, 2})
|
// assert.IsNonDecreasing(t, []int{1, 1, 2})
|
||||||
// assert.IsNonDecreasing(t, []float{1, 2})
|
// assert.IsNonDecreasing(t, []float{1, 2})
|
||||||
// assert.IsNonDecreasing(t, []string{"a", "b"})
|
// assert.IsNonDecreasing(t, []string{"a", "b"})
|
||||||
func IsNonDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
func IsNonDecreasing(t TestingT, object interface{}, msgAndArgs ...interface{}) bool {
|
||||||
return isOrdered(t, object, []CompareType{compareLess, compareEqual}, "\"%v\" is not less than or equal to \"%v\"", msgAndArgs...)
|
return isOrdered(t, object, []compareResult{compareLess, compareEqual}, "\"%v\" is not less than or equal to \"%v\"", msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
@ -1,39 +1,40 @@
|
||||||
// Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
// Package assert provides a set of comprehensive testing tools for use with the normal Go testing system.
|
||||||
//
|
//
|
||||||
// Example Usage
|
// # Example Usage
|
||||||
//
|
//
|
||||||
// The following is a complete example using assert in a standard test function:
|
// The following is a complete example using assert in a standard test function:
|
||||||
// import (
|
|
||||||
// "testing"
|
|
||||||
// "github.com/stretchr/testify/assert"
|
|
||||||
// )
|
|
||||||
//
|
//
|
||||||
// func TestSomething(t *testing.T) {
|
// import (
|
||||||
|
// "testing"
|
||||||
|
// "github.com/stretchr/testify/assert"
|
||||||
|
// )
|
||||||
//
|
//
|
||||||
// var a string = "Hello"
|
// func TestSomething(t *testing.T) {
|
||||||
// var b string = "Hello"
|
|
||||||
//
|
//
|
||||||
// assert.Equal(t, a, b, "The two words should be the same.")
|
// var a string = "Hello"
|
||||||
|
// var b string = "Hello"
|
||||||
//
|
//
|
||||||
// }
|
// assert.Equal(t, a, b, "The two words should be the same.")
|
||||||
|
//
|
||||||
|
// }
|
||||||
//
|
//
|
||||||
// if you assert many times, use the format below:
|
// if you assert many times, use the format below:
|
||||||
//
|
//
|
||||||
// import (
|
// import (
|
||||||
// "testing"
|
// "testing"
|
||||||
// "github.com/stretchr/testify/assert"
|
// "github.com/stretchr/testify/assert"
|
||||||
// )
|
// )
|
||||||
//
|
//
|
||||||
// func TestSomething(t *testing.T) {
|
// func TestSomething(t *testing.T) {
|
||||||
// assert := assert.New(t)
|
// assert := assert.New(t)
|
||||||
//
|
//
|
||||||
// var a string = "Hello"
|
// var a string = "Hello"
|
||||||
// var b string = "Hello"
|
// var b string = "Hello"
|
||||||
//
|
//
|
||||||
// assert.Equal(a, b, "The two words should be the same.")
|
// assert.Equal(a, b, "The two words should be the same.")
|
||||||
// }
|
// }
|
||||||
//
|
//
|
||||||
// Assertions
|
// # Assertions
|
||||||
//
|
//
|
||||||
// Assertions allow you to easily write test code, and are global funcs in the `assert` package.
|
// Assertions allow you to easily write test code, and are global funcs in the `assert` package.
|
||||||
// All assertion functions take, as the first argument, the `*testing.T` object provided by the
|
// All assertion functions take, as the first argument, the `*testing.T` object provided by the
|
||||||
|
|
|
@ -546,7 +546,7 @@ func TestRegexpWrapper(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
False(t, assert.Regexp(tc.rx, tc.str), "Expected \"%s\" to not match \"%s\"", tc.rx, tc.str)
|
False(t, assert.Regexp(tc.rx, tc.str), "Expected %q to not match %q", tc.rx, tc.str)
|
||||||
False(t, assert.Regexp(regexp.MustCompile(tc.rx), tc.str))
|
False(t, assert.Regexp(regexp.MustCompile(tc.rx), tc.str))
|
||||||
True(t, assert.NotRegexp(tc.rx, tc.str))
|
True(t, assert.NotRegexp(tc.rx, tc.str))
|
||||||
True(t, assert.NotRegexp(regexp.MustCompile(tc.rx), tc.str))
|
True(t, assert.NotRegexp(regexp.MustCompile(tc.rx), tc.str))
|
||||||
|
|
|
@ -12,7 +12,7 @@ import (
|
||||||
// an error if building a new request fails.
|
// an error if building a new request fails.
|
||||||
func httpCode(handler http.HandlerFunc, method, url string, values url.Values) (int, error) {
|
func httpCode(handler http.HandlerFunc, method, url string, values url.Values) (int, error) {
|
||||||
w := httptest.NewRecorder()
|
w := httptest.NewRecorder()
|
||||||
req, err := http.NewRequest(method, url, nil)
|
req, err := http.NewRequest(method, url, http.NoBody)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return -1, err
|
return -1, err
|
||||||
}
|
}
|
||||||
|
@ -23,7 +23,7 @@ func httpCode(handler http.HandlerFunc, method, url string, values url.Values) (
|
||||||
|
|
||||||
// HTTPSuccess asserts that a specified handler returns a success status code.
|
// HTTPSuccess asserts that a specified handler returns a success status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil)
|
// assert.HTTPSuccess(t, myHandler, "POST", "http://www.google.com", nil)
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool {
|
func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool {
|
||||||
|
@ -32,12 +32,12 @@ func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, value
|
||||||
}
|
}
|
||||||
code, err := httpCode(handler, method, url, values)
|
code, err := httpCode(handler, method, url, values)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err))
|
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
isSuccessCode := code >= http.StatusOK && code <= http.StatusPartialContent
|
isSuccessCode := code >= http.StatusOK && code <= http.StatusPartialContent
|
||||||
if !isSuccessCode {
|
if !isSuccessCode {
|
||||||
Fail(t, fmt.Sprintf("Expected HTTP success status code for %q but received %d", url+"?"+values.Encode(), code))
|
Fail(t, fmt.Sprintf("Expected HTTP success status code for %q but received %d", url+"?"+values.Encode(), code), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return isSuccessCode
|
return isSuccessCode
|
||||||
|
@ -45,7 +45,7 @@ func HTTPSuccess(t TestingT, handler http.HandlerFunc, method, url string, value
|
||||||
|
|
||||||
// HTTPRedirect asserts that a specified handler returns a redirect status code.
|
// HTTPRedirect asserts that a specified handler returns a redirect status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
// assert.HTTPRedirect(t, myHandler, "GET", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool {
|
func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool {
|
||||||
|
@ -54,12 +54,12 @@ func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, valu
|
||||||
}
|
}
|
||||||
code, err := httpCode(handler, method, url, values)
|
code, err := httpCode(handler, method, url, values)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err))
|
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
isRedirectCode := code >= http.StatusMultipleChoices && code <= http.StatusTemporaryRedirect
|
isRedirectCode := code >= http.StatusMultipleChoices && code <= http.StatusTemporaryRedirect
|
||||||
if !isRedirectCode {
|
if !isRedirectCode {
|
||||||
Fail(t, fmt.Sprintf("Expected HTTP redirect status code for %q but received %d", url+"?"+values.Encode(), code))
|
Fail(t, fmt.Sprintf("Expected HTTP redirect status code for %q but received %d", url+"?"+values.Encode(), code), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return isRedirectCode
|
return isRedirectCode
|
||||||
|
@ -67,7 +67,7 @@ func HTTPRedirect(t TestingT, handler http.HandlerFunc, method, url string, valu
|
||||||
|
|
||||||
// HTTPError asserts that a specified handler returns an error status code.
|
// HTTPError asserts that a specified handler returns an error status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
// assert.HTTPError(t, myHandler, "POST", "/a/b/c", url.Values{"a": []string{"b", "c"}}
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool {
|
func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, msgAndArgs ...interface{}) bool {
|
||||||
|
@ -76,12 +76,12 @@ func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values
|
||||||
}
|
}
|
||||||
code, err := httpCode(handler, method, url, values)
|
code, err := httpCode(handler, method, url, values)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err))
|
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
isErrorCode := code >= http.StatusBadRequest
|
isErrorCode := code >= http.StatusBadRequest
|
||||||
if !isErrorCode {
|
if !isErrorCode {
|
||||||
Fail(t, fmt.Sprintf("Expected HTTP error status code for %q but received %d", url+"?"+values.Encode(), code))
|
Fail(t, fmt.Sprintf("Expected HTTP error status code for %q but received %d", url+"?"+values.Encode(), code), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return isErrorCode
|
return isErrorCode
|
||||||
|
@ -89,7 +89,7 @@ func HTTPError(t TestingT, handler http.HandlerFunc, method, url string, values
|
||||||
|
|
||||||
// HTTPStatusCode asserts that a specified handler returns a specified status code.
|
// HTTPStatusCode asserts that a specified handler returns a specified status code.
|
||||||
//
|
//
|
||||||
// assert.HTTPStatusCode(t, myHandler, "GET", "/notImplemented", nil, 501)
|
// assert.HTTPStatusCode(t, myHandler, "GET", "/notImplemented", nil, 501)
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) bool {
|
func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, statuscode int, msgAndArgs ...interface{}) bool {
|
||||||
|
@ -98,12 +98,12 @@ func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, va
|
||||||
}
|
}
|
||||||
code, err := httpCode(handler, method, url, values)
|
code, err := httpCode(handler, method, url, values)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err))
|
Fail(t, fmt.Sprintf("Failed to build test request, got error: %s", err), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
successful := code == statuscode
|
successful := code == statuscode
|
||||||
if !successful {
|
if !successful {
|
||||||
Fail(t, fmt.Sprintf("Expected HTTP status code %d for %q but received %d", statuscode, url+"?"+values.Encode(), code))
|
Fail(t, fmt.Sprintf("Expected HTTP status code %d for %q but received %d", statuscode, url+"?"+values.Encode(), code), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return successful
|
return successful
|
||||||
|
@ -113,7 +113,10 @@ func HTTPStatusCode(t TestingT, handler http.HandlerFunc, method, url string, va
|
||||||
// empty string if building a new request fails.
|
// empty string if building a new request fails.
|
||||||
func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values) string {
|
func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values) string {
|
||||||
w := httptest.NewRecorder()
|
w := httptest.NewRecorder()
|
||||||
req, err := http.NewRequest(method, url+"?"+values.Encode(), nil)
|
if len(values) > 0 {
|
||||||
|
url += "?" + values.Encode()
|
||||||
|
}
|
||||||
|
req, err := http.NewRequest(method, url, http.NoBody)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
@ -124,7 +127,7 @@ func HTTPBody(handler http.HandlerFunc, method, url string, values url.Values) s
|
||||||
// HTTPBodyContains asserts that a specified handler returns a
|
// HTTPBodyContains asserts that a specified handler returns a
|
||||||
// body that contains a string.
|
// body that contains a string.
|
||||||
//
|
//
|
||||||
// assert.HTTPBodyContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")
|
// assert.HTTPBodyContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool {
|
func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
@ -135,7 +138,7 @@ func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string,
|
||||||
|
|
||||||
contains := strings.Contains(body, fmt.Sprint(str))
|
contains := strings.Contains(body, fmt.Sprint(str))
|
||||||
if !contains {
|
if !contains {
|
||||||
Fail(t, fmt.Sprintf("Expected response body for \"%s\" to contain \"%s\" but found \"%s\"", url+"?"+values.Encode(), str, body))
|
Fail(t, fmt.Sprintf("Expected response body for %q to contain %q but found %q", url+"?"+values.Encode(), str, body), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return contains
|
return contains
|
||||||
|
@ -144,7 +147,7 @@ func HTTPBodyContains(t TestingT, handler http.HandlerFunc, method, url string,
|
||||||
// HTTPBodyNotContains asserts that a specified handler returns a
|
// HTTPBodyNotContains asserts that a specified handler returns a
|
||||||
// body that does not contain a string.
|
// body that does not contain a string.
|
||||||
//
|
//
|
||||||
// assert.HTTPBodyNotContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")
|
// assert.HTTPBodyNotContains(t, myHandler, "GET", "www.google.com", nil, "I'm Feeling Lucky")
|
||||||
//
|
//
|
||||||
// Returns whether the assertion was successful (true) or not (false).
|
// Returns whether the assertion was successful (true) or not (false).
|
||||||
func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool {
|
func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url string, values url.Values, str interface{}, msgAndArgs ...interface{}) bool {
|
||||||
|
@ -155,7 +158,7 @@ func HTTPBodyNotContains(t TestingT, handler http.HandlerFunc, method, url strin
|
||||||
|
|
||||||
contains := strings.Contains(body, fmt.Sprint(str))
|
contains := strings.Contains(body, fmt.Sprint(str))
|
||||||
if contains {
|
if contains {
|
||||||
Fail(t, fmt.Sprintf("Expected response body for \"%s\" to NOT contain \"%s\" but found \"%s\"", url+"?"+values.Encode(), str, body))
|
Fail(t, fmt.Sprintf("Expected response body for %q to NOT contain %q but found %q", url+"?"+values.Encode(), str, body), msgAndArgs...)
|
||||||
}
|
}
|
||||||
|
|
||||||
return !contains
|
return !contains
|
||||||
|
|
|
@ -2,6 +2,7 @@ package assert
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"testing"
|
"testing"
|
||||||
|
@ -11,6 +12,12 @@ func httpOK(w http.ResponseWriter, r *http.Request) {
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func httpReadBody(w http.ResponseWriter, r *http.Request) {
|
||||||
|
_, _ = io.Copy(io.Discard, r.Body)
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write([]byte("hello"))
|
||||||
|
}
|
||||||
|
|
||||||
func httpRedirect(w http.ResponseWriter, r *http.Request) {
|
func httpRedirect(w http.ResponseWriter, r *http.Request) {
|
||||||
w.WriteHeader(http.StatusTemporaryRedirect)
|
w.WriteHeader(http.StatusTemporaryRedirect)
|
||||||
}
|
}
|
||||||
|
@ -34,21 +41,33 @@ func TestHTTPSuccess(t *testing.T) {
|
||||||
assert.Equal(HTTPSuccess(mockT2, httpRedirect, "GET", "/", nil), false)
|
assert.Equal(HTTPSuccess(mockT2, httpRedirect, "GET", "/", nil), false)
|
||||||
assert.True(mockT2.Failed())
|
assert.True(mockT2.Failed())
|
||||||
|
|
||||||
mockT3 := new(testing.T)
|
mockT3 := new(mockTestingT)
|
||||||
assert.Equal(HTTPSuccess(mockT3, httpError, "GET", "/", nil), false)
|
assert.Equal(HTTPSuccess(
|
||||||
|
mockT3, httpError, "GET", "/", nil,
|
||||||
|
"was not expecting a failure here",
|
||||||
|
), false)
|
||||||
assert.True(mockT3.Failed())
|
assert.True(mockT3.Failed())
|
||||||
|
assert.Contains(mockT3.errorString(), "was not expecting a failure here")
|
||||||
|
|
||||||
mockT4 := new(testing.T)
|
mockT4 := new(testing.T)
|
||||||
assert.Equal(HTTPSuccess(mockT4, httpStatusCode, "GET", "/", nil), false)
|
assert.Equal(HTTPSuccess(mockT4, httpStatusCode, "GET", "/", nil), false)
|
||||||
assert.True(mockT4.Failed())
|
assert.True(mockT4.Failed())
|
||||||
|
|
||||||
|
mockT5 := new(testing.T)
|
||||||
|
assert.Equal(HTTPSuccess(mockT5, httpReadBody, "POST", "/", nil), true)
|
||||||
|
assert.False(mockT5.Failed())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHTTPRedirect(t *testing.T) {
|
func TestHTTPRedirect(t *testing.T) {
|
||||||
assert := New(t)
|
assert := New(t)
|
||||||
|
|
||||||
mockT1 := new(testing.T)
|
mockT1 := new(mockTestingT)
|
||||||
assert.Equal(HTTPRedirect(mockT1, httpOK, "GET", "/", nil), false)
|
assert.Equal(HTTPRedirect(
|
||||||
|
mockT1, httpOK, "GET", "/", nil,
|
||||||
|
"was expecting a 3xx status code. Got 200.",
|
||||||
|
), false)
|
||||||
assert.True(mockT1.Failed())
|
assert.True(mockT1.Failed())
|
||||||
|
assert.Contains(mockT1.errorString(), "was expecting a 3xx status code. Got 200.")
|
||||||
|
|
||||||
mockT2 := new(testing.T)
|
mockT2 := new(testing.T)
|
||||||
assert.Equal(HTTPRedirect(mockT2, httpRedirect, "GET", "/", nil), true)
|
assert.Equal(HTTPRedirect(mockT2, httpRedirect, "GET", "/", nil), true)
|
||||||
|
@ -70,9 +89,13 @@ func TestHTTPError(t *testing.T) {
|
||||||
assert.Equal(HTTPError(mockT1, httpOK, "GET", "/", nil), false)
|
assert.Equal(HTTPError(mockT1, httpOK, "GET", "/", nil), false)
|
||||||
assert.True(mockT1.Failed())
|
assert.True(mockT1.Failed())
|
||||||
|
|
||||||
mockT2 := new(testing.T)
|
mockT2 := new(mockTestingT)
|
||||||
assert.Equal(HTTPError(mockT2, httpRedirect, "GET", "/", nil), false)
|
assert.Equal(HTTPError(
|
||||||
|
mockT2, httpRedirect, "GET", "/", nil,
|
||||||
|
"Expected this request to error out. But it didn't",
|
||||||
|
), false)
|
||||||
assert.True(mockT2.Failed())
|
assert.True(mockT2.Failed())
|
||||||
|
assert.Contains(mockT2.errorString(), "Expected this request to error out. But it didn't")
|
||||||
|
|
||||||
mockT3 := new(testing.T)
|
mockT3 := new(testing.T)
|
||||||
assert.Equal(HTTPError(mockT3, httpError, "GET", "/", nil), true)
|
assert.Equal(HTTPError(mockT3, httpError, "GET", "/", nil), true)
|
||||||
|
@ -94,9 +117,13 @@ func TestHTTPStatusCode(t *testing.T) {
|
||||||
assert.Equal(HTTPStatusCode(mockT2, httpRedirect, "GET", "/", nil, http.StatusSwitchingProtocols), false)
|
assert.Equal(HTTPStatusCode(mockT2, httpRedirect, "GET", "/", nil, http.StatusSwitchingProtocols), false)
|
||||||
assert.True(mockT2.Failed())
|
assert.True(mockT2.Failed())
|
||||||
|
|
||||||
mockT3 := new(testing.T)
|
mockT3 := new(mockTestingT)
|
||||||
assert.Equal(HTTPStatusCode(mockT3, httpError, "GET", "/", nil, http.StatusSwitchingProtocols), false)
|
assert.Equal(HTTPStatusCode(
|
||||||
|
mockT3, httpError, "GET", "/", nil, http.StatusSwitchingProtocols,
|
||||||
|
"Expected the status code to be %d", http.StatusSwitchingProtocols,
|
||||||
|
), false)
|
||||||
assert.True(mockT3.Failed())
|
assert.True(mockT3.Failed())
|
||||||
|
assert.Contains(mockT3.errorString(), "Expected the status code to be 101")
|
||||||
|
|
||||||
mockT4 := new(testing.T)
|
mockT4 := new(testing.T)
|
||||||
assert.Equal(HTTPStatusCode(mockT4, httpStatusCode, "GET", "/", nil, http.StatusSwitchingProtocols), true)
|
assert.Equal(HTTPStatusCode(mockT4, httpStatusCode, "GET", "/", nil, http.StatusSwitchingProtocols), true)
|
||||||
|
@ -122,7 +149,7 @@ func TestHTTPStatusesWrapper(t *testing.T) {
|
||||||
|
|
||||||
func httpHelloName(w http.ResponseWriter, r *http.Request) {
|
func httpHelloName(w http.ResponseWriter, r *http.Request) {
|
||||||
name := r.FormValue("name")
|
name := r.FormValue("name")
|
||||||
_, _ = w.Write([]byte(fmt.Sprintf("Hello, %s!", name)))
|
_, _ = fmt.Fprintf(w, "Hello, %s!", name)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHTTPRequestWithNoParams(t *testing.T) {
|
func TestHTTPRequestWithNoParams(t *testing.T) {
|
||||||
|
@ -156,15 +183,21 @@ func TestHTTPRequestWithParams(t *testing.T) {
|
||||||
|
|
||||||
func TestHttpBody(t *testing.T) {
|
func TestHttpBody(t *testing.T) {
|
||||||
assert := New(t)
|
assert := New(t)
|
||||||
mockT := new(testing.T)
|
mockT := new(mockTestingT)
|
||||||
|
|
||||||
assert.True(HTTPBodyContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "Hello, World!"))
|
assert.True(HTTPBodyContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "Hello, World!"))
|
||||||
assert.True(HTTPBodyContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "World"))
|
assert.True(HTTPBodyContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "World"))
|
||||||
assert.False(HTTPBodyContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "world"))
|
assert.False(HTTPBodyContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "world"))
|
||||||
|
|
||||||
assert.False(HTTPBodyNotContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "Hello, World!"))
|
assert.False(HTTPBodyNotContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "Hello, World!"))
|
||||||
assert.False(HTTPBodyNotContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "World"))
|
assert.False(HTTPBodyNotContains(
|
||||||
|
mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "World",
|
||||||
|
"Expected the request body to not contain 'World'. But it did.",
|
||||||
|
))
|
||||||
assert.True(HTTPBodyNotContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "world"))
|
assert.True(HTTPBodyNotContains(mockT, httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "world"))
|
||||||
|
assert.Contains(mockT.errorString(), "Expected the request body to not contain 'World'. But it did.")
|
||||||
|
|
||||||
|
assert.True(HTTPBodyContains(mockT, httpReadBody, "GET", "/", nil, "hello"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHttpBodyWrappers(t *testing.T) {
|
func TestHttpBodyWrappers(t *testing.T) {
|
||||||
|
@ -178,5 +211,4 @@ func TestHttpBodyWrappers(t *testing.T) {
|
||||||
assert.False(mockAssert.HTTPBodyNotContains(httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "Hello, World!"))
|
assert.False(mockAssert.HTTPBodyNotContains(httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "Hello, World!"))
|
||||||
assert.False(mockAssert.HTTPBodyNotContains(httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "World"))
|
assert.False(mockAssert.HTTPBodyNotContains(httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "World"))
|
||||||
assert.True(mockAssert.HTTPBodyNotContains(httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "world"))
|
assert.True(mockAssert.HTTPBodyNotContains(httpHelloName, "GET", "/", url.Values{"name": []string{"World"}}, "world"))
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
// This package exists just to isolate tests that reference the [unsafe] package.
|
||||||
|
//
|
||||||
|
// The tests in this package are totally safe.
|
||||||
|
package unsafetests
|
|
@ -0,0 +1,34 @@
|
||||||
|
package unsafetests_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"testing"
|
||||||
|
"unsafe"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ignoreTestingT struct{}
|
||||||
|
|
||||||
|
var _ assert.TestingT = ignoreTestingT{}
|
||||||
|
|
||||||
|
func (ignoreTestingT) Helper() {}
|
||||||
|
|
||||||
|
func (ignoreTestingT) Errorf(format string, args ...interface{}) {
|
||||||
|
// Run the formatting, but ignore the result
|
||||||
|
msg := fmt.Sprintf(format, args...)
|
||||||
|
_ = msg
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnsafePointers(t *testing.T) {
|
||||||
|
var ignore ignoreTestingT
|
||||||
|
|
||||||
|
assert.True(t, assert.Nil(t, unsafe.Pointer(nil), "unsafe.Pointer(nil) is nil"))
|
||||||
|
assert.False(t, assert.NotNil(ignore, unsafe.Pointer(nil), "unsafe.Pointer(nil) is nil"))
|
||||||
|
|
||||||
|
assert.True(t, assert.Nil(t, unsafe.Pointer((*int)(nil)), "unsafe.Pointer((*int)(nil)) is nil"))
|
||||||
|
assert.False(t, assert.NotNil(ignore, unsafe.Pointer((*int)(nil)), "unsafe.Pointer((*int)(nil)) is nil"))
|
||||||
|
|
||||||
|
assert.False(t, assert.Nil(ignore, unsafe.Pointer(new(int)), "unsafe.Pointer(new(int)) is NOT nil"))
|
||||||
|
assert.True(t, assert.NotNil(t, unsafe.Pointer(new(int)), "unsafe.Pointer(new(int)) is NOT nil"))
|
||||||
|
}
|
|
@ -0,0 +1,25 @@
|
||||||
|
//go:build testify_yaml_custom && !testify_yaml_fail && !testify_yaml_default
|
||||||
|
// +build testify_yaml_custom,!testify_yaml_fail,!testify_yaml_default
|
||||||
|
|
||||||
|
// Package yaml is an implementation of YAML functions that calls a pluggable implementation.
|
||||||
|
//
|
||||||
|
// This implementation is selected with the testify_yaml_custom build tag.
|
||||||
|
//
|
||||||
|
// go test -tags testify_yaml_custom
|
||||||
|
//
|
||||||
|
// This implementation can be used at build time to replace the default implementation
|
||||||
|
// to avoid linking with [gopkg.in/yaml.v3].
|
||||||
|
//
|
||||||
|
// In your test package:
|
||||||
|
//
|
||||||
|
// import assertYaml "github.com/stretchr/testify/assert/yaml"
|
||||||
|
//
|
||||||
|
// func init() {
|
||||||
|
// assertYaml.Unmarshal = func (in []byte, out interface{}) error {
|
||||||
|
// // ...
|
||||||
|
// return nil
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
package yaml
|
||||||
|
|
||||||
|
var Unmarshal func(in []byte, out interface{}) error
|
|
@ -0,0 +1,37 @@
|
||||||
|
//go:build !testify_yaml_fail && !testify_yaml_custom
|
||||||
|
// +build !testify_yaml_fail,!testify_yaml_custom
|
||||||
|
|
||||||
|
// Package yaml is just an indirection to handle YAML deserialization.
|
||||||
|
//
|
||||||
|
// This package is just an indirection that allows the builder to override the
|
||||||
|
// indirection with an alternative implementation of this package that uses
|
||||||
|
// another implementation of YAML deserialization. This allows to not either not
|
||||||
|
// use YAML deserialization at all, or to use another implementation than
|
||||||
|
// [gopkg.in/yaml.v3] (for example for license compatibility reasons, see [PR #1120]).
|
||||||
|
//
|
||||||
|
// Alternative implementations are selected using build tags:
|
||||||
|
//
|
||||||
|
// - testify_yaml_fail: [Unmarshal] always fails with an error
|
||||||
|
// - testify_yaml_custom: [Unmarshal] is a variable. Caller must initialize it
|
||||||
|
// before calling any of [github.com/stretchr/testify/assert.YAMLEq] or
|
||||||
|
// [github.com/stretchr/testify/assert.YAMLEqf].
|
||||||
|
//
|
||||||
|
// Usage:
|
||||||
|
//
|
||||||
|
// go test -tags testify_yaml_fail
|
||||||
|
//
|
||||||
|
// You can check with "go list" which implementation is linked:
|
||||||
|
//
|
||||||
|
// go list -f '{{.Imports}}' github.com/stretchr/testify/assert/yaml
|
||||||
|
// go list -tags testify_yaml_fail -f '{{.Imports}}' github.com/stretchr/testify/assert/yaml
|
||||||
|
// go list -tags testify_yaml_custom -f '{{.Imports}}' github.com/stretchr/testify/assert/yaml
|
||||||
|
//
|
||||||
|
// [PR #1120]: https://github.com/stretchr/testify/pull/1120
|
||||||
|
package yaml
|
||||||
|
|
||||||
|
import goyaml "gopkg.in/yaml.v3"
|
||||||
|
|
||||||
|
// Unmarshal is just a wrapper of [gopkg.in/yaml.v3.Unmarshal].
|
||||||
|
func Unmarshal(in []byte, out interface{}) error {
|
||||||
|
return goyaml.Unmarshal(in, out)
|
||||||
|
}
|
|
@ -0,0 +1,18 @@
|
||||||
|
//go:build testify_yaml_fail && !testify_yaml_custom && !testify_yaml_default
|
||||||
|
// +build testify_yaml_fail,!testify_yaml_custom,!testify_yaml_default
|
||||||
|
|
||||||
|
// Package yaml is an implementation of YAML functions that always fail.
|
||||||
|
//
|
||||||
|
// This implementation can be used at build time to replace the default implementation
|
||||||
|
// to avoid linking with [gopkg.in/yaml.v3]:
|
||||||
|
//
|
||||||
|
// go test -tags testify_yaml_fail
|
||||||
|
package yaml
|
||||||
|
|
||||||
|
import "errors"
|
||||||
|
|
||||||
|
var errNotImplemented = errors.New("YAML functions are not available (see https://pkg.go.dev/github.com/stretchr/testify/assert/yaml)")
|
||||||
|
|
||||||
|
func Unmarshal([]byte, interface{}) error {
|
||||||
|
return errNotImplemented
|
||||||
|
}
|
18
doc.go
18
doc.go
|
@ -1,23 +1,15 @@
|
||||||
// ** We are working on testify v2 and would love to hear what you'd like to see in it, have your say here: https://cutt.ly/testify **
|
|
||||||
// Package testify is a set of packages that provide many tools for testifying that your code will behave as you intend.
|
// Package testify is a set of packages that provide many tools for testifying that your code will behave as you intend.
|
||||||
//
|
//
|
||||||
// testify contains the following packages:
|
// testify contains the following packages:
|
||||||
//
|
//
|
||||||
// The assert package provides a comprehensive set of assertion functions that tie in to the Go testing system.
|
// The assert package provides a comprehensive set of assertion functions that tie in to the Go testing system.
|
||||||
//
|
//
|
||||||
// The http package contains tools to make it easier to test http activity using the Go testing system.
|
|
||||||
//
|
|
||||||
// The mock package provides a system by which it is possible to mock your objects and verify calls are happening as expected.
|
// The mock package provides a system by which it is possible to mock your objects and verify calls are happening as expected.
|
||||||
//
|
//
|
||||||
// The suite package provides a basic structure for using structs as testing suites, and methods on those structs as tests. It includes setup/teardown functionality in the way of interfaces.
|
// The suite package provides a basic structure for using structs as testing suites, and methods on those structs as tests. It includes setup/teardown functionality in the way of interfaces.
|
||||||
|
//
|
||||||
|
// A [golangci-lint] compatible linter for testify is available called [testifylint].
|
||||||
|
//
|
||||||
|
// [golangci-lint]: https://golangci-lint.run/
|
||||||
|
// [testifylint]: https://github.com/Antonboom/testifylint
|
||||||
package testify
|
package testify
|
||||||
|
|
||||||
// blank imports help docs.
|
|
||||||
import (
|
|
||||||
// assert package
|
|
||||||
_ "github.com/stretchr/testify/assert"
|
|
||||||
// http package
|
|
||||||
_ "github.com/stretchr/testify/http"
|
|
||||||
// mock package
|
|
||||||
_ "github.com/stretchr/testify/mock"
|
|
||||||
)
|
|
||||||
|
|
10
go.mod
10
go.mod
|
@ -1,10 +1,16 @@
|
||||||
module github.com/stretchr/testify
|
module github.com/stretchr/testify
|
||||||
|
|
||||||
go 1.13
|
// This should match the minimum supported version that is tested in
|
||||||
|
// .github/workflows/main.yml
|
||||||
|
go 1.17
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/davecgh/go-spew v1.1.1
|
github.com/davecgh/go-spew v1.1.1
|
||||||
github.com/pmezard/go-difflib v1.0.0
|
github.com/pmezard/go-difflib v1.0.0
|
||||||
github.com/stretchr/objx v0.4.0
|
github.com/stretchr/objx v0.5.2
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Break dependency cycle with objx.
|
||||||
|
// See https://github.com/stretchr/objx/pull/140
|
||||||
|
exclude github.com/stretchr/testify v1.8.2
|
||||||
|
|
6
go.sum
6
go.sum
|
@ -4,9 +4,13 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
|
||||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
github.com/stretchr/objx v0.4.0 h1:M2gUjqZET1qApGOWNSnZ49BAIMX4F/1plDv3+l31EJ4=
|
|
||||||
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
|
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
|
||||||
|
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
|
||||||
|
github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
|
||||||
|
github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
|
||||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
|
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
|
||||||
|
github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
// Package http DEPRECATED USE net/http/httptest
|
// Deprecated: Use [net/http/httptest] instead.
|
||||||
package http
|
package http
|
||||||
|
|
|
@ -4,7 +4,7 @@ import (
|
||||||
"net/http"
|
"net/http"
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestResponseWriter DEPRECATED: We recommend you use http://golang.org/pkg/net/http/httptest instead.
|
// Deprecated: Use [net/http/httptest] instead.
|
||||||
type TestResponseWriter struct {
|
type TestResponseWriter struct {
|
||||||
|
|
||||||
// StatusCode is the last int written by the call to WriteHeader(int)
|
// StatusCode is the last int written by the call to WriteHeader(int)
|
||||||
|
@ -17,7 +17,7 @@ type TestResponseWriter struct {
|
||||||
header http.Header
|
header http.Header
|
||||||
}
|
}
|
||||||
|
|
||||||
// Header DEPRECATED: We recommend you use http://golang.org/pkg/net/http/httptest instead.
|
// Deprecated: Use [net/http/httptest] instead.
|
||||||
func (rw *TestResponseWriter) Header() http.Header {
|
func (rw *TestResponseWriter) Header() http.Header {
|
||||||
|
|
||||||
if rw.header == nil {
|
if rw.header == nil {
|
||||||
|
@ -27,7 +27,7 @@ func (rw *TestResponseWriter) Header() http.Header {
|
||||||
return rw.header
|
return rw.header
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write DEPRECATED: We recommend you use http://golang.org/pkg/net/http/httptest instead.
|
// Deprecated: Use [net/http/httptest] instead.
|
||||||
func (rw *TestResponseWriter) Write(bytes []byte) (int, error) {
|
func (rw *TestResponseWriter) Write(bytes []byte) (int, error) {
|
||||||
|
|
||||||
// assume 200 success if no header has been set
|
// assume 200 success if no header has been set
|
||||||
|
@ -43,7 +43,7 @@ func (rw *TestResponseWriter) Write(bytes []byte) (int, error) {
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// WriteHeader DEPRECATED: We recommend you use http://golang.org/pkg/net/http/httptest instead.
|
// Deprecated: Use [net/http/httptest] instead.
|
||||||
func (rw *TestResponseWriter) WriteHeader(i int) {
|
func (rw *TestResponseWriter) WriteHeader(i int) {
|
||||||
rw.StatusCode = i
|
rw.StatusCode = i
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,12 +6,12 @@ import (
|
||||||
"github.com/stretchr/testify/mock"
|
"github.com/stretchr/testify/mock"
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestRoundTripper DEPRECATED USE net/http/httptest
|
// Deprecated: Use [net/http/httptest] instead.
|
||||||
type TestRoundTripper struct {
|
type TestRoundTripper struct {
|
||||||
mock.Mock
|
mock.Mock
|
||||||
}
|
}
|
||||||
|
|
||||||
// RoundTrip DEPRECATED USE net/http/httptest
|
// Deprecated: Use [net/http/httptest] instead.
|
||||||
func (t *TestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
func (t *TestRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
args := t.Called(req)
|
args := t.Called(req)
|
||||||
return args.Get(0).(*http.Response), args.Error(1)
|
return args.Get(0).(*http.Response), args.Error(1)
|
||||||
|
|
30
mock/doc.go
30
mock/doc.go
|
@ -1,17 +1,17 @@
|
||||||
// Package mock provides a system by which it is possible to mock your objects
|
// Package mock provides a system by which it is possible to mock your objects
|
||||||
// and verify calls are happening as expected.
|
// and verify calls are happening as expected.
|
||||||
//
|
//
|
||||||
// Example Usage
|
// # Example Usage
|
||||||
//
|
//
|
||||||
// The mock package provides an object, Mock, that tracks activity on another object. It is usually
|
// The mock package provides an object, Mock, that tracks activity on another object. It is usually
|
||||||
// embedded into a test object as shown below:
|
// embedded into a test object as shown below:
|
||||||
//
|
//
|
||||||
// type MyTestObject struct {
|
// type MyTestObject struct {
|
||||||
// // add a Mock object instance
|
// // add a Mock object instance
|
||||||
// mock.Mock
|
// mock.Mock
|
||||||
//
|
//
|
||||||
// // other fields go here as normal
|
// // other fields go here as normal
|
||||||
// }
|
// }
|
||||||
//
|
//
|
||||||
// When implementing the methods of an interface, you wire your functions up
|
// When implementing the methods of an interface, you wire your functions up
|
||||||
// to call the Mock.Called(args...) method, and return the appropriate values.
|
// to call the Mock.Called(args...) method, and return the appropriate values.
|
||||||
|
@ -19,25 +19,25 @@
|
||||||
// For example, to mock a method that saves the name and age of a person and returns
|
// For example, to mock a method that saves the name and age of a person and returns
|
||||||
// the year of their birth or an error, you might write this:
|
// the year of their birth or an error, you might write this:
|
||||||
//
|
//
|
||||||
// func (o *MyTestObject) SavePersonDetails(firstname, lastname string, age int) (int, error) {
|
// func (o *MyTestObject) SavePersonDetails(firstname, lastname string, age int) (int, error) {
|
||||||
// args := o.Called(firstname, lastname, age)
|
// args := o.Called(firstname, lastname, age)
|
||||||
// return args.Int(0), args.Error(1)
|
// return args.Int(0), args.Error(1)
|
||||||
// }
|
// }
|
||||||
//
|
//
|
||||||
// The Int, Error and Bool methods are examples of strongly typed getters that take the argument
|
// The Int, Error and Bool methods are examples of strongly typed getters that take the argument
|
||||||
// index position. Given this argument list:
|
// index position. Given this argument list:
|
||||||
//
|
//
|
||||||
// (12, true, "Something")
|
// (12, true, "Something")
|
||||||
//
|
//
|
||||||
// You could read them out strongly typed like this:
|
// You could read them out strongly typed like this:
|
||||||
//
|
//
|
||||||
// args.Int(0)
|
// args.Int(0)
|
||||||
// args.Bool(1)
|
// args.Bool(1)
|
||||||
// args.String(2)
|
// args.String(2)
|
||||||
//
|
//
|
||||||
// For objects of your own type, use the generic Arguments.Get(index) method and make a type assertion:
|
// For objects of your own type, use the generic Arguments.Get(index) method and make a type assertion:
|
||||||
//
|
//
|
||||||
// return args.Get(0).(*MyObject), args.Get(1).(*AnotherObjectOfMine)
|
// return args.Get(0).(*MyObject), args.Get(1).(*AnotherObjectOfMine)
|
||||||
//
|
//
|
||||||
// This may cause a panic if the object you are getting is nil (the type assertion will fail), in those
|
// This may cause a panic if the object you are getting is nil (the type assertion will fail), in those
|
||||||
// cases you should check for nil first.
|
// cases you should check for nil first.
|
||||||
|
|
478
mock/mock.go
478
mock/mock.go
|
@ -3,6 +3,7 @@ package mock
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"path"
|
||||||
"reflect"
|
"reflect"
|
||||||
"regexp"
|
"regexp"
|
||||||
"runtime"
|
"runtime"
|
||||||
|
@ -13,9 +14,13 @@ import (
|
||||||
"github.com/davecgh/go-spew/spew"
|
"github.com/davecgh/go-spew/spew"
|
||||||
"github.com/pmezard/go-difflib/difflib"
|
"github.com/pmezard/go-difflib/difflib"
|
||||||
"github.com/stretchr/objx"
|
"github.com/stretchr/objx"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// regex for GCCGO functions
|
||||||
|
var gccgoRE = regexp.MustCompile(`\.pN\d+_`)
|
||||||
|
|
||||||
// TestingT is an interface wrapper around *testing.T
|
// TestingT is an interface wrapper around *testing.T
|
||||||
type TestingT interface {
|
type TestingT interface {
|
||||||
Logf(format string, args ...interface{})
|
Logf(format string, args ...interface{})
|
||||||
|
@ -70,14 +75,17 @@ type Call struct {
|
||||||
// if the PanicMsg is set to a non nil string the function call will panic
|
// if the PanicMsg is set to a non nil string the function call will panic
|
||||||
// irrespective of other settings
|
// irrespective of other settings
|
||||||
PanicMsg *string
|
PanicMsg *string
|
||||||
|
|
||||||
|
// Calls which must be satisfied before this call can be
|
||||||
|
requires []*Call
|
||||||
}
|
}
|
||||||
|
|
||||||
func newCall(parent *Mock, methodName string, callerInfo []string, methodArguments ...interface{}) *Call {
|
func newCall(parent *Mock, methodName string, callerInfo []string, methodArguments Arguments, returnArguments Arguments) *Call {
|
||||||
return &Call{
|
return &Call{
|
||||||
Parent: parent,
|
Parent: parent,
|
||||||
Method: methodName,
|
Method: methodName,
|
||||||
Arguments: methodArguments,
|
Arguments: methodArguments,
|
||||||
ReturnArguments: make([]interface{}, 0),
|
ReturnArguments: returnArguments,
|
||||||
callerInfo: callerInfo,
|
callerInfo: callerInfo,
|
||||||
Repeatability: 0,
|
Repeatability: 0,
|
||||||
WaitFor: nil,
|
WaitFor: nil,
|
||||||
|
@ -96,7 +104,7 @@ func (c *Call) unlock() {
|
||||||
|
|
||||||
// Return specifies the return arguments for the expectation.
|
// Return specifies the return arguments for the expectation.
|
||||||
//
|
//
|
||||||
// Mock.On("DoSomething").Return(errors.New("failed"))
|
// Mock.On("DoSomething").Return(errors.New("failed"))
|
||||||
func (c *Call) Return(returnArguments ...interface{}) *Call {
|
func (c *Call) Return(returnArguments ...interface{}) *Call {
|
||||||
c.lock()
|
c.lock()
|
||||||
defer c.unlock()
|
defer c.unlock()
|
||||||
|
@ -106,9 +114,9 @@ func (c *Call) Return(returnArguments ...interface{}) *Call {
|
||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
// Panic specifies if the functon call should fail and the panic message
|
// Panic specifies if the function call should fail and the panic message
|
||||||
//
|
//
|
||||||
// Mock.On("DoSomething").Panic("test panic")
|
// Mock.On("DoSomething").Panic("test panic")
|
||||||
func (c *Call) Panic(msg string) *Call {
|
func (c *Call) Panic(msg string) *Call {
|
||||||
c.lock()
|
c.lock()
|
||||||
defer c.unlock()
|
defer c.unlock()
|
||||||
|
@ -118,24 +126,24 @@ func (c *Call) Panic(msg string) *Call {
|
||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
|
||||||
// Once indicates that that the mock should only return the value once.
|
// Once indicates that the mock should only return the value once.
|
||||||
//
|
//
|
||||||
// Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Once()
|
// Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Once()
|
||||||
func (c *Call) Once() *Call {
|
func (c *Call) Once() *Call {
|
||||||
return c.Times(1)
|
return c.Times(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Twice indicates that that the mock should only return the value twice.
|
// Twice indicates that the mock should only return the value twice.
|
||||||
//
|
//
|
||||||
// Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Twice()
|
// Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Twice()
|
||||||
func (c *Call) Twice() *Call {
|
func (c *Call) Twice() *Call {
|
||||||
return c.Times(2)
|
return c.Times(2)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Times indicates that that the mock should only return the indicated number
|
// Times indicates that the mock should only return the indicated number
|
||||||
// of times.
|
// of times.
|
||||||
//
|
//
|
||||||
// Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Times(5)
|
// Mock.On("MyMethod", arg1, arg2).Return(returnArg1, returnArg2).Times(5)
|
||||||
func (c *Call) Times(i int) *Call {
|
func (c *Call) Times(i int) *Call {
|
||||||
c.lock()
|
c.lock()
|
||||||
defer c.unlock()
|
defer c.unlock()
|
||||||
|
@ -146,7 +154,7 @@ func (c *Call) Times(i int) *Call {
|
||||||
// WaitUntil sets the channel that will block the mock's return until its closed
|
// WaitUntil sets the channel that will block the mock's return until its closed
|
||||||
// or a message is received.
|
// or a message is received.
|
||||||
//
|
//
|
||||||
// Mock.On("MyMethod", arg1, arg2).WaitUntil(time.After(time.Second))
|
// Mock.On("MyMethod", arg1, arg2).WaitUntil(time.After(time.Second))
|
||||||
func (c *Call) WaitUntil(w <-chan time.Time) *Call {
|
func (c *Call) WaitUntil(w <-chan time.Time) *Call {
|
||||||
c.lock()
|
c.lock()
|
||||||
defer c.unlock()
|
defer c.unlock()
|
||||||
|
@ -156,7 +164,7 @@ func (c *Call) WaitUntil(w <-chan time.Time) *Call {
|
||||||
|
|
||||||
// After sets how long to block until the call returns
|
// After sets how long to block until the call returns
|
||||||
//
|
//
|
||||||
// Mock.On("MyMethod", arg1, arg2).After(time.Second)
|
// Mock.On("MyMethod", arg1, arg2).After(time.Second)
|
||||||
func (c *Call) After(d time.Duration) *Call {
|
func (c *Call) After(d time.Duration) *Call {
|
||||||
c.lock()
|
c.lock()
|
||||||
defer c.unlock()
|
defer c.unlock()
|
||||||
|
@ -168,10 +176,10 @@ func (c *Call) After(d time.Duration) *Call {
|
||||||
// mocking a method (such as an unmarshaler) that takes a pointer to a struct and
|
// mocking a method (such as an unmarshaler) that takes a pointer to a struct and
|
||||||
// sets properties in such struct
|
// sets properties in such struct
|
||||||
//
|
//
|
||||||
// Mock.On("Unmarshal", AnythingOfType("*map[string]interface{}")).Return().Run(func(args Arguments) {
|
// Mock.On("Unmarshal", AnythingOfType("*map[string]interface{}")).Return().Run(func(args Arguments) {
|
||||||
// arg := args.Get(0).(*map[string]interface{})
|
// arg := args.Get(0).(*map[string]interface{})
|
||||||
// arg["foo"] = "bar"
|
// arg["foo"] = "bar"
|
||||||
// })
|
// })
|
||||||
func (c *Call) Run(fn func(args Arguments)) *Call {
|
func (c *Call) Run(fn func(args Arguments)) *Call {
|
||||||
c.lock()
|
c.lock()
|
||||||
defer c.unlock()
|
defer c.unlock()
|
||||||
|
@ -191,14 +199,101 @@ func (c *Call) Maybe() *Call {
|
||||||
// On chains a new expectation description onto the mocked interface. This
|
// On chains a new expectation description onto the mocked interface. This
|
||||||
// allows syntax like.
|
// allows syntax like.
|
||||||
//
|
//
|
||||||
// Mock.
|
// Mock.
|
||||||
// On("MyMethod", 1).Return(nil).
|
// On("MyMethod", 1).Return(nil).
|
||||||
// On("MyOtherMethod", 'a', 'b', 'c').Return(errors.New("Some Error"))
|
// On("MyOtherMethod", 'a', 'b', 'c').Return(errors.New("Some Error"))
|
||||||
|
//
|
||||||
//go:noinline
|
//go:noinline
|
||||||
func (c *Call) On(methodName string, arguments ...interface{}) *Call {
|
func (c *Call) On(methodName string, arguments ...interface{}) *Call {
|
||||||
return c.Parent.On(methodName, arguments...)
|
return c.Parent.On(methodName, arguments...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Unset removes all mock handlers that satisfy the call instance arguments from being
|
||||||
|
// called. Only supported on call instances with static input arguments.
|
||||||
|
//
|
||||||
|
// For example, the only handler remaining after the following would be "MyMethod(2, 2)":
|
||||||
|
//
|
||||||
|
// Mock.
|
||||||
|
// On("MyMethod", 2, 2).Return(0).
|
||||||
|
// On("MyMethod", 3, 3).Return(0).
|
||||||
|
// On("MyMethod", Anything, Anything).Return(0)
|
||||||
|
// Mock.On("MyMethod", 3, 3).Unset()
|
||||||
|
func (c *Call) Unset() *Call {
|
||||||
|
var unlockOnce sync.Once
|
||||||
|
|
||||||
|
for _, arg := range c.Arguments {
|
||||||
|
if v := reflect.ValueOf(arg); v.Kind() == reflect.Func {
|
||||||
|
panic(fmt.Sprintf("cannot use Func in expectations. Use mock.AnythingOfType(\"%T\")", arg))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
c.lock()
|
||||||
|
defer unlockOnce.Do(c.unlock)
|
||||||
|
|
||||||
|
foundMatchingCall := false
|
||||||
|
|
||||||
|
// in-place filter slice for calls to be removed - iterate from 0'th to last skipping unnecessary ones
|
||||||
|
var index int // write index
|
||||||
|
for _, call := range c.Parent.ExpectedCalls {
|
||||||
|
if call.Method == c.Method {
|
||||||
|
_, diffCount := call.Arguments.Diff(c.Arguments)
|
||||||
|
if diffCount == 0 {
|
||||||
|
foundMatchingCall = true
|
||||||
|
// Remove from ExpectedCalls - just skip it
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c.Parent.ExpectedCalls[index] = call
|
||||||
|
index++
|
||||||
|
}
|
||||||
|
// trim slice up to last copied index
|
||||||
|
c.Parent.ExpectedCalls = c.Parent.ExpectedCalls[:index]
|
||||||
|
|
||||||
|
if !foundMatchingCall {
|
||||||
|
unlockOnce.Do(c.unlock)
|
||||||
|
c.Parent.fail("\n\nmock: Could not find expected call\n-----------------------------\n\n%s\n\n",
|
||||||
|
callString(c.Method, c.Arguments, true),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotBefore indicates that the mock should only be called after the referenced
|
||||||
|
// calls have been called as expected. The referenced calls may be from the
|
||||||
|
// same mock instance and/or other mock instances.
|
||||||
|
//
|
||||||
|
// Mock.On("Do").Return(nil).NotBefore(
|
||||||
|
// Mock.On("Init").Return(nil)
|
||||||
|
// )
|
||||||
|
func (c *Call) NotBefore(calls ...*Call) *Call {
|
||||||
|
c.lock()
|
||||||
|
defer c.unlock()
|
||||||
|
|
||||||
|
for _, call := range calls {
|
||||||
|
if call.Parent == nil {
|
||||||
|
panic("not before calls must be created with Mock.On()")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
c.requires = append(c.requires, calls...)
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// InOrder defines the order in which the calls should be made
|
||||||
|
//
|
||||||
|
// For example:
|
||||||
|
//
|
||||||
|
// InOrder(
|
||||||
|
// Mock.On("init").Return(nil),
|
||||||
|
// Mock.On("Do").Return(nil),
|
||||||
|
// )
|
||||||
|
func InOrder(calls ...*Call) {
|
||||||
|
for i := 1; i < len(calls); i++ {
|
||||||
|
calls[i].NotBefore(calls[i-1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Mock is the workhorse used to track activity on another object.
|
// Mock is the workhorse used to track activity on another object.
|
||||||
// For an example of its usage, refer to the "Example Usage" section at the top
|
// For an example of its usage, refer to the "Example Usage" section at the top
|
||||||
// of this document.
|
// of this document.
|
||||||
|
@ -218,7 +313,7 @@ type Mock struct {
|
||||||
// this data completely allowing you to do whatever you like with it.
|
// this data completely allowing you to do whatever you like with it.
|
||||||
testData objx.Map
|
testData objx.Map
|
||||||
|
|
||||||
mutex *sync.Mutex
|
mutex sync.Mutex
|
||||||
}
|
}
|
||||||
|
|
||||||
// String provides a %v format string for Mock.
|
// String provides a %v format string for Mock.
|
||||||
|
@ -243,12 +338,11 @@ func (m *Mock) TestData() objx.Map {
|
||||||
Setting expectations
|
Setting expectations
|
||||||
*/
|
*/
|
||||||
|
|
||||||
// Test sets the test struct variable of the mock object
|
// Test sets the [TestingT] on which errors will be reported, otherwise errors
|
||||||
|
// will cause a panic.
|
||||||
|
// Test should not be called on an object that is going to be used in a
|
||||||
|
// goroutine other than the one running the test function.
|
||||||
func (m *Mock) Test(t TestingT) {
|
func (m *Mock) Test(t TestingT) {
|
||||||
if m.mutex == nil {
|
|
||||||
m.mutex = &sync.Mutex{}
|
|
||||||
}
|
|
||||||
|
|
||||||
m.mutex.Lock()
|
m.mutex.Lock()
|
||||||
defer m.mutex.Unlock()
|
defer m.mutex.Unlock()
|
||||||
m.test = t
|
m.test = t
|
||||||
|
@ -271,7 +365,7 @@ func (m *Mock) fail(format string, args ...interface{}) {
|
||||||
// On starts a description of an expectation of the specified method
|
// On starts a description of an expectation of the specified method
|
||||||
// being called.
|
// being called.
|
||||||
//
|
//
|
||||||
// Mock.On("MyMethod", arg1, arg2)
|
// Mock.On("MyMethod", arg1, arg2)
|
||||||
func (m *Mock) On(methodName string, arguments ...interface{}) *Call {
|
func (m *Mock) On(methodName string, arguments ...interface{}) *Call {
|
||||||
for _, arg := range arguments {
|
for _, arg := range arguments {
|
||||||
if v := reflect.ValueOf(arg); v.Kind() == reflect.Func {
|
if v := reflect.ValueOf(arg); v.Kind() == reflect.Func {
|
||||||
|
@ -279,12 +373,10 @@ func (m *Mock) On(methodName string, arguments ...interface{}) *Call {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Since we start mocks with the .On() function, m.mutex should be reset
|
|
||||||
m.mutex = &sync.Mutex{}
|
|
||||||
|
|
||||||
m.mutex.Lock()
|
m.mutex.Lock()
|
||||||
defer m.mutex.Unlock()
|
defer m.mutex.Unlock()
|
||||||
c := newCall(m, methodName, assert.CallerInfo(), arguments...)
|
|
||||||
|
c := newCall(m, methodName, assert.CallerInfo(), arguments, make([]interface{}, 0))
|
||||||
m.ExpectedCalls = append(m.ExpectedCalls, c)
|
m.ExpectedCalls = append(m.ExpectedCalls, c)
|
||||||
return c
|
return c
|
||||||
}
|
}
|
||||||
|
@ -364,6 +456,10 @@ func callString(method string, arguments Arguments, includeArgumentValues bool)
|
||||||
if includeArgumentValues {
|
if includeArgumentValues {
|
||||||
var argVals []string
|
var argVals []string
|
||||||
for argIndex, arg := range arguments {
|
for argIndex, arg := range arguments {
|
||||||
|
if _, ok := arg.(*FunctionalOptionsArgument); ok {
|
||||||
|
argVals = append(argVals, fmt.Sprintf("%d: %s", argIndex, arg))
|
||||||
|
continue
|
||||||
|
}
|
||||||
argVals = append(argVals, fmt.Sprintf("%d: %#v", argIndex, arg))
|
argVals = append(argVals, fmt.Sprintf("%d: %#v", argIndex, arg))
|
||||||
}
|
}
|
||||||
argValsString = fmt.Sprintf("\n\t\t%s", strings.Join(argVals, "\n\t\t"))
|
argValsString = fmt.Sprintf("\n\t\t%s", strings.Join(argVals, "\n\t\t"))
|
||||||
|
@ -387,9 +483,8 @@ func (m *Mock) Called(arguments ...interface{}) Arguments {
|
||||||
// For Ex: github_com_docker_libkv_store_mock.WatchTree.pN39_github_com_docker_libkv_store_mock.Mock
|
// For Ex: github_com_docker_libkv_store_mock.WatchTree.pN39_github_com_docker_libkv_store_mock.Mock
|
||||||
// uses interface information unlike golang github.com/docker/libkv/store/mock.(*Mock).WatchTree
|
// uses interface information unlike golang github.com/docker/libkv/store/mock.(*Mock).WatchTree
|
||||||
// With GCCGO we need to remove interface information starting from pN<dd>.
|
// With GCCGO we need to remove interface information starting from pN<dd>.
|
||||||
re := regexp.MustCompile("\\.pN\\d+_")
|
if gccgoRE.MatchString(functionPath) {
|
||||||
if re.MatchString(functionPath) {
|
functionPath = gccgoRE.Split(functionPath, -1)[0]
|
||||||
functionPath = re.Split(functionPath, -1)[0]
|
|
||||||
}
|
}
|
||||||
parts := strings.Split(functionPath, ".")
|
parts := strings.Split(functionPath, ".")
|
||||||
functionName := parts[len(parts)-1]
|
functionName := parts[len(parts)-1]
|
||||||
|
@ -406,10 +501,10 @@ func (m *Mock) MethodCalled(methodName string, arguments ...interface{}) Argumen
|
||||||
found, call := m.findExpectedCall(methodName, arguments...)
|
found, call := m.findExpectedCall(methodName, arguments...)
|
||||||
|
|
||||||
if found < 0 {
|
if found < 0 {
|
||||||
// expected call found but it has already been called with repeatable times
|
// expected call found, but it has already been called with repeatable times
|
||||||
if call != nil {
|
if call != nil {
|
||||||
m.mutex.Unlock()
|
m.mutex.Unlock()
|
||||||
m.fail("\nassert: mock: The method has been called over %d times.\n\tEither do one more Mock.On(\"%s\").Return(...), or remove extra call.\n\tThis call was unexpected:\n\t\t%s\n\tat: %s", call.totalCalls, methodName, callString(methodName, arguments, true), assert.CallerInfo())
|
m.fail("\nassert: mock: The method has been called over %d times.\n\tEither do one more Mock.On(%#v).Return(...), or remove extra call.\n\tThis call was unexpected:\n\t\t%s\n\tat: %s", call.totalCalls, methodName, callString(methodName, arguments, true), assert.CallerInfo())
|
||||||
}
|
}
|
||||||
// we have to fail here - because we don't know what to do
|
// we have to fail here - because we don't know what to do
|
||||||
// as the return arguments. This is because:
|
// as the return arguments. This is because:
|
||||||
|
@ -421,14 +516,34 @@ func (m *Mock) MethodCalled(methodName string, arguments ...interface{}) Argumen
|
||||||
m.mutex.Unlock()
|
m.mutex.Unlock()
|
||||||
|
|
||||||
if closestCall != nil {
|
if closestCall != nil {
|
||||||
m.fail("\n\nmock: Unexpected Method Call\n-----------------------------\n\n%s\n\nThe closest call I have is: \n\n%s\n\n%s\nDiff: %s",
|
m.fail("\n\nmock: Unexpected Method Call\n-----------------------------\n\n%s\n\nThe closest call I have is: \n\n%s\n\n%s\nDiff: %s\nat: %s\n",
|
||||||
callString(methodName, arguments, true),
|
callString(methodName, arguments, true),
|
||||||
callString(methodName, closestCall.Arguments, true),
|
callString(methodName, closestCall.Arguments, true),
|
||||||
diffArguments(closestCall.Arguments, arguments),
|
diffArguments(closestCall.Arguments, arguments),
|
||||||
strings.TrimSpace(mismatch),
|
strings.TrimSpace(mismatch),
|
||||||
|
assert.CallerInfo(),
|
||||||
)
|
)
|
||||||
} else {
|
} else {
|
||||||
m.fail("\nassert: mock: I don't know what to return because the method call was unexpected.\n\tEither do Mock.On(\"%s\").Return(...) first, or remove the %s() call.\n\tThis method was unexpected:\n\t\t%s\n\tat: %s", methodName, methodName, callString(methodName, arguments, true), assert.CallerInfo())
|
m.fail("\nassert: mock: I don't know what to return because the method call was unexpected.\n\tEither do Mock.On(%#v).Return(...) first, or remove the %s() call.\n\tThis method was unexpected:\n\t\t%s\n\tat: %s", methodName, methodName, callString(methodName, arguments, true), assert.CallerInfo())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, requirement := range call.requires {
|
||||||
|
if satisfied, _ := requirement.Parent.checkExpectation(requirement); !satisfied {
|
||||||
|
m.mutex.Unlock()
|
||||||
|
m.fail("mock: Unexpected Method Call\n-----------------------------\n\n%s\n\nMust not be called before%s:\n\n%s",
|
||||||
|
callString(call.Method, call.Arguments, true),
|
||||||
|
func() (s string) {
|
||||||
|
if requirement.totalCalls > 0 {
|
||||||
|
s = " another call of"
|
||||||
|
}
|
||||||
|
if call.Parent != requirement.Parent {
|
||||||
|
s += " method from another mock instance"
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}(),
|
||||||
|
callString(requirement.Method, requirement.Arguments, true),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -440,7 +555,7 @@ func (m *Mock) MethodCalled(methodName string, arguments ...interface{}) Argumen
|
||||||
call.totalCalls++
|
call.totalCalls++
|
||||||
|
|
||||||
// add the call
|
// add the call
|
||||||
m.Calls = append(m.Calls, *newCall(m, methodName, assert.CallerInfo(), arguments...))
|
m.Calls = append(m.Calls, *newCall(m, methodName, assert.CallerInfo(), arguments, call.ReturnArguments))
|
||||||
m.mutex.Unlock()
|
m.mutex.Unlock()
|
||||||
|
|
||||||
// block if specified
|
// block if specified
|
||||||
|
@ -476,7 +591,7 @@ func (m *Mock) MethodCalled(methodName string, arguments ...interface{}) Argumen
|
||||||
Assertions
|
Assertions
|
||||||
*/
|
*/
|
||||||
|
|
||||||
type assertExpectationser interface {
|
type assertExpectationiser interface {
|
||||||
AssertExpectations(TestingT) bool
|
AssertExpectations(TestingT) bool
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -489,11 +604,11 @@ func AssertExpectationsForObjects(t TestingT, testObjects ...interface{}) bool {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
for _, obj := range testObjects {
|
for _, obj := range testObjects {
|
||||||
if m, ok := obj.(Mock); ok {
|
if m, ok := obj.(*Mock); ok {
|
||||||
t.Logf("Deprecated mock.AssertExpectationsForObjects(myMock.Mock) use mock.AssertExpectationsForObjects(myMock)")
|
t.Logf("Deprecated mock.AssertExpectationsForObjects(myMock.Mock) use mock.AssertExpectationsForObjects(myMock)")
|
||||||
obj = &m
|
obj = m
|
||||||
}
|
}
|
||||||
m := obj.(assertExpectationser)
|
m := obj.(assertExpectationiser)
|
||||||
if !m.AssertExpectations(t) {
|
if !m.AssertExpectations(t) {
|
||||||
t.Logf("Expectations didn't match for Mock: %+v", reflect.TypeOf(m))
|
t.Logf("Expectations didn't match for Mock: %+v", reflect.TypeOf(m))
|
||||||
return false
|
return false
|
||||||
|
@ -505,41 +620,42 @@ func AssertExpectationsForObjects(t TestingT, testObjects ...interface{}) bool {
|
||||||
// AssertExpectations asserts that everything specified with On and Return was
|
// AssertExpectations asserts that everything specified with On and Return was
|
||||||
// in fact called as expected. Calls may have occurred in any order.
|
// in fact called as expected. Calls may have occurred in any order.
|
||||||
func (m *Mock) AssertExpectations(t TestingT) bool {
|
func (m *Mock) AssertExpectations(t TestingT) bool {
|
||||||
|
if s, ok := t.(interface{ Skipped() bool }); ok && s.Skipped() {
|
||||||
|
return true
|
||||||
|
}
|
||||||
if h, ok := t.(tHelper); ok {
|
if h, ok := t.(tHelper); ok {
|
||||||
h.Helper()
|
h.Helper()
|
||||||
}
|
}
|
||||||
if m.mutex == nil {
|
|
||||||
m.mutex = &sync.Mutex{}
|
|
||||||
}
|
|
||||||
|
|
||||||
m.mutex.Lock()
|
m.mutex.Lock()
|
||||||
defer m.mutex.Unlock()
|
defer m.mutex.Unlock()
|
||||||
var somethingMissing bool
|
|
||||||
var failedExpectations int
|
var failedExpectations int
|
||||||
|
|
||||||
// iterate through each expectation
|
// iterate through each expectation
|
||||||
expectedCalls := m.expectedCalls()
|
expectedCalls := m.expectedCalls()
|
||||||
for _, expectedCall := range expectedCalls {
|
for _, expectedCall := range expectedCalls {
|
||||||
if !expectedCall.optional && !m.methodWasCalled(expectedCall.Method, expectedCall.Arguments) && expectedCall.totalCalls == 0 {
|
satisfied, reason := m.checkExpectation(expectedCall)
|
||||||
somethingMissing = true
|
if !satisfied {
|
||||||
failedExpectations++
|
failedExpectations++
|
||||||
t.Logf("FAIL:\t%s(%s)\n\t\tat: %s", expectedCall.Method, expectedCall.Arguments.String(), expectedCall.callerInfo)
|
t.Logf(reason)
|
||||||
} else {
|
|
||||||
if expectedCall.Repeatability > 0 {
|
|
||||||
somethingMissing = true
|
|
||||||
failedExpectations++
|
|
||||||
t.Logf("FAIL:\t%s(%s)\n\t\tat: %s", expectedCall.Method, expectedCall.Arguments.String(), expectedCall.callerInfo)
|
|
||||||
} else {
|
|
||||||
t.Logf("PASS:\t%s(%s)", expectedCall.Method, expectedCall.Arguments.String())
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if somethingMissing {
|
if failedExpectations != 0 {
|
||||||
t.Errorf("FAIL: %d out of %d expectation(s) were met.\n\tThe code you are testing needs to make %d more call(s).\n\tat: %s", len(expectedCalls)-failedExpectations, len(expectedCalls), failedExpectations, assert.CallerInfo())
|
t.Errorf("FAIL: %d out of %d expectation(s) were met.\n\tThe code you are testing needs to make %d more call(s).\n\tat: %s", len(expectedCalls)-failedExpectations, len(expectedCalls), failedExpectations, assert.CallerInfo())
|
||||||
}
|
}
|
||||||
|
|
||||||
return !somethingMissing
|
return failedExpectations == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Mock) checkExpectation(call *Call) (bool, string) {
|
||||||
|
if !call.optional && !m.methodWasCalled(call.Method, call.Arguments) && call.totalCalls == 0 {
|
||||||
|
return false, fmt.Sprintf("FAIL:\t%s(%s)\n\t\tat: %s", call.Method, call.Arguments.String(), call.callerInfo)
|
||||||
|
}
|
||||||
|
if call.Repeatability > 0 {
|
||||||
|
return false, fmt.Sprintf("FAIL:\t%s(%s)\n\t\tat: %s", call.Method, call.Arguments.String(), call.callerInfo)
|
||||||
|
}
|
||||||
|
return true, fmt.Sprintf("PASS:\t%s(%s)", call.Method, call.Arguments.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
// AssertNumberOfCalls asserts that the method was called expectedCalls times.
|
// AssertNumberOfCalls asserts that the method was called expectedCalls times.
|
||||||
|
@ -673,34 +789,80 @@ const (
|
||||||
Anything = "mock.Anything"
|
Anything = "mock.Anything"
|
||||||
)
|
)
|
||||||
|
|
||||||
// AnythingOfTypeArgument is a string that contains the type of an argument
|
// AnythingOfTypeArgument contains the type of an argument
|
||||||
// for use when type checking. Used in Diff and Assert.
|
// for use when type checking. Used in [Arguments.Diff] and [Arguments.Assert].
|
||||||
type AnythingOfTypeArgument string
|
//
|
||||||
|
// Deprecated: this is an implementation detail that must not be used. Use the [AnythingOfType] constructor instead, example:
|
||||||
|
//
|
||||||
|
// m.On("Do", mock.AnythingOfType("string"))
|
||||||
|
//
|
||||||
|
// All explicit type declarations can be replaced with interface{} as is expected by [Mock.On], example:
|
||||||
|
//
|
||||||
|
// func anyString interface{} {
|
||||||
|
// return mock.AnythingOfType("string")
|
||||||
|
// }
|
||||||
|
type AnythingOfTypeArgument = anythingOfTypeArgument
|
||||||
|
|
||||||
// AnythingOfType returns an AnythingOfTypeArgument object containing the
|
// anythingOfTypeArgument is a string that contains the type of an argument
|
||||||
// name of the type to check for. Used in Diff and Assert.
|
// for use when type checking. Used in Diff and Assert.
|
||||||
|
type anythingOfTypeArgument string
|
||||||
|
|
||||||
|
// AnythingOfType returns a special value containing the
|
||||||
|
// name of the type to check for. The type name will be matched against the type name returned by [reflect.Type.String].
|
||||||
|
//
|
||||||
|
// Used in Diff and Assert.
|
||||||
//
|
//
|
||||||
// For example:
|
// For example:
|
||||||
// Assert(t, AnythingOfType("string"), AnythingOfType("int"))
|
//
|
||||||
|
// args.Assert(t, AnythingOfType("string"), AnythingOfType("int"))
|
||||||
func AnythingOfType(t string) AnythingOfTypeArgument {
|
func AnythingOfType(t string) AnythingOfTypeArgument {
|
||||||
return AnythingOfTypeArgument(t)
|
return anythingOfTypeArgument(t)
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsTypeArgument is a struct that contains the type of an argument
|
// IsTypeArgument is a struct that contains the type of an argument
|
||||||
// for use when type checking. This is an alternative to AnythingOfType.
|
// for use when type checking. This is an alternative to [AnythingOfType].
|
||||||
// Used in Diff and Assert.
|
// Used in [Arguments.Diff] and [Arguments.Assert].
|
||||||
type IsTypeArgument struct {
|
type IsTypeArgument struct {
|
||||||
t interface{}
|
t reflect.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsType returns an IsTypeArgument object containing the type to check for.
|
// IsType returns an IsTypeArgument object containing the type to check for.
|
||||||
// You can provide a zero-value of the type to check. This is an
|
// You can provide a zero-value of the type to check. This is an
|
||||||
// alternative to AnythingOfType. Used in Diff and Assert.
|
// alternative to [AnythingOfType]. Used in [Arguments.Diff] and [Arguments.Assert].
|
||||||
//
|
//
|
||||||
// For example:
|
// For example:
|
||||||
// Assert(t, IsType(""), IsType(0))
|
//
|
||||||
|
// args.Assert(t, IsType(""), IsType(0))
|
||||||
func IsType(t interface{}) *IsTypeArgument {
|
func IsType(t interface{}) *IsTypeArgument {
|
||||||
return &IsTypeArgument{t: t}
|
return &IsTypeArgument{t: reflect.TypeOf(t)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// FunctionalOptionsArgument contains a list of functional options arguments
|
||||||
|
// expected for use when matching a list of arguments.
|
||||||
|
type FunctionalOptionsArgument struct {
|
||||||
|
values []interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// String returns the string representation of FunctionalOptionsArgument
|
||||||
|
func (f *FunctionalOptionsArgument) String() string {
|
||||||
|
var name string
|
||||||
|
if len(f.values) > 0 {
|
||||||
|
name = "[]" + reflect.TypeOf(f.values[0]).String()
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.Replace(fmt.Sprintf("%#v", f.values), "[]interface {}", name, 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FunctionalOptions returns an [FunctionalOptionsArgument] object containing
|
||||||
|
// the expected functional-options to check for.
|
||||||
|
//
|
||||||
|
// For example:
|
||||||
|
//
|
||||||
|
// args.Assert(t, FunctionalOptions(foo.Opt1("strValue"), foo.Opt2(613)))
|
||||||
|
func FunctionalOptions(values ...interface{}) *FunctionalOptionsArgument {
|
||||||
|
return &FunctionalOptionsArgument{
|
||||||
|
values: values,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// argumentMatcher performs custom argument matching, returning whether or
|
// argumentMatcher performs custom argument matching, returning whether or
|
||||||
|
@ -746,10 +908,11 @@ func (f argumentMatcher) String() string {
|
||||||
// and false otherwise.
|
// and false otherwise.
|
||||||
//
|
//
|
||||||
// Example:
|
// Example:
|
||||||
// m.On("Do", MatchedBy(func(req *http.Request) bool { return req.Host == "example.com" }))
|
|
||||||
//
|
//
|
||||||
// |fn|, must be a function accepting a single argument (of the expected type)
|
// m.On("Do", MatchedBy(func(req *http.Request) bool { return req.Host == "example.com" }))
|
||||||
// which returns a bool. If |fn| doesn't match the required signature,
|
//
|
||||||
|
// fn must be a function accepting a single argument (of the expected type)
|
||||||
|
// which returns a bool. If fn doesn't match the required signature,
|
||||||
// MatchedBy() panics.
|
// MatchedBy() panics.
|
||||||
func MatchedBy(fn interface{}) argumentMatcher {
|
func MatchedBy(fn interface{}) argumentMatcher {
|
||||||
fnType := reflect.TypeOf(fn)
|
fnType := reflect.TypeOf(fn)
|
||||||
|
@ -821,35 +984,66 @@ func (args Arguments) Diff(objects []interface{}) (string, int) {
|
||||||
}
|
}
|
||||||
|
|
||||||
if matcher, ok := expected.(argumentMatcher); ok {
|
if matcher, ok := expected.(argumentMatcher); ok {
|
||||||
if matcher.Matches(actual) {
|
var matches bool
|
||||||
|
func() {
|
||||||
|
defer func() {
|
||||||
|
if r := recover(); r != nil {
|
||||||
|
actualFmt = fmt.Sprintf("panic in argument matcher: %v", r)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
matches = matcher.Matches(actual)
|
||||||
|
}()
|
||||||
|
if matches {
|
||||||
output = fmt.Sprintf("%s\t%d: PASS: %s matched by %s\n", output, i, actualFmt, matcher)
|
output = fmt.Sprintf("%s\t%d: PASS: %s matched by %s\n", output, i, actualFmt, matcher)
|
||||||
} else {
|
} else {
|
||||||
differences++
|
differences++
|
||||||
output = fmt.Sprintf("%s\t%d: FAIL: %s not matched by %s\n", output, i, actualFmt, matcher)
|
output = fmt.Sprintf("%s\t%d: FAIL: %s not matched by %s\n", output, i, actualFmt, matcher)
|
||||||
}
|
}
|
||||||
} else if reflect.TypeOf(expected) == reflect.TypeOf((*AnythingOfTypeArgument)(nil)).Elem() {
|
|
||||||
// type checking
|
|
||||||
if reflect.TypeOf(actual).Name() != string(expected.(AnythingOfTypeArgument)) && reflect.TypeOf(actual).String() != string(expected.(AnythingOfTypeArgument)) {
|
|
||||||
// not match
|
|
||||||
differences++
|
|
||||||
output = fmt.Sprintf("%s\t%d: FAIL: type %s != type %s - %s\n", output, i, expected, reflect.TypeOf(actual).Name(), actualFmt)
|
|
||||||
}
|
|
||||||
} else if reflect.TypeOf(expected) == reflect.TypeOf((*IsTypeArgument)(nil)) {
|
|
||||||
t := expected.(*IsTypeArgument).t
|
|
||||||
if reflect.TypeOf(t) != reflect.TypeOf(actual) {
|
|
||||||
differences++
|
|
||||||
output = fmt.Sprintf("%s\t%d: FAIL: type %s != type %s - %s\n", output, i, reflect.TypeOf(t).Name(), reflect.TypeOf(actual).Name(), actualFmt)
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
// normal checking
|
switch expected := expected.(type) {
|
||||||
|
case anythingOfTypeArgument:
|
||||||
|
// type checking
|
||||||
|
if reflect.TypeOf(actual).Name() != string(expected) && reflect.TypeOf(actual).String() != string(expected) {
|
||||||
|
// not match
|
||||||
|
differences++
|
||||||
|
output = fmt.Sprintf("%s\t%d: FAIL: type %s != type %s - %s\n", output, i, expected, reflect.TypeOf(actual).Name(), actualFmt)
|
||||||
|
}
|
||||||
|
case *IsTypeArgument:
|
||||||
|
actualT := reflect.TypeOf(actual)
|
||||||
|
if actualT != expected.t {
|
||||||
|
differences++
|
||||||
|
output = fmt.Sprintf("%s\t%d: FAIL: type %s != type %s - %s\n", output, i, expected.t.Name(), actualT.Name(), actualFmt)
|
||||||
|
}
|
||||||
|
case *FunctionalOptionsArgument:
|
||||||
|
var name string
|
||||||
|
if len(expected.values) > 0 {
|
||||||
|
name = "[]" + reflect.TypeOf(expected.values[0]).String()
|
||||||
|
}
|
||||||
|
|
||||||
if assert.ObjectsAreEqual(expected, Anything) || assert.ObjectsAreEqual(actual, Anything) || assert.ObjectsAreEqual(actual, expected) {
|
const tName = "[]interface{}"
|
||||||
// match
|
if name != reflect.TypeOf(actual).String() && len(expected.values) != 0 {
|
||||||
output = fmt.Sprintf("%s\t%d: PASS: %s == %s\n", output, i, actualFmt, expectedFmt)
|
differences++
|
||||||
} else {
|
output = fmt.Sprintf("%s\t%d: FAIL: type %s != type %s - %s\n", output, i, tName, reflect.TypeOf(actual).Name(), actualFmt)
|
||||||
// not match
|
} else {
|
||||||
differences++
|
if ef, af := assertOpts(expected.values, actual); ef == "" && af == "" {
|
||||||
output = fmt.Sprintf("%s\t%d: FAIL: %s != %s\n", output, i, actualFmt, expectedFmt)
|
// match
|
||||||
|
output = fmt.Sprintf("%s\t%d: PASS: %s == %s\n", output, i, tName, tName)
|
||||||
|
} else {
|
||||||
|
// not match
|
||||||
|
differences++
|
||||||
|
output = fmt.Sprintf("%s\t%d: FAIL: %s != %s\n", output, i, af, ef)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
default:
|
||||||
|
if assert.ObjectsAreEqual(expected, Anything) || assert.ObjectsAreEqual(actual, Anything) || assert.ObjectsAreEqual(actual, expected) {
|
||||||
|
// match
|
||||||
|
output = fmt.Sprintf("%s\t%d: PASS: %s == %s\n", output, i, actualFmt, expectedFmt)
|
||||||
|
} else {
|
||||||
|
// not match
|
||||||
|
differences++
|
||||||
|
output = fmt.Sprintf("%s\t%d: FAIL: %s != %s\n", output, i, actualFmt, expectedFmt)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -931,7 +1125,7 @@ func (args Arguments) Error(index int) error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if s, ok = obj.(error); !ok {
|
if s, ok = obj.(error); !ok {
|
||||||
panic(fmt.Sprintf("assert: arguments: Error(%d) failed because object wasn't correct type: %v", index, args.Get(index)))
|
panic(fmt.Sprintf("assert: arguments: Error(%d) failed because object wasn't correct type: %v", index, obj))
|
||||||
}
|
}
|
||||||
return s
|
return s
|
||||||
}
|
}
|
||||||
|
@ -1016,3 +1210,89 @@ var spewConfig = spew.ConfigState{
|
||||||
type tHelper interface {
|
type tHelper interface {
|
||||||
Helper()
|
Helper()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func assertOpts(expected, actual interface{}) (expectedFmt, actualFmt string) {
|
||||||
|
expectedOpts := reflect.ValueOf(expected)
|
||||||
|
actualOpts := reflect.ValueOf(actual)
|
||||||
|
|
||||||
|
var expectedFuncs []*runtime.Func
|
||||||
|
var expectedNames []string
|
||||||
|
for i := 0; i < expectedOpts.Len(); i++ {
|
||||||
|
f := runtimeFunc(expectedOpts.Index(i).Interface())
|
||||||
|
expectedFuncs = append(expectedFuncs, f)
|
||||||
|
expectedNames = append(expectedNames, funcName(f))
|
||||||
|
}
|
||||||
|
var actualFuncs []*runtime.Func
|
||||||
|
var actualNames []string
|
||||||
|
for i := 0; i < actualOpts.Len(); i++ {
|
||||||
|
f := runtimeFunc(actualOpts.Index(i).Interface())
|
||||||
|
actualFuncs = append(actualFuncs, f)
|
||||||
|
actualNames = append(actualNames, funcName(f))
|
||||||
|
}
|
||||||
|
|
||||||
|
if expectedOpts.Len() != actualOpts.Len() {
|
||||||
|
expectedFmt = fmt.Sprintf("%v", expectedNames)
|
||||||
|
actualFmt = fmt.Sprintf("%v", actualNames)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < expectedOpts.Len(); i++ {
|
||||||
|
if !isFuncSame(expectedFuncs[i], actualFuncs[i]) {
|
||||||
|
expectedFmt = expectedNames[i]
|
||||||
|
actualFmt = actualNames[i]
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
expectedOpt := expectedOpts.Index(i).Interface()
|
||||||
|
actualOpt := actualOpts.Index(i).Interface()
|
||||||
|
|
||||||
|
ot := reflect.TypeOf(expectedOpt)
|
||||||
|
var expectedValues []reflect.Value
|
||||||
|
var actualValues []reflect.Value
|
||||||
|
if ot.NumIn() == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < ot.NumIn(); i++ {
|
||||||
|
vt := ot.In(i).Elem()
|
||||||
|
expectedValues = append(expectedValues, reflect.New(vt))
|
||||||
|
actualValues = append(actualValues, reflect.New(vt))
|
||||||
|
}
|
||||||
|
|
||||||
|
reflect.ValueOf(expectedOpt).Call(expectedValues)
|
||||||
|
reflect.ValueOf(actualOpt).Call(actualValues)
|
||||||
|
|
||||||
|
for i := 0; i < ot.NumIn(); i++ {
|
||||||
|
if expectedArg, actualArg := expectedValues[i].Interface(), actualValues[i].Interface(); !assert.ObjectsAreEqual(expectedArg, actualArg) {
|
||||||
|
expectedFmt = fmt.Sprintf("%s(%T) -> %#v", expectedNames[i], expectedArg, expectedArg)
|
||||||
|
actualFmt = fmt.Sprintf("%s(%T) -> %#v", expectedNames[i], actualArg, actualArg)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func runtimeFunc(opt interface{}) *runtime.Func {
|
||||||
|
return runtime.FuncForPC(reflect.ValueOf(opt).Pointer())
|
||||||
|
}
|
||||||
|
|
||||||
|
func funcName(f *runtime.Func) string {
|
||||||
|
name := f.Name()
|
||||||
|
trimmed := strings.TrimSuffix(path.Base(name), path.Ext(name))
|
||||||
|
splitted := strings.Split(trimmed, ".")
|
||||||
|
|
||||||
|
if len(splitted) == 0 {
|
||||||
|
return trimmed
|
||||||
|
}
|
||||||
|
|
||||||
|
return splitted[len(splitted)-1]
|
||||||
|
}
|
||||||
|
|
||||||
|
func isFuncSame(f1, f2 *runtime.Func) bool {
|
||||||
|
f1File, f1Loc := f1.FileLine(f1.Entry())
|
||||||
|
f2File, f2Loc := f2.FileLine(f2.Entry())
|
||||||
|
|
||||||
|
return f1File == f2File && f1Loc == f2Loc
|
||||||
|
}
|
||||||
|
|
|
@ -32,6 +32,40 @@ func (i *TestExampleImplementation) TheExampleMethod(a, b, c int) (int, error) {
|
||||||
return args.Int(0), errors.New("Whoops")
|
return args.Int(0), errors.New("Whoops")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type options struct {
|
||||||
|
num int
|
||||||
|
str string
|
||||||
|
}
|
||||||
|
|
||||||
|
type OptionFn func(*options)
|
||||||
|
|
||||||
|
func OpNum(n int) OptionFn {
|
||||||
|
return func(o *options) {
|
||||||
|
o.num = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func OpStr(s string) OptionFn {
|
||||||
|
return func(o *options) {
|
||||||
|
o.str = s
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func OpBytes(b []byte) OptionFn {
|
||||||
|
return func(m *options) {
|
||||||
|
m.str = string(b)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *TestExampleImplementation) TheExampleMethodFunctionalOptions(x string, opts ...OptionFn) error {
|
||||||
|
args := i.Called(x, opts)
|
||||||
|
return args.Error(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TheExampleMethodFunctionalOptionsIndirect(i *TestExampleImplementation) {
|
||||||
|
i.TheExampleMethodFunctionalOptions("test", OpNum(1), OpStr("foo"))
|
||||||
|
}
|
||||||
|
|
||||||
//go:noinline
|
//go:noinline
|
||||||
func (i *TestExampleImplementation) TheExampleMethod2(yesorno bool) {
|
func (i *TestExampleImplementation) TheExampleMethod2(yesorno bool) {
|
||||||
i.Called(yesorno)
|
i.Called(yesorno)
|
||||||
|
@ -113,7 +147,7 @@ func (m *MockTestingT) Errorf(string, ...interface{}) {
|
||||||
// the execution stops.
|
// the execution stops.
|
||||||
// When expecting this method, the call that invokes it should use the following code:
|
// When expecting this method, the call that invokes it should use the following code:
|
||||||
//
|
//
|
||||||
// assert.PanicsWithValue(t, mockTestingTFailNowCalled, func() {...})
|
// assert.PanicsWithValue(t, mockTestingTFailNowCalled, func() {...})
|
||||||
func (m *MockTestingT) FailNow() {
|
func (m *MockTestingT) FailNow() {
|
||||||
m.failNowCount++
|
m.failNowCount++
|
||||||
|
|
||||||
|
@ -151,7 +185,7 @@ func Test_Mock_Chained_On(t *testing.T) {
|
||||||
var mockedService = new(TestExampleImplementation)
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
// determine our current line number so we can assert the expected calls callerInfo properly
|
// determine our current line number so we can assert the expected calls callerInfo properly
|
||||||
_, _, line, _ := runtime.Caller(0)
|
_, filename, line, _ := runtime.Caller(0)
|
||||||
mockedService.
|
mockedService.
|
||||||
On("TheExampleMethod", 1, 2, 3).
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
Return(0).
|
Return(0).
|
||||||
|
@ -164,14 +198,14 @@ func Test_Mock_Chained_On(t *testing.T) {
|
||||||
Method: "TheExampleMethod",
|
Method: "TheExampleMethod",
|
||||||
Arguments: []interface{}{1, 2, 3},
|
Arguments: []interface{}{1, 2, 3},
|
||||||
ReturnArguments: []interface{}{0},
|
ReturnArguments: []interface{}{0},
|
||||||
callerInfo: []string{fmt.Sprintf("mock_test.go:%d", line+2)},
|
callerInfo: []string{fmt.Sprintf("%s:%d", filename, line+2)},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Parent: &mockedService.Mock,
|
Parent: &mockedService.Mock,
|
||||||
Method: "TheExampleMethod3",
|
Method: "TheExampleMethod3",
|
||||||
Arguments: []interface{}{AnythingOfType("*mock.ExampleType")},
|
Arguments: []interface{}{AnythingOfType("*mock.ExampleType")},
|
||||||
ReturnArguments: []interface{}{nil},
|
ReturnArguments: []interface{}{nil},
|
||||||
callerInfo: []string{fmt.Sprintf("mock_test.go:%d", line+4)},
|
callerInfo: []string{fmt.Sprintf("%s:%d", filename, line+4)},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
assert.Equal(t, expectedCalls, mockedService.ExpectedCalls)
|
assert.Equal(t, expectedCalls, mockedService.ExpectedCalls)
|
||||||
|
@ -233,6 +267,32 @@ func Test_Mock_On_WithIntArgMatcher(t *testing.T) {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_Mock_On_WithArgMatcherThatPanics(t *testing.T) {
|
||||||
|
var mockedService TestExampleImplementation
|
||||||
|
|
||||||
|
mockedService.On("TheExampleMethod2", MatchedBy(func(_ interface{}) bool {
|
||||||
|
panic("try to lock mockedService")
|
||||||
|
})).Return()
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
assertedExpectations := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
tt := new(testing.T)
|
||||||
|
mockedService.AssertExpectations(tt)
|
||||||
|
close(assertedExpectations)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-assertedExpectations:
|
||||||
|
case <-time.After(time.Second):
|
||||||
|
t.Fatal("AssertExpectations() deadlocked, did the panic leave mockedService locked?")
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
mockedService.TheExampleMethod2(false)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func TestMock_WithTest(t *testing.T) {
|
func TestMock_WithTest(t *testing.T) {
|
||||||
var (
|
var (
|
||||||
mockedService TestExampleImplementation
|
mockedService TestExampleImplementation
|
||||||
|
@ -462,6 +522,161 @@ func Test_Mock_On_WithFuncTypeArg(t *testing.T) {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Unset(t *testing.T) {
|
||||||
|
// make a test impl object
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
call := mockedService.
|
||||||
|
On("TheExampleMethodFuncType", "argA").
|
||||||
|
Return("blah")
|
||||||
|
|
||||||
|
found, foundCall := mockedService.findExpectedCall("TheExampleMethodFuncType", "argA")
|
||||||
|
require.NotEqual(t, -1, found)
|
||||||
|
require.Equal(t, foundCall, call)
|
||||||
|
|
||||||
|
call.Unset()
|
||||||
|
|
||||||
|
found, foundCall = mockedService.findExpectedCall("TheExampleMethodFuncType", "argA")
|
||||||
|
require.Equal(t, -1, found)
|
||||||
|
|
||||||
|
var expectedCall *Call
|
||||||
|
require.Equal(t, expectedCall, foundCall)
|
||||||
|
|
||||||
|
fn := func(string) error { return nil }
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
mockedService.TheExampleMethodFuncType(fn)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Since every time you call On it creates a new object
|
||||||
|
// the last time you call Unset it will only unset the last call
|
||||||
|
func Test_Mock_Chained_UnsetOnlyUnsetsLastCall(t *testing.T) {
|
||||||
|
// make a test impl object
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
// determine our current line number so we can assert the expected calls callerInfo properly
|
||||||
|
_, filename, line, _ := runtime.Caller(0)
|
||||||
|
mockedService.
|
||||||
|
On("TheExampleMethod1", 1, 1).
|
||||||
|
Return(0).
|
||||||
|
On("TheExampleMethod2", 2, 2).
|
||||||
|
On("TheExampleMethod3", 3, 3, 3).
|
||||||
|
Return(nil).
|
||||||
|
Unset()
|
||||||
|
|
||||||
|
expectedCalls := []*Call{
|
||||||
|
{
|
||||||
|
Parent: &mockedService.Mock,
|
||||||
|
Method: "TheExampleMethod1",
|
||||||
|
Arguments: []interface{}{1, 1},
|
||||||
|
ReturnArguments: []interface{}{0},
|
||||||
|
callerInfo: []string{fmt.Sprintf("%s:%d", filename, line+2)},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Parent: &mockedService.Mock,
|
||||||
|
Method: "TheExampleMethod2",
|
||||||
|
Arguments: []interface{}{2, 2},
|
||||||
|
ReturnArguments: []interface{}{},
|
||||||
|
callerInfo: []string{fmt.Sprintf("%s:%d", filename, line+4)},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
assert.Equal(t, 2, len(expectedCalls))
|
||||||
|
assert.Equal(t, expectedCalls, mockedService.ExpectedCalls)
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_UnsetIfAlreadyUnsetFails(t *testing.T) {
|
||||||
|
// make a test impl object
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mock1 := mockedService.
|
||||||
|
On("TheExampleMethod1", 1, 1).
|
||||||
|
Return(1)
|
||||||
|
|
||||||
|
assert.Equal(t, 1, len(mockedService.ExpectedCalls))
|
||||||
|
mock1.Unset()
|
||||||
|
assert.Equal(t, 0, len(mockedService.ExpectedCalls))
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
mock1.Unset()
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, 0, len(mockedService.ExpectedCalls))
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_UnsetByOnMethodSpec(t *testing.T) {
|
||||||
|
// make a test impl object
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mock1 := mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(0, nil)
|
||||||
|
|
||||||
|
assert.Equal(t, 1, len(mockedService.ExpectedCalls))
|
||||||
|
mock1.On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(0, nil).Unset()
|
||||||
|
|
||||||
|
assert.Equal(t, 0, len(mockedService.ExpectedCalls))
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
mock1.Unset()
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, 0, len(mockedService.ExpectedCalls))
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_UnsetByOnMethodSpecAmongOthers(t *testing.T) {
|
||||||
|
// make a test impl object
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
_, filename, line, _ := runtime.Caller(0)
|
||||||
|
mock1 := mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(0, nil).
|
||||||
|
On("TheExampleMethodVariadic", 1, 2, 3, 4, 5).Once().
|
||||||
|
Return(nil)
|
||||||
|
mock1.
|
||||||
|
On("TheExampleMethodFuncType", Anything).
|
||||||
|
Return(nil)
|
||||||
|
|
||||||
|
assert.Equal(t, 3, len(mockedService.ExpectedCalls))
|
||||||
|
mock1.On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(0, nil).Unset()
|
||||||
|
|
||||||
|
assert.Equal(t, 2, len(mockedService.ExpectedCalls))
|
||||||
|
|
||||||
|
expectedCalls := []*Call{
|
||||||
|
{
|
||||||
|
Parent: &mockedService.Mock,
|
||||||
|
Method: "TheExampleMethodVariadic",
|
||||||
|
Repeatability: 1,
|
||||||
|
Arguments: []interface{}{1, 2, 3, 4, 5},
|
||||||
|
ReturnArguments: []interface{}{nil},
|
||||||
|
callerInfo: []string{fmt.Sprintf("%s:%d", filename, line+4)},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
Parent: &mockedService.Mock,
|
||||||
|
Method: "TheExampleMethodFuncType",
|
||||||
|
Arguments: []interface{}{Anything},
|
||||||
|
ReturnArguments: []interface{}{nil},
|
||||||
|
callerInfo: []string{fmt.Sprintf("%s:%d", filename, line+7)},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Equal(t, 2, len(mockedService.ExpectedCalls))
|
||||||
|
assert.Equal(t, expectedCalls, mockedService.ExpectedCalls)
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Unset_WithFuncPanics(t *testing.T) {
|
||||||
|
// make a test impl object
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
mock1 := mockedService.On("TheExampleMethod", 1)
|
||||||
|
mock1.Arguments = append(mock1.Arguments, func(string) error { return nil })
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
mock1.Unset()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func Test_Mock_Return(t *testing.T) {
|
func Test_Mock_Return(t *testing.T) {
|
||||||
|
|
||||||
// make a test impl object
|
// make a test impl object
|
||||||
|
@ -713,6 +928,245 @@ func Test_Mock_Return_Nothing(t *testing.T) {
|
||||||
assert.Equal(t, 0, len(call.ReturnArguments))
|
assert.Equal(t, 0, len(call.ReturnArguments))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_NotBefore_In_Order(t *testing.T) {
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
b := mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil)
|
||||||
|
c := mockedService.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return().
|
||||||
|
NotBefore(b)
|
||||||
|
|
||||||
|
require.Equal(t, []*Call{b, c}, mockedService.ExpectedCalls)
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod(1, 2, 3)
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_InOrder_Uses_NotBefore(t *testing.T) {
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
InOrder(
|
||||||
|
mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil),
|
||||||
|
mockedService.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return(),
|
||||||
|
)
|
||||||
|
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod(1, 2, 3)
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_NotBefore_Out_Of_Order(t *testing.T) {
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
b := mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil).Twice()
|
||||||
|
c := mockedService.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return().
|
||||||
|
NotBefore(b)
|
||||||
|
|
||||||
|
require.Equal(t, []*Call{b, c}, mockedService.ExpectedCalls)
|
||||||
|
|
||||||
|
expectedPanicString := `mock: Unexpected Method Call
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
TheExampleMethod2(bool)
|
||||||
|
0: true
|
||||||
|
|
||||||
|
Must not be called before:
|
||||||
|
|
||||||
|
TheExampleMethod(int,int,int)
|
||||||
|
0: 1
|
||||||
|
1: 2
|
||||||
|
2: 3`
|
||||||
|
require.PanicsWithValue(t, expectedPanicString, func() {
|
||||||
|
mockedService.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_InOrder_Uses_NotBefore_Out_Of_Order(t *testing.T) {
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
InOrder(
|
||||||
|
mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil).Twice(),
|
||||||
|
mockedService.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return(),
|
||||||
|
)
|
||||||
|
|
||||||
|
expectedPanicString := `mock: Unexpected Method Call
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
TheExampleMethod2(bool)
|
||||||
|
0: true
|
||||||
|
|
||||||
|
Must not be called before:
|
||||||
|
|
||||||
|
TheExampleMethod(int,int,int)
|
||||||
|
0: 1
|
||||||
|
1: 2
|
||||||
|
2: 3`
|
||||||
|
require.PanicsWithValue(t, expectedPanicString, func() {
|
||||||
|
mockedService.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_NotBefore_Not_Enough_Times(t *testing.T) {
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
b := mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil).Twice()
|
||||||
|
c := mockedService.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return().
|
||||||
|
NotBefore(b)
|
||||||
|
|
||||||
|
require.Equal(t, []*Call{b, c}, mockedService.ExpectedCalls)
|
||||||
|
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod(1, 2, 3)
|
||||||
|
})
|
||||||
|
expectedPanicString := `mock: Unexpected Method Call
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
TheExampleMethod2(bool)
|
||||||
|
0: true
|
||||||
|
|
||||||
|
Must not be called before another call of:
|
||||||
|
|
||||||
|
TheExampleMethod(int,int,int)
|
||||||
|
0: 1
|
||||||
|
1: 2
|
||||||
|
2: 3`
|
||||||
|
require.PanicsWithValue(t, expectedPanicString, func() {
|
||||||
|
mockedService.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_NotBefore_Different_Mock_In_Order(t *testing.T) {
|
||||||
|
var (
|
||||||
|
mockedService1 = new(TestExampleImplementation)
|
||||||
|
mockedService2 = new(TestExampleImplementation)
|
||||||
|
)
|
||||||
|
|
||||||
|
b := mockedService1.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil)
|
||||||
|
c := mockedService2.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return().
|
||||||
|
NotBefore(b)
|
||||||
|
|
||||||
|
require.Equal(t, []*Call{c}, mockedService2.ExpectedCalls)
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService1.TheExampleMethod(1, 2, 3)
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService2.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_NotBefore_Different_Mock_Out_Of_Order(t *testing.T) {
|
||||||
|
var (
|
||||||
|
mockedService1 = new(TestExampleImplementation)
|
||||||
|
mockedService2 = new(TestExampleImplementation)
|
||||||
|
)
|
||||||
|
|
||||||
|
b := mockedService1.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil)
|
||||||
|
c := mockedService2.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return().
|
||||||
|
NotBefore(b)
|
||||||
|
|
||||||
|
require.Equal(t, []*Call{c}, mockedService2.ExpectedCalls)
|
||||||
|
|
||||||
|
expectedPanicString := `mock: Unexpected Method Call
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
TheExampleMethod2(bool)
|
||||||
|
0: true
|
||||||
|
|
||||||
|
Must not be called before method from another mock instance:
|
||||||
|
|
||||||
|
TheExampleMethod(int,int,int)
|
||||||
|
0: 1
|
||||||
|
1: 2
|
||||||
|
2: 3`
|
||||||
|
require.PanicsWithValue(t, expectedPanicString, func() {
|
||||||
|
mockedService2.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_NotBefore_In_Order_With_Non_Dependant(t *testing.T) {
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
a := mockedService.
|
||||||
|
On("TheExampleMethod", 1, 2, 3).
|
||||||
|
Return(4, nil)
|
||||||
|
b := mockedService.
|
||||||
|
On("TheExampleMethod", 4, 5, 6).
|
||||||
|
Return(4, nil)
|
||||||
|
c := mockedService.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return().
|
||||||
|
NotBefore(a, b)
|
||||||
|
d := mockedService.
|
||||||
|
On("TheExampleMethod7", []bool{}).Return(nil)
|
||||||
|
|
||||||
|
require.Equal(t, []*Call{a, b, c, d}, mockedService.ExpectedCalls)
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod7([]bool{})
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod(1, 2, 3)
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod7([]bool{})
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod(4, 5, 6)
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod7([]bool{})
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod2(true)
|
||||||
|
})
|
||||||
|
require.NotPanics(t, func() {
|
||||||
|
mockedService.TheExampleMethod7([]bool{})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_Return_NotBefore_Orphan_Call(t *testing.T) {
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
require.PanicsWithValue(t, "not before calls must be created with Mock.On()", func() {
|
||||||
|
mockedService.
|
||||||
|
On("TheExampleMethod2", true).
|
||||||
|
Return().
|
||||||
|
NotBefore(&Call{Method: "Not", Arguments: Arguments{"how", "it's"}, ReturnArguments: Arguments{"done"}})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func Test_Mock_findExpectedCall(t *testing.T) {
|
func Test_Mock_findExpectedCall(t *testing.T) {
|
||||||
|
|
||||||
m := new(Mock)
|
m := new(Mock)
|
||||||
|
@ -813,7 +1267,7 @@ func Test_Mock_Called_blocks(t *testing.T) {
|
||||||
|
|
||||||
var mockedService = new(TestExampleImplementation)
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
mockedService.Mock.On("asyncCall", 1, 2, 3).Return(5, "6", true).After(2 * time.Millisecond)
|
mockedService.Mock.On("asyncCall", 1, 2, 3).Return(5, "6", true).After(20 * time.Millisecond)
|
||||||
|
|
||||||
ch := make(chan Arguments)
|
ch := make(chan Arguments)
|
||||||
|
|
||||||
|
@ -822,7 +1276,7 @@ func Test_Mock_Called_blocks(t *testing.T) {
|
||||||
select {
|
select {
|
||||||
case <-ch:
|
case <-ch:
|
||||||
t.Fatal("should have waited")
|
t.Fatal("should have waited")
|
||||||
case <-time.After(1 * time.Millisecond):
|
case <-time.After(10 * time.Millisecond):
|
||||||
}
|
}
|
||||||
|
|
||||||
returnArguments := <-ch
|
returnArguments := <-ch
|
||||||
|
@ -1045,6 +1499,85 @@ func Test_Mock_AssertExpectationsCustomType(t *testing.T) {
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_Mock_AssertExpectationsFunctionalOptionsType(t *testing.T) {
|
||||||
|
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mockedService.On("TheExampleMethodFunctionalOptions", "test", FunctionalOptions(OpNum(1), OpStr("foo"))).Return(nil).Once()
|
||||||
|
|
||||||
|
tt := new(testing.T)
|
||||||
|
assert.False(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
// make the call now
|
||||||
|
mockedService.TheExampleMethodFunctionalOptions("test", OpNum(1), OpStr("foo"))
|
||||||
|
|
||||||
|
// now assert expectations
|
||||||
|
assert.True(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_AssertExpectationsFunctionalOptionsType_Empty(t *testing.T) {
|
||||||
|
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mockedService.On("TheExampleMethodFunctionalOptions", "test", FunctionalOptions()).Return(nil).Once()
|
||||||
|
|
||||||
|
tt := new(testing.T)
|
||||||
|
assert.False(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
// make the call now
|
||||||
|
mockedService.TheExampleMethodFunctionalOptions("test")
|
||||||
|
|
||||||
|
// now assert expectations
|
||||||
|
assert.True(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_AssertExpectationsFunctionalOptionsType_Indirectly(t *testing.T) {
|
||||||
|
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mockedService.On("TheExampleMethodFunctionalOptions", "test", FunctionalOptions(OpNum(1), OpStr("foo"))).Return(nil).Once()
|
||||||
|
|
||||||
|
tt := new(testing.T)
|
||||||
|
assert.False(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
// make the call now
|
||||||
|
TheExampleMethodFunctionalOptionsIndirect(mockedService)
|
||||||
|
|
||||||
|
// now assert expectations
|
||||||
|
assert.True(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_AssertExpectationsFunctionalOptionsType_Diff_Func(t *testing.T) {
|
||||||
|
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mockedService.On("TheExampleMethodFunctionalOptions", "test", FunctionalOptions(OpStr("this"))).Return(nil).Once()
|
||||||
|
|
||||||
|
tt := new(testing.T)
|
||||||
|
assert.False(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
mockedService.TheExampleMethodFunctionalOptions("test", OpBytes([]byte("this")))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func Test_Mock_AssertExpectationsFunctionalOptionsType_Diff_Arg(t *testing.T) {
|
||||||
|
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mockedService.On("TheExampleMethodFunctionalOptions", "test", FunctionalOptions(OpStr("this"))).Return(nil).Once()
|
||||||
|
|
||||||
|
tt := new(testing.T)
|
||||||
|
assert.False(t, mockedService.AssertExpectations(tt))
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
mockedService.TheExampleMethodFunctionalOptions("test", OpStr("that"))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func Test_Mock_AssertExpectations_With_Repeatability(t *testing.T) {
|
func Test_Mock_AssertExpectations_With_Repeatability(t *testing.T) {
|
||||||
|
|
||||||
var mockedService = new(TestExampleImplementation)
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
@ -1066,6 +1599,16 @@ func Test_Mock_AssertExpectations_With_Repeatability(t *testing.T) {
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Test_Mock_AssertExpectations_Skipped_Test(t *testing.T) {
|
||||||
|
|
||||||
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
|
||||||
|
mockedService.On("Test_Mock_AssertExpectations_Skipped_Test", 1, 2, 3).Return(5, 6, 7)
|
||||||
|
defer mockedService.AssertExpectations(t)
|
||||||
|
|
||||||
|
t.Skip("skipping test to ensure AssertExpectations does not fail")
|
||||||
|
}
|
||||||
|
|
||||||
func Test_Mock_TwoCallsWithDifferentArguments(t *testing.T) {
|
func Test_Mock_TwoCallsWithDifferentArguments(t *testing.T) {
|
||||||
|
|
||||||
var mockedService = new(TestExampleImplementation)
|
var mockedService = new(TestExampleImplementation)
|
||||||
|
@ -1189,17 +1732,14 @@ func Test_Mock_IsMethodCallable(t *testing.T) {
|
||||||
|
|
||||||
func TestIsArgsEqual(t *testing.T) {
|
func TestIsArgsEqual(t *testing.T) {
|
||||||
var expected = Arguments{5, 3, 4, 6, 7, 2}
|
var expected = Arguments{5, 3, 4, 6, 7, 2}
|
||||||
var args = make([]interface{}, 5)
|
|
||||||
for i := 1; i < len(expected); i++ {
|
// Copy elements 1 to 5
|
||||||
args[i-1] = expected[i]
|
args := append(([]interface{})(nil), expected[1:]...)
|
||||||
}
|
|
||||||
args[2] = expected[1]
|
args[2] = expected[1]
|
||||||
assert.False(t, isArgsEqual(expected, args))
|
assert.False(t, isArgsEqual(expected, args))
|
||||||
|
|
||||||
var arr = make([]interface{}, 6)
|
// Clone
|
||||||
for i := 0; i < len(expected); i++ {
|
arr := append(([]interface{})(nil), expected...)
|
||||||
arr[i] = expected[i]
|
|
||||||
}
|
|
||||||
assert.True(t, isArgsEqual(expected, arr))
|
assert.True(t, isArgsEqual(expected, arr))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1229,7 +1769,7 @@ func Test_Mock_AssertOptional(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
Arguments helper methods
|
Arguments helper methods
|
||||||
*/
|
*/
|
||||||
func Test_Arguments_Get(t *testing.T) {
|
func Test_Arguments_Get(t *testing.T) {
|
||||||
|
|
||||||
|
@ -1535,7 +2075,7 @@ func TestAfterTotalWaitTimeWhileExecution(t *testing.T) {
|
||||||
|
|
||||||
end := time.Now()
|
end := time.Now()
|
||||||
elapsedTime := end.Sub(start)
|
elapsedTime := end.Sub(start)
|
||||||
assert.True(t, elapsedTime > waitMs, fmt.Sprintf("Total elapsed time:%v should be atleast greater than %v", elapsedTime, waitMs))
|
assert.True(t, elapsedTime > waitMs, fmt.Sprintf("Total elapsed time:%v should be at least greater than %v", elapsedTime, waitMs))
|
||||||
assert.Equal(t, total, len(results))
|
assert.Equal(t, total, len(results))
|
||||||
for i := range results {
|
for i := range results {
|
||||||
assert.Equal(t, fmt.Sprintf("Time%d", i), results[i], "Return value of method should be same")
|
assert.Equal(t, fmt.Sprintf("Time%d", i), results[i], "Return value of method should be same")
|
||||||
|
@ -1546,7 +2086,7 @@ func TestArgumentMatcherToPrintMismatch(t *testing.T) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if r := recover(); r != nil {
|
if r := recover(); r != nil {
|
||||||
matchingExp := regexp.MustCompile(
|
matchingExp := regexp.MustCompile(
|
||||||
`\s+mock: Unexpected Method Call\s+-*\s+GetTime\(int\)\s+0: 1\s+The closest call I have is:\s+GetTime\(mock.argumentMatcher\)\s+0: mock.argumentMatcher\{.*?\}\s+Diff:.*\(int=1\) not matched by func\(int\) bool`)
|
`\s+mock: Unexpected Method Call\s+-*\s+GetTime\(int\)\s+0: 1\s+The closest call I have is:\s+GetTime\(mock.argumentMatcher\)\s+0: mock.argumentMatcher\{.*?\}\s+Diff:.*\(int=1\) not matched by func\(int\) bool\nat: \[[^\]]+mock\/mock_test.go`)
|
||||||
assert.Regexp(t, matchingExp, r)
|
assert.Regexp(t, matchingExp, r)
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
@ -1563,7 +2103,7 @@ func TestArgumentMatcherToPrintMismatchWithReferenceType(t *testing.T) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if r := recover(); r != nil {
|
if r := recover(); r != nil {
|
||||||
matchingExp := regexp.MustCompile(
|
matchingExp := regexp.MustCompile(
|
||||||
`\s+mock: Unexpected Method Call\s+-*\s+GetTimes\(\[\]int\)\s+0: \[\]int\{1\}\s+The closest call I have is:\s+GetTimes\(mock.argumentMatcher\)\s+0: mock.argumentMatcher\{.*?\}\s+Diff:.*\(\[\]int=\[1\]\) not matched by func\(\[\]int\) bool`)
|
`\s+mock: Unexpected Method Call\s+-*\s+GetTimes\(\[\]int\)\s+0: \[\]int\{1\}\s+The closest call I have is:\s+GetTimes\(mock.argumentMatcher\)\s+0: mock.argumentMatcher\{.*?\}\s+Diff:.*\(\[\]int=\[1\]\) not matched by func\(\[\]int\) bool\nat: \[[^\]]+mock\/mock_test.go`)
|
||||||
assert.Regexp(t, matchingExp, r)
|
assert.Regexp(t, matchingExp, r)
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
@ -1594,7 +2134,7 @@ func TestClosestCallMismatchedArgumentInformationShowsTheClosest(t *testing.T) {
|
||||||
func TestClosestCallFavorsFirstMock(t *testing.T) {
|
func TestClosestCallFavorsFirstMock(t *testing.T) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if r := recover(); r != nil {
|
if r := recover(); r != nil {
|
||||||
diffRegExp := `Difference found in argument 0:\s+--- Expected\s+\+\+\+ Actual\s+@@ -2,4 \+2,4 @@\s+\(bool\) true,\s+- \(bool\) true,\s+- \(bool\) true\s+\+ \(bool\) false,\s+\+ \(bool\) false\s+}\s+`
|
diffRegExp := `Difference found in argument 0:\s+--- Expected\s+\+\+\+ Actual\s+@@ -2,4 \+2,4 @@\s+\(bool\) true,\s+- \(bool\) true,\s+- \(bool\) true\s+\+ \(bool\) false,\s+\+ \(bool\) false\s+}\s+Diff: 0: FAIL: \(\[\]bool=\[(true\s?|false\s?){3}]\) != \(\[\]bool=\[(true\s?|false\s?){3}\]\)`
|
||||||
matchingExp := regexp.MustCompile(unexpectedCallRegex(`TheExampleMethod7([]bool)`, `0: \[\]bool{true, false, false}`, `0: \[\]bool{true, true, true}`, diffRegExp))
|
matchingExp := regexp.MustCompile(unexpectedCallRegex(`TheExampleMethod7([]bool)`, `0: \[\]bool{true, false, false}`, `0: \[\]bool{true, true, true}`, diffRegExp))
|
||||||
assert.Regexp(t, matchingExp, r)
|
assert.Regexp(t, matchingExp, r)
|
||||||
}
|
}
|
||||||
|
@ -1610,7 +2150,7 @@ func TestClosestCallFavorsFirstMock(t *testing.T) {
|
||||||
func TestClosestCallUsesRepeatabilityToFindClosest(t *testing.T) {
|
func TestClosestCallUsesRepeatabilityToFindClosest(t *testing.T) {
|
||||||
defer func() {
|
defer func() {
|
||||||
if r := recover(); r != nil {
|
if r := recover(); r != nil {
|
||||||
diffRegExp := `Difference found in argument 0:\s+--- Expected\s+\+\+\+ Actual\s+@@ -1,4 \+1,4 @@\s+\(\[\]bool\) \(len=3\) {\s+- \(bool\) false,\s+- \(bool\) false,\s+\+ \(bool\) true,\s+\+ \(bool\) true,\s+\(bool\) false\s+`
|
diffRegExp := `Difference found in argument 0:\s+--- Expected\s+\+\+\+ Actual\s+@@ -1,4 \+1,4 @@\s+\(\[\]bool\) \(len=3\) {\s+- \(bool\) false,\s+- \(bool\) false,\s+\+ \(bool\) true,\s+\+ \(bool\) true,\s+\(bool\) false\s+Diff: 0: FAIL: \(\[\]bool=\[(true\s?|false\s?){3}]\) != \(\[\]bool=\[(true\s?|false\s?){3}\]\)`
|
||||||
matchingExp := regexp.MustCompile(unexpectedCallRegex(`TheExampleMethod7([]bool)`, `0: \[\]bool{true, true, false}`, `0: \[\]bool{false, false, false}`, diffRegExp))
|
matchingExp := regexp.MustCompile(unexpectedCallRegex(`TheExampleMethod7([]bool)`, `0: \[\]bool{true, true, false}`, `0: \[\]bool{false, false, false}`, diffRegExp))
|
||||||
assert.Regexp(t, matchingExp, r)
|
assert.Regexp(t, matchingExp, r)
|
||||||
}
|
}
|
||||||
|
@ -1667,7 +2207,7 @@ func Test_isBetterMatchThanReturnsFalseIfRepeatabilityIsLessThanOrEqualToOther(t
|
||||||
|
|
||||||
func unexpectedCallRegex(method, calledArg, expectedArg, diff string) string {
|
func unexpectedCallRegex(method, calledArg, expectedArg, diff string) string {
|
||||||
rMethod := regexp.QuoteMeta(method)
|
rMethod := regexp.QuoteMeta(method)
|
||||||
return fmt.Sprintf(`\s+mock: Unexpected Method Call\s+-*\s+%s\s+%s\s+The closest call I have is:\s+%s\s+%s\s+%s`,
|
return fmt.Sprintf(`\s+mock: Unexpected Method Call\s+-*\s+%s\s+%s\s+The closest call I have is:\s+%s\s+%s\s+%s\nat: \[[^\]]+mock\/mock_test.go`,
|
||||||
rMethod, calledArg, rMethod, expectedArg, diff)
|
rMethod, calledArg, rMethod, expectedArg, diff)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,27 +1,30 @@
|
||||||
// Package require implements the same assertions as the `assert` package but
|
// Package require implements the same assertions as the `assert` package but
|
||||||
// stops test execution when a test fails.
|
// stops test execution when a test fails.
|
||||||
//
|
//
|
||||||
// Example Usage
|
// # Example Usage
|
||||||
//
|
//
|
||||||
// The following is a complete example using require in a standard test function:
|
// The following is a complete example using require in a standard test function:
|
||||||
// import (
|
|
||||||
// "testing"
|
|
||||||
// "github.com/stretchr/testify/require"
|
|
||||||
// )
|
|
||||||
//
|
//
|
||||||
// func TestSomething(t *testing.T) {
|
// import (
|
||||||
|
// "testing"
|
||||||
|
// "github.com/stretchr/testify/require"
|
||||||
|
// )
|
||||||
//
|
//
|
||||||
// var a string = "Hello"
|
// func TestSomething(t *testing.T) {
|
||||||
// var b string = "Hello"
|
|
||||||
//
|
//
|
||||||
// require.Equal(t, a, b, "The two words should be the same.")
|
// var a string = "Hello"
|
||||||
|
// var b string = "Hello"
|
||||||
//
|
//
|
||||||
// }
|
// require.Equal(t, a, b, "The two words should be the same.")
|
||||||
//
|
//
|
||||||
// Assertions
|
// }
|
||||||
|
//
|
||||||
|
// # Assertions
|
||||||
//
|
//
|
||||||
// The `require` package have same global functions as in the `assert` package,
|
// The `require` package have same global functions as in the `assert` package,
|
||||||
// but instead of returning a boolean result they call `t.FailNow()`.
|
// but instead of returning a boolean result they call `t.FailNow()`.
|
||||||
|
// A consequence of this is that it must be called from the goroutine running
|
||||||
|
// the test function, not from other goroutines created during the test.
|
||||||
//
|
//
|
||||||
// Every assertion function also takes an optional string message as the final argument,
|
// Every assertion function also takes an optional string message as the final argument,
|
||||||
// allowing custom error messages to be appended to the message the assertion method outputs.
|
// allowing custom error messages to be appended to the message the assertion method outputs.
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -1,4 +1,4 @@
|
||||||
{{.Comment}}
|
{{ replace .Comment "assert." "require."}}
|
||||||
func {{.DocInfo.Name}}(t TestingT, {{.Params}}) {
|
func {{.DocInfo.Name}}(t TestingT, {{.Params}}) {
|
||||||
if h, ok := t.(tHelper); ok { h.Helper() }
|
if h, ok := t.(tHelper); ok { h.Helper() }
|
||||||
if assert.{{.DocInfo.Name}}(t, {{.ForwardedParams}}) { return }
|
if assert.{{.DocInfo.Name}}(t, {{.ForwardedParams}}) { return }
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -6,7 +6,7 @@ type TestingT interface {
|
||||||
FailNow()
|
FailNow()
|
||||||
}
|
}
|
||||||
|
|
||||||
type tHelper interface {
|
type tHelper = interface {
|
||||||
Helper()
|
Helper()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -5,6 +5,8 @@ import (
|
||||||
"errors"
|
"errors"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
// AssertionTesterInterface defines an interface to be used for testing assertion methods
|
// AssertionTesterInterface defines an interface to be used for testing assertion methods
|
||||||
|
@ -681,3 +683,30 @@ func TestErrorAssertionFunc(t *testing.T) {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestEventuallyWithTFalse(t *testing.T) {
|
||||||
|
mockT := new(MockT)
|
||||||
|
|
||||||
|
condition := func(collect *assert.CollectT) {
|
||||||
|
True(collect, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
EventuallyWithT(mockT, condition, 100*time.Millisecond, 20*time.Millisecond)
|
||||||
|
True(t, mockT.Failed, "Check should fail")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEventuallyWithTTrue(t *testing.T) {
|
||||||
|
mockT := new(MockT)
|
||||||
|
|
||||||
|
counter := 0
|
||||||
|
condition := func(collect *assert.CollectT) {
|
||||||
|
defer func() {
|
||||||
|
counter += 1
|
||||||
|
}()
|
||||||
|
True(collect, counter == 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
EventuallyWithT(mockT, condition, 100*time.Millisecond, 20*time.Millisecond)
|
||||||
|
False(t, mockT.Failed, "Check should pass")
|
||||||
|
Equal(t, 2, counter, "Condition is expected to be called 2 times")
|
||||||
|
}
|
||||||
|
|
63
suite/doc.go
63
suite/doc.go
|
@ -5,6 +5,8 @@
|
||||||
// or individual tests (depending on which interface(s) you
|
// or individual tests (depending on which interface(s) you
|
||||||
// implement).
|
// implement).
|
||||||
//
|
//
|
||||||
|
// The suite package does not support parallel tests. See [issue 934].
|
||||||
|
//
|
||||||
// A testing suite is usually built by first extending the built-in
|
// A testing suite is usually built by first extending the built-in
|
||||||
// suite functionality from suite.Suite in testify. Alternatively,
|
// suite functionality from suite.Suite in testify. Alternatively,
|
||||||
// you could reproduce that logic on your own if you wanted (you
|
// you could reproduce that logic on your own if you wanted (you
|
||||||
|
@ -29,37 +31,40 @@
|
||||||
// Suite object has assertion methods.
|
// Suite object has assertion methods.
|
||||||
//
|
//
|
||||||
// A crude example:
|
// A crude example:
|
||||||
// // Basic imports
|
|
||||||
// import (
|
|
||||||
// "testing"
|
|
||||||
// "github.com/stretchr/testify/assert"
|
|
||||||
// "github.com/stretchr/testify/suite"
|
|
||||||
// )
|
|
||||||
//
|
//
|
||||||
// // Define the suite, and absorb the built-in basic suite
|
// // Basic imports
|
||||||
// // functionality from testify - including a T() method which
|
// import (
|
||||||
// // returns the current testing context
|
// "testing"
|
||||||
// type ExampleTestSuite struct {
|
// "github.com/stretchr/testify/assert"
|
||||||
// suite.Suite
|
// "github.com/stretchr/testify/suite"
|
||||||
// VariableThatShouldStartAtFive int
|
// )
|
||||||
// }
|
|
||||||
//
|
//
|
||||||
// // Make sure that VariableThatShouldStartAtFive is set to five
|
// // Define the suite, and absorb the built-in basic suite
|
||||||
// // before each test
|
// // functionality from testify - including a T() method which
|
||||||
// func (suite *ExampleTestSuite) SetupTest() {
|
// // returns the current testing context
|
||||||
// suite.VariableThatShouldStartAtFive = 5
|
// type ExampleTestSuite struct {
|
||||||
// }
|
// suite.Suite
|
||||||
|
// VariableThatShouldStartAtFive int
|
||||||
|
// }
|
||||||
//
|
//
|
||||||
// // All methods that begin with "Test" are run as tests within a
|
// // Make sure that VariableThatShouldStartAtFive is set to five
|
||||||
// // suite.
|
// // before each test
|
||||||
// func (suite *ExampleTestSuite) TestExample() {
|
// func (suite *ExampleTestSuite) SetupTest() {
|
||||||
// assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
|
// suite.VariableThatShouldStartAtFive = 5
|
||||||
// suite.Equal(5, suite.VariableThatShouldStartAtFive)
|
// }
|
||||||
// }
|
|
||||||
//
|
//
|
||||||
// // In order for 'go test' to run this suite, we need to create
|
// // All methods that begin with "Test" are run as tests within a
|
||||||
// // a normal test function and pass our suite to suite.Run
|
// // suite.
|
||||||
// func TestExampleTestSuite(t *testing.T) {
|
// func (suite *ExampleTestSuite) TestExample() {
|
||||||
// suite.Run(t, new(ExampleTestSuite))
|
// assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
|
||||||
// }
|
// suite.Equal(5, suite.VariableThatShouldStartAtFive)
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// // In order for 'go test' to run this suite, we need to create
|
||||||
|
// // a normal test function and pass our suite to suite.Run
|
||||||
|
// func TestExampleTestSuite(t *testing.T) {
|
||||||
|
// suite.Run(t, new(ExampleTestSuite))
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// [issue 934]: https://github.com/stretchr/testify/issues/934
|
||||||
package suite
|
package suite
|
||||||
|
|
|
@ -7,6 +7,7 @@ import "testing"
|
||||||
type TestingSuite interface {
|
type TestingSuite interface {
|
||||||
T() *testing.T
|
T() *testing.T
|
||||||
SetT(*testing.T)
|
SetT(*testing.T)
|
||||||
|
SetS(suite TestingSuite)
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetupAllSuite has a SetupSuite method, which will run before the
|
// SetupAllSuite has a SetupSuite method, which will run before the
|
||||||
|
@ -51,3 +52,15 @@ type AfterTest interface {
|
||||||
type WithStats interface {
|
type WithStats interface {
|
||||||
HandleStats(suiteName string, stats *SuiteInformation)
|
HandleStats(suiteName string, stats *SuiteInformation)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetupSubTest has a SetupSubTest method, which will run before each
|
||||||
|
// subtest in the suite.
|
||||||
|
type SetupSubTest interface {
|
||||||
|
SetupSubTest()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TearDownSubTest has a TearDownSubTest method, which will run after
|
||||||
|
// each subtest in the suite have been run.
|
||||||
|
type TearDownSubTest interface {
|
||||||
|
TearDownSubTest()
|
||||||
|
}
|
||||||
|
|
|
@ -22,9 +22,13 @@ var matchMethod = flag.String("testify.m", "", "regular expression to select tes
|
||||||
// retrieving the current *testing.T context.
|
// retrieving the current *testing.T context.
|
||||||
type Suite struct {
|
type Suite struct {
|
||||||
*assert.Assertions
|
*assert.Assertions
|
||||||
|
|
||||||
mu sync.RWMutex
|
mu sync.RWMutex
|
||||||
require *require.Assertions
|
require *require.Assertions
|
||||||
t *testing.T
|
t *testing.T
|
||||||
|
|
||||||
|
// Parent suite to have access to the implemented methods of parent struct
|
||||||
|
s TestingSuite
|
||||||
}
|
}
|
||||||
|
|
||||||
// T retrieves the current *testing.T context.
|
// T retrieves the current *testing.T context.
|
||||||
|
@ -43,12 +47,18 @@ func (suite *Suite) SetT(t *testing.T) {
|
||||||
suite.require = require.New(t)
|
suite.require = require.New(t)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetS needs to set the current test suite as parent
|
||||||
|
// to get access to the parent methods
|
||||||
|
func (suite *Suite) SetS(s TestingSuite) {
|
||||||
|
suite.s = s
|
||||||
|
}
|
||||||
|
|
||||||
// Require returns a require context for suite.
|
// Require returns a require context for suite.
|
||||||
func (suite *Suite) Require() *require.Assertions {
|
func (suite *Suite) Require() *require.Assertions {
|
||||||
suite.mu.Lock()
|
suite.mu.Lock()
|
||||||
defer suite.mu.Unlock()
|
defer suite.mu.Unlock()
|
||||||
if suite.require == nil {
|
if suite.require == nil {
|
||||||
suite.require = require.New(suite.T())
|
panic("'Require' must not be called before 'Run' or 'SetT'")
|
||||||
}
|
}
|
||||||
return suite.require
|
return suite.require
|
||||||
}
|
}
|
||||||
|
@ -62,13 +72,19 @@ func (suite *Suite) Assert() *assert.Assertions {
|
||||||
suite.mu.Lock()
|
suite.mu.Lock()
|
||||||
defer suite.mu.Unlock()
|
defer suite.mu.Unlock()
|
||||||
if suite.Assertions == nil {
|
if suite.Assertions == nil {
|
||||||
suite.Assertions = assert.New(suite.T())
|
panic("'Assert' must not be called before 'Run' or 'SetT'")
|
||||||
}
|
}
|
||||||
return suite.Assertions
|
return suite.Assertions
|
||||||
}
|
}
|
||||||
|
|
||||||
func failOnPanic(t *testing.T) {
|
func recoverAndFailOnPanic(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
r := recover()
|
r := recover()
|
||||||
|
failOnPanic(t, r)
|
||||||
|
}
|
||||||
|
|
||||||
|
func failOnPanic(t *testing.T, r interface{}) {
|
||||||
|
t.Helper()
|
||||||
if r != nil {
|
if r != nil {
|
||||||
t.Errorf("test panicked: %v\n%s", r, debug.Stack())
|
t.Errorf("test panicked: %v\n%s", r, debug.Stack())
|
||||||
t.FailNow()
|
t.FailNow()
|
||||||
|
@ -81,9 +97,21 @@ func failOnPanic(t *testing.T) {
|
||||||
// Provides compatibility with go test pkg -run TestSuite/TestName/SubTestName.
|
// Provides compatibility with go test pkg -run TestSuite/TestName/SubTestName.
|
||||||
func (suite *Suite) Run(name string, subtest func()) bool {
|
func (suite *Suite) Run(name string, subtest func()) bool {
|
||||||
oldT := suite.T()
|
oldT := suite.T()
|
||||||
defer suite.SetT(oldT)
|
|
||||||
return oldT.Run(name, func(t *testing.T) {
|
return oldT.Run(name, func(t *testing.T) {
|
||||||
suite.SetT(t)
|
suite.SetT(t)
|
||||||
|
defer suite.SetT(oldT)
|
||||||
|
|
||||||
|
defer recoverAndFailOnPanic(t)
|
||||||
|
|
||||||
|
if setupSubTest, ok := suite.s.(SetupSubTest); ok {
|
||||||
|
setupSubTest.SetupSubTest()
|
||||||
|
}
|
||||||
|
|
||||||
|
if tearDownSubTest, ok := suite.s.(TearDownSubTest); ok {
|
||||||
|
defer tearDownSubTest.TearDownSubTest()
|
||||||
|
}
|
||||||
|
|
||||||
subtest()
|
subtest()
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -91,9 +119,10 @@ func (suite *Suite) Run(name string, subtest func()) bool {
|
||||||
// Run takes a testing suite and runs all of the tests attached
|
// Run takes a testing suite and runs all of the tests attached
|
||||||
// to it.
|
// to it.
|
||||||
func Run(t *testing.T, suite TestingSuite) {
|
func Run(t *testing.T, suite TestingSuite) {
|
||||||
defer failOnPanic(t)
|
defer recoverAndFailOnPanic(t)
|
||||||
|
|
||||||
suite.SetT(t)
|
suite.SetT(t)
|
||||||
|
suite.SetS(suite)
|
||||||
|
|
||||||
var suiteSetupDone bool
|
var suiteSetupDone bool
|
||||||
|
|
||||||
|
@ -136,10 +165,14 @@ func Run(t *testing.T, suite TestingSuite) {
|
||||||
F: func(t *testing.T) {
|
F: func(t *testing.T) {
|
||||||
parentT := suite.T()
|
parentT := suite.T()
|
||||||
suite.SetT(t)
|
suite.SetT(t)
|
||||||
defer failOnPanic(t)
|
defer recoverAndFailOnPanic(t)
|
||||||
defer func() {
|
defer func() {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
r := recover()
|
||||||
|
|
||||||
if stats != nil {
|
if stats != nil {
|
||||||
passed := !t.Failed()
|
passed := !t.Failed() && r == nil
|
||||||
stats.end(method.Name, passed)
|
stats.end(method.Name, passed)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -152,6 +185,7 @@ func Run(t *testing.T, suite TestingSuite) {
|
||||||
}
|
}
|
||||||
|
|
||||||
suite.SetT(parentT)
|
suite.SetT(parentT)
|
||||||
|
failOnPanic(t, r)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
if setupTestSuite, ok := suite.(SetupTestSuite); ok {
|
if setupTestSuite, ok := suite.(SetupTestSuite); ok {
|
||||||
|
|
|
@ -4,7 +4,7 @@ import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"errors"
|
"errors"
|
||||||
"flag"
|
"flag"
|
||||||
"io/ioutil"
|
"io"
|
||||||
"math/rand"
|
"math/rand"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
|
@ -21,20 +21,20 @@ import (
|
||||||
type SuiteRequireTwice struct{ Suite }
|
type SuiteRequireTwice struct{ Suite }
|
||||||
|
|
||||||
// TestSuiteRequireTwice checks for regressions of issue #149 where
|
// TestSuiteRequireTwice checks for regressions of issue #149 where
|
||||||
// suite.requirements was not initialised in suite.SetT()
|
// suite.requirements was not initialized in suite.SetT()
|
||||||
// A regression would result on these tests panicking rather than failing.
|
// A regression would result on these tests panicking rather than failing.
|
||||||
func TestSuiteRequireTwice(t *testing.T) {
|
func TestSuiteRequireTwice(t *testing.T) {
|
||||||
ok := testing.RunTests(
|
ok := testing.RunTests(
|
||||||
allTestsFilter,
|
allTestsFilter,
|
||||||
[]testing.InternalTest{{
|
[]testing.InternalTest{{
|
||||||
Name: "TestSuiteRequireTwice",
|
Name: t.Name() + "/SuiteRequireTwice",
|
||||||
F: func(t *testing.T) {
|
F: func(t *testing.T) {
|
||||||
suite := new(SuiteRequireTwice)
|
suite := new(SuiteRequireTwice)
|
||||||
Run(t, suite)
|
Run(t, suite)
|
||||||
},
|
},
|
||||||
}},
|
}},
|
||||||
)
|
)
|
||||||
assert.Equal(t, false, ok)
|
assert.False(t, ok)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *SuiteRequireTwice) TestRequireOne() {
|
func (s *SuiteRequireTwice) TestRequireOne() {
|
||||||
|
@ -104,31 +104,31 @@ func TestSuiteRecoverPanic(t *testing.T) {
|
||||||
ok := true
|
ok := true
|
||||||
panickingTests := []testing.InternalTest{
|
panickingTests := []testing.InternalTest{
|
||||||
{
|
{
|
||||||
Name: "TestPanicInSetupSuite",
|
Name: t.Name() + "/InSetupSuite",
|
||||||
F: func(t *testing.T) { Run(t, &panickingSuite{panicInSetupSuite: true}) },
|
F: func(t *testing.T) { Run(t, &panickingSuite{panicInSetupSuite: true}) },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Name: "TestPanicInSetupTest",
|
Name: t.Name() + "/InSetupTest",
|
||||||
F: func(t *testing.T) { Run(t, &panickingSuite{panicInSetupTest: true}) },
|
F: func(t *testing.T) { Run(t, &panickingSuite{panicInSetupTest: true}) },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Name: "TestPanicInBeforeTest",
|
Name: t.Name() + "InBeforeTest",
|
||||||
F: func(t *testing.T) { Run(t, &panickingSuite{panicInBeforeTest: true}) },
|
F: func(t *testing.T) { Run(t, &panickingSuite{panicInBeforeTest: true}) },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Name: "TestPanicInTest",
|
Name: t.Name() + "/InTest",
|
||||||
F: func(t *testing.T) { Run(t, &panickingSuite{panicInTest: true}) },
|
F: func(t *testing.T) { Run(t, &panickingSuite{panicInTest: true}) },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Name: "TestPanicInAfterTest",
|
Name: t.Name() + "/InAfterTest",
|
||||||
F: func(t *testing.T) { Run(t, &panickingSuite{panicInAfterTest: true}) },
|
F: func(t *testing.T) { Run(t, &panickingSuite{panicInAfterTest: true}) },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Name: "TestPanicInTearDownTest",
|
Name: t.Name() + "/InTearDownTest",
|
||||||
F: func(t *testing.T) { Run(t, &panickingSuite{panicInTearDownTest: true}) },
|
F: func(t *testing.T) { Run(t, &panickingSuite{panicInTearDownTest: true}) },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
Name: "TestPanicInTearDownSuite",
|
Name: t.Name() + "/InTearDownSuite",
|
||||||
F: func(t *testing.T) { Run(t, &panickingSuite{panicInTearDownSuite: true}) },
|
F: func(t *testing.T) { Run(t, &panickingSuite{panicInTearDownSuite: true}) },
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
@ -151,14 +151,19 @@ type SuiteTester struct {
|
||||||
Suite
|
Suite
|
||||||
|
|
||||||
// Keep counts of how many times each method is run.
|
// Keep counts of how many times each method is run.
|
||||||
SetupSuiteRunCount int
|
SetupSuiteRunCount int
|
||||||
TearDownSuiteRunCount int
|
TearDownSuiteRunCount int
|
||||||
SetupTestRunCount int
|
SetupTestRunCount int
|
||||||
TearDownTestRunCount int
|
TearDownTestRunCount int
|
||||||
TestOneRunCount int
|
TestOneRunCount int
|
||||||
TestTwoRunCount int
|
TestTwoRunCount int
|
||||||
TestSubtestRunCount int
|
TestSubtestRunCount int
|
||||||
NonTestMethodRunCount int
|
NonTestMethodRunCount int
|
||||||
|
SetupSubTestRunCount int
|
||||||
|
TearDownSubTestRunCount int
|
||||||
|
|
||||||
|
SetupSubTestNames []string
|
||||||
|
TearDownSubTestNames []string
|
||||||
|
|
||||||
SuiteNameBefore []string
|
SuiteNameBefore []string
|
||||||
TestNameBefore []string
|
TestNameBefore []string
|
||||||
|
@ -255,6 +260,16 @@ func (suite *SuiteTester) TestSubtest() {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (suite *SuiteTester) TearDownSubTest() {
|
||||||
|
suite.TearDownSubTestNames = append(suite.TearDownSubTestNames, suite.T().Name())
|
||||||
|
suite.TearDownSubTestRunCount++
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *SuiteTester) SetupSubTest() {
|
||||||
|
suite.SetupSubTestNames = append(suite.SetupSubTestNames, suite.T().Name())
|
||||||
|
suite.SetupSubTestRunCount++
|
||||||
|
}
|
||||||
|
|
||||||
type SuiteSkipTester struct {
|
type SuiteSkipTester struct {
|
||||||
// Include our basic suite logic.
|
// Include our basic suite logic.
|
||||||
Suite
|
Suite
|
||||||
|
@ -291,13 +306,13 @@ func TestRunSuite(t *testing.T) {
|
||||||
|
|
||||||
// The suite was only run once, so the SetupSuite and TearDownSuite
|
// The suite was only run once, so the SetupSuite and TearDownSuite
|
||||||
// methods should have each been run only once.
|
// methods should have each been run only once.
|
||||||
assert.Equal(t, suiteTester.SetupSuiteRunCount, 1)
|
assert.Equal(t, 1, suiteTester.SetupSuiteRunCount)
|
||||||
assert.Equal(t, suiteTester.TearDownSuiteRunCount, 1)
|
assert.Equal(t, 1, suiteTester.TearDownSuiteRunCount)
|
||||||
|
|
||||||
assert.Equal(t, len(suiteTester.SuiteNameAfter), 4)
|
assert.Len(t, suiteTester.SuiteNameAfter, 4)
|
||||||
assert.Equal(t, len(suiteTester.SuiteNameBefore), 4)
|
assert.Len(t, suiteTester.SuiteNameBefore, 4)
|
||||||
assert.Equal(t, len(suiteTester.TestNameAfter), 4)
|
assert.Len(t, suiteTester.TestNameAfter, 4)
|
||||||
assert.Equal(t, len(suiteTester.TestNameBefore), 4)
|
assert.Len(t, suiteTester.TestNameBefore, 4)
|
||||||
|
|
||||||
assert.Contains(t, suiteTester.TestNameAfter, "TestOne")
|
assert.Contains(t, suiteTester.TestNameAfter, "TestOne")
|
||||||
assert.Contains(t, suiteTester.TestNameAfter, "TestTwo")
|
assert.Contains(t, suiteTester.TestNameAfter, "TestTwo")
|
||||||
|
@ -309,6 +324,12 @@ func TestRunSuite(t *testing.T) {
|
||||||
assert.Contains(t, suiteTester.TestNameBefore, "TestSkip")
|
assert.Contains(t, suiteTester.TestNameBefore, "TestSkip")
|
||||||
assert.Contains(t, suiteTester.TestNameBefore, "TestSubtest")
|
assert.Contains(t, suiteTester.TestNameBefore, "TestSubtest")
|
||||||
|
|
||||||
|
assert.Contains(t, suiteTester.SetupSubTestNames, "TestRunSuite/TestSubtest/first")
|
||||||
|
assert.Contains(t, suiteTester.SetupSubTestNames, "TestRunSuite/TestSubtest/second")
|
||||||
|
|
||||||
|
assert.Contains(t, suiteTester.TearDownSubTestNames, "TestRunSuite/TestSubtest/first")
|
||||||
|
assert.Contains(t, suiteTester.TearDownSubTestNames, "TestRunSuite/TestSubtest/second")
|
||||||
|
|
||||||
for _, suiteName := range suiteTester.SuiteNameAfter {
|
for _, suiteName := range suiteTester.SuiteNameAfter {
|
||||||
assert.Equal(t, "SuiteTester", suiteName)
|
assert.Equal(t, "SuiteTester", suiteName)
|
||||||
}
|
}
|
||||||
|
@ -328,17 +349,20 @@ func TestRunSuite(t *testing.T) {
|
||||||
// There are four test methods (TestOne, TestTwo, TestSkip, and TestSubtest), so
|
// There are four test methods (TestOne, TestTwo, TestSkip, and TestSubtest), so
|
||||||
// the SetupTest and TearDownTest methods (which should be run once for
|
// the SetupTest and TearDownTest methods (which should be run once for
|
||||||
// each test) should have been run four times.
|
// each test) should have been run four times.
|
||||||
assert.Equal(t, suiteTester.SetupTestRunCount, 4)
|
assert.Equal(t, 4, suiteTester.SetupTestRunCount)
|
||||||
assert.Equal(t, suiteTester.TearDownTestRunCount, 4)
|
assert.Equal(t, 4, suiteTester.TearDownTestRunCount)
|
||||||
|
|
||||||
// Each test should have been run once.
|
// Each test should have been run once.
|
||||||
assert.Equal(t, suiteTester.TestOneRunCount, 1)
|
assert.Equal(t, 1, suiteTester.TestOneRunCount)
|
||||||
assert.Equal(t, suiteTester.TestTwoRunCount, 1)
|
assert.Equal(t, 1, suiteTester.TestTwoRunCount)
|
||||||
assert.Equal(t, suiteTester.TestSubtestRunCount, 1)
|
assert.Equal(t, 1, suiteTester.TestSubtestRunCount)
|
||||||
|
|
||||||
|
assert.Equal(t, 2, suiteTester.TearDownSubTestRunCount)
|
||||||
|
assert.Equal(t, 2, suiteTester.SetupSubTestRunCount)
|
||||||
|
|
||||||
// Methods that don't match the test method identifier shouldn't
|
// Methods that don't match the test method identifier shouldn't
|
||||||
// have been run at all.
|
// have been run at all.
|
||||||
assert.Equal(t, suiteTester.NonTestMethodRunCount, 0)
|
assert.Equal(t, 0, suiteTester.NonTestMethodRunCount)
|
||||||
|
|
||||||
suiteSkipTester := new(SuiteSkipTester)
|
suiteSkipTester := new(SuiteSkipTester)
|
||||||
Run(t, suiteSkipTester)
|
Run(t, suiteSkipTester)
|
||||||
|
@ -346,8 +370,8 @@ func TestRunSuite(t *testing.T) {
|
||||||
// The suite was only run once, so the SetupSuite and TearDownSuite
|
// The suite was only run once, so the SetupSuite and TearDownSuite
|
||||||
// methods should have each been run only once, even though SetupSuite
|
// methods should have each been run only once, even though SetupSuite
|
||||||
// called Skip()
|
// called Skip()
|
||||||
assert.Equal(t, suiteSkipTester.SetupSuiteRunCount, 1)
|
assert.Equal(t, 1, suiteSkipTester.SetupSuiteRunCount)
|
||||||
assert.Equal(t, suiteSkipTester.TearDownSuiteRunCount, 1)
|
assert.Equal(t, 1, suiteSkipTester.TearDownSuiteRunCount)
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -416,7 +440,7 @@ func (sc *StdoutCapture) StopCapture() (string, error) {
|
||||||
}
|
}
|
||||||
os.Stdout.Close()
|
os.Stdout.Close()
|
||||||
os.Stdout = sc.oldStdout
|
os.Stdout = sc.oldStdout
|
||||||
bytes, err := ioutil.ReadAll(sc.readPipe)
|
bytes, err := io.ReadAll(sc.readPipe)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
|
@ -427,7 +451,7 @@ func TestSuiteLogging(t *testing.T) {
|
||||||
suiteLoggingTester := new(SuiteLoggingTester)
|
suiteLoggingTester := new(SuiteLoggingTester)
|
||||||
capture := StdoutCapture{}
|
capture := StdoutCapture{}
|
||||||
internalTest := testing.InternalTest{
|
internalTest := testing.InternalTest{
|
||||||
Name: "SomeTest",
|
Name: t.Name() + "/SuiteLoggingTester",
|
||||||
F: func(subT *testing.T) {
|
F: func(subT *testing.T) {
|
||||||
Run(subT, suiteLoggingTester)
|
Run(subT, suiteLoggingTester)
|
||||||
},
|
},
|
||||||
|
@ -468,7 +492,7 @@ func (s *CallOrderSuite) SetupSuite() {
|
||||||
|
|
||||||
func (s *CallOrderSuite) TearDownSuite() {
|
func (s *CallOrderSuite) TearDownSuite() {
|
||||||
s.call("TearDownSuite")
|
s.call("TearDownSuite")
|
||||||
assert.Equal(s.T(), "SetupSuite;SetupTest;Test A;TearDownTest;SetupTest;Test B;TearDownTest;TearDownSuite", strings.Join(s.callOrder, ";"))
|
assert.Equal(s.T(), "SetupSuite;SetupTest;Test A;SetupSubTest;SubTest A1;TearDownSubTest;SetupSubTest;SubTest A2;TearDownSubTest;TearDownTest;SetupTest;Test B;SetupSubTest;SubTest B1;TearDownSubTest;SetupSubTest;SubTest B2;TearDownSubTest;TearDownTest;TearDownSuite", strings.Join(s.callOrder, ";"))
|
||||||
}
|
}
|
||||||
func (s *CallOrderSuite) SetupTest() {
|
func (s *CallOrderSuite) SetupTest() {
|
||||||
s.call("SetupTest")
|
s.call("SetupTest")
|
||||||
|
@ -478,12 +502,32 @@ func (s *CallOrderSuite) TearDownTest() {
|
||||||
s.call("TearDownTest")
|
s.call("TearDownTest")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (s *CallOrderSuite) SetupSubTest() {
|
||||||
|
s.call("SetupSubTest")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *CallOrderSuite) TearDownSubTest() {
|
||||||
|
s.call("TearDownSubTest")
|
||||||
|
}
|
||||||
|
|
||||||
func (s *CallOrderSuite) Test_A() {
|
func (s *CallOrderSuite) Test_A() {
|
||||||
s.call("Test A")
|
s.call("Test A")
|
||||||
|
s.Run("SubTest A1", func() {
|
||||||
|
s.call("SubTest A1")
|
||||||
|
})
|
||||||
|
s.Run("SubTest A2", func() {
|
||||||
|
s.call("SubTest A2")
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *CallOrderSuite) Test_B() {
|
func (s *CallOrderSuite) Test_B() {
|
||||||
s.call("Test B")
|
s.call("Test B")
|
||||||
|
s.Run("SubTest B1", func() {
|
||||||
|
s.call("SubTest B1")
|
||||||
|
})
|
||||||
|
s.Run("SubTest B2", func() {
|
||||||
|
s.call("SubTest B2")
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
type suiteWithStats struct {
|
type suiteWithStats struct {
|
||||||
|
@ -501,19 +545,37 @@ func (s *suiteWithStats) TestSomething() {
|
||||||
s.Equal(1, 1)
|
s.Equal(1, 1)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (s *suiteWithStats) TestPanic() {
|
||||||
|
panic("oops")
|
||||||
|
}
|
||||||
|
|
||||||
func TestSuiteWithStats(t *testing.T) {
|
func TestSuiteWithStats(t *testing.T) {
|
||||||
suiteWithStats := new(suiteWithStats)
|
suiteWithStats := new(suiteWithStats)
|
||||||
Run(t, suiteWithStats)
|
|
||||||
|
suiteSuccess := testing.RunTests(allTestsFilter, []testing.InternalTest{
|
||||||
|
{
|
||||||
|
Name: t.Name() + "/suiteWithStats",
|
||||||
|
F: func(t *testing.T) {
|
||||||
|
Run(t, suiteWithStats)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
require.False(t, suiteSuccess, "suiteWithStats should report test failure because of panic in TestPanic")
|
||||||
|
|
||||||
assert.True(t, suiteWithStats.wasCalled)
|
assert.True(t, suiteWithStats.wasCalled)
|
||||||
assert.NotZero(t, suiteWithStats.stats.Start)
|
assert.NotZero(t, suiteWithStats.stats.Start)
|
||||||
assert.NotZero(t, suiteWithStats.stats.End)
|
assert.NotZero(t, suiteWithStats.stats.End)
|
||||||
assert.True(t, suiteWithStats.stats.Passed())
|
assert.False(t, suiteWithStats.stats.Passed())
|
||||||
|
|
||||||
testStats := suiteWithStats.stats.TestStats["TestSomething"]
|
testStats := suiteWithStats.stats.TestStats
|
||||||
assert.NotZero(t, testStats.Start)
|
|
||||||
assert.NotZero(t, testStats.End)
|
assert.NotZero(t, testStats["TestSomething"].Start)
|
||||||
assert.True(t, testStats.Passed)
|
assert.NotZero(t, testStats["TestSomething"].End)
|
||||||
|
assert.True(t, testStats["TestSomething"].Passed)
|
||||||
|
|
||||||
|
assert.NotZero(t, testStats["TestPanic"].Start)
|
||||||
|
assert.NotZero(t, testStats["TestPanic"].End)
|
||||||
|
assert.False(t, testStats["TestPanic"].Passed)
|
||||||
}
|
}
|
||||||
|
|
||||||
// FailfastSuite will test the behavior when running with the failfast flag
|
// FailfastSuite will test the behavior when running with the failfast flag
|
||||||
|
@ -535,21 +597,51 @@ func TestFailfastSuite(t *testing.T) {
|
||||||
ok := testing.RunTests(
|
ok := testing.RunTests(
|
||||||
allTestsFilter,
|
allTestsFilter,
|
||||||
[]testing.InternalTest{{
|
[]testing.InternalTest{{
|
||||||
Name: "TestFailfastSuite",
|
Name: t.Name() + "/FailfastSuite",
|
||||||
F: func(t *testing.T) {
|
F: func(t *testing.T) {
|
||||||
Run(t, s)
|
Run(t, s)
|
||||||
},
|
},
|
||||||
}},
|
}},
|
||||||
)
|
)
|
||||||
assert.Equal(t, false, ok)
|
assert.False(t, ok)
|
||||||
|
var expect []string
|
||||||
if failFast {
|
if failFast {
|
||||||
// Test A Fails and because we are running with failfast Test B never runs and we proceed straight to TearDownSuite
|
// Test A Fails and because we are running with failfast Test B never runs and we proceed straight to TearDownSuite
|
||||||
assert.Equal(t, "SetupSuite;SetupTest;Test A Fails;TearDownTest;TearDownSuite", strings.Join(s.callOrder, ";"))
|
expect = []string{"SetupSuite", "SetupTest", "Test A Fails", "TearDownTest", "TearDownSuite"}
|
||||||
} else {
|
} else {
|
||||||
// Test A Fails and because we are running without failfast we continue and run Test B and then proceed to TearDownSuite
|
// Test A Fails and because we are running without failfast we continue and run Test B and then proceed to TearDownSuite
|
||||||
assert.Equal(t, "SetupSuite;SetupTest;Test A Fails;TearDownTest;SetupTest;Test B Passes;TearDownTest;TearDownSuite", strings.Join(s.callOrder, ";"))
|
expect = []string{"SetupSuite", "SetupTest", "Test A Fails", "TearDownTest", "SetupTest", "Test B Passes", "TearDownTest", "TearDownSuite"}
|
||||||
}
|
}
|
||||||
|
callOrderAssert(t, expect, s.callOrder)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type tHelper interface {
|
||||||
|
Helper()
|
||||||
|
}
|
||||||
|
|
||||||
|
// callOrderAssert is a help with confirms that asserts that expect
|
||||||
|
// matches one or more times in callOrder. This makes it compatible
|
||||||
|
// with go test flag -count=X where X > 1.
|
||||||
|
func callOrderAssert(t *testing.T, expect, callOrder []string) {
|
||||||
|
var ti interface{} = t
|
||||||
|
if h, ok := ti.(tHelper); ok {
|
||||||
|
h.Helper()
|
||||||
|
}
|
||||||
|
|
||||||
|
callCount := len(callOrder)
|
||||||
|
expectCount := len(expect)
|
||||||
|
if callCount > expectCount && callCount%expectCount == 0 {
|
||||||
|
// Command line flag -count=X where X > 1.
|
||||||
|
for len(callOrder) >= expectCount {
|
||||||
|
assert.Equal(t, expect, callOrder[:expectCount])
|
||||||
|
callOrder = callOrder[expectCount:]
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Equal(t, expect, callOrder)
|
||||||
|
}
|
||||||
|
|
||||||
func TestFailfastSuiteFailFastOn(t *testing.T) {
|
func TestFailfastSuiteFailFastOn(t *testing.T) {
|
||||||
// To test this with failfast on (and isolated from other intended test failures in our test suite) we launch it in its own process
|
// To test this with failfast on (and isolated from other intended test failures in our test suite) we launch it in its own process
|
||||||
cmd := exec.Command("go", "test", "-v", "-race", "-run", "TestFailfastSuite", "-failfast")
|
cmd := exec.Command("go", "test", "-v", "-race", "-run", "TestFailfastSuite", "-failfast")
|
||||||
|
@ -587,3 +679,70 @@ func (s *FailfastSuite) Test_B_Passes() {
|
||||||
s.call("Test B Passes")
|
s.call("Test B Passes")
|
||||||
s.Require().True(true)
|
s.Require().True(true)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type subtestPanicSuite struct {
|
||||||
|
Suite
|
||||||
|
inTearDownSuite bool
|
||||||
|
inTearDownTest bool
|
||||||
|
inTearDownSubTest bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *subtestPanicSuite) TearDownSuite() {
|
||||||
|
s.inTearDownSuite = true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *subtestPanicSuite) TearDownTest() {
|
||||||
|
s.inTearDownTest = true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *subtestPanicSuite) TearDownSubTest() {
|
||||||
|
s.inTearDownSubTest = true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *subtestPanicSuite) TestSubtestPanic() {
|
||||||
|
ok := s.Run("subtest", func() {
|
||||||
|
panic("panic")
|
||||||
|
})
|
||||||
|
s.False(ok, "subtest failure is expected")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSubtestPanic(t *testing.T) {
|
||||||
|
suite := new(subtestPanicSuite)
|
||||||
|
ok := testing.RunTests(
|
||||||
|
allTestsFilter,
|
||||||
|
[]testing.InternalTest{{
|
||||||
|
Name: t.Name() + "/subtestPanicSuite",
|
||||||
|
F: func(t *testing.T) {
|
||||||
|
Run(t, suite)
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
)
|
||||||
|
assert.False(t, ok, "TestSubtestPanic/subtest should make the testsuite fail")
|
||||||
|
assert.True(t, suite.inTearDownSubTest)
|
||||||
|
assert.True(t, suite.inTearDownTest)
|
||||||
|
assert.True(t, suite.inTearDownSuite)
|
||||||
|
}
|
||||||
|
|
||||||
|
type unInitializedSuite struct {
|
||||||
|
Suite
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestUnInitializedSuites asserts the behavior of the suite methods when the
|
||||||
|
// suite is not initialized
|
||||||
|
func TestUnInitializedSuites(t *testing.T) {
|
||||||
|
t.Run("should panic on Require", func(t *testing.T) {
|
||||||
|
suite := new(unInitializedSuite)
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
suite.Require().True(true)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("should panic on Assert", func(t *testing.T) {
|
||||||
|
suite := new(unInitializedSuite)
|
||||||
|
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
suite.Assert().True(true)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in New Issue