✨ [patch] Pre-defined staging queue priority in config (#40)

* ☸️ Add priorities config type

* ✨ Support priority queues

* 🐛 Fix queue label

* ✅ Add unit tests

* ✅ Update e2e tests

* 💬 Update queue priority definition

api/v1beta1/config_types.go

@@ -288,6 +288,11 @@ type ConfigSpec struct {
 	// +optional
 	Bundles ConfigBundles `json:"bundles,omitempty"`
 
+	// PriorityQueues represents a list of bundles/components' name which needs to be prioritized
+	// the first one has the highest priority and the last one has the lowest priority
+	// +optional
+	PriorityQueues []string `json:"priorityQueues,omitempty"`
+
 	// Staging represents configuration about staging
 	Staging *ConfigStaging `json:"staging"`
 

config/crds/env.samsahai.io_configs.yaml

@@ -183,6 +183,13 @@ spec:
               description: Envs represents urls of values file per environments ordering
                 by less priority to high priority
               type: object
+            priorityQueues:
+              description: PriorityQueues represents a list of bundles/components'
+                name which needs to be prioritized the first one has the highest priority
+                and the last one has the lowest priority
+              items:
+                type: string
+              type: array
             report:
               description: Reporter represents configuration about reporter
               properties:

docs/docs.go

@@ -1,6 +1,6 @@
 // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
 // This file was generated by swaggo/swag at
-// 2020-06-12 13:43:13.431642 +0700 +07 m=+0.161754686
+// 2020-06-18 09:43:32.662924 +0700 +07 m=+0.108614951
 
 package docs
 
@@ -1037,6 +1037,13 @@ var doc = `{
                     "description": "Envs represents urls of values file per environments\nordering by less priority to high priority\n+optional",
                     "type": "object"
                 },
+                "priorityQueues": {
+                    "description": "PriorityQueues represents a list of bundles/components' name which needs to be prioritized\nthe first one has the highest priority and the last one has the lowest priority\n+optional",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
                 "report": {
                     "description": "Reporter represents configuration about reporter\n+optional",
                     "type": "object",

docs/swagger.json

@@ -1016,6 +1016,13 @@
                     "description": "Envs represents urls of values file per environments\nordering by less priority to high priority\n+optional",
                     "type": "object"
                 },
+                "priorityQueues": {
+                    "description": "PriorityQueues represents a list of bundles/components' name which needs to be prioritized\nthe first one has the highest priority and the last one has the lowest priority\n+optional",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
                 "report": {
                     "description": "Reporter represents configuration about reporter\n+optional",
                     "type": "object",

docs/swagger.yaml

@@ -350,6 +350,14 @@ definitions:
           ordering by less priority to high priority
           +optional
         type: object
+      priorityQueues:
+        description: |-
+          PriorityQueues represents a list of bundles/components' name which needs to be prioritized
+          the first one has the highest priority and the last one has the lowest priority
+          +optional
+        items:
+          type: string
+        type: array
       report:
         $ref: '#/definitions/v1beta1.ConfigReporter'
         description: |-

internal/config/controller.go

@@ -146,6 +146,17 @@ func (c *controller) GetBundles(configName string) (s2hv1beta1.ConfigBundles, er
 	return config.Spec.Bundles, nil
 }
 
+// GetPriorityQueues returns a list of priority queues which defined in Config
+func (c *controller) GetPriorityQueues(configName string) ([]string, error) {
+	config, err := c.Get(configName)
+	if err != nil {
+		logger.Error(err, "cannot get Config", "name", configName)
+		return []string{}, err
+	}
+
+	return config.Spec.PriorityQueues, nil
+}
+
 // Update updates Config CRD
 func (c *controller) Update(config *s2hv1beta1.Config) error {
 	if err := c.client.Update(context.TODO(), config); err != nil {

internal/configuration.go

@@ -17,6 +17,9 @@ type ConfigController interface {
 	// GetBundles returns a group of components for each bundle
 	GetBundles(configName string) (s2hv1beta1.ConfigBundles, error)
 
+	// GetPriorityQueues returns a list of priority queues which defined in Config
+	GetPriorityQueues(configName string) ([]string, error)
+
 	// Update updates Config CRD
 	Update(config *s2hv1beta1.Config) error
 

internal/desiredcomponent/controller.go

@@ -127,6 +127,11 @@ func (c *controller) Reconcile(req reconcile.Request) (reconcile.Result, error)
 		logger.Error(err, "cannot get bundle name", "team", c.teamName, "component", comp.Spec.Name)
 	}
 
+	priorityQueues, err := c.s2hClient.GetPriorityQueues(ctx, &samsahairpc.TeamName{Name: c.teamName})
+	if err != nil {
+		logger.Error(err, "cannot get priority queues", "team", c.teamName)
+	}
+
 	comps := []*s2hv1beta1.QueueComponent{
 		{
 			Name:       comp.Spec.Name,
@@ -135,7 +140,7 @@ func (c *controller) Reconcile(req reconcile.Request) (reconcile.Result, error)
 		},
 	}
 	q := queue.NewUpgradeQueue(c.teamName, req.Namespace, comp.Spec.Name, bundle.Name, comps)
-	err = c.queueCtrl.Add(q)
+	err = c.queueCtrl.Add(q, priorityQueues.GetQueues())
 	if err != nil {
 		return reconcile.Result{}, err
 	}

internal/queue.go

@@ -8,8 +8,8 @@ import (
 
 // QueueController manages updating component queue through CRD
 type QueueController interface {
-	// Add adds Queue
-	Add(q *v1beta1.Queue) error
+	// Add adds Queue with priority list
+	Add(q *v1beta1.Queue, priorityQueues []string) error
 
 	// AddTop adds Queue to the top
 	AddTop(q *v1beta1.Queue) error