feat(assert): new assert package to be used in blogo
This commit is contained in:
202
assert/LICENSE-APACHE
Normal file
202
assert/LICENSE-APACHE
Normal file
@@ -0,0 +1,202 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
23
assert/LICENSE-MIT
Normal file
23
assert/LICENSE-MIT
Normal file
@@ -0,0 +1,23 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Gustavo "Guz" L. de Mello
|
||||
Copyright (c) 2025 The Lored.dev Contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
17
assert/README.md
Normal file
17
assert/README.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# \[Tiny\] Assert
|
||||
|
||||
A minimal assertion package, all in one single file that you can copy and paste
|
||||
to vendor-in and use without adding any dependencies to your project.
|
||||
|
||||
Inspired by [`stretchr/testify`'s assert package][testify] and [`cheekybits/is`][is].
|
||||
|
||||
[testify]: https://github.com/stretchr/testify/tree/master/assert
|
||||
[is]: https://github.com/cheekybits/is
|
||||
|
||||
## License
|
||||
|
||||
The `assert.go` file and package is distributed under the terms of both the
|
||||
[Apache License (Version 2.0)](./LICENSE-APACHE) and the [MIT license](./LICENSE-MIT),
|
||||
at your option. You may use and/or copy the contents of the file, without removing the original
|
||||
license and copyright notice, as required by the licenses.
|
||||
|
||||
544
assert/assert.go
Normal file
544
assert/assert.go
Normal file
@@ -0,0 +1,544 @@
|
||||
// Copyright (c) 2025 Gustavo "Guz" L. de Mello
|
||||
// Copyright (c) 2025 The Lored.dev Contributors
|
||||
//
|
||||
// Contents of this file, expect as otherwise noted, are dual-licensed under the
|
||||
// Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0> or
|
||||
// the MIT license <http://opensource.org/licenses/MIT>, at you option.
|
||||
//
|
||||
// You may use this file in compliance with the licenses.
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, this file distributed
|
||||
// under the licenses is distributed on as "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
|
||||
// OF ANY KIND, either express or implied.
|
||||
//
|
||||
// An original copy of this file can be found at http://forge.capytal.company/loreddev/x/assert/assert.go.
|
||||
|
||||
// # [Tiny] Assert
|
||||
//
|
||||
// Minimal set of assertions functions for testing and simulation testing, all in
|
||||
// one file.
|
||||
//
|
||||
// The most simple way of using the package is importing it directly and using the
|
||||
// alias functions:
|
||||
//
|
||||
// package main
|
||||
//
|
||||
// import (
|
||||
// "log"
|
||||
// "forge.capytal.company/loreddev/x/assert"
|
||||
// )
|
||||
//
|
||||
// func main() {
|
||||
// expected := "value"
|
||||
// value := "value"
|
||||
// log.Println(assert.Equal(expected, value)) // "true"
|
||||
// }
|
||||
//
|
||||
// Or proverbially, you can create your own "assert" variable and have more control
|
||||
// over how asserts work, see [NewAssertions] for more information:
|
||||
//
|
||||
// package main
|
||||
//
|
||||
// import (
|
||||
// "log/slog"
|
||||
// "forge.capytal.company/loreddev/x/assert"
|
||||
// )
|
||||
//
|
||||
// var logger = slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{}))
|
||||
// var assert = assert.NewAssertions(assert.Opts{Logger: logger})
|
||||
//
|
||||
// func main() {
|
||||
// expected := "value"
|
||||
// value := "not value"
|
||||
// assert.Equal(expected, value) // "expected \"value\", got \"not value\"" with the call stack and returns false
|
||||
// }
|
||||
package assert
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"log/slog"
|
||||
"os"
|
||||
"path"
|
||||
"reflect"
|
||||
"runtime"
|
||||
"strings"
|
||||
"unicode"
|
||||
"unicode/utf8"
|
||||
)
|
||||
|
||||
// Assertions represents all the API provided by the [assert] package. Implementation
|
||||
// of this interface can have extra logic on their state such as panicking or using
|
||||
// [testing.T.FailNow] to halt the program from continuing on failed assertions instead
|
||||
// of just return false.
|
||||
type Assertions interface {
|
||||
// Asserts that the object are not zero-valued or nil, aka. "are ok".
|
||||
OK(obj any, msg ...any) bool
|
||||
|
||||
// Asserts that the actual value is equal to the expected value.
|
||||
Equal(expected, actual any, msg ...any) bool
|
||||
// Asserts that the actual value is not equal to the expected value.
|
||||
NotEqual(expected, actual any, msg ...any) bool
|
||||
|
||||
// Asserts that the object is nil.
|
||||
Nil(obj any, msg ...any) bool
|
||||
// Asserts that the object is not nil.
|
||||
NotNil(obj any, msg ...any) bool
|
||||
|
||||
// Asserts that the object is a boolean true.
|
||||
True(obj any, msg ...any) bool
|
||||
// Asserts that the object is a boolean false.
|
||||
False(obj any, msg ...any) bool
|
||||
|
||||
// Asserts that the object is zero-valued.
|
||||
Zero(obj any, msg ...any) bool
|
||||
// Asserts that the object is not zero-valued.
|
||||
NotZero(obj any, msg ...any) bool
|
||||
|
||||
// Asserts that the function panics.
|
||||
Panic(fn func(), msg ...any) bool
|
||||
// Asserts that the function does not panics.
|
||||
NotPanic(fn func(), msg ...any) bool
|
||||
|
||||
// Returns false and marks the test as having failed, if the underlying
|
||||
// implementation has access to a [testing.T.Fail]. Implementations can also log
|
||||
// the call stack using [CallerInfo].
|
||||
Fail(failureMsg string, msg ...any) bool
|
||||
// Returns false, marks the test as having failed, and calls [testing.T.FailNow] if the
|
||||
// underlying implementation has access to it, otherwise, simply panics.
|
||||
// Implementations can also log the call stack using [CallerInfo].
|
||||
FailNow(failureMsg string, msg ...any) bool
|
||||
|
||||
// Gets the caller stack.
|
||||
CallerInfo() []string
|
||||
}
|
||||
|
||||
var defaultAssert = NewAssertions()
|
||||
|
||||
// Asserts that the object are not zero-valued or nil, aka. "are ok".
|
||||
func OK(obj any, msg ...any) bool {
|
||||
return defaultAssert.OK(obj, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the actual value is equal to the expected value.
|
||||
func Equal(expected, actual any, msg ...any) bool {
|
||||
return defaultAssert.Equal(expected, actual, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the actual value is not equal to the expected value.
|
||||
func NotEqual(expected, actual any, msg ...any) bool {
|
||||
return defaultAssert.NotEqual(expected, actual, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the object is nil.
|
||||
func Nil(obj any, msg ...any) bool {
|
||||
return defaultAssert.Nil(obj, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the object is not nil.
|
||||
func NotNil(obj any, msg ...any) bool {
|
||||
return defaultAssert.NotNil(obj, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the object is a boolean true.
|
||||
func True(obj any, msg ...any) bool {
|
||||
return defaultAssert.True(obj, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the object is a boolean false.
|
||||
func False(obj any, msg ...any) bool {
|
||||
return defaultAssert.False(obj, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the object is zero-valued.
|
||||
func Zero(obj any, msg ...any) bool {
|
||||
return defaultAssert.Zero(obj, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the object is not zero-valued.
|
||||
func NotZero(obj any, msg ...any) bool {
|
||||
return defaultAssert.NotZero(obj, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the function panics.
|
||||
func Panic(fn func(), msg ...any) bool {
|
||||
return defaultAssert.Panic(fn, msg...)
|
||||
}
|
||||
|
||||
// Asserts that the function does not panics.
|
||||
func NotPanic(fn func(), msg ...any) bool {
|
||||
return defaultAssert.NotPanic(fn, msg...)
|
||||
}
|
||||
|
||||
// Returns false and logs the failure message using [slog.TextHandler] to [os.Stdout].
|
||||
func Fail(failureMsg string, msg ...any) bool {
|
||||
return NewAssertions(
|
||||
Opts{Logger: slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{}))},
|
||||
).Fail(failureMsg, msg...)
|
||||
}
|
||||
|
||||
// Panics and logs the failure message using [slog.TextHandler] to [os.Stdout].
|
||||
func FailNow(failureMsg string, msg ...any) bool {
|
||||
return defaultAssert.FailNow(failureMsg, msg...)
|
||||
}
|
||||
|
||||
// Creates a new implementation of Assertions, use [Opts] if you want to better manipulate
|
||||
// the behaviour of assertions.
|
||||
func NewAssertions(opts ...Opts) Assertions {
|
||||
opt := Opts{}
|
||||
if len(opts) > 0 {
|
||||
opt = opts[0]
|
||||
}
|
||||
|
||||
var h helperT
|
||||
if th, ok := opt.Testing.(helperT); ok {
|
||||
h = th
|
||||
}
|
||||
|
||||
if opt.Logger == nil {
|
||||
opt.Logger = slog.New(slog.NewTextHandler(io.Discard, &slog.HandlerOptions{}))
|
||||
}
|
||||
|
||||
return &assertions{
|
||||
panic: opt.Panic,
|
||||
|
||||
t: opt.Testing,
|
||||
h: h,
|
||||
|
||||
log: opt.Logger,
|
||||
}
|
||||
}
|
||||
|
||||
type Opts struct {
|
||||
// Wherever the assertions should panic/[FailNow] instead of just logging and
|
||||
// marking the test as failed. Optional, defaults to false.
|
||||
Panic bool
|
||||
// The testing framework to be used by assertions. Optional, if none is provided
|
||||
// the assertions just returns false in the functions, if [Opts.Panic] is set to true, the
|
||||
// assertions use panic() instead of [FailNow].
|
||||
Testing TestingT
|
||||
// The logger used by the assertions if none Testing framework is provided. Optional,
|
||||
// creates a logger that writes to [io.Discard] if none is provided.
|
||||
Logger *slog.Logger
|
||||
}
|
||||
|
||||
// Wrapper interface around [testing.T].
|
||||
type TestingT interface {
|
||||
Errorf(format string, args ...any)
|
||||
}
|
||||
type helperT interface {
|
||||
Helper()
|
||||
}
|
||||
|
||||
// Creates a new implementation of Assertions that always return true, with the exception
|
||||
// of [Assertions.Fail] and [Assertions.FailNow] which returns false, and [Assertions.CallerInfo]
|
||||
// which returns the actual caller info (uses [CallerInfo] underlying). It is useful it you use
|
||||
// assertions in production and want to disable them without changing any code.
|
||||
func NewDisabledAssertions() Assertions {
|
||||
return &disabledAssertions{}
|
||||
}
|
||||
|
||||
type assertions struct {
|
||||
panic bool
|
||||
|
||||
t TestingT
|
||||
h helperT
|
||||
|
||||
log *slog.Logger
|
||||
}
|
||||
|
||||
func (as *assertions) OK(obj any, msg ...any) bool {
|
||||
switch {
|
||||
case as.nil(obj):
|
||||
return as.failOrPanic("unexpected nil value", msg...)
|
||||
case as.zero(obj):
|
||||
return as.failOrPanic("unexpected zero value", msg...)
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
func (as *assertions) Equal(e, a any, msg ...any) bool {
|
||||
if as.equal(e, a) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic(fmt.Sprintf("expected %v, got %v", e, a), msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) NotEqual(e, a any, msg ...any) bool {
|
||||
if !as.equal(e, a) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic(fmt.Sprintf("not expected %v, got %v", e, a), msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) equal(e, a any) bool {
|
||||
if an, en := as.nil(a), as.nil(e); an || en {
|
||||
if (an && !en) || (!an && en) {
|
||||
return false
|
||||
}
|
||||
return en == an
|
||||
}
|
||||
|
||||
if reflect.DeepEqual(e, a) {
|
||||
return true
|
||||
}
|
||||
|
||||
ev, av := reflect.ValueOf(e), reflect.ValueOf(a)
|
||||
|
||||
if ev == av {
|
||||
return true
|
||||
}
|
||||
|
||||
if av.Type().ConvertibleTo(ev.Type()) {
|
||||
return reflect.DeepEqual(e, av.Convert(ev.Type()).Interface())
|
||||
}
|
||||
|
||||
if fmt.Sprintf("%#v", e) == fmt.Sprintf("%#v", a) {
|
||||
return true
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
func (as *assertions) Nil(obj any, msg ...any) bool {
|
||||
if as.nil(obj) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic("expected nil value", msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) NotNil(obj any, msg ...any) bool {
|
||||
if !as.nil(obj) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic("expected not-nil value", msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) nil(obj any) bool {
|
||||
if obj == nil {
|
||||
return true
|
||||
}
|
||||
v := reflect.ValueOf(obj)
|
||||
k := v.Kind()
|
||||
if k >= reflect.Chan && k <= reflect.Slice && v.IsNil() {
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func (as *assertions) True(obj any, msg ...any) bool {
|
||||
if b, ok := obj.(bool); ok && b {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic("expected true", msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) False(obj any, msg ...any) bool {
|
||||
if b, ok := obj.(bool); ok && !b {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic("expected false", msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) Zero(obj any, msg ...any) bool {
|
||||
if as.zero(obj) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic(fmt.Sprintf("expected zero value, got %v", obj), msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) NotZero(obj any, msg ...any) bool {
|
||||
if !as.zero(obj) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic(fmt.Sprintf("expected non-zero value, got %v", obj), msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) zero(obj any) bool {
|
||||
if obj != nil && !reflect.DeepEqual(obj, reflect.Zero(reflect.TypeOf(obj)).Interface()) {
|
||||
return false
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func (as *assertions) Panic(fn func(), msg ...any) bool {
|
||||
if as.panics(fn) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic("expected panic", msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) NotPanic(fn func(), msg ...any) bool {
|
||||
if !as.panics(fn) {
|
||||
return true
|
||||
}
|
||||
return as.failOrPanic("unexpected panic", msg...)
|
||||
}
|
||||
|
||||
func (as *assertions) panics(fn func()) bool {
|
||||
var r any
|
||||
func() {
|
||||
defer func() {
|
||||
r = recover()
|
||||
}()
|
||||
fn()
|
||||
}()
|
||||
return r != nil
|
||||
}
|
||||
|
||||
func (as *assertions) Fail(failureMsg string, msg ...any) bool {
|
||||
as.fail(failureMsg, msg...)
|
||||
if ft, ok := as.t.(interface {
|
||||
Fail()
|
||||
}); ok {
|
||||
ft.Fail()
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func (as *assertions) FailNow(failureMsg string, msg ...any) bool {
|
||||
as.fail(failureMsg, msg...)
|
||||
if ft, ok := as.t.(interface {
|
||||
FailNow()
|
||||
}); ok {
|
||||
ft.FailNow()
|
||||
} else {
|
||||
panic(fmtMessage(msg))
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func (as *assertions) fail(failureMsg string, msg ...any) {
|
||||
if as.h != nil {
|
||||
as.h.Helper()
|
||||
}
|
||||
content := make(map[string]string, 4)
|
||||
|
||||
content["Stack Trace"] = strings.Join(as.CallerInfo(), "\n\t")
|
||||
content["Error"] = failureMsg
|
||||
|
||||
if n, ok := as.t.(interface {
|
||||
Name() string
|
||||
}); ok {
|
||||
content["Test"] = n.Name()
|
||||
}
|
||||
|
||||
if msg := fmtMessage(msg); msg != "" {
|
||||
content["Message"] = msg
|
||||
}
|
||||
|
||||
var out string
|
||||
for k, m := range content {
|
||||
var c string
|
||||
for _, s := range strings.Split(m, "\n") {
|
||||
c += fmt.Sprintf("\t%s\n", s)
|
||||
}
|
||||
out += fmt.Sprintf("\t%s:\n%s", k, c)
|
||||
}
|
||||
|
||||
if as.t != nil {
|
||||
as.t.Errorf("\n%s", out)
|
||||
} else {
|
||||
as.log.Error(out)
|
||||
}
|
||||
}
|
||||
|
||||
func (as *assertions) failOrPanic(failureMsg string, msg ...any) bool {
|
||||
if as.panic {
|
||||
return as.FailNow(failureMsg, msg...)
|
||||
} else {
|
||||
return as.Fail(failureMsg, msg...)
|
||||
}
|
||||
}
|
||||
|
||||
func fmtMessage(msg []any) string {
|
||||
switch len(msg) {
|
||||
case 0:
|
||||
return ""
|
||||
case 1:
|
||||
if s, ok := msg[0].(string); ok {
|
||||
return s
|
||||
} else {
|
||||
return fmt.Sprintf("%v", msg[0])
|
||||
}
|
||||
default:
|
||||
var m string
|
||||
if s, ok := msg[0].(string); ok {
|
||||
m = s
|
||||
} else {
|
||||
m = fmt.Sprintf("%v", msg[0])
|
||||
}
|
||||
return fmt.Sprintf(m, msg[1:]...)
|
||||
}
|
||||
}
|
||||
|
||||
func (as *assertions) CallerInfo() []string {
|
||||
callers := []string{}
|
||||
for i := 0; ; i++ {
|
||||
pc, file, line, ok := runtime.Caller(i)
|
||||
if !ok {
|
||||
// We reached the end of the call stack
|
||||
break
|
||||
}
|
||||
|
||||
// Edge case found in https://github.com/stretchr/testify/issues/180
|
||||
if file == "<autogenerated>" {
|
||||
break
|
||||
}
|
||||
|
||||
f := runtime.FuncForPC(pc)
|
||||
if f == nil {
|
||||
break
|
||||
}
|
||||
name := f.Name()
|
||||
|
||||
if name == "testing.Runner" {
|
||||
break
|
||||
}
|
||||
|
||||
filename := path.Base(file)
|
||||
dirname := path.Base(path.Dir(file))
|
||||
if (dirname != "assert" && dirname != "mock" && dirname != "require") ||
|
||||
filename == "mock_test.go" {
|
||||
callers = append(callers, fmt.Sprintf("%s:%d", file, line))
|
||||
}
|
||||
|
||||
// Remove the package
|
||||
s := strings.Split(name, ".")
|
||||
name = s[len(s)-1]
|
||||
|
||||
if isTest(name, "Test") || isTest(name, "Benchmark") || isTest(name, "Example") {
|
||||
break
|
||||
}
|
||||
}
|
||||
return callers
|
||||
}
|
||||
|
||||
func isTest(name, prefix string) bool {
|
||||
if !strings.HasPrefix(name, prefix) {
|
||||
return false
|
||||
}
|
||||
if len(name) == len(prefix) {
|
||||
return true
|
||||
}
|
||||
r, _ := utf8.DecodeRuneInString(name[len(prefix):])
|
||||
return !unicode.IsLower(r)
|
||||
}
|
||||
|
||||
type disabledAssertions struct{}
|
||||
|
||||
func (_ *disabledAssertions) OK(any, ...any) bool { return true }
|
||||
func (_ *disabledAssertions) Equal(_, _ any, _ ...any) bool { return true }
|
||||
func (_ *disabledAssertions) NotEqual(_, _ any, _ ...any) bool { return true }
|
||||
func (_ *disabledAssertions) Nil(any, ...any) bool { return true }
|
||||
func (_ *disabledAssertions) NotNil(any, ...any) bool { return true }
|
||||
func (_ *disabledAssertions) True(any, ...any) bool { return true }
|
||||
func (_ *disabledAssertions) False(any, ...any) bool { return true }
|
||||
func (_ *disabledAssertions) Zero(any, ...any) bool { return true }
|
||||
func (_ *disabledAssertions) NotZero(any, ...any) bool { return true }
|
||||
func (_ *disabledAssertions) Panic(func(), ...any) bool { return true }
|
||||
func (_ *disabledAssertions) NotPanic(func(), ...any) bool { return true }
|
||||
func (_ *disabledAssertions) Fail(string, ...any) bool { return false }
|
||||
func (_ *disabledAssertions) FailNow(string, ...any) bool { return false }
|
||||
func (_ *disabledAssertions) CallerInfo() []string { return defaultAssert.CallerInfo() }
|
||||
Reference in New Issue
Block a user