Merge pull request #33 from calvinmclean/feature/testing-new

Add new testing utilities

Author: calvinmclean

.github/workflows/main.yml

@@ -36,7 +36,7 @@ jobs:
           go-version: "1.21"
 
       - name: Test
-        run: go test -short -race -covermode=atomic -coverprofile=coverage.out -coverpkg=.,./storage ./...
+        run: go test -short -race -covermode=atomic -coverprofile=coverage.out -coverpkg=.,./storage,./test ./...
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v3

babyapi.go

@@ -20,7 +20,7 @@ type API[T Resource] struct {
 	name string
 	base string
 
-	subAPIs       map[string]RelatedAPI
+	subAPIs       map[string]relatedAPI
 	middlewares   []func(http.Handler) http.Handler
 	idMiddlewares []func(http.Handler) http.Handler
 
@@ -50,10 +50,10 @@ type API[T Resource] struct {
 
 	onCreateOrUpdate func(*http.Request, T) *ErrResponse
 
-	parent RelatedAPI
+	parent relatedAPI
 
-	customResponseCodes map[string]int
-	serverCtx           context.Context
+	responseCodes map[string]int
+	serverCtx     context.Context
 
 	// GetAll is the handler for /base and returns an array of resources
 	GetAll http.HandlerFunc
@@ -82,7 +82,7 @@ func NewAPI[T Resource](name, base string, instance func() T) *API[T] {
 	api := &API[T]{
 		name,
 		base,
-		map[string]RelatedAPI{},
+		map[string]relatedAPI{},
 		nil,
 		nil,
 		MapStorage[T]{},
@@ -99,7 +99,7 @@ func NewAPI[T Resource](name, base string, instance func() T) *API[T] {
 		defaultBeforeAfter,
 		func(*http.Request, T) *ErrResponse { return nil },
 		nil,
-		map[string]int{},
+		defaultResponseCodes(),
 		nil,
 		nil,
 		nil,
@@ -149,7 +149,7 @@ func (a *API[T]) Name() string {
 
 // SetCustomResponseCode will override the default response codes for the specified HTTP verb
 func (a *API[T]) SetCustomResponseCode(verb string, code int) *API[T] {
-	a.customResponseCodes[verb] = code
+	a.responseCodes[verb] = code
 	return a
 }
 
@@ -206,12 +206,14 @@ func (a *API[T]) SetResponseWrapper(responseWrapper func(T) render.Renderer) *AP
 
 // Client returns a new Client based on the API's configuration. It is a shortcut for NewClient
 func (a *API[T]) Client(addr string) *Client[T] {
-	return NewClient[T](addr, makePathWithRoot(a.base, a.parent))
+	return NewClient[T](addr, makePathWithRoot(a.base, a.parent)).
+		SetCustomResponseCodeMap(a.responseCodes)
 }
 
 // AnyClient returns a new Client based on the API's configuration. It is a shortcut for NewClient
 func (a *API[T]) AnyClient(addr string) *Client[*AnyResource] {
-	return NewClient[*AnyResource](addr, makePathWithRoot(a.base, a.parent))
+	return NewClient[*AnyResource](addr, makePathWithRoot(a.base, a.parent)).
+		SetCustomResponseCodeMap(a.responseCodes)
 }
 
 // AddCustomRootRoute appends a custom API route to the absolute root path ("/"). It does not work for APIs with

babyapi_test.go

@@ -15,6 +15,7 @@ import (
 	"time"
 
 	"github.com/calvinmclean/babyapi"
+	babytest "github.com/calvinmclean/babyapi/test"
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/render"
 	"github.com/rs/xid"
@@ -194,12 +195,13 @@ func TestBabyAPI(t *testing.T) {
 
 	t.Run("DeleteAlbum", func(t *testing.T) {
 		t.Run("Successful", func(t *testing.T) {
-			err := client.Delete(context.Background(), album1.GetID())
+			resp, err := client.Delete(context.Background(), album1.GetID())
 			require.NoError(t, err)
+			require.Equal(t, http.NoBody, resp.Response.Body)
 		})
 
 		t.Run("NotFound", func(t *testing.T) {
-			err := client.Delete(context.Background(), album1.GetID())
+			_, err := client.Delete(context.Background(), album1.GetID())
 			require.Error(t, err)
 			require.Equal(t, "error deleting resource: unexpected response with text: Resource not found.", err.Error())
 		})
@@ -285,7 +287,7 @@ func TestNestedAPI(t *testing.T) {
 	artistAPI.AddNestedAPI(albumAPI).AddNestedAPI(musicVideoAPI)
 	albumAPI.AddNestedAPI(songAPI)
 
-	serverURL, stop := babyapi.TestServe[*Artist](t, artistAPI)
+	serverURL, stop := babytest.TestServe[*Artist](t, artistAPI)
 	defer stop()
 
 	artist1 := &Artist{Name: "Artist1"}
@@ -508,7 +510,7 @@ func TestCLI(t *testing.T) {
 		{
 			"Delete",
 			[]string{"delete", "Albums", "cljcqg5o402e9s28rbp0"},
-			`null`,
+			``,
 			false,
 		},
 		{
@@ -664,7 +666,7 @@ func TestHTML(t *testing.T) {
 		Content:         "Item1",
 	}
 
-	address, closer := babyapi.TestServe[*ListItem](t, api)
+	address, closer := babytest.TestServe[*ListItem](t, api)
 	defer closer()
 
 	client := api.Client(address)
@@ -718,7 +720,7 @@ func TestServerSentEvents(t *testing.T) {
 
 	events := api.AddServerSentEventHandler("/events")
 
-	address, closer := babyapi.TestServe[*ListItem](t, api)
+	address, closer := babytest.TestServe[*ListItem](t, api)
 	defer closer()
 
 	item1 := &ListItem{
@@ -813,23 +815,23 @@ func TestAPIModifiers(t *testing.T) {
 		require.NoError(t, err)
 		r.Header.Add("Content-Type", "application/json")
 
-		w := babyapi.Test[*Album](t, api, r)
+		w := babytest.TestRequest[*Album](t, api, r)
 		require.Equal(t, http.StatusTeapot, w.Result().StatusCode)
 	})
 
 	t.Run("DeleteResource", func(t *testing.T) {
 		r, err := http.NewRequest(http.MethodDelete, "/albums/"+albumID, http.NoBody)
 		require.NoError(t, err)
 
-		w := babyapi.Test[*Album](t, api, r)
+		w := babytest.TestRequest[*Album](t, api, r)
 		require.Equal(t, http.StatusNoContent, w.Result().StatusCode)
 	})
 
 	t.Run("GetResourceNotFound", func(t *testing.T) {
 		r, err := http.NewRequest(http.MethodGet, "/albums/DoesNotExist", http.NoBody)
 		require.NoError(t, err)
 
-		w := babyapi.Test[*Album](t, api, r)
+		w := babytest.TestRequest[*Album](t, api, r)
 		require.Equal(t, http.StatusNotFound, w.Result().StatusCode)
 	})
 
@@ -919,7 +921,7 @@ func TestRootAPIWithMiddlewareAndCustomHandlers(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.method+tt.path, func(t *testing.T) {
 			r := httptest.NewRequest(tt.method, tt.path, http.NoBody)
-			w := babyapi.Test[*babyapi.NilResource](t, api, r)
+			w := babytest.TestRequest[*babyapi.NilResource](t, api, r)
 
 			require.Equal(t, tt.expectedStatus, w.Result().StatusCode)
 		})
@@ -1080,7 +1082,7 @@ func TestRootAPICLI(t *testing.T) {
 		{
 			"Delete",
 			[]string{"delete", "MusicVideos", "cljcqg5o402e9s28rbp0"},
-			`null`,
+			``,
 			false,
 		},
 		{

cli.go

@@ -62,22 +62,32 @@ func (a *API[T]) RunWithArgs(out io.Writer, args []string, bindAddress string, a
 	return a.runClientCLI(out, args, address, pretty, headers, query)
 }
 
-func (a *API[T]) buildClientMap(selfClient *Client[*AnyResource], clientMap map[string]*Client[*AnyResource], reqEditor func(*http.Request) error) {
-	for name, child := range a.subAPIs {
-		base := makePathWithRoot(child.Base(), a)
+// CreateClientMap returns a map of API names to the corresponding Client for that child API. This makes it easy to use
+// child APIs dynamically. The initial parent/base client must be provided so child APIs can use NewSubClient
+func (a *API[T]) CreateClientMap(parent *Client[*AnyResource]) map[string]*Client[*AnyResource] {
+	clientMap := map[string]*Client[*AnyResource]{}
+	if !a.rootAPI {
+		clientMap[a.name] = parent
+	}
 
+	for _, child := range a.subAPIs {
+		base := makePathWithRoot(child.Base(), a)
 		var childClient *Client[*AnyResource]
+
 		if a.rootAPI && a.parent == nil {
 			// If the current API is a root API and has no parent, then this client has no need for parent IDs
-			childClient = NewClient[*AnyResource](selfClient.addr, base)
+			childClient = NewClient[*AnyResource](parent.addr, base)
 		} else {
-			childClient = NewSubClient[*AnyResource, *AnyResource](selfClient, base)
+			childClient = NewSubClient[*AnyResource, *AnyResource](parent, base)
 		}
 
-		childClient.SetRequestEditor(reqEditor)
-		clientMap[name] = childClient
-		child.buildClientMap(childClient, clientMap, reqEditor)
+		childMap := child.CreateClientMap(childClient)
+		for n, c := range childMap {
+			clientMap[n] = c
+		}
 	}
+
+	return clientMap
 }
 
 func (a *API[T]) runClientCLI(out io.Writer, args []string, address string, pretty bool, headers []string, query string) error {
@@ -107,21 +117,16 @@ func (a *API[T]) runClientCLI(out io.Writer, args []string, address string, pret
 		return nil
 	}
 
-	selfClient := a.AnyClient(address)
-	selfClient.SetRequestEditor(reqEditor)
-
-	clientMap := map[string]*Client[*AnyResource]{}
-	if !a.rootAPI {
-		clientMap[a.name] = selfClient
-	}
-	a.buildClientMap(selfClient, clientMap, reqEditor)
+	clientMap := a.CreateClientMap(a.AnyClient(address))
 
 	targetAPI := args[1]
 	client, ok := clientMap[targetAPI]
 	if !ok {
 		return fmt.Errorf("invalid API %q. valid options are: %v", targetAPI, maps.Keys[map[string]*Client[*AnyResource]](clientMap))
 	}
 
+	client.SetRequestEditor(reqEditor)
+
 	var cmd func([]string, *Client[*AnyResource]) (*Response[*AnyResource], error)
 	switch args[0] {
 	case "get":
@@ -171,12 +176,12 @@ func (a *API[T]) runDeleteCommand(args []string, client *Client[*AnyResource]) (
 	if len(args) < 1 {
 		return nil, fmt.Errorf("at least one argument required")
 	}
-	err := client.Delete(context.Background(), args[0], args[1:]...)
+	result, err := client.Delete(context.Background(), args[0], args[1:]...)
 	if err != nil {
 		return nil, fmt.Errorf("error running Delete: %w", err)
 	}
 
-	return nil, nil
+	return result, nil
 }
 
 func (a *API[T]) runListCommand(args []string, client *Client[*AnyResource]) (*Response[*ResourceList[*AnyResource]], error) {