README
¶
yaptest - Go+ HTTP Test Framework
yaptest is a web server testing framework. This classfile has the file suffix _ytest.gox.
Before using yaptest, you need to add github.com/goplus/yap to go.mod:
gop get github.com/goplus/yap@latest
Suppose we have a web server (foo/get_p_#id.yap):
json {
"id": ${id},
}
Then we create a yaptest file (foo/foo_ytest.gox):
mock "foo.com", new(AppV2) // name of any YAP v2 web server is `AppV2`
id := "123"
get "http://foo.com/p/${id}"
ret 200
json {
"id": id,
}
The directive mock creates the web server by mockhttp. Then we write test code directly.
You can change the directive mock to testServer (see foo/bar_ytest.gox), and keep everything else unchanged:
testServer "foo.com", new(AppV2)
id := "123"
get "http://foo.com/p/${id}"
ret 200
json {
"id": id,
}
The directive testServer creates the web server by net/http/httptest and obtained a random port as the service address. Then it calls the directive host to map the random service address to foo.com. This makes all other code no need to changed.
match
This is almost the core concept in yaptest. It matches two objects.
Let’s look at a simple example first:
id := Var(int)
match id, 1+2
echo id
Here we define a variable called id and match it with expression 1+2. If the variable is unbound, it is assigned the value of the expression. In this way the value of id becomes 3.
So far, you've seen match like the assignment side. But you cannot assign a different value to a variable that has been bound:
id := Var(int)
match id, 1+2
match id, 3
echo id
match id, 5 // unmatched value - expected: 3, got: 5
In the second match statement, the variable id has been bound. At this time, it will be compared with the expression value. If it is equal, it will succeed, otherwise an error will be reported (such as the third match statement above).
The match statement can be complex, such as:
d := Var(string)
match {
"c": {"d": d},
}, {
"a": 1,
"b": 3.14,
"c": {"d": "hello", "e": "world"},
"f": 1,
}
echo d
match d, "hello"
Generally, the syntax of the match command is:
match <ExpectedObject> <SourceObject>
Unbound variables are allowed in <ExpectedObject>, but cannot appear in <SourceObject>. <ExpectedObject> and <SourceObject> do not have to be exactly the same, but what appears in <ExpectedObject> must also appear in <SourceObject>. That is, it is required to be a subset relationship (<ExpectedObject> is a subset of <SourceObject>).
If a variable in <ExpectedObject> has not been bound, it will be bound according to the value of the corresponding <SourceObject>; if the variable has been bound, the values on both sides must match.
The cornerstone of yaptest is matching grammar. Let's look at the example you saw at the beginning:
id := "123"
get "http://foo.com/p/${id}"
ret 200
json {
"id": id,
}
It is equivalent to:
id := "123"
get "http://foo.com/p/${id}"
send // send request
match 200, resp.code // assert resp.code == 200
match "application/json", resp.header.get("Content-Type")
match { // assert resp.body.id == id
"id": id,
}, resp.body
Documentation
¶
Index ¶
- Constants
- func Bearer(token string) auth.RTComposer
- func Form(m map[string]any) (ret url.Values)
- func Gopt_App_Main(app interface{ ... }, workers ...interface{ initCase(*App, CaseT) })
- func Gopt_App_TestMain(app interface{ ... }, m *testing.M)
- func Gopt_CaseApp_TestMain(c interface{ ... }, t *testing.T)
- func JsonEncode(v any) string
- type App
- type Case
- func (p *Case) DELETE(url string) *Request
- func (p *Case) GET(url string) *Request
- func (p *Case) Get(url string) *Request
- func (p *Case) HEAD(url string) *Request
- func (p *Case) Head(url string) *Request
- func (p *Case) OPTIONS(url string) *Request
- func (p *Case) Options(url string) *Request
- func (p *Case) PATCH(url string) *Request
- func (p *Case) POST(url string) *Request
- func (p *Case) PUT(url string) *Request
- func (p *Case) Patch(url string) *Request
- func (p *Case) Post(url string) *Request
- func (p *Case) Put(url string) *Request
- func (p *Case) Req__0(method, url string) *Request
- func (p *Case) Req__1() *Request
- func (p *Case) T() CaseT
- type CaseApp
- type CaseT
- type Request
- func (p *Request) Auth(auth auth.RTComposer) *Request
- func (p *Request) Binary(body any) *Request
- func (p *Request) Body(bodyType string, body any) *Request
- func (p *Request) Form(body any) *Request
- func (p *Request) Header__0(key string, value any) *Request
- func (p *Request) Header__1() http.Header
- func (p *Request) Json(body any) *Request
- func (p *Request) Resp() *Response
- func (p *Request) RetWith(code any) *Request
- func (p *Request) Send() *Request
- func (p *Request) Text(body any) *Request
- func (p *Request) WithBinary(bodyType string, body []byte) *Request
- func (p *Request) WithBody(bodyType string, body RequestBody) *Request
- func (p *Request) WithBodyEx(bodyType string, body any) *Request
- func (p *Request) WithForm(body url.Values) *Request
- func (p *Request) WithFormEx(body any) *Request
- func (p *Request) WithHeader(key string, value any) *Request
- func (p *Request) WithJson(body any) *Request
- func (p *Request) WithText(bodyType, body string) *Request
- type RequestBody
- type Response
Constants ¶
const ( GopPackage = "github.com/goplus/yap/test" GopTestClass = true )
const (
Gopo_Request_Ret = ".Send,.RetWith"
)
Variables ¶
This section is empty.
Functions ¶
func Bearer ¶ added in v0.7.3
func Bearer(token string) auth.RTComposer
Bearer creates a Bearer Authorization by specified token.
func Gopt_App_Main ¶
Gopt_App_Main is required by Go+ compiler as the Main entry of a YAP testing project.
func Gopt_App_TestMain ¶ added in v0.7.2
Gopt_App_TestMain is required by Go+ compiler as the TestMain entry of a YAP testing project.
func Gopt_CaseApp_TestMain ¶ added in v0.8.1
Gopt_CaseApp_TestMain is required by Go+ compiler as the entry of a YAP test case.
func JsonEncode ¶
JsonEncode encodes a value into string in json format.
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
func (*App) Host ¶ added in v0.7.2
Host replaces a host into real. For example:
host "https://example.com" "http://localhost:8080" host "http://example.com" "http://localhost:8888"
func (*App) RunTestServer ¶ added in v0.7.3
RunTestServer runs a HTTP server by httptest.Server.
type Case ¶
type Case struct {
*Request
test.Case
DefaultHeader http.Header
// contains filtered or unexported fields
}
type Request ¶
type Request struct {
// contains filtered or unexported fields
}
func (*Request) Auth ¶
func (p *Request) Auth(auth auth.RTComposer) *Request
Auth sets an Authorization for this request.
func (*Request) Body ¶
Body sets request body for this request (if request is not sended), or matches response body of this request (after response is returned). Here body can be: string, Var(string), []byte, RequestBody.
func (*Request) Header__0 ¶ added in v0.7.3
Header sets a Header for this request (if request is not sended), or matches a Header for response of this request (after response is returned). Here value can be: string, []string, Var(string), Var([]string).
func (*Request) Json ¶
body can be:
- map[string]any, Var(map[string]any), []any, Var([]any),
- []string, Var([]string), string, Var(string), int, Var(int),
- bool, Var(bool), float64, Var(float64).
func (*Request) WithFormEx ¶
func (*Request) WithHeader ¶
WithHeader sets a Header for this request.
type Response ¶
type Response struct {
// contains filtered or unexported fields
}
Source Files
Directories