Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: add consumer test ( E2E ) #880

Merged
merged 23 commits into from
Dec 2, 2020
Merged

test: add consumer test ( E2E ) #880

Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
3b825b8
test: add consumer e2e test without username
idbeta Nov 26, 2020
c5b357b
test: add testcase for incorrect scene
idbeta Nov 26, 2020
bdf17d8
chore: fix style
idbeta Nov 26, 2020
4f60712
chore: remove useless underscore
idbeta Nov 26, 2020
89a6b3f
chore: remove useless code
idbeta Nov 26, 2020
949f52f
chore: fix comment
idbeta Nov 26, 2020
2529be7
test: remove testcases which are not E2E
idbeta Nov 26, 2020
2a373b9
chore: enhance case stability
idbeta Nov 26, 2020
606828b
test: modify test function name
idbeta Nov 26, 2020
e934a69
Merge branch 'master' into add-e2e-test-consumer2
idbeta Nov 26, 2020
264906a
chore: change word
idbeta Nov 26, 2020
c759588
fix: enhance testcase stability
idbeta Nov 26, 2020
2d503e0
test: after delete consumer verify it again
idbeta Nov 26, 2020
4f80138
update `MangerApiExpect` to `ManagerApiExpect`
idbeta Dec 1, 2020
ccbcdbf
update `scheme` to `schema`
idbeta Dec 1, 2020
f9079e4
Merge branch 'master' into add-e2e-test-consumer2
membphis Dec 1, 2020
b811b1d
chore: add a space after `//` in the comment
idbeta Dec 1, 2020
89fdd40
fix: add `resp.Body.Close()`
idbeta Dec 1, 2020
d2b3521
fix: try to resolve the crash
idbeta Dec 2, 2020
1d22524
Merge branch 'master' into add-e2e-test-consumer2
idbeta Dec 2, 2020
cdce591
fix: the port of manager-api is changed from 8080 to 9000
idbeta Dec 2, 2020
66ca482
modify indentation
idbeta Dec 2, 2020
8e65c7f
increase waiting time to prevent failure
idbeta Dec 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
262 changes: 244 additions & 18 deletions api/test/e2e/consumer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@
package e2e

import (
"fmt"
"io/ioutil"
"net/http"
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/tidwall/gjson"
)

func TestConsumer_with_key_auth(t *testing.T) {
Expand All @@ -29,19 +35,19 @@ func TestConsumer_with_key_auth(t *testing.T) {
Method: http.MethodPut,
Path: "/apisix/admin/routes/r1",
Body: `{
"uri": "/hello",
"plugins": {
"key-auth": {}
},
"upstream": {
"type": "roundrobin",
"nodes": [{
"uri": "/hello",
"plugins": {
"key-auth": {}
},
"upstream": {
"type": "roundrobin",
"nodes": [{
"host": "172.16.238.20",
"port": 1980,
"weight": 1
}]
}
}`,
}
}`,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
},
Expand All @@ -52,22 +58,22 @@ func TestConsumer_with_key_auth(t *testing.T) {
Path: "/hello",
ExpectStatus: http.StatusUnauthorized,
ExpectBody: "Missing API key found in request",
Sleep: sleepTime, //sleep x millisecond before verify route
Sleep: sleepTime * 2,
},
{
caseDesc: "create consumer",
Object: ManagerApiExpect(t),
Path: "/apisix/admin/consumers",
Method: http.MethodPut,
Body: `{
"username": "jack",
"plugins": {
"key-auth": {
"key": "auth-one"
}
},
"desc": "test description"
}`,
"username": "jack",
"plugins": {
"key-auth": {
"key": "auth-one"
}
},
"desc": "test description"
}`,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
},
Expand Down Expand Up @@ -131,3 +137,223 @@ func TestConsumer_with_key_auth(t *testing.T) {
testCaseCheck(tc)
}
}

func TestConsumer_with_notexist_plugin(t *testing.T) {
tests := []HttpTestCase{
{
caseDesc: "create consumer with not exist plugin",
Object: ManagerApiExpect(t),
Path: "/apisix/admin/consumers",
Method: http.MethodPut,
Body: `{
"username": "jack",
"plugins": {
"key-authaa": {
"key": "auth-one"
}
},
"desc": "test description"
}`,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusBadRequest,
ExpectBody: "schema validate failed: schema not found, path: plugins.key-authaa",
},
{
caseDesc: "verify the consumer",
Object: ManagerApiExpect(t),
Path: "/apisix/admin/consumers/jack",
Method: http.MethodGet,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusNotFound,
Sleep: sleepTime,
},
}

for _, tc := range tests {
testCaseCheck(tc)
}
}

