Configurable query parameters runtime data structures.

api/disabled_parameters.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"fmt"
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/labstack/echo/v4"
 )
@@ -73,29 +74,31 @@ func NewDisabledMapFromOA3(swag *openapi3.Swagger) *DisabledMap {
 	return rval
 }
 
-// VerifyRC is the return code for the Verify function
-type VerifyRC int
+// ErrVerifyFailedEndpoint an error that signifies that the entire endpoint is disabled
+var ErrVerifyFailedEndpoint error = fmt.Errorf("endpoint is disabled")
 
-const (
-	verifyIsGood VerifyRC = iota
-	verifyFailedEndpoint
-	verifyFailedParameter
-)
+// ErrVerifyFailedParameter an error that signifies that a parameter was provided when it was disabled
+type ErrVerifyFailedParameter struct {
+	ParameterName string
+}
+
+func (evfp ErrVerifyFailedParameter) Error() string {
+	return fmt.Sprintf("provided disabled parameter: %s", evfp.ParameterName)
+}
 
 // DisabledParameterErrorReporter defines an error reporting interface
 // for the Verify functions
 type DisabledParameterErrorReporter interface {
 	Errorf(format string, args ...interface{})
 }
 
-// Verify returns verifyIsGood if the function can continue (i.e. the parameters are valid and disabled
-// parameters are not supplied), otherwise verifyFailedEndpoint if the endpoint failed and
-// verifyFailedParameter if a disabled parameter was provided.  If verifyFailedParameter is returned
-// then the variable name that caused it is provided.  In all other cases, it is empty
-func Verify(dm *DisabledMap, nameOfHandlerFunc string, ctx echo.Context, log DisabledParameterErrorReporter) (VerifyRC, string) {
+// Verify returns nil if the function can continue (i.e. the parameters are valid and disabled
+// parameters are not supplied), otherwise VerifyFailedEndpoint if the endpoint failed and
+// VerifyFailedParameter if a disabled parameter was provided.
+func Verify(dm *DisabledMap, nameOfHandlerFunc string, ctx echo.Context, log DisabledParameterErrorReporter) error {
 
 	if dm == nil || dm.Data == nil {
-		return verifyIsGood, ""
+		return nil
 	}
 
 	if val, ok := dm.Data[nameOfHandlerFunc]; ok {
@@ -105,13 +108,13 @@ func Verify(dm *DisabledMap, nameOfHandlerFunc string, ctx echo.Context, log Dis
 	// If the function name wasn't in the map something got messed up....
 	log.Errorf("verify function could not find name of handler function in map: %s", nameOfHandlerFunc)
 	// We want to fail-safe to not stop the indexer
-	return verifyIsGood, ""
+	return nil
 }
 
-func (ec *EndpointConfig) verify(ctx echo.Context, log DisabledParameterErrorReporter) (VerifyRC, string) {
+func (ec *EndpointConfig) verify(ctx echo.Context, log DisabledParameterErrorReporter) error {
 
 	if ec.EndpointDisabled {
-		return verifyFailedEndpoint, ""
+		return ErrVerifyFailedEndpoint
 	}
 
 	queryParams := ctx.QueryParams()
@@ -127,7 +130,7 @@ func (ec *EndpointConfig) verify(ctx echo.Context, log DisabledParameterErrorRep
 		queryValue := queryParams.Get(paramName)
 		if queryValue != "" {
 			// If the query value is non-zero, and it was disabled, we should return false
-			return verifyFailedParameter, paramName
+			return ErrVerifyFailedParameter{paramName}
 		}
 
 		if formErr != nil {
@@ -137,9 +140,9 @@ func (ec *EndpointConfig) verify(ctx echo.Context, log DisabledParameterErrorRep
 		formValue := formParams.Get(paramName)
 		if formValue != "" {
 			// If the query value is non-zero, and it was disabled, we should return false
-			return verifyFailedParameter, paramName
+			return ErrVerifyFailedParameter{paramName}
 		}
 	}
 
-	return verifyIsGood, ""
+	return nil
 }

api/disabled_parameters_test.go

@@ -18,8 +18,7 @@ func TestFailingParam(t *testing.T) {
 	type testingStruct struct {
 		name               string
 		setFormValues      func(*url.Values)
-		expectedRval       VerifyRC
-		expectedRstr       string
+		expectedError      error
 		expectedErrorCount int
 		mimeType           string
 	}
@@ -28,19 +27,19 @@ func TestFailingParam(t *testing.T) {
 			"non-disabled param provided",
 			func(f *url.Values) {
 				f.Set("3", "Provided")
-			}, verifyIsGood, "", 0, echo.MIMEApplicationForm,
+			}, nil, 0, echo.MIMEApplicationForm,
 		},
 		{
 			"disabled param provided but empty",
 			func(f *url.Values) {
 				f.Set("1", "")
-			}, verifyIsGood, "", 0, echo.MIMEApplicationForm,
+			}, nil, 0, echo.MIMEApplicationForm,
 		},
 		{
 			"disabled param provided",
 			func(f *url.Values) {
 				f.Set("1", "Provided")
-			}, verifyFailedParameter, "1", 0, echo.MIMEApplicationForm,
+			}, ErrVerifyFailedParameter{"1"}, 0, echo.MIMEApplicationForm,
 		},
 	}
 
@@ -49,7 +48,7 @@ func TestFailingParam(t *testing.T) {
 			"Error encountered for Form Params",
 			func(f *url.Values) {
 				f.Set("1", "Provided")
-			}, verifyIsGood, "", 1, echo.MIMEMultipartForm,
+			}, nil, 1, echo.MIMEMultipartForm,
 		},
 	}
 
@@ -83,11 +82,10 @@ func TestFailingParam(t *testing.T) {
 
 		logger, hook := test.NewNullLogger()
 
-		rval, rstr := Verify(dm, "K1", *ctx, logger)
+		err := Verify(dm, "K1", *ctx, logger)
 
-		require.Equal(t, tstruct.expectedRval, rval)
+		require.Equal(t, tstruct.expectedError, err)
 		require.Equal(t, tstruct.expectedErrorCount, len(hook.AllEntries()))
-		require.Equal(t, tstruct.expectedRstr, rstr)
 	}
 
 	for _, test := range tests {
@@ -126,11 +124,10 @@ func TestFailingEndpoint(t *testing.T) {
 
 	logger, hook := test.NewNullLogger()
 
-	rval, rstr := Verify(dm, "K1", ctx, logger)
+	err := Verify(dm, "K1", ctx, logger)
 
-	require.Equal(t, verifyFailedEndpoint, rval)
+	require.Equal(t, ErrVerifyFailedEndpoint, err)
 	require.Equal(t, 0, len(hook.AllEntries()))
-	require.Empty(t, rstr)
 }
 
 // TestVerifyNonExistentHandler tests that nonexistent endpoint is logged
@@ -150,17 +147,15 @@ func TestVerifyNonExistentHandler(t *testing.T) {
 
 	logger, hook := test.NewNullLogger()
 
-	rval, rstr := Verify(dm, "DoesntExist", ctx, logger)
+	err := Verify(dm, "DoesntExist", ctx, logger)
 
-	require.Equal(t, verifyIsGood, rval)
+	require.Equal(t, nil, err)
 	require.Equal(t, 1, len(hook.AllEntries()))
-	require.Empty(t, rstr)
 
 	hook.Reset()
 
-	rval, rstr = Verify(dm, "K1", ctx, logger)
+	err = Verify(dm, "K1", ctx, logger)
 
-	require.Equal(t, verifyIsGood, rval)
+	require.Equal(t, nil, err)
 	require.Equal(t, 0, len(hook.AllEntries()))
-	require.Empty(t, rstr)
 }