feat: Implement plural upgrade (#391)

* feat: Implement `plural upgrade`

creates an entry on an upgrade queue, especially helpful for CONFIG upgrades in CD

* Add require args validator

Author: michaeljguarino

cmd/plural/plural.go

@@ -235,6 +235,18 @@ func (p *Plural) getCommands() []cli.Command {
 			},
 			Action: tracked(latestVersion(owned(upstreamSynced(p.destroy))), "cli.destroy"),
 		},
+		{
+			Name:      "upgrade",
+			Usage:     "creates an upgrade in the upgrade queue QUEUE for application REPO",
+			ArgsUsage: "QUEUE REPO",
+			Flags: []cli.Flag{
+				cli.StringFlag{
+					Name:  "f",
+					Usage: "file containing upgrade contents, use - for stdin",
+				},
+			},
+			Action: latestVersion(requireArgs(p.handleUpgrade, []string{"QUEUE", "REPO"})),
+		},
 		{
 			Name:  "init",
 			Usage: "initializes plural within a git repo",

cmd/plural/upgrade.go

@@ -0,0 +1,36 @@
+package main
+
+import (
+	"io"
+	"os"
+
+	"github.com/pluralsh/plural/pkg/api"
+	"github.com/urfave/cli"
+)
+
+func (p *Plural) handleUpgrade(c *cli.Context) (err error) {
+	p.InitPluralClient()
+	queue, repo := c.Args().Get(0), c.Args().Get(1)
+	f := os.Stdin
+	fname := c.String("f")
+	if fname != "-" && fname != "" {
+		f, err = os.Open(fname)
+		if err != nil {
+			return
+		}
+		defer f.Close()
+	}
+
+	contents, err := io.ReadAll(f)
+	if err != nil {
+		return
+	}
+
+	attrs, err := api.ConstructUpgradeAttributes(contents)
+	if err != nil {
+		return
+	}
+
+	err = p.CreateUpgrade(queue, repo, attrs)
+	return api.GetErrorResponse(err, "CreateUpgrade")
+}

go.mod

@@ -44,7 +44,7 @@ require (
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/packethost/packngo v0.29.0
 	github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8
-	github.com/pluralsh/gqlclient v1.3.12
+	github.com/pluralsh/gqlclient v1.3.13
 	github.com/pluralsh/plural-operator v0.5.3
 	github.com/pluralsh/polly v0.1.1
 	github.com/rodaine/hclencoder v0.0.1

go.sum

@@ -899,14 +899,12 @@ github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
 github.com/pkg/sftp v1.10.1/go.mod h1:lYOWFsE0bwd1+KfKJaKeuokY15vzFx25BLbzYYoAxZI=
 github.com/pluralsh/controller-reconcile-helper v0.0.4 h1:1o+7qYSyoeqKFjx+WgQTxDz4Q2VMpzprJIIKShxqG0E=
 github.com/pluralsh/controller-reconcile-helper v0.0.4/go.mod h1:AfY0gtteD6veBjmB6jiRx/aR4yevEf6K0M13/pGan/s=
-github.com/pluralsh/gqlclient v1.3.12 h1:BM+7fILoO06kvVBrL4kEB5AuZMVc3TvqupNi/HNrZkA=
-github.com/pluralsh/gqlclient v1.3.12/go.mod h1:z1qHnvPeqIN/a+5OzFs40e6HI6tDxzh1+yJuEpvqGy4=
+github.com/pluralsh/gqlclient v1.3.13 h1:ihix+ruoIkwiVdPnvJecrsxrVYEKTG26JFHPiF36O3U=
+github.com/pluralsh/gqlclient v1.3.13/go.mod h1:z1qHnvPeqIN/a+5OzFs40e6HI6tDxzh1+yJuEpvqGy4=
 github.com/pluralsh/oauth v0.9.2 h1:tM9hBK4tCnJUeCOgX0ctxBBCS3hiCDPoxkJLODtedmQ=
 github.com/pluralsh/oauth v0.9.2/go.mod h1:aTUw/75rzcsbvW+/TLvWtHVDXFIdtFrDtUncOq9vHyM=
 github.com/pluralsh/plural-operator v0.5.3 h1:GaPL3LgimfzKZNHt7zXzqYZpb0hgyW9noHYnkA+rqNs=
 github.com/pluralsh/plural-operator v0.5.3/go.mod h1:WIXiz26/WDcUn0FA7Q1jPxmfsm98U1/JL8YpIdKVLX0=
-github.com/pluralsh/polly v0.1.0 h1:xr/+LWIORtA0CzedEQ8gM7YhHBjcql6Oekwwz1+SEfM=
-github.com/pluralsh/polly v0.1.0/go.mod h1:Yo1/jcW+4xwhWG+ZJikZy4J4HJkMNPZ7sq5auL2c/tY=
 github.com/pluralsh/polly v0.1.1 h1:VtbS83re2YuDgscvaFgfzEDZs9uXRV84fCdvKCgIRE4=
 github.com/pluralsh/polly v0.1.1/go.mod h1:Yo1/jcW+4xwhWG+ZJikZy4J4HJkMNPZ7sq5auL2c/tY=
 github.com/pmezard/go-difflib v0.0.0-20151028094244-d8ed2627bdf0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=

pkg/api/client.go

@@ -83,6 +83,7 @@ type Client interface {
 	PromoteCluster() error
 	Clusters() ([]*Cluster, error)
 	Cluster(id string) (*Cluster, error)
+	CreateUpgrade(queue, repository string, attrs gqlclient.UpgradeAttributes) error
 }
 
 type client struct {

pkg/api/upgrades.go

@@ -0,0 +1,17 @@
+package api
+
+import (
+	"github.com/pluralsh/gqlclient"
+	"sigs.k8s.io/yaml"
+)
+
+func (client *client) CreateUpgrade(queue, repository string, attrs gqlclient.UpgradeAttributes) error {
+	_, err := client.pluralClient.CreateUpgrade(client.ctx, queue, repository, attrs)
+	return err
+}
+
+func ConstructUpgradeAttributes(marshalled []byte) (gqlclient.UpgradeAttributes, error) {
+	var attrs gqlclient.UpgradeAttributes
+	err := yaml.Unmarshal(marshalled, &attrs)
+	return attrs, err
+}

pkg/api/users.go

@@ -8,10 +8,6 @@ import (
 	"github.com/samber/lo"
 )
 
-type UpgradeAttributes struct {
-	Message string
-}
-
 type UserEventAttributes struct {
 	Event  string
 	Data   string