Skip to content

refactor: add generic API request helper functions #572

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.

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

Merged
merged 1 commit into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
86 changes: 86 additions & 0 deletions hcloud/client_generic.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
package hcloud

import (
"bytes"
"context"
"encoding/json"
)

func getRequest[Schema any](ctx context.Context, client *Client, url string) (*Schema, *Response, error) {
req, err := client.NewRequest(ctx, "GET", url, nil)
if err != nil {
return nil, nil, err
}

var respBody Schema
resp, err := client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}

return &respBody, resp, nil
}

func postRequest[Schema any](ctx context.Context, client *Client, url string, reqBody any) (*Schema, *Response, error) {
reqBodyBytes, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}

req, err := client.NewRequest(ctx, "POST", url, bytes.NewReader(reqBodyBytes))
if err != nil {
return nil, nil, err
}

var respBody Schema
resp, err := client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}

return &respBody, resp, nil
}

func putRequest[Schema any](ctx context.Context, client *Client, url string, reqBody any) (*Schema, *Response, error) {
reqBodyBytes, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}

req, err := client.NewRequest(ctx, "PUT", url, bytes.NewReader(reqBodyBytes))
if err != nil {
return nil, nil, err
}

var respBody Schema
resp, err := client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}

return &respBody, resp, nil
}

func deleteRequest[Schema any](ctx context.Context, client *Client, url string) (*Schema, *Response, error) {
req, err := client.NewRequest(ctx, "DELETE", url, nil)
if err != nil {
return nil, nil, err
}

var respBody Schema
resp, err := client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}

return &respBody, resp, nil
}

func deleteRequestNoResult(ctx context.Context, client *Client, url string) (*Response, error) {
req, err := client.NewRequest(ctx, "DELETE", url, nil)
if err != nil {
return nil, err
}

return client.Do(req, nil)
}
115 changes: 115 additions & 0 deletions hcloud/client_generic_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
package hcloud

import (
"io"
"net/http"
"testing"

"github.com/stretchr/testify/require"

"github.com/hetznercloud/hcloud-go/v2/hcloud/exp/mockutil"
"github.com/hetznercloud/hcloud-go/v2/hcloud/schema"
)

func TestGenericRequest(t *testing.T) {
t.Run("get", func(t *testing.T) {
ctx, server, client := makeTestUtils(t)

server.Expect([]mockutil.Request{
{
Method: "GET", Path: "/resource",
Status: 200,
JSON: schema.ActionGetResponse{Action: schema.Action{ID: 1234}},
},
})

respBody, resp, err := getRequest[schema.ActionGetResponse](ctx, client, "/resource")
require.NoError(t, err)
require.NotNil(t, resp)
require.NotNil(t, respBody)

require.Equal(t, int64(1234), respBody.Action.ID)
})

t.Run("post", func(t *testing.T) {
ctx, server, client := makeTestUtils(t)

server.Expect([]mockutil.Request{
{
Method: "POST", Path: "/resource",
Want: func(t *testing.T, r *http.Request) {
bodyBytes, err := io.ReadAll(r.Body)
require.NoError(t, err)
require.JSONEq(t, `{"hello": "world"}`, string(bodyBytes))
},
Status: 200,
JSON: schema.ActionGetResponse{Action: schema.Action{ID: 1234}},
},
})

respBody, resp, err := postRequest[schema.ActionGetResponse](ctx, client, "/resource", map[string]string{"hello": "world"})
require.NoError(t, err)
require.NotNil(t, resp)
require.NotNil(t, respBody)

require.Equal(t, int64(1234), respBody.Action.ID)
})

t.Run("put", func(t *testing.T) {
ctx, server, client := makeTestUtils(t)

server.Expect([]mockutil.Request{
{
Method: "PUT", Path: "/resource",
Want: func(t *testing.T, r *http.Request) {
bodyBytes, err := io.ReadAll(r.Body)
require.NoError(t, err)
require.JSONEq(t, `{"hello": "world"}`, string(bodyBytes))
},
Status: 200,
JSON: schema.ActionGetResponse{Action: schema.Action{ID: 1234}},
},
})

respBody, resp, err := putRequest[schema.ActionGetResponse](ctx, client, "/resource", map[string]string{"hello": "world"})
require.NoError(t, err)
require.NotNil(t, resp)
require.NotNil(t, respBody)

require.Equal(t, int64(1234), respBody.Action.ID)
})

t.Run("delete", func(t *testing.T) {
ctx, server, client := makeTestUtils(t)

server.Expect([]mockutil.Request{
{
Method: "DELETE", Path: "/resource",
Status: 200,
JSON: schema.ActionGetResponse{Action: schema.Action{ID: 1234}},
},
})

respBody, resp, err := deleteRequest[schema.ActionGetResponse](ctx, client, "/resource")
require.NoError(t, err)
require.NotNil(t, resp)
require.NotNil(t, respBody)

require.Equal(t, int64(1234), respBody.Action.ID)
})

t.Run("delete no result", func(t *testing.T) {
ctx, server, client := makeTestUtils(t)

server.Expect([]mockutil.Request{
{
Method: "DELETE", Path: "/resource",
Status: 204,
},
})

resp, err := deleteRequestNoResult(ctx, client, "/resource")
require.NoError(t, err)
require.NotNil(t, resp)
})
}
15 changes: 15 additions & 0 deletions hcloud/client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,24 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/hetznercloud/hcloud-go/v2/hcloud/exp/mockutil"
"github.com/hetznercloud/hcloud-go/v2/hcloud/schema"
)

func makeTestUtils(t *testing.T) (context.Context, *mockutil.Server, *Client) {
ctx := context.Background()

server := mockutil.NewServer(t, nil)

client := NewClient(
WithEndpoint(server.URL),
WithRetryOpts(RetryOpts{BackoffFunc: ConstantBackoff(0), MaxRetries: 5}),
WithPollOpts(PollOpts{BackoffFunc: ConstantBackoff(0)}),
)

return ctx, server, client
}

type testEnv struct {
Server *httptest.Server
Mux *http.ServeMux
Expand Down
Loading