func TestConsumer_add_consumer_with_labels(t *testing.T) {
tests := []HttpTestCase{
{
caseDesc: "create the consumer",
Object: ManagerApiExpect(t),
Path: "/apisix/admin/consumers",
Method: http.MethodPut,
Body: `{
"username": "jack",
"labels": {
"build":"16",
"env":"production",
"version":"v2"
},
"plugins": {
"key-auth": {
"key": "auth-two"
}
membphis marked this conversation as resolved.
Show resolved Hide resolved
},
"desc": "test description"
}`,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
},
{
caseDesc: "verify the consumer",
Object: ManagerApiExpect(t),
Method: http.MethodGet,
Path: "/apisix/admin/consumers/jack",
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
ExpectBody: "\"username\":\"jack\",\"desc\":\"test description\",\"plugins\":{\"key-auth\":{\"key\":\"auth-two\"}},\"labels\":{\"build\":\"16\",\"env\":\"production\",\"version\":\"v2\"}",
Sleep: sleepTime,
},
{
caseDesc: "create the route",
Object: ManagerApiExpect(t),
Method: http.MethodPut,
Path: "/apisix/admin/routes/r1",
Body: `{
"uri": "/hello",
"plugins": {
"key-auth": {}
},
"upstream": {
"type": "roundrobin",
"nodes": [{
"host": "172.16.238.20",
"port": 1980,
"weight": 1
}]
}
}`,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
},
{
caseDesc: "hit the route with correct apikey",
Object: APISIXExpect(t),
Method: http.MethodGet,
Path: "/hello",
Headers: map[string]string{"apikey": "auth-two"},
ExpectStatus: http.StatusOK,
Sleep: sleepTime,
},
{
caseDesc: "delete the consumer",
Object: ManagerApiExpect(t),
Method: http.MethodDelete,
Path: "/apisix/admin/consumers/jack",
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
},
{
caseDesc: "delete the route",
Object: ManagerApiExpect(t),
Method: http.MethodDelete,
Path: "/apisix/admin/routes/r1",
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
},
}

for _, tc := range tests {
testCaseCheck(tc)
}
}

func TestConsumer_with_createtime_updatetime(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not use the testing framework? Is this test related to the title?

Copy link
Contributor Author

@idbeta idbeta Nov 26, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This case is used to test when the consumer is updated, it's create_time should not be updated and update_time should be updated. The current framework does not support obtaining update_time and create_time from the response, so I use standard library and assert to achieve it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping @moonming

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping @moonming Can you review it when you have time?

tests := []HttpTestCase{
{
caseDesc: "create the consumer",
Object: ManagerApiExpect(t),
Path: "/apisix/admin/consumers",
Method: http.MethodPut,
Body: `{
"username":"jack",
"desc": "new consumer"
}`,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
Sleep: sleepTime,
},
}
for _, tc := range tests {
testCaseCheck(tc)
}

basepath := "http://127.0.0.1:9000/apisix/admin/consumers"
time.Sleep(time.Duration(1) * time.Second)

// get the consumer, save createtime and updatetime
request, _ := http.NewRequest("GET", basepath+"/jack", nil)
request.Header.Add("Authorization", token)
resp, err := http.DefaultClient.Do(request)
if err != nil {
fmt.Printf("server not responding %s", err.Error())
}
defer resp.Body.Close()
respBody, _ := ioutil.ReadAll(resp.Body)
createtime := gjson.Get(string(respBody), "data.create_time")
updatetime := gjson.Get(string(respBody), "data.update_time")

// wait 1 second so the update_time should be different
time.Sleep(time.Duration(1) * time.Second)

tests = []HttpTestCase{
{
caseDesc: "update the consumer",
Object: ManagerApiExpect(t),
Path: "/apisix/admin/consumers",
Method: http.MethodPut,
Body: `{
"username":"jack",
"desc": "updated consumer"
}`,
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
Sleep: sleepTime,
},
}

for _, tc := range tests {
testCaseCheck(tc)
}

// get the consumer
request, _ = http.NewRequest("GET", basepath+"/jack", nil)
request.Header.Add("Authorization", token)
resp, _ = http.DefaultClient.Do(request)
membphis marked this conversation as resolved.
Show resolved Hide resolved
respBody, _ = ioutil.ReadAll(resp.Body)
createtime2 := gjson.Get(string(respBody), "data.create_time")
updatetime2 := gjson.Get(string(respBody), "data.update_time")

// verify the consumer and compare result
assert.Equal(t, "updated consumer", gjson.Get(string(respBody), "data.desc").String())
assert.Equal(t, createtime.String(), createtime2.String())
assert.NotEqual(t, updatetime.String(), updatetime2.String())

tests = []HttpTestCase{
{
caseDesc: "delete the consumer",
Object: ManagerApiExpect(t),
Method: http.MethodDelete,
Path: "/apisix/admin/consumers/jack",
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusOK,
},
{
caseDesc: "after delete consumer verify it again",
Object: ManagerApiExpect(t),
Method: http.MethodGet,
Path: "/apisix/admin/consumers/jack",
Headers: map[string]string{"Authorization": token},
ExpectStatus: http.StatusNotFound,
Sleep: sleepTime,
},
}

for _, tc := range tests {
testCaseCheck(tc)
}
}