This repository has been archived by the owner on May 15, 2024. It is now read-only.
feat: api schema tests #168
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| package test | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "os" | ||
| "strconv" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/filecoin-project/motion/api" | ||
| "github.com/stretchr/testify/require" | ||
| "gopkg.in/yaml.v3" | ||
| ) | ||
|
|
||
| type testCase struct { | ||
| name string | ||
| onMethod string | ||
| onPath string | ||
| onBody string | ||
| onContentType string | ||
| expectStatus int | ||
| expectBody string // may be regex. optional (empty = not tested) | ||
|
|
||
| // Silences error for this schema case | ||
| skip bool | ||
| } | ||
|
|
||
| type schemaCase struct { | ||
| method string | ||
| path string | ||
| status string | ||
| covered bool | ||
| } | ||
|
|
||
| func (s schemaCase) String() string { | ||
| return fmt.Sprintf("%s %s -> %s (covered: %v)\n", s.method, s.path, s.status, s.covered) | ||
| } | ||
|
|
||
| func TestApi(t *testing.T) { | ||
| env := NewEnvironment(t) | ||
|
|
||
| // Prereq: post 1 piece of data to test on | ||
| var testBlobResp api.PostBlobResponse | ||
| { | ||
| resp, err := http.Post( | ||
| requireJoinUrlPath(t, env.MotionAPIEndpoint, "v0", "blob"), | ||
| "application/octet-stream", | ||
| bytes.NewReader([]byte("a")), | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
| require.NoError(t, json.NewDecoder(resp.Body).Decode(&testBlobResp)) | ||
|
|
||
| resp.Body.Close() | ||
| } | ||
|
|
||
| // ---- Add test cases here ---- | ||
| tests := []testCase{ | ||
| { | ||
| name: "POST /v0/blob is 201", | ||
| onMethod: http.MethodPost, | ||
| onPath: "/v0/blob", | ||
| onBody: "fish", | ||
| onContentType: "application/octet-stream", | ||
| expectBody: "{\"id\":\".*\"}", | ||
| expectStatus: 201, | ||
| }, | ||
| { | ||
| // not reliably testable | ||
| onMethod: http.MethodPost, | ||
| onPath: "/v0/blob", | ||
| expectStatus: 500, | ||
| skip: true, | ||
| }, | ||
| { | ||
| // not reliably testable | ||
| onMethod: http.MethodPost, | ||
| onPath: "/v0/blob", | ||
| expectStatus: 503, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "GET /v0/blob/{id} is 200", | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/" + testBlobResp.ID, | ||
| expectStatus: 200, | ||
| }, | ||
| { | ||
| name: "GET /v0/blob/{id} for unknown ID is 404", | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/00000000-0000-0000-0000-000000000000", | ||
| expectStatus: 404, | ||
| }, | ||
| { | ||
| // not reliably testable | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/00000000-0000-0000-0000-000000000000", | ||
| expectStatus: 500, | ||
| skip: true, | ||
| }, | ||
| { | ||
| // not reliably testable | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/00000000-0000-0000-0000-000000000000", | ||
| expectStatus: 503, | ||
| skip: true, | ||
| }, | ||
| { | ||
| name: "GET /v0/blob/{id}/status is 200", | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/" + testBlobResp.ID + "/status", | ||
| expectStatus: 200, | ||
| }, | ||
| { | ||
| name: "GET /v0/blob/{id}/status for unknown ID is 404", | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/00000000-0000-0000-0000-000000000000/status", | ||
| expectStatus: 404, | ||
| }, | ||
| { | ||
| // not reliably testable | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/00000000-0000-0000-0000-000000000000/status", | ||
| expectStatus: 500, | ||
| skip: true, | ||
| }, | ||
| { | ||
| // not reliably testable | ||
| onMethod: http.MethodGet, | ||
| onPath: "/v0/blob/00000000-0000-0000-0000-000000000000/status", | ||
| expectStatus: 503, | ||
| skip: true, | ||
| }, | ||
| } | ||
|
|
||
| // Read and parse openapi.yaml for ensuring all paths, methods, and status | ||
| // codes are covered | ||
|
|
||
| schemaString, err := os.ReadFile("../../openapi.yaml") | ||
| require.NoError(t, err, "could not find openapi.yaml") | ||
|
|
||
| schemaMap := make(map[string]interface{}) | ||
| err = yaml.Unmarshal(schemaString, schemaMap) | ||
| require.NoError(t, err) | ||
|
|
||
| var schemaCases []schemaCase | ||
|
|
||
| type kvmap = map[string]interface{} | ||
| for pathName, path := range schemaMap["paths"].(kvmap) { | ||
| for methodName, method := range path.(kvmap) { | ||
| for statusCode := range method.(kvmap)["responses"].(kvmap) { | ||
| schemaCases = append(schemaCases, schemaCase{ | ||
| method: methodName, | ||
| path: pathName, | ||
| status: statusCode, | ||
| covered: false, | ||
| }) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Run all tests | ||
| for _, test := range tests { | ||
| if !test.skip { | ||
| req, err := http.NewRequest( | ||
| test.onMethod, | ||
| requireJoinUrlPath(t, env.MotionAPIEndpoint, test.onPath), | ||
| bytes.NewReader([]byte(test.expectBody)), | ||
| ) | ||
| req.Header.Set("Content-Type", test.onContentType) | ||
| require.NoError(t, err) | ||
|
|
||
| resp, err := http.DefaultClient.Do(req) | ||
| require.NoError(t, err) | ||
|
|
||
| // Body must be as expected | ||
| var body string | ||
| if test.expectBody != "" { | ||
| bodyBytes, err := io.ReadAll(resp.Body) | ||
| require.NoError(t, err) | ||
|
|
||
| body = string(bodyBytes) | ||
| require.Regexp(t, test.expectBody, string(body)) | ||
| } | ||
|
|
||
| resp.Body.Close() | ||
|
|
||
| // Status code must be as expected | ||
| require.Equal(t, test.expectStatus, resp.StatusCode, "Incorrect status code for test %#v (resp body: %v)", test, body) | ||
| } | ||
|
|
||
| // Find matching schema case and mark as covered | ||
| for i := range schemaCases { | ||
|
There was a problem hiding this comment. I would do it differently
There was a problem hiding this comment. Re 1. Do you think it's worth the increase in LOC? No one is asking for http client library for such simple api (yet) right? Re 2. Either works. Considering the work is done already, and we want to focus on e2e tests first/more than vide coverage would it make sense to revisit this at later date and leave it as is for now? There was a problem hiding this comment. considering that everything works right now, and the code does and will continue to do its job for now, i'd say we can look at codegen client / coverage as a followup, as they are more heavy commitments compared to what i wrote so far |
||
| methodsMatch := strings.EqualFold(schemaCases[i].method, test.onMethod) | ||
| pathsMatch := schemaPathFitsTest(schemaCases[i].path, test.onPath) | ||
| statusesMatch := schemaCases[i].status == strconv.Itoa(test.expectStatus) | ||
|
|
||
| if methodsMatch && pathsMatch && statusesMatch { | ||
| schemaCases[i].covered = true | ||
| break | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Make sure all schema cases are covered | ||
| var notCovered []schemaCase | ||
| for _, schemaCase := range schemaCases { | ||
| if !schemaCase.covered { | ||
| notCovered = append(notCovered, schemaCase) | ||
| } | ||
| } | ||
|
|
||
| require.Empty(t, notCovered, "all schema cases must be covered") | ||
| } | ||
|
|
||
| // Checks whether a test's path fits into a schema path listed in openapi.yaml, | ||
| // where the schema path may have variable parts (example, schema /foo/bar/{x} | ||
| // == test /foo/bar/5). | ||
| func schemaPathFitsTest(schemaPath string, testPath string) bool { | ||
| schemaParts := strings.Split(schemaPath, "/") | ||
| testParts := strings.Split(testPath, "/") | ||
|
|
||
| if len(schemaParts) != len(testParts) { | ||
| return false | ||
| } | ||
|
|
||
| for i := range schemaParts { | ||
| if schemaParts[i] == testParts[i] { | ||
| continue | ||
| } else if schemaParts[i][0] == '{' { | ||
| continue | ||
| } else { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| return true | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I recommend using
https://github.com/parnurzeal/gorequest
to simplify above code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would avoid extra dependencies if we can help it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
avoiding extra dependencies was my thinking while writing this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think such dependency would greatly reduce the LOC for testing, plus, it won't be built into the binary.