Merge pull request #139 from cloudfoundry/integrate-configuration-object

chore(autoscaling-policy): Displays the Configuration Information

Author: asalan316

api/apihelper.go

@@ -266,7 +266,7 @@ func (helper *APIHelper) CreatePolicy(data interface{}) error {
 	}
 	defer resp.Body.Close()
 
-	raw, err := ioutil.ReadAll(resp.Body)
+	raw, err := io.ReadAll(resp.Body)
 
 	if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusCreated {
 
@@ -303,7 +303,7 @@ func (helper *APIHelper) DeletePolicy() error {
 	}
 	defer resp.Body.Close()
 
-	raw, err := ioutil.ReadAll(resp.Body)
+	raw, err := io.ReadAll(resp.Body)
 	if resp.StatusCode != http.StatusOK {
 		var errorMsg string
 		switch resp.StatusCode {
@@ -358,7 +358,7 @@ func (helper *APIHelper) GetAggregatedMetrics(metricName string, startTime, endT
 	}
 	defer resp.Body.Close()
 
-	raw, err := ioutil.ReadAll(resp.Body)
+	raw, err := io.ReadAll(resp.Body)
 	if resp.StatusCode != http.StatusOK {
 		var errorMsg string
 		switch resp.StatusCode {
@@ -424,7 +424,7 @@ func (helper *APIHelper) GetHistory(startTime, endTime int64, asc bool, page uin
 	}
 	defer resp.Body.Close()
 
-	raw, err := ioutil.ReadAll(resp.Body)
+	raw, err := io.ReadAll(resp.Body)
 	if resp.StatusCode != http.StatusOK {
 		var errorMsg string
 		switch resp.StatusCode {

api/apihelper_test.go

@@ -29,7 +29,7 @@ var _ = Describe("API Helper Test", func() {
 		err        error
 		apiServer  *ghttp.Server
 		apihelper  *APIHelper
-		fakePolicy ScalingPolicy = ScalingPolicy{
+		fakePolicy = ScalingPolicy{
 			InstanceMin: 1,
 			InstanceMax: 2,
 			ScalingRules: []*ScalingRule{
@@ -44,6 +44,56 @@ var _ = Describe("API Helper Test", func() {
 				},
 			},
 		}
+		fakePolicyWithConfiguration = ScalingPolicy{
+			InstanceMin: 1,
+			InstanceMax: 2,
+			ScalingRules: []*ScalingRule{
+				{
+					MetricType:            "memoryused",
+					StatWindowSeconds:     300,
+					BreachDurationSeconds: 600,
+					Threshold:             30,
+					Operator:              "<=",
+					CoolDownSeconds:       300,
+					Adjustment:            "-1",
+				},
+			},
+			Configuration: &Configuration{
+				CustomMetrics: struct {
+					MetricSubmissionStrategy struct {
+						AllowFrom string `json:"allow_from"`
+					} `json:"metric_submission_strategy"`
+				}{
+					MetricSubmissionStrategy: struct {
+						AllowFrom string `json:"allow_from"`
+					}{
+						AllowFrom: "bound_app",
+					},
+				},
+			},
+		}
+		expectedPolicyWithConfigurationJSON = `{
+  "instance_min_count": 1,
+        "instance_max_count": 2,
+        "scaling_rules": [
+          {
+            "metric_type": "memoryused",
+            "stat_window_secs": 300,
+            "breach_duration_secs": 600,
+            "threshold": 30,
+            "operator": "<=",
+            "cool_down_secs": 300,
+            "adjustment": "-1"
+          }
+        ],
+        "configuration": {
+          "custom_metrics": {
+            "metric_submission_strategy": {
+              "allow_from": "bound_app"
+            }
+          }
+        }
+	}`
 	)
 
 	BeforeEach(func() {
@@ -174,7 +224,7 @@ var _ = Describe("API Helper Test", func() {
 		})
 
 		Context("Get policy", func() {
-			var urlpath string = "/v1/apps/" + fakeAppId + "/policy"
+			var urlpath = "/v1/apps/" + fakeAppId + "/policy"
 
 			Context("Succeed with valid auth token", func() {
 				BeforeEach(func() {
@@ -186,12 +236,12 @@ var _ = Describe("API Helper Test", func() {
 					)
 				})
 
-				It("succeed", func() {
+				It("succeed with policy only", func() {
 					response, err := apihelper.GetPolicy()
 					Expect(err).NotTo(HaveOccurred())
 
 					var actualPolicy ScalingPolicy
-					_ = json.Unmarshal([]byte(response), &actualPolicy)
+					_ = json.Unmarshal(response, &actualPolicy)
 					Expect(actualPolicy).To(MatchFields(IgnoreExtras, Fields{
 						"InstanceMin": BeNumerically("==", fakePolicy.InstanceMin),
 						"InstanceMax": BeNumerically("==", fakePolicy.InstanceMax),
@@ -207,6 +257,19 @@ var _ = Describe("API Helper Test", func() {
 						"Adjustment":            Equal(fakePolicy.ScalingRules[0].Adjustment),
 					}))
 				})
+				It("succeed with policy and configuration", func() {
+					apiServer.RouteToHandler("GET", urlpath,
+						ghttp.CombineHandlers(
+							ghttp.RespondWithJSONEncoded(http.StatusOK, &fakePolicyWithConfiguration),
+							ghttp.VerifyHeaderKV("Authorization", fakeAccessToken),
+						),
+					)
+					response, err := apihelper.GetPolicy()
+					Expect(err).NotTo(HaveOccurred())
+
+					Expect(response).To(MatchJSON(expectedPolicyWithConfigurationJSON))
+
+				})
 			})
 
 			Context("Unauthorized Access", func() {
@@ -748,7 +811,7 @@ var _ = Describe("API Helper Test", func() {
 
 		})
 
-		Context("Get Histrory", func() {
+		Context("Get History", func() {
 			var urlpath = "/v1/apps/" + fakeAppId + "/scaling_histories"
 			var now int64
 			var histories, reversedHistories []*AppScalingHistory

commands/retrieve_history.go

@@ -105,7 +105,7 @@ func RetrieveHistory(cliConnection api.Connection, appName string, startTime, en
 		data       [][]string
 	)
 
-	for true {
+	for {
 		next, data, err = apihelper.GetHistory(startTime, endTime, asc, page)
 		if err != nil {
 			return err

devbox.lock

@@ -309,7 +309,7 @@
     },
     "python@latest": {
       "last_modified": "2024-08-14T11:41:26Z",
-      "plugin_version": "0.0.3",
+      "plugin_version": "0.0.4",
       "resolved": "github:NixOS/nixpkgs/0cb2fd7c59fed0cd82ef858cbcbdb552b9a33465#python3",
       "source": "devbox-search",
       "version": "3.12.4",

main.go

@@ -33,7 +33,7 @@ var BuildVcsId string
 var BuildVcsIdDate string
 
 func (as *AutoScaler) GetMetadata() plugin.PluginMetadata {
-	version := getVetsion()
+	version := getVersion()
 
 	return plugin.PluginMetadata{
 		Name:    "AutoScaler",
@@ -114,7 +114,7 @@ OPTIONS:
 	}
 }
 
-func getVetsion() plugin.VersionType {
+func getVersion() plugin.VersionType {
 	// We set a default version 0.0.0, and then we try to parse the version from the build flags
 	// errors are ignored, as we will use the default version in case of errors
 	version := plugin.VersionType{Major: 0, Minor: 0, Build: 0}
@@ -129,14 +129,14 @@ func main() {
 
 	args := os.Args[1:]
 	if len(args) == 0 {
-		version := getVetsion()
+		version := getVersion()
 		fmt.Printf("Upstream Version: %d.%d.%d\n", version.Major, version.Minor, version.Build)
 		fmt.Println("Build Prerelease: ", BuildPrerelease)
 		fmt.Println("Build Version: ", BuildMeta)
 		fmt.Println("Build Date: ", BuildDate)
 		fmt.Println("VCS Url:", BuildVcsUrl)
 		fmt.Println("VCS Identifier: ", BuildVcsId)
-		fmt.Println("VCS Identififer Date: ", BuildVcsIdDate)
+		fmt.Println("VCS Identifier Date: ", BuildVcsIdDate)
 	}
 	plugin.Start(new(AutoScaler))
 }

models/models.go

@@ -4,11 +4,20 @@ type ScalingType int
 
 type ScalingStatus int
 
+type Configuration struct {
+	CustomMetrics struct {
+		MetricSubmissionStrategy struct {
+			AllowFrom string `json:"allow_from"`
+		} `json:"metric_submission_strategy"`
+	} `json:"custom_metrics"`
+}
+
 type ScalingPolicy struct {
-	InstanceMin  int               `json:"instance_min_count"`
-	InstanceMax  int               `json:"instance_max_count"`
-	ScalingRules []*ScalingRule    `json:"scaling_rules,omitempty"`
-	Schedules    *ScalingSchedules `json:"schedules,omitempty"`
+	InstanceMin   int               `json:"instance_min_count"`
+	InstanceMax   int               `json:"instance_max_count"`
+	ScalingRules  []*ScalingRule    `json:"scaling_rules,omitempty"`
+	Schedules     *ScalingSchedules `json:"schedules,omitempty"`
+	Configuration *Configuration    `json:"configuration,omitempty"`
 }
 
 type ScalingRule struct {

ui/message.go

@@ -12,8 +12,8 @@ const (
 	SetAPIEndpoint     = "Setting AutoScaler api endpoint to %s..."
 	UnsetAPIEndpoint   = "Unsetting AutoScaler api endpoint."
 	InvalidAPIEndpoint = "Invalid AutoScaler API endpoint : %s"
-	InvalidSSLCerts    = "Issue connnecting to %s: %s\nTIP: Use --skip-ssl-validation to continue with an insecure API endpoint."
-	InconsistentDomain = "Failed to set AutoScaler domain to %s since it is inconsitent with the domain of CF API %s."
+	InvalidSSLCerts    = "Issue connecting to %s: %s\nTIP: Use --skip-ssl-validation to continue with an insecure API endpoint."
+	InconsistentDomain = "Failed to set AutoScaler domain to %s since it is inconsistent with the domain of CF API %s."
 
 	Unauthorized  = "Unauthorized. Failed to access AutoScaler API endpoint %s."
 	LoginRequired = "You must be logged in %s first."