refactor: add more consts and use them

Author: Nivl

errors/validation_error_test.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/pb33f/libopenapi-validator/helpers"
 	"github.com/stretchr/testify/require"
 )
 
@@ -82,7 +83,7 @@ func TestValidationError_Error_WithSchemaValidationErrors_AndSpecLineColumn(t *t
 func TestValidationError_IsPathMissingError(t *testing.T) {
 	// Test the IsPathMissingError method
 	v := &ValidationError{
-		ValidationType:    "path",
+		ValidationType:    helpers.ParameterValidationPath,
 		ValidationSubType: "missing",
 	}
 
@@ -101,7 +102,7 @@ func TestValidationError_IsPathMissingError(t *testing.T) {
 func TestValidationError_IsOperationMissingError(t *testing.T) {
 	// Test the IsOperationMissingError method
 	v := &ValidationError{
-		ValidationType:    "path",
+		ValidationType:    helpers.ParameterValidationPath,
 		ValidationSubType: "missingOperation",
 	}
 

helpers/constants.go

@@ -16,6 +16,8 @@ const (
 	RequestBodyContentType    = "contentType"
 	RequestMissingOperation   = "missingOperation"
 	ResponseBodyResponseCode  = "statusCode"
+	SecurityValidation        = "security"
+	DocumentValidation        = "document"
 	SpaceDelimited            = "spaceDelimited"
 	PipeDelimited             = "pipeDelimited"
 	DefaultDelimited          = "default"

parameters/validate_security.go

@@ -71,7 +71,7 @@ func (v *paramValidator) ValidateSecurityWithPathItem(request *http.Request, pat
 						Message: fmt.Sprintf("Security scheme '%s' is missing", secName),
 						Reason: fmt.Sprintf("The security scheme '%s' is defined as being required, "+
 							"however it's missing from the components", secName),
-						ValidationType: "security",
+						ValidationType: helpers.SecurityValidation,
 						SpecLine:       sec.GoLow().Requirements.ValueNode.Line,
 						SpecCol:        sec.GoLow().Requirements.ValueNode.Column,
 						HowToFix:       "Add the missing security scheme to the components",
@@ -131,7 +131,7 @@ func (v *paramValidator) validateHTTPSecurityScheme(
 				{
 					Message:           fmt.Sprintf("Authorization header for '%s' scheme", secScheme.Scheme),
 					Reason:            "Authorization header was not found",
-					ValidationType:    "security",
+					ValidationType:    helpers.SecurityValidation,
 					ValidationSubType: secScheme.Scheme,
 					SpecLine:          sec.GoLow().Requirements.ValueNode.Line,
 					SpecCol:           sec.GoLow().Requirements.ValueNode.Column,
@@ -159,7 +159,7 @@ func (v *paramValidator) validateAPIKeySecurityScheme(
 				{
 					Message:           fmt.Sprintf("API Key %s not found in header", secScheme.Name),
 					Reason:            "API Key not found in http header for security scheme 'apiKey' with type 'header'",
-					ValidationType:    "security",
+					ValidationType:    helpers.SecurityValidation,
 					ValidationSubType: "apiKey",
 					SpecLine:          sec.GoLow().Requirements.ValueNode.Line,
 					SpecCol:           sec.GoLow().Requirements.ValueNode.Column,
@@ -183,7 +183,7 @@ func (v *paramValidator) validateAPIKeySecurityScheme(
 				{
 					Message:           fmt.Sprintf("API Key %s not found in query", secScheme.Name),
 					Reason:            "API Key not found in URL query for security scheme 'apiKey' with type 'query'",
-					ValidationType:    "security",
+					ValidationType:    helpers.SecurityValidation,
 					ValidationSubType: "apiKey",
 					SpecLine:          sec.GoLow().Requirements.ValueNode.Line,
 					SpecCol:           sec.GoLow().Requirements.ValueNode.Column,
@@ -207,7 +207,7 @@ func (v *paramValidator) validateAPIKeySecurityScheme(
 			{
 				Message:           fmt.Sprintf("API Key %s not found in cookies", secScheme.Name),
 				Reason:            "API Key not found in http request cookies for security scheme 'apiKey' with type 'cookie'",
-				ValidationType:    "security",
+				ValidationType:    helpers.SecurityValidation,
 				ValidationSubType: "apiKey",
 				SpecLine:          sec.GoLow().Requirements.ValueNode.Line,
 				SpecCol:           sec.GoLow().Requirements.ValueNode.Column,

schema_validation/validate_document.go

@@ -46,7 +46,7 @@ func ValidateOpenAPIDocument(doc libopenapi.Document, opts ...config.Option) (bo
 			ReferenceSchema: loadedSchema,
 		}
 		validationErrors = append(validationErrors, &liberrors.ValidationError{
-			ValidationType:         "schema",
+			ValidationType:         helpers.Schema,
 			ValidationSubType:      "compilation",
 			Message:                "OpenAPI document schema compilation failed",
 			Reason:                 fmt.Sprintf("The OpenAPI schema failed to compile: %s", err.Error()),

schema_validation/validate_document_test.go

@@ -68,7 +68,7 @@ func validateOpenAPIDocumentWithMalformedSchema(loadedSchema string, decodedDocu
 			ReferenceSchema: loadedSchema,
 		}
 		validationErrors = append(validationErrors, &liberrors.ValidationError{
-			ValidationType:         "schema",
+			ValidationType:         helpers.Schema,
 			ValidationSubType:      "compilation",
 			Message:                "OpenAPI document schema compilation failed",
 			Reason:                 fmt.Sprintf("The OpenAPI schema failed to compile: %s", err.Error()),

validator.go

@@ -124,7 +124,7 @@ func (v *validator) GetResponseBodyValidator() responses.ResponseBodyValidator {
 func (v *validator) ValidateDocument() (bool, []*errors.ValidationError) {
 	if v.document == nil {
 		return false, []*errors.ValidationError{{
-			ValidationType:    "document",
+			ValidationType:    helpers.DocumentValidation,
 			ValidationSubType: "missing",
 			Message:           "Document is not set",
 			Reason:            "The document cannot be validated as it is not set",

validator_test.go

@@ -2400,25 +2400,25 @@ paths:
 func TestSortValidationErrors(t *testing.T) {
 	// Create errors in random order
 	errs := []*errors.ValidationError{
-		{ValidationType: "security", Message: "API Key missing"},
-		{ValidationType: "parameter", Message: "Path param invalid"},
-		{ValidationType: "request", Message: "Body invalid"},
-		{ValidationType: "parameter", Message: "Header missing"},
-		{ValidationType: "security", Message: "Auth header missing"},
+		{ValidationType: helpers.SecurityValidation, Message: "API Key missing"},
+		{ValidationType: helpers.ParameterValidation, Message: "Path param invalid"},
+		{ValidationType: helpers.RequestValidation, Message: "Body invalid"},
+		{ValidationType: helpers.ParameterValidation, Message: "Header missing"},
+		{ValidationType: helpers.SecurityValidation, Message: "Auth header missing"},
 	}
 
 	sortValidationErrors(errs)
 
 	// Verify sorted by validation type first, then by message
-	assert.Equal(t, "parameter", errs[0].ValidationType)
+	assert.Equal(t, helpers.ParameterValidation, errs[0].ValidationType)
 	assert.Equal(t, "Header missing", errs[0].Message)
-	assert.Equal(t, "parameter", errs[1].ValidationType)
+	assert.Equal(t, helpers.ParameterValidation, errs[1].ValidationType)
 	assert.Equal(t, "Path param invalid", errs[1].Message)
-	assert.Equal(t, "request", errs[2].ValidationType)
+	assert.Equal(t, helpers.RequestValidation, errs[2].ValidationType)
 	assert.Equal(t, "Body invalid", errs[2].Message)
-	assert.Equal(t, "security", errs[3].ValidationType)
+	assert.Equal(t, helpers.SecurityValidation, errs[3].ValidationType)
 	assert.Equal(t, "API Key missing", errs[3].Message)
-	assert.Equal(t, "security", errs[4].ValidationType)
+	assert.Equal(t, helpers.SecurityValidation, errs[4].ValidationType)
 	assert.Equal(t, "Auth header missing", errs[4].Message)
 }
 
@@ -2432,9 +2432,9 @@ func TestSortValidationErrors_Empty(t *testing.T) {
 // TestSortValidationErrors_SingleElement tests sorting single element slice
 func TestSortValidationErrors_SingleElement(t *testing.T) {
 	errs := []*errors.ValidationError{
-		{ValidationType: "parameter", Message: "Invalid value"},
+		{ValidationType: helpers.ParameterValidation, Message: "Invalid value"},
 	}
 	sortValidationErrors(errs)
 	assert.Len(t, errs, 1)
-	assert.Equal(t, "parameter", errs[0].ValidationType)
+	assert.Equal(t, helpers.ParameterValidation, errs[0].ValidationType)
 }