Finishes porting of legacy- and v0.1-parser to current code-base;

Author: joergdw

api/broker/binding_request_parser/binding-request-parser.go

@@ -8,17 +8,32 @@ import (
 	"code.cloudfoundry.org/app-autoscaler/src/autoscaler/models"
 )
 
+type Parser interface {
+	// Default policies are specified on service-instance-level. Consequently, we need to leave the
+	// field Parameters.ScalingPolicy empty when no policy has been specified and instead … let the
+	// consumer of the BindingRequest decided what to do with this (i.e. he will use then the
+	// default-policy.)
+	Parse(bindingReqParams string, ccAppGuid models.GUID) (models.AppScalingConfig, error)
+}
+
+
+// ================================================================================
+// Parsing or validation errors
+// ================================================================================
+
 type JsonSchemaError []gojsonschema.ResultError
 
 func (e *JsonSchemaError) Error() string {
 	var errors []gojsonschema.ResultError = *e
 	return fmt.Sprintf("%s", errors)
 }
 
-type Parser interface {
-	// Default policies are specified on service-instance-level. Consequently, we need to leave the
-	// field Parameters.ScalingPolicy empty when no policy has been specified and instead … let the
-	// consumer of the BindingRequest decided what to do with this (i.e. he will use then the
-	// default-policy.)
-	Parse(bindingReqParams string, ccAppGuid models.GUID) (models.AppScalingConfig, error)
+
+// This error type is used, when the passed binding-request fails to validate against the schema.
+type BindReqNoAppGuid struct{}
+
+func (e BindReqNoAppGuid) Error() string {
+	return "error: service must be bound to an application; Please provide a GUID of an app!"
 }
+
+var _ error = BindReqNoAppGuid{}

api/broker/binding_request_parser/binding-request-parser_test.go

@@ -1,8 +1,6 @@
 package binding_request_parser_test
 
 import (
-	"path/filepath"
-
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
@@ -14,40 +12,31 @@ import (
 )
 
 var _ = Describe("BindingRequestParsers", func() {
-	const cleanSchemaFilePath string = "file://./binding-request.json"
+	const v0_1SchemaFilePath string = "file://./v0_1/meta.schema.json"
+	const legacySchemaFilePath string = "file://./legacy/schema.json"
+
 	const validModernBindingRequestRaw string = `
-		{
-		  "configuration": {
-			"app_guid": "8d0cee08-23ad-4813-a779-ad8118ea0b91",
-			"custom_metrics": {
-			  "metric_submission_strategy": {
-				"allow_from": "bound_app"
+	{
+		"schema-version": "0.1",
+		"configuration": {
+			  "app_guid": "8d0cee08-23ad-4813-a779-ad8118ea0b91",
+			  "custom_metrics": {
+				  "metric_submission_strategy": {
+					  "allow_from": "bound_app"
+				  }
 			  }
-			}
-		  },
-		  "scaling-policy": {
-			  "instance_min_count": 1,
-			  "instance_max_count": 4,
-			  "scaling_rules": [
-				{
-				  "metric_type": "memoryutil",
-				  "breach_duration_secs": 600,
+		},
+		"instance_min_count": 1,
+		"instance_max_count": 5,
+		"scaling_rules": [
+			  {
+				  "metric_type": "memoryused",
 				  "threshold": 30,
 				  "operator": "<",
-				  "cool_down_secs": 300,
 				  "adjustment": "-1"
-				},
-				{
-				  "metric_type": "memoryutil",
-				  "breach_duration_secs": 600,
-				  "threshold": 90,
-				  "operator": ">=",
-				  "cool_down_secs": 300,
-				  "adjustment": "+1"
-				}
-			  ]
-		  }
-		}`
+			  }
+		]
+	}`
 	const validLegacyBindingRequestRaw string = `
 		{
 		 "configuration": {
@@ -85,18 +74,19 @@ var _ = Describe("BindingRequestParsers", func() {
 			err         error
 		)
 		var _ = BeforeEach(func() {
-			v0_1Parser, err = brp_v1.NewFromFile(cleanSchemaFilePath)
+			v0_1Parser, err = brp_v1.NewFromFile(v0_1SchemaFilePath, models.X509Certificate)
 			Expect(err).NotTo(HaveOccurred())
 		})
 		Context("When using the new format for binding-requests", func() {
 			Context("and parsing a valid and complete one", func() {
 				It("should return a correctly populated BindingRequestParameters", func() {
 					bindingRequestRaw := validModernBindingRequestRaw
+					ccAppGuid := models.GUID("") // Raw request is about creating a service-key;
 
-					bindingRequest, err := v0_1Parser.Parse(bindingRequestRaw)
+					bindingRequest, err := v0_1Parser.Parse(bindingRequestRaw, ccAppGuid)
 
 					Expect(err).NotTo(HaveOccurred())
-					Expect(bindingRequest.Configuration.AppGUID).To(
+					Expect(bindingRequest.GetConfiguration().GetAppGUID()).To(
 						Equal(models.GUID("8d0cee08-23ad-4813-a779-ad8118ea0b91")))
 				})
 			})
@@ -105,14 +95,12 @@ var _ = Describe("BindingRequestParsers", func() {
 
 	Describe("LegacyBindingRequestParser", func() {
 		var (
-			legacyParser      lp.LegacyBindingRequestParser
-			schemaFilePathAbs string
+			legacyParser      lp.BindingRequestParser
 			err               error
 		)
 		var _ = BeforeEach(func() {
-			schemaFilePathAbs, err = filepath.Abs("./legacy/schema.json")
 			Expect(err).NotTo(HaveOccurred())
-			legacyParser, err = lp.New("file://" + schemaFilePathAbs)
+			legacyParser, err = lp.New(legacySchemaFilePath, models.X509Certificate)
 			Expect(err).NotTo(HaveOccurred())
 		})
 

api/broker/binding_request_parser/combined_parser/parser.go

@@ -4,7 +4,7 @@
 package combined_parser
 
 // import (
-//	"code.cloudfoundry.org/app-autoscaler/src/autoscaler/api/binding_request_parser"
+//	"code.cloudfoundry.org/app-autoscaler/src/autoscaler/api/broker/binding_request_parser"
 // )
 
 // // Combined parser that tries out all other parser that are associated to it in order

api/broker/binding_request_parser/legacy/parser.go

@@ -9,12 +9,12 @@ import (
 	"code.cloudfoundry.org/app-autoscaler/src/autoscaler/models"
 )
 
-type LegacyBindingRequestParser struct {
+type BindingRequestParser struct {
 	schema *gojsonschema.Schema
 	defaultCustomMetricsCredentialType models.CustomMetricsBindingAuthScheme
 }
 
-var _ binding_request_parser.Parser = LegacyBindingRequestParser{}
+var _ binding_request_parser.Parser = BindingRequestParser{}
 
 // New creates a new LegacyBindingRequestParser with the JSON schema loaded from the specified file
 // path.
@@ -23,16 +23,24 @@ var _ binding_request_parser.Parser = LegacyBindingRequestParser{}
 // "file:///path/to/schema.json").
 //
 // Returns an error if the schema file cannot be loaded or parsed.
-func New(schemaFilePath string) (LegacyBindingRequestParser, error) {
+func New(
+	schemaFilePath string, defaultCustomMetricsCredentialType models.CustomMetricsBindingAuthScheme,
+) (BindingRequestParser, error) {
 	schemaLoader := gojsonschema.NewReferenceLoader(schemaFilePath)
 	schema, err := gojsonschema.NewSchema(schemaLoader)
 	if err != nil {
-		return LegacyBindingRequestParser{}, err
+		return BindingRequestParser{}, err
 	}
-	return LegacyBindingRequestParser{schema: schema}, nil
+
+	parser := BindingRequestParser{
+		schema: schema,
+		defaultCustomMetricsCredentialType: defaultCustomMetricsCredentialType,
+	}
+
+	return parser, nil
 }
 
-func (p LegacyBindingRequestParser) Parse(
+func (p BindingRequestParser) Parse(
 	bindingReqParams string, ccAppGuid models.GUID,
 ) (models.AppScalingConfig, error) {
 	validationErr := p.Validate(bindingReqParams)
@@ -49,7 +57,7 @@ func (p LegacyBindingRequestParser) Parse(
 	return p.toBindingParameters(parsedParameters, ccAppGuid)
 }
 
-func (p LegacyBindingRequestParser) Validate(bindingReqParams string) error {
+func (p BindingRequestParser) Validate(bindingReqParams string) error {
 	documentLoader := gojsonschema.NewStringLoader(bindingReqParams)
 	validationResult, err := p.schema.Validate(documentLoader)
 	if err != nil {
@@ -65,7 +73,7 @@ func (p LegacyBindingRequestParser) Validate(bindingReqParams string) error {
 	return nil
 }
 
-func (p LegacyBindingRequestParser) toBindingParameters(
+func (p BindingRequestParser) toBindingParameters(
 	bindingReqParams policyAndBindingCfg, ccAppGuid models.GUID,
 ) (models.AppScalingConfig, error) {
 	appGuid := ccAppGuid
@@ -117,13 +125,18 @@ This is an programming-error.`,
 
 	bindingConfig := *models.NewBindingConfig(appGuid, customMetricsBindAuthScheme)
 	policyDefinition := readPolicyDefinition(bindingReqParams)
-	scalingPolicy := models.NewScalingPolicy(customMetricsStrat, &policyDefinition)
+	scalingPolicy := models.NewScalingPolicy(customMetricsStrat, policyDefinition)
 
 	return *models.NewAppScalingConfig(bindingConfig, *scalingPolicy), nil
 }
 
-func readPolicyDefinition(bindingReqParams policyAndBindingCfg) models.PolicyDefinition {
-	// 🚧 To-do: What if no policy has been provided?
+func readPolicyDefinition(bindingReqParams policyAndBindingCfg) *models.PolicyDefinition {
+	noPolicyIsSet := bindingReqParams.InstanceMin == 0 && bindingReqParams.InstanceMax == 0 &&
+		len(bindingReqParams.ScalingRules) == 0 && bindingReqParams.Schedules == nil
+	if noPolicyIsSet {
+		return nil
+	}
+
 
 	policyDefinition := models.PolicyDefinition{
 		InstanceMin: bindingReqParams.InstanceMin,
@@ -176,5 +189,5 @@ func readPolicyDefinition(bindingReqParams policyAndBindingCfg) models.PolicyDef
 		}
 	}
 
-	return policyDefinition
+	return &policyDefinition
 }