testutil

README

Test Utils

testutil provide some test help util functions. eg: http test, mock ENV value

• assert go tests helper
• env variable mocks
• http request mock

Install

go get github.com/gookit/goutil/testutil

assert tests

package assert_test

import (
	"testing"

	"github.com/gookit/goutil/errorx"
	"github.com/gookit/goutil/testutil/assert"
)

func TestErr(t *testing.T) {
	err := errorx.Raw("this is a error")

	assert.NoErr(t, err, "user custom message")
	assert.ErrMsg(t, err, "this is a error")
}

Run tests for special method:

go test -v -run ^TestErr$
go test -v -run ^TestErr$ ./testutil/assert/...

Error on fail:

Mock for tests

More test utils

Wraps buffer

testutil.Buffer is wraps the bytes.Buffer and useful for testing. Will not return error on call WriteX methods

func (b *Buffer) WriteString(ss ...string) // will not return error
func (b *Buffer) WriteAny(vs ...interface{})
func (b *Buffer) ResetAndGet() string

Wraps writer

testutil.TestWriter is wraps the testutil.Buffer. it can be custom return error on write, close, flush.

Examples:

package testutil_test

import (
	"testing"

	"github.com/gookit/goutil/testutil"
	"github.com/gookit/goutil/testutil/assert"
)

func TestNewTestWriter(t *testing.T) {
	tw := testutil.NewTestWriter()
	_, err := tw.Write([]byte("hello"))
	assert.NoErr(t, err)
	assert.Eq(t, "hello", tw.String())
	assert.NoErr(t, tw.Flush())
	assert.Eq(t, "", tw.String())
	assert.NoErr(t, tw.Close())

	tw.SetErrOnWrite()
	_, err = tw.Write([]byte("hello"))
	assert.Err(t, err)
	assert.Eq(t, "", tw.String())

	tw.SetErrOnFlush()
	assert.Err(t, tw.Flush())

	tw.SetErrOnClose()
	assert.Err(t, tw.Close())
}

Functions API

func ClearOSEnv()
func DiscardStdout() error
func MockCleanOsEnv(mp map[string]string, fn func())
func MockEnvValue(key, val string, fn func(nv string))
func MockEnvValues(kvMap map[string]string, fn func())
func MockOsEnv(mp map[string]string, fn func())
func MockOsEnvByText(envText string, fn func())
func MockRequest(h http.Handler, method, path string, data *MD) *httptest.ResponseRecorder
func NewHttpRequest(method, path string, data *MD) *http.Request
func RestoreStderr(printData ...bool) (s string)
func RestoreStdout(printData ...bool) (s string)
func RevertOSEnv()
func RewriteStderr()
func RewriteStdout()
type Buffer struct{ ... }
    func NewBuffer() *Buffer
type M map[string]string
type MD struct{ ... }
type TestWriter struct{ ... }
    func NewTestWriter() *TestWriter

Code Check & Testing

gofmt -w -l ./
golint ./...
go test ./...

Testing in docker:

cd goutil
docker run -ti -v $(pwd):/go/work golang:1.18
root@xx:/go/work# go test ./...

Upgrade interface{} to any:

# 查看此次替换会影响到的源文件列表
gofmt -l -r 'interface{} -> any' .
# do 
gofmt -w -r 'interface{} -> any' .

Documentation

Overview

Package testutil provide some test help util functions. eg: http test, mock ENV value

Index

