-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
new: (PROPOSAL) Add API request & pagination helpers using generics (#…
…456) * cool * Respect page * Add method helpers * one more * oops * tidy up * Add basic tests * Add unit tests * make tidy * oops * Re-use mock function * Use t.Helper * Aggregate -> Get * pls * nolint * Re-run image fixtures * oops * Store pages and results in listoptions * Maintain ListOptions backwards compatibility * Rerun example fixtures --------- Co-authored-by: Zhiwei Liang <[email protected]>
- Loading branch information
1 parent
852aace
commit f8ed8e9
Showing
38 changed files
with
1,319 additions
and
710 deletions.
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
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,77 @@ | ||
| package testutil | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "reflect" | ||
| "regexp" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| "github.com/jarcoal/httpmock" | ||
| "golang.org/x/oauth2" | ||
| ) | ||
|
|
||
| var validTestAPIKey = "NOTANAPIKEY" | ||
|
|
||
| func MockRequestURL(path string) *regexp.Regexp { | ||
| return regexp.MustCompile(fmt.Sprintf("/[a-zA-Z0-9]+/%s", strings.TrimPrefix(path, "/"))) | ||
| } | ||
|
|
||
| func MockRequestBodyValidate(t *testing.T, expected interface{}, response interface{}) httpmock.Responder { | ||
| t.Helper() | ||
|
|
||
| return func(request *http.Request) (*http.Response, error) { | ||
| eType := reflect.TypeOf(expected) | ||
| result := reflect.New(eType) | ||
|
|
||
| i := result.Interface() | ||
|
|
||
| data, err := io.ReadAll(request.Body) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| if err := json.Unmarshal(data, &i); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| // Deref the pointer if necessary | ||
| if result.Kind() == reflect.Pointer { | ||
| result = result.Elem() | ||
| } | ||
|
|
||
| resultValue := result.Interface() | ||
|
|
||
| if !reflect.DeepEqual(expected, resultValue) { | ||
| t.Fatalf("request body does not match request options: %s", cmp.Diff(expected, resultValue)) | ||
| } | ||
|
|
||
| return httpmock.NewJsonResponse(200, response) | ||
| } | ||
| } | ||
|
|
||
| // CreateMockClient is generic because importing the linodego package will result | ||
| // in a cyclic dependency. This pattern isn't ideal but works for now. | ||
| func CreateMockClient[T any](t *testing.T, createFunc func(*http.Client) T) *T { | ||
| t.Helper() | ||
|
|
||
| tokenSource := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: validTestAPIKey}) | ||
|
|
||
| client := &http.Client{ | ||
| Transport: &oauth2.Transport{ | ||
| Source: tokenSource, | ||
| }, | ||
| } | ||
| httpmock.ActivateNonDefault(client) | ||
|
|
||
| t.Cleanup(func() { | ||
| httpmock.DeactivateAndReset() | ||
| }) | ||
|
|
||
| result := createFunc(client) | ||
| return &result | ||
| } |
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
Oops, something went wrong.