Use dynamic OccurrenceConstraintViolation error for v16 and v2

Signed-off-by: Lorenzo <[email protected]>

Author: lorenzodonini

ocpp1.6_test/proto_test.go

@@ -51,7 +51,7 @@ func (suite *OcppV16TestSuite) TestChargePointSendResponseError() {
 		{
 			name:        "ocurrence validation",
 			confirmData: CustomData{Field1: "", Field2: 42},
-			expectedErr: &ocpp.Error{Code: ocppj.OccurrenceConstraintViolation, Description: "Field CallResult.Payload.Data.Field1 required but not found for feature DataTransfer"},
+			expectedErr: &ocpp.Error{Code: ocppj.OccurrenceConstraintViolationV16, Description: "Field CallResult.Payload.Data.Field1 required but not found for feature DataTransfer"},
 		},
 		{
 			name:        "marshaling error",
@@ -130,7 +130,7 @@ func (suite *OcppV16TestSuite) TestCentralSystemSendResponseError() {
 	require.Error(t, err)
 	require.IsType(t, &ocpp.Error{}, err)
 	ocppErr = err.(*ocpp.Error)
-	assert.Equal(t, ocppj.OccurrenceConstraintViolation, ocppErr.Code)
+	assert.Equal(t, ocppj.OccurrenceConstraintViolationV16, ocppErr.Code)
 	assert.Equal(t, "Field CallResult.Payload.Data.Field1 required but not found for feature DataTransfer", ocppErr.Description)
 	// Test 2: marshaling error
 	dataTransferConfirmation = core.NewDataTransferConfirmation(core.DataTransferStatusAccepted)
@@ -158,4 +158,5 @@ func (suite *OcppV16TestSuite) TestCentralSystemSendResponseError() {
 
 func (suite *OcppV16TestSuite) TestErrorCodes() {
 	suite.Equal(ocppj.FormatViolationV16, ocppj.FormatErrorType(suite.ocppjCentralSystem))
+	suite.Equal(ocppj.OccurrenceConstraintViolationV16, ocppj.OccurrenceConstraintErrorType(suite.ocppjCentralSystem))
 }

ocpp2.0.1_test/proto_test.go

@@ -57,7 +57,7 @@ func (suite *OcppV2TestSuite) TestChargePointSendResponseError() {
 	result := <-resultChannel
 	require.IsType(t, &ocpp.Error{}, result)
 	ocppErr = result.(*ocpp.Error)
-	assert.Equal(t, ocppj.OccurrenceConstraintViolation, ocppErr.Code)
+	assert.Equal(t, ocppj.OccurrenceConstraintViolationV2, ocppErr.Code)
 	assert.Equal(t, "Field CallResult.Payload.Data.Field1 required but not found for feature DataTransfer", ocppErr.Description)
 	// Test 2: marshaling error
 	dataTransferResponse = data.NewDataTransferResponse(data.DataTransferStatusAccepted)
@@ -132,7 +132,7 @@ func (suite *OcppV2TestSuite) TestCentralSystemSendResponseError() {
 	require.Error(t, err)
 	require.IsType(t, &ocpp.Error{}, err)
 	ocppErr = err.(*ocpp.Error)
-	assert.Equal(t, ocppj.OccurrenceConstraintViolation, ocppErr.Code)
+	assert.Equal(t, ocppj.OccurrenceConstraintViolationV2, ocppErr.Code)
 	assert.Equal(t, "Field CallResult.Payload.Data.Field1 required but not found for feature DataTransfer", ocppErr.Description)
 	// Test 2: marshaling error
 	dataTransferResponse = data.NewDataTransferResponse(data.DataTransferStatusAccepted)
@@ -160,4 +160,5 @@ func (suite *OcppV2TestSuite) TestCentralSystemSendResponseError() {
 
 func (suite *OcppV2TestSuite) TestErrorCodes() {
 	suite.Equal(ocppj.FormatViolationV2, ocppj.FormatErrorType(suite.ocppjServer))
+	suite.Equal(ocppj.OccurrenceConstraintViolationV2, ocppj.OccurrenceConstraintErrorType(suite.ocppjServer))
 }

ocppj/central_system_test.go

@@ -332,7 +332,7 @@ func (suite *OcppJTestSuite) TestCentralSystemHandleFailedResponse() {
 	require.Nil(t, callResult)
 	suite.centralSystem.HandleFailedResponseError(mockChargePointID, mockUniqueID, err, mockResponse.GetFeatureName())
 	rawResponse := <-msgC
-	expectedErr := fmt.Sprintf(`[4,"%v","%v","Field %s required but not found for feature %s",{}]`, mockUniqueID, ocppj.OccurrenceConstraintViolation, mockField, mockResponse.GetFeatureName())
+	expectedErr := fmt.Sprintf(`[4,"%v","%v","Field %s required but not found for feature %s",{}]`, mockUniqueID, ocppj.OccurrenceConstraintErrorType(suite.centralSystem), mockField, mockResponse.GetFeatureName())
 	assert.Equal(t, expectedErr, string(rawResponse))
 	// 2. property constraint validation error
 	val := "len4"

ocppj/charge_point_test.go

@@ -306,7 +306,7 @@ func (suite *OcppJTestSuite) TestChargePointHandleFailedResponse() {
 	require.Nil(t, callResult)
 	suite.chargePoint.HandleFailedResponseError(mockUniqueID, err, mockResponse.GetFeatureName())
 	rawResponse := <-msgC
-	expectedErr := fmt.Sprintf(`[4,"%v","%v","Field %s required but not found for feature %s",{}]`, mockUniqueID, ocppj.OccurrenceConstraintViolation, mockField, mockResponse.GetFeatureName())
+	expectedErr := fmt.Sprintf(`[4,"%v","%v","Field %s required but not found for feature %s",{}]`, mockUniqueID, ocppj.OccurrenceConstraintErrorType(suite.chargePoint), mockField, mockResponse.GetFeatureName())
 	assert.Equal(t, expectedErr, string(rawResponse))
 	// 2. property constraint validation error
 	val := "len4"

ocppj/client.go

@@ -1,6 +1,7 @@
 package ocppj
 
 import (
+	"errors"
 	"fmt"
 
 	"gopkg.in/go-playground/validator.v9"
@@ -331,11 +332,12 @@ func (c *Client) HandleFailedResponseError(requestID string, err error, featureN
 	switch err.(type) {
 	case validator.ValidationErrors:
 		// Validation error
-		validationErr := err.(validator.ValidationErrors)
-		responseErr = errorFromValidation(validationErr, requestID, featureName)
+		var validationErr validator.ValidationErrors
+		errors.As(err, &validationErr)
+		responseErr = errorFromValidation(c, validationErr, requestID, featureName)
 	case *ocpp.Error:
 		// Internal OCPP error
-		responseErr = err.(*ocpp.Error)
+		errors.As(err, &responseErr)
 	case error:
 		// Unknown error
 		responseErr = ocpp.NewError(GenericError, err.Error(), requestID)

ocppj/ocppj.go

@@ -184,18 +184,19 @@ func (callError *CallError) MarshalJSON() ([]byte, error) {
 }
 
 const (
-	NotImplemented                ocpp.ErrorCode = "NotImplemented"                // Requested Action is not known by receiver.
-	NotSupported                  ocpp.ErrorCode = "NotSupported"                  // Requested Action is recognized but not supported by the receiver.
-	InternalError                 ocpp.ErrorCode = "InternalError"                 // An internal error occurred and the receiver was not able to process the requested Action successfully.
-	MessageTypeNotSupported       ocpp.ErrorCode = "MessageTypeNotSupported"       // A message with an Message Type Number received that is not supported by this implementation.
-	ProtocolError                 ocpp.ErrorCode = "ProtocolError"                 // Payload for Action is incomplete.
-	SecurityError                 ocpp.ErrorCode = "SecurityError"                 // During the processing of Action a security issue occurred preventing receiver from completing the Action successfully.
-	PropertyConstraintViolation   ocpp.ErrorCode = "PropertyConstraintViolation"   // Payload is syntactically correct but at least one field contains an invalid value.
-	OccurrenceConstraintViolation ocpp.ErrorCode = "OccurrenceConstraintViolation" // Payload for Action is syntactically correct but at least one of the fields violates occurrence constraints.
-	TypeConstraintViolation       ocpp.ErrorCode = "TypeConstraintViolation"       // Payload for Action is syntactically correct but at least one of the fields violates data type constraints (e.g. “somestring”: 12).
-	GenericError                  ocpp.ErrorCode = "GenericError"                  // Any other error not covered by the previous ones.
-	FormatViolationV2             ocpp.ErrorCode = "FormatViolation"               // Payload for Action is syntactically incorrect. This is only valid for OCPP 2.0.1
-	FormatViolationV16            ocpp.ErrorCode = "FormationViolation"            // Payload for Action is syntactically incorrect or not conform the PDU structure for Action. This is only valid for OCPP 1.6
+	NotImplemented                   ocpp.ErrorCode = "NotImplemented"                // Requested Action is not known by receiver.
+	NotSupported                     ocpp.ErrorCode = "NotSupported"                  // Requested Action is recognized but not supported by the receiver.
+	InternalError                    ocpp.ErrorCode = "InternalError"                 // An internal error occurred and the receiver was not able to process the requested Action successfully.
+	MessageTypeNotSupported          ocpp.ErrorCode = "MessageTypeNotSupported"       // A message with a Message Type Number received that is not supported by this implementation.
+	ProtocolError                    ocpp.ErrorCode = "ProtocolError"                 // Payload for Action is incomplete.
+	SecurityError                    ocpp.ErrorCode = "SecurityError"                 // During the processing of Action a security issue occurred preventing receiver from completing the Action successfully.
+	PropertyConstraintViolation      ocpp.ErrorCode = "PropertyConstraintViolation"   // Payload is syntactically correct but at least one field contains an invalid value.
+	OccurrenceConstraintViolationV2  ocpp.ErrorCode = "OccurrenceConstraintViolation" // Payload for Action is syntactically correct but at least one of the fields violates occurrence constraints.
+	OccurrenceConstraintViolationV16 ocpp.ErrorCode = "OccurenceConstraintViolation"  // Payload for Action is syntactically correct but at least one of the fields violates occurrence constraints. Contains a typo in OCPP 1.6
+	TypeConstraintViolation          ocpp.ErrorCode = "TypeConstraintViolation"       // Payload for Action is syntactically correct but at least one of the fields violates data type constraints (e.g. “somestring”: 12).
+	GenericError                     ocpp.ErrorCode = "GenericError"                  // Any other error not covered by the previous ones.
+	FormatViolationV2                ocpp.ErrorCode = "FormatViolation"               // Payload for Action is syntactically incorrect. This is only valid for OCPP 2.0.1
+	FormatViolationV16               ocpp.ErrorCode = "FormationViolation"            // Payload for Action is syntactically incorrect or not conform the PDU structure for Action. This is only valid for OCPP 1.6
 )
 
 type dialector interface {
@@ -213,10 +214,21 @@ func FormatErrorType(d dialector) ocpp.ErrorCode {
 	}
 }
 
+func OccurrenceConstraintErrorType(d dialector) ocpp.ErrorCode {
+	switch d.Dialect() {
+	case ocpp.V16:
+		return OccurrenceConstraintViolationV16
+	case ocpp.V2:
+		return OccurrenceConstraintViolationV2
+	default:
+		panic(fmt.Sprintf("invalid dialect: %v", d))
+	}
+}
+
 func IsErrorCodeValid(fl validator.FieldLevel) bool {
 	code := ocpp.ErrorCode(fl.Field().String())
 	switch code {
-	case NotImplemented, NotSupported, InternalError, MessageTypeNotSupported, ProtocolError, SecurityError, FormatViolationV16, FormatViolationV2, PropertyConstraintViolation, OccurrenceConstraintViolation, TypeConstraintViolation, GenericError:
+	case NotImplemented, NotSupported, InternalError, MessageTypeNotSupported, ProtocolError, SecurityError, FormatViolationV16, FormatViolationV2, PropertyConstraintViolation, OccurrenceConstraintViolationV16, OccurrenceConstraintViolationV2, TypeConstraintViolation, GenericError:
 		return true
 	}
 	return false
@@ -263,12 +275,12 @@ func getValueLength(value interface{}) int {
 	}
 }
 
-func occurenceViolation(fieldError validator.FieldError, messageId, feature string) *ocpp.Error {
+func occurrenceViolation(d dialector, fieldError validator.FieldError, messageId, feature string) *ocpp.Error {
 	description := fmt.Sprintf("Field %s required but not found", fieldError.Namespace())
 	if feature != "" {
 		description = fmt.Sprintf("%s for feature %s", description, feature)
 	}
-	return ocpp.NewError(OccurrenceConstraintViolation, description, messageId)
+	return ocpp.NewError(OccurrenceConstraintErrorType(d), description, messageId)
 }
 
 func propertyConstraintViolation(fieldError validator.FieldError, details, messageId, feature string) *ocpp.Error {
@@ -283,11 +295,11 @@ func propertyConstraintViolation(fieldError validator.FieldError, details, messa
 	)
 }
 
-func errorFromValidation(validationErrors validator.ValidationErrors, messageId string, feature string) *ocpp.Error {
+func errorFromValidation(d dialector, validationErrors validator.ValidationErrors, messageId, feature string) *ocpp.Error {
 	for _, el := range validationErrors {
 		switch el.ActualTag() {
 		case "required":
-			return occurenceViolation(el, messageId, feature)
+			return occurrenceViolation(d, el, messageId, feature)
 		case "max":
 			return propertyConstraintViolation(el, "maximum", messageId, feature)
 		case "min":
@@ -440,7 +452,7 @@ func (endpoint *Endpoint) ParseMessage(arr []interface{}, pendingRequestState Cl
 		}
 		err = Validate.Struct(call)
 		if err != nil {
-			return nil, errorFromValidation(err.(validator.ValidationErrors), uniqueId, action)
+			return nil, errorFromValidation(endpoint, err.(validator.ValidationErrors), uniqueId, action)
 		}
 		return &call, nil
 	} else if typeId == CALL_RESULT {
@@ -461,7 +473,7 @@ func (endpoint *Endpoint) ParseMessage(arr []interface{}, pendingRequestState Cl
 		}
 		err = Validate.Struct(callResult)
 		if err != nil {
-			return nil, errorFromValidation(err.(validator.ValidationErrors), uniqueId, request.GetFeatureName())
+			return nil, errorFromValidation(endpoint, err.(validator.ValidationErrors), uniqueId, request.GetFeatureName())
 		}
 		return &callResult, nil
 	} else if typeId == CALL_ERROR {
@@ -495,7 +507,7 @@ func (endpoint *Endpoint) ParseMessage(arr []interface{}, pendingRequestState Cl
 		}
 		err := Validate.Struct(callError)
 		if err != nil {
-			return nil, errorFromValidation(err.(validator.ValidationErrors), uniqueId, "")
+			return nil, errorFromValidation(endpoint, err.(validator.ValidationErrors), uniqueId, "")
 		}
 		return &callError, nil
 	} else {

ocppj/ocppj_test.go

@@ -740,7 +740,7 @@ func (suite *OcppJTestSuite) TestParseMessageInvalidRequest() {
 	protoErr := err.(*ocpp.Error)
 	require.NotNil(t, protoErr)
 	assert.Equal(t, messageId, protoErr.MessageId)
-	assert.Equal(t, ocppj.OccurrenceConstraintViolation, protoErr.Code)
+	assert.Equal(t, ocppj.OccurrenceConstraintErrorType(suite.chargePoint), protoErr.Code)
 	// Test invalid request -> max constraint wrong
 	mockRequest.MockValue = "somelongvalue"
 	message, err = suite.chargePoint.ParseMessage(mockMessage, suite.chargePoint.RequestState)
@@ -769,7 +769,7 @@ func (suite *OcppJTestSuite) TestParseMessageInvalidConfirmation() {
 	protoErr := err.(*ocpp.Error)
 	require.NotNil(t, protoErr)
 	assert.Equal(t, messageId, protoErr.MessageId)
-	assert.Equal(t, ocppj.OccurrenceConstraintViolation, protoErr.Code)
+	assert.Equal(t, ocppj.OccurrenceConstraintErrorType(suite.chargePoint), protoErr.Code)
 	// Test invalid request -> max constraint wrong
 	mockConfirmation.MockValue = "min"
 	suite.chargePoint.RequestState.AddPendingRequest(messageId, pendingRequest) // Manually add a pending request, so that responses are not rejected

ocppj/server.go

@@ -1,6 +1,7 @@
 package ocppj
 
 import (
+	"errors"
 	"fmt"
 
 	"gopkg.in/go-playground/validator.v9"
@@ -304,11 +305,12 @@ func (s *Server) HandleFailedResponseError(clientID string, requestID string, er
 	switch err.(type) {
 	case validator.ValidationErrors:
 		// Validation error
-		validationErr := err.(validator.ValidationErrors)
-		responseErr = errorFromValidation(validationErr, requestID, featureName)
+		var validationErr validator.ValidationErrors
+		errors.As(err, &validationErr)
+		responseErr = errorFromValidation(s, validationErr, requestID, featureName)
 	case *ocpp.Error:
 		// Internal OCPP error
-		responseErr = err.(*ocpp.Error)
+		errors.As(err, &responseErr)
 	case error:
 		// Unknown error
 		responseErr = ocpp.NewError(GenericError, err.Error(), requestID)