• func ClearOSEnv()
• func DiscardStdout() error
• func MockCleanOsEnv(mp map[string]string, fn func())
• func MockEnvValue(key, val string, fn func(nv string))
• func MockEnvValues(kvMap map[string]string, fn func())
• func MockOsEnv(mp map[string]string, fn func())
• func MockOsEnvByText(envText string, fn func())
• func MockRequest(h http.Handler, method, path string, data *MD) *httptest.ResponseRecorder
• func NewBuffer() *byteutil.Buffer
• func NewDirEnt(fpath string, isDir ...bool) *fakeobj.DirEntry
• func NewHTTPRequest(method, path string, data *MD) *http.Request
• func NewHttpRequest(method, path string, data *MD) *http.Request
• func RestoreStderr(printData ...bool) (s string)
• func RestoreStdout(printData ...bool) (s string)
• func RestoreTimeLocal()
• func RevertOSEnv()
• func RewriteStderr()
• func RewriteStdout()
• func SetTimeLocal(tl *time.Location)
• func SetTimeLocalUTC()
• type Buffer
• type DirEnt
• type EchoReply
  • func BuildEchoReply(r *http.Request) *EchoReply
  • func ParseBodyToReply(bd io.ReadCloser) *EchoReply
  • func ParseRespToReply(w *http.Response) *EchoReply
  • func (r *EchoReply) ContentType() string
• type EchoServer
  • func NewEchoServer() *EchoServer
  • func (s *EchoServer) HTTPHost() string
  • func (s *EchoServer) HostAddr() string
• type M
• type MD
• type TestWriter
  • func NewTestWriter() *TestWriter

Functions

func ClearOSEnv

func ClearOSEnv()

ClearOSEnv info.

Usage:

testutil.ClearOSEnv()
defer testutil.RevertOSEnv()
// do something ...

func DiscardStdout

func DiscardStdout() error

DiscardStdout Discard os.Stdout output

Usage:

DiscardStdout()
fmt.Println("Hello, playground")
RestoreStdout()

func MockCleanOsEnv

func MockCleanOsEnv(mp map[string]string, fn func())

MockCleanOsEnv by env map data.

will clear all old ENV data, use given data map. will recover old ENV after fn run.

func MockEnvValue

func MockEnvValue(key, val string, fn func(nv string))

MockEnvValue will store old env value, set new val. will restore old value on end.

func MockEnvValues

func MockEnvValues(kvMap map[string]string, fn func())

MockEnvValues will store old env value, set new val. will restore old value on end.

func MockOsEnv

func MockOsEnv(mp map[string]string, fn func())

MockOsEnv by env map data. alias of MockCleanOsEnv

func MockOsEnvByText

func MockOsEnvByText(envText string, fn func())

MockOsEnvByText by env multi line text string. will clear all old ENV data, use given data map, and will recover old ENV after fn run.

Usage:

testutil.MockOsEnvByText(`
	APP_COMMAND = login
	APP_ENV = dev
	APP_DEBUG = true

`, func() {
		// do something ...
})

func MockRequest

func MockRequest(h http.Handler, method, path string, data *MD) *httptest.ResponseRecorder

MockRequest mock an HTTP Request

Usage:

handler := router.New()
res := MockRequest(handler, "GET", "/path", nil)

// with data 1
body := strings.NewReader("string ...")
res := MockRequest(handler, "POST", "/path", &MD{
	Body: body,
	HeaderM: M{"x-head": "val"}
})

// with data 2
res := MockRequest(handler, "POST", "/path", &MD{
	BodyString: "data string",
	HeaderM: M{"x-head": "val"}
})

func NewBuffer

func NewBuffer() *byteutil.Buffer

NewBuffer instance

func NewDirEnt

func NewDirEnt(fpath string, isDir ...bool) *fakeobj.DirEntry

NewDirEnt create a fs.DirEntry

func NewHTTPRequest

func NewHTTPRequest(method, path string, data *MD) *http.Request

NewHTTPRequest quick create request for http testing Usage:

req := NewHttpRequest("GET", "/path", nil)

// with data 1
body := strings.NewReader("string ...")
req := NewHttpRequest("POST", "/path", &MD{
	Body: body,
	Headers: M{"x-head": "val"}
})

// with data 2
req := NewHttpRequest("POST", "/path", &MD{
	BodyString: "data string",
	Headers: M{"x-head": "val"}
})

func NewHttpRequest

func NewHttpRequest(method, path string, data *MD) *http.Request

NewHttpRequest for http testing, alias of NewHTTPRequest()

Deprecated: use NewHTTPRequest() instead.

func RestoreStderr

func RestoreStderr(printData ...bool) (s string)

RestoreStderr restore os.Stderr

func RestoreStdout

func RestoreStdout(printData ...bool) (s string)

RestoreStdout restore os.Stdout

func RestoreTimeLocal

func RestoreTimeLocal()

RestoreTimeLocal restore time.Local

func RevertOSEnv

func RevertOSEnv()

RevertOSEnv info

func RewriteStderr

func RewriteStderr()

RewriteStderr rewrite os.Stderr

Usage:

RewriteStderr()
fmt.Fprintln(os.Stderr, "Hello, playground")
msg := RestoreStderr()

func RewriteStdout

func RewriteStdout()

RewriteStdout rewrite os.Stdout

Usage:

RewriteStdout()
fmt.Println("Hello, playground")
msg := RestoreStdout()

func SetTimeLocal

func SetTimeLocal(tl *time.Location)

SetTimeLocal custom time.Local for testing.

func SetTimeLocalUTC

func SetTimeLocalUTC()

SetTimeLocalUTC custom time.Local=UTC for testing.

Types

type Buffer

type Buffer = byteutil.Buffer

Buffer wrap and extends the bytes.Buffer

type DirEnt

type DirEnt = fakeobj.DirEntry

DirEnt implements the fs.DirEntry

type EchoReply

type EchoReply struct {
	Origin string `json:"origin"`
	URL    string `json:"url"`
	Method string `json:"method"`
	// Query data
	Query   map[string]any `json:"query,omitempty"`
	Headers map[string]any `json:"headers,omitempty"`
	Form    map[string]any `json:"form,omitempty"`
	// Body data string
	Body  string         `json:"body,omitempty"`
	JSON  any            `json:"json,omitempty"`
	Files map[string]any `json:"files,omitempty"`
}

EchoReply http response data reply model

func BuildEchoReply

func BuildEchoReply(r *http.Request) *EchoReply

BuildEchoReply build reply body data

func ParseBodyToReply

func ParseBodyToReply(bd io.ReadCloser) *EchoReply

ParseBodyToReply parse http body to reply

func ParseRespToReply

func ParseRespToReply(w *http.Response) *EchoReply

ParseRespToReply parse http response to reply

func (*EchoReply) ContentType

func (r *EchoReply) ContentType() string

ContentType get content type

type EchoServer

type EchoServer struct {
	*httptest.Server
}

EchoServer for testing http request.

func NewEchoServer

func NewEchoServer() *EchoServer

NewEchoServer create an echo server for testing.

Usage on testing:

var testSrvAddr string

func TestMain(m *testing.M) {
	// create server
	s := testutil.NewEchoServer()
	defer s.Close()
	testSrvAddr = s.HTTPHost()
	fmt.Println("Test server listen on:", testSrvAddr)

	m.Run()
}

// in a test case ...
res := http.Get(testSrvAddr)
rpl := testutil.ParseRespToReply(res)
// assert ...

func (*EchoServer) HTTPHost

func (s *EchoServer) HTTPHost() string

HTTPHost get http host address. eg: http://127.0.0.1:8999

func (*EchoServer) HostAddr

func (s *EchoServer) HostAddr() string

HostAddr get host address. eg: 127.0.0.1:8999

type M

type M map[string]string

M short name for map

type MD

type MD struct {
	// Headers headers
	Headers M
	// Body body. eg: strings.NewReader("name=inhere")
	Body io.Reader
	// BodyString quick add body.
	BodyString string
	// BeforeSend callback
	BeforeSend func(req *http.Request)
}

MD simple request data

type TestWriter

type TestWriter = fakeobj.Writer

TestWriter struct, useful for testing. alias of fakeobj.Writer

func NewTestWriter

func NewTestWriter() *TestWriter

NewTestWriter instance