Merge pull request #30 from marccampbell/ship-channels

Ship and Platform clients

Author: marccampbell

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+All you need is a computer with Go installed, and a Replicatd account to test with.
+
+### Design
+
+Replicated apps can be "platform" or "ship". Avoid deep-in-the-callstack checks for app type. There's a common "Client" class that should handle the switch on appType, and call the appropriate implementation. We would like to avoid having this switch get lower in the call stack.
+
+Sometimes, the two different app types require different parametes (promote release is an example, one takes "required" and one doesn't). Don't normalize these to the lowest common denominator. The goal of this CLI is to provide all functionality, with minimal internal knowledge to manage Replicated apps. The app schemas will continue to be a little different, this CLI should mask these differences while still providing access to all features of both appTypes.

README.md

@@ -101,14 +101,14 @@ import (
 	"log"
 	"os"
 
-	"github.com/replicatedhq/replicated/client"
+	"github.com/replicatedhq/replicated/pkg/platformclient"
 )
 
 func main() {
 	token := os.Getenv("REPLICATED_API_TOKEN")
 	appSlugOrID := os.Getenv("REPLICATED_APP")
 
-	api := client.New(token)
+	api := platformclient.New(token)
 
 	app, err := api.GetApp(appSlugOrID)
 	if err != nil {

cli/cmd/channel_adoption.go

@@ -23,7 +23,7 @@ func (r *runners) channelAdoption(cmd *cobra.Command, args []string) error {
 	}
 	chanID := args[0]
 
-	appChan, _, err := r.api.GetChannel(r.appID, chanID)
+	appChan, _, err := r.platformAPI.GetChannel(r.appID, chanID)
 	if err != nil {
 		return err
 	}

cli/cmd/channel_counts.go

@@ -23,7 +23,7 @@ func (r *runners) channelCounts(cmd *cobra.Command, args []string) error {
 	}
 	chanID := args[0]
 
-	appChan, _, err := r.api.GetChannel(r.appID, chanID)
+	appChan, _, err := r.platformAPI.GetChannel(r.appID, chanID)
 	if err != nil {
 		return err
 	}

cli/cmd/channel_create.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"github.com/replicatedhq/replicated/cli/print"
-	"github.com/replicatedhq/replicated/client"
 	"github.com/spf13/cobra"
 )
 
@@ -26,11 +25,7 @@ func init() {
 }
 
 func (r *runners) channelCreate(cmd *cobra.Command, args []string) error {
-	opts := &client.ChannelOptions{
-		Name:        channelCreateName,
-		Description: channelCreateDescription,
-	}
-	allChannels, err := r.api.CreateChannel(r.appID, opts)
+	allChannels, err := r.api.CreateChannel(r.appID, channelCreateName, channelCreateDescription)
 	if err != nil {
 		return err
 	}

cli/cmd/channel_inspect.go

@@ -25,7 +25,7 @@ func (r *runners) channelInspect(cmd *cobra.Command, args []string) error {
 	}
 	chanID := args[0]
 
-	appChan, _, err := r.api.GetChannel(r.appID, chanID)
+	appChan, _, err := r.platformAPI.GetChannel(r.appID, chanID)
 	if err != nil {
 		return err
 	}

cli/cmd/channel_releases.go

@@ -23,7 +23,7 @@ func (r *runners) channelReleases(cmd *cobra.Command, args []string) error {
 	}
 	chanID := args[0]
 
-	_, releases, err := r.api.GetChannel(r.appID, chanID)
+	_, releases, err := r.platformAPI.GetChannel(r.appID, chanID)
 	if err != nil {
 		return err
 	}

cli/cmd/channel_rm.go

@@ -24,7 +24,7 @@ func (r *runners) channelRemove(cmd *cobra.Command, args []string) error {
 	}
 	chanID := args[0]
 
-	if err := r.api.ArchiveChannel(r.appID, chanID); err != nil {
+	if err := r.platformAPI.ArchiveChannel(r.appID, chanID); err != nil {
 		return err
 	}
 

cli/cmd/release_create.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"io/ioutil"
 
-	"github.com/replicatedhq/replicated/client"
 	"github.com/spf13/cobra"
 )
 
@@ -55,8 +54,8 @@ func (r *runners) releaseCreate(cmd *cobra.Command, args []string) error {
 
 		promoteChannelIDs := make([]string, 0)
 		for _, c := range channels {
-			if c.Id == createReleasePromote || c.Name == createReleasePromote {
-				promoteChannelIDs = append(promoteChannelIDs, c.Id)
+			if c.ID == createReleasePromote || c.Name == createReleasePromote {
+				promoteChannelIDs = append(promoteChannelIDs, c.ID)
 			}
 		}
 
@@ -69,10 +68,7 @@ func (r *runners) releaseCreate(cmd *cobra.Command, args []string) error {
 		promoteChanID = promoteChannelIDs[0]
 	}
 
-	opts := &client.ReleaseOptions{
-		YAML: createReleaseYaml,
-	}
-	release, err := r.api.CreateRelease(r.appID, opts)
+	release, err := r.api.CreateRelease(r.appID, createReleaseYaml)
 	if err != nil {
 		return err
 	}

cli/cmd/release_inspect.go

@@ -6,7 +6,7 @@ import (
 	"strconv"
 
 	"github.com/replicatedhq/replicated/cli/print"
-	vendorAPI "github.com/replicatedhq/replicated/client"
+	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/spf13/cobra"
 )
 
@@ -30,9 +30,9 @@ func (r *runners) releaseInspect(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("Failed to parse sequence argument %s", args[0])
 	}
 
-	release, err := r.api.GetRelease(r.appID, seq)
+	release, err := r.platformAPI.GetRelease(r.appID, seq)
 	if err != nil {
-		if err == vendorAPI.ErrNotFound {
+		if err == platformclient.ErrNotFound {
 			return fmt.Errorf("No such release %d", seq)
 		}
 		return err

cli/cmd/release_promote.go

@@ -40,7 +40,7 @@ func (r *runners) releasePromote(cmd *cobra.Command, args []string) error {
 	}
 	chanID := args[1]
 
-	if err := r.api.PromoteRelease(r.appID, seq, releaseVersion, releaseNotes, !releaseOptional, chanID); err != nil {
+	if err := r.platformAPI.PromoteRelease(r.appID, seq, releaseVersion, releaseNotes, !releaseOptional, chanID); err != nil {
 		return err
 	}
 

cli/cmd/release_update.go

@@ -6,7 +6,6 @@ import (
 	"io/ioutil"
 	"strconv"
 
-	"github.com/replicatedhq/replicated/client"
 	"github.com/spf13/cobra"
 )
 
@@ -43,8 +42,7 @@ func (r *runners) releaseUpdate(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("invalid release sequence: %s", args[0])
 	}
 
-	opts := &client.ReleaseOptions{YAML: updateReleaseYaml}
-	if err := r.api.UpdateRelease(r.appID, seq, opts); err != nil {
+	if err := r.platformAPI.UpdateRelease(r.appID, seq, updateReleaseYaml); err != nil {
 		return fmt.Errorf("Failure setting new yaml config for release: %v", err)
 	}
 

cli/cmd/root.go

@@ -6,7 +6,10 @@ import (
 	"os"
 	"text/tabwriter"
 
+	"github.com/replicatedhq/replicated/pkg/shipclient"
+
 	"github.com/replicatedhq/replicated/client"
+	"github.com/replicatedhq/replicated/pkg/platformclient"
 	"github.com/spf13/cobra"
 )
 
@@ -20,15 +23,21 @@ const (
 
 var appSlugOrID string
 var apiToken string
-var apiOrigin = "https://api.replicated.com/vendor"
+var platformOrigin = "https://api.replicated.com/vendor"
+var shipOrigin = "https://g.replicated.com/graphql"
 
 func init() {
 	RootCmd.PersistentFlags().StringVar(&appSlugOrID, "app", "", "The app slug or app id to use in all calls")
 	RootCmd.PersistentFlags().StringVar(&apiToken, "token", "", "The API token to use to access your app in the Vendor API")
 
 	originFromEnv := os.Getenv("REPLICATED_API_ORIGIN")
 	if originFromEnv != "" {
-		apiOrigin = originFromEnv
+		platformOrigin = originFromEnv
+	}
+
+	shipOriginFromEnv := os.Getenv("REPLICATED_SHIP_ORIGIN")
+	if shipOriginFromEnv != "" {
+		shipOrigin = shipOriginFromEnv
 	}
 }
 
@@ -102,18 +111,38 @@ func Execute(stdin io.Reader, stdout io.Writer, stderr io.Writer) error {
 				return errors.New("Please provide your API token")
 			}
 		}
-		api := client.NewHTTPClient(apiOrigin, apiToken)
-		runCmds.api = api
+		platformAPI := platformclient.NewHTTPClient(platformOrigin, apiToken)
+		runCmds.platformAPI = platformAPI
+
+		shipAPI := shipclient.NewGraphQLClient(shipOrigin, apiToken)
+		runCmds.shipAPI = shipAPI
+
+		commonAPI := client.NewClient(platformOrigin, shipOrigin, apiToken)
+		runCmds.api = commonAPI
 
 		if appSlugOrID == "" {
 			appSlugOrID = os.Getenv("REPLICATED_APP")
 		}
 
-		app, err := api.GetApp(appSlugOrID)
+		appType, err := commonAPI.GetAppType(appSlugOrID)
 		if err != nil {
 			return err
 		}
-		runCmds.appID = app.Id
+		runCmds.appType = appType
+
+		if appType == "platform" {
+			app, err := platformAPI.GetApp(appSlugOrID)
+			if err != nil {
+				return err
+			}
+			runCmds.appID = app.Id
+		} else if appType == "ship" {
+			app, err := shipAPI.GetApp(appSlugOrID)
+			if err != nil {
+				return err
+			}
+			runCmds.appID = app.ID
+		}
 
 		return nil
 	}

cli/cmd/runner.go

@@ -4,14 +4,20 @@ import (
 	"io"
 	"text/tabwriter"
 
+	"github.com/replicatedhq/replicated/pkg/shipclient"
+
 	"github.com/replicatedhq/replicated/client"
+	"github.com/replicatedhq/replicated/pkg/platformclient"
 )
 
 // Runner holds the I/O dependencies and configurations used by individual
 // commands, which are defined as methods on this type.
 type runners struct {
-	appID string
-	api   client.Client
-	stdin io.Reader
-	w     *tabwriter.Writer
+	appID       string
+	appType     string
+	api         client.Client
+	platformAPI platformclient.Client
+	shipAPI     shipclient.Client
+	stdin       io.Reader
+	w           *tabwriter.Writer
 }

cli/cmd/shiprelease.go

@@ -6,9 +6,10 @@ import (
 
 // releaseCmd represents the release command
 var shipReleaseCommand = &cobra.Command{
-	Use:   "shiprelease",
-	Short: "Manage ship releases",
-	Long:  `The shiprelease command allows vendors to create, display, modify, and archive their Ship releases.`,
+	Use:    "shiprelease",
+	Short:  "Manage ship releases",
+	Long:   `The shiprelease command allows vendors to create, display, modify, and archive their Ship releases.`,
+	Hidden: true,
 }
 
 func init() {

cli/cmd/shiprelease_create.go

@@ -6,14 +6,15 @@ import (
 	"io/ioutil"
 	"net/url"
 
+	"os"
+	"strings"
+
 	"github.com/go-kit/kit/log"
 	"github.com/mitchellh/cli"
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/ship/pkg/e2e"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
-	"os"
-	"strings"
 )
 
 func init() {
@@ -117,10 +118,7 @@ func (r *Releaser) getParams() (token, specContents, semver, channelID, gqlAddr
 	return
 }
 
-func (r *Releaser) Release(
-	ctx context.Context,
-) error {
-
+func (r *Releaser) Release(ctx context.Context) error {
 	token, specContents, semver, channelID, gqlAddr, err := r.getParams()
 	if err != nil {
 		return errors.Wrap(err, "load params")

cli/print/apps.go

@@ -0,0 +1,33 @@
+package print
+
+import (
+	"text/tabwriter"
+	"text/template"
+
+	apps "github.com/replicatedhq/replicated/gen/go/v1"
+)
+
+var appsTmplSrc = `ID	NAME	SCHEDULER
+{{ range . -}}
+{{ .ID }}	{{ .Name }}	{{ .Scheduler }}
+{{ end }}`
+
+var appsTmpl = template.Must(template.New("apps").Funcs(funcs).Parse(appsTmplSrc))
+
+func Apps(w *tabwriter.Writer, apps []apps.AppAndChannels) error {
+	as := make([]map[string]interface{}, len(apps))
+
+	for i, a := range apps {
+		as[i] = map[string]interface{}{
+			"ID":        a.App.Id,
+			"Name":      a.App.Name,
+			"Scheduler": a.App.Scheduler,
+		}
+	}
+
+	if err := appsTmpl.Execute(w, as); err != nil {
+		return err
+	}
+
+	return w.Flush()
+}

cli/print/channels.go

@@ -4,17 +4,25 @@ import (
 	"text/tabwriter"
 	"text/template"
 
-	channels "github.com/replicatedhq/replicated/gen/go/v1"
+	platformChannels "github.com/replicatedhq/replicated/gen/go/v1"
+	"github.com/replicatedhq/replicated/pkg/types"
 )
 
 var channelsTmplSrc = `ID	NAME	RELEASE	VERSION
 {{ range . -}}
-{{ .Id }}	{{ .Name }}	{{ if ge .ReleaseSequence 1 }}{{ .ReleaseSequence }}{{else}}	{{end}}	{{ .ReleaseLabel }}
+{{ .ID }}	{{ .Name }}	{{ if ge .ReleaseSequence 1 }}{{ .ReleaseSequence }}{{else}}	{{end}}	{{ .ReleaseLabel }}
 {{ end }}`
 
 var channelsTmpl = template.Must(template.New("channels").Parse(channelsTmplSrc))
 
-func Channels(w *tabwriter.Writer, channels []channels.AppChannel) error {
+func Channels(w *tabwriter.Writer, channels []types.Channel) error {
+	if err := channelsTmpl.Execute(w, channels); err != nil {
+		return err
+	}
+	return w.Flush()
+}
+
+func PlatformChannels(w *tabwriter.Writer, channels []platformChannels.AppChannel) error {
 	if err := channelsTmpl.Execute(w, channels); err != nil {
 		return err
 	}

cli/print/releases.go

@@ -6,7 +6,7 @@ import (
 	"text/template"
 	"time"
 
-	releases "github.com/replicatedhq/replicated/gen/go/v1"
+	"github.com/replicatedhq/replicated/pkg/types"
 )
 
 var releasesTmplSrc = `SEQUENCE	CREATED	EDITED	ACTIVE_CHANNELS
@@ -16,7 +16,7 @@ var releasesTmplSrc = `SEQUENCE	CREATED	EDITED	ACTIVE_CHANNELS
 
 var releasesTmpl = template.Must(template.New("Releases").Funcs(funcs).Parse(releasesTmplSrc))
 
-func Releases(w *tabwriter.Writer, appReleases []releases.AppReleaseInfo) error {
+func Releases(w *tabwriter.Writer, appReleases []types.ReleaseInfo) error {
 	rs := make([]map[string]interface{}, len(appReleases))
 
 	for i, r := range appReleases {