Merge pull request #383 from ssoroka/must-specify-openapi

must specify openapi config
danielgtaylor · Apr 15, 2024 · 808a95d · 808a95d
2 parents a3eb57c + fff0bc7
commit 808a95d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/error_test.go b/error_test.go
@@ -78,12 +78,11 @@ func TestErrorResponses(t *testing.T) {
 }
 
 func TestNegotiateError(t *testing.T) {
-	_, api := humatest.New(t, huma.Config{})
+	_, api := humatest.New(t, huma.Config{OpenAPI: &huma.OpenAPI{Info: &huma.Info{Title: "Test API", Version: "1.0.0"}}})
 
 	req, _ := http.NewRequest("GET", "/", nil)
 	resp := httptest.NewRecorder()
 	ctx := humatest.NewContext(nil, req, resp)
-
 	require.Error(t, huma.WriteErr(api, ctx, 400, "bad request"))
 }
 

diff --git a/humatest/humatest.go b/humatest/humatest.go
@@ -200,6 +200,11 @@ func Wrap(tb TB, api huma.API) TestAPI {
 // to customize how the API is created. If no configuration is provided then
 // a simple default configuration supporting `application/json` is used.
 func New(tb TB, configs ...huma.Config) (http.Handler, TestAPI) {
+	for _, config := range configs {
+		if config.OpenAPI == nil {
+			panic("custom huma.Config structs must specify a value for OpenAPI")
+		}
+	}
 	if len(configs) == 0 {
 		configs = append(configs, huma.Config{
 			OpenAPI: &huma.OpenAPI{

diff --git a/humatest/humatest_test.go b/humatest/humatest_test.go
@@ -164,3 +164,9 @@ func TestDumpBodyError(t *testing.T) {
 	_, err = io.ReadAll(req.Body)
 	require.Error(t, err)
 }
+
+func TestOpenAPIRequired(t *testing.T) {
+	assert.PanicsWithValue(t, "custom huma.Config structs must specify a value for OpenAPI", func() {
+		New(t, huma.Config{})
+	})
+}