Improved messaging when requested channel slug not allowed by license

Author: pandemicsyn

cmd/kots/cli/install.go

@@ -167,6 +167,11 @@ func InstallCmd() *cobra.Command {
 			if err != nil {
 				return errors.Wrap(err, "failed to extract preferred channel slug")
 			}
+			if preferredChannelSlug == "" {
+				preferredChannelSlug = "stable"
+				log.ActionWithoutSpinner(fmt.Sprintf("No channel specified in upstream URI, falling back to channel %q.", preferredChannelSlug))
+			}
+
 			license, err = kotslicense.VerifyAndUpdateLicense(log, license, preferredChannelSlug, isAirgap)
 			if err != nil {
 				return errors.Wrap(err, "failed to verify and update license")

cmd/kots/cli/pull.go

@@ -1,6 +1,7 @@
 package cli
 
 import (
+	"fmt"
 	"os"
 	"path"
 	"strings"
@@ -101,13 +102,19 @@ func PullCmd() *cobra.Command {
 			}
 
 			upstream := pull.RewriteUpstream(args[0])
+
+			log := logger.NewCLILogger(cmd.OutOrStdout())
+			log.Initialize()
+
 			preferredChannelSlug, err := extractPreferredChannelSlug(upstream)
 			if err != nil {
 				return errors.Wrap(err, "failed to extract preferred channel slug")
 			}
 
-			log := logger.NewCLILogger(cmd.OutOrStdout())
-			log.Initialize()
+			if preferredChannelSlug == "" {
+				preferredChannelSlug = "stable"
+				log.ActionWithoutSpinner(fmt.Sprintf("No channel specified in upstream URI, falling back to channel %q.", preferredChannelSlug))
+			}
 
 			// If we are passed a multi-channel license, verify that the requested channel is in the license
 			// so that we can warn the user immediately if it is not.

cmd/kots/cli/util.go

@@ -67,5 +67,5 @@ func extractPreferredChannelSlug(upstreamURI string) (string, error) {
 	if replicatedUpstream.Channel != nil {
 		return *replicatedUpstream.Channel, nil
 	}
-	return "stable", nil
+	return "", nil
 }

cmd/kots/cli/util_test.go

@@ -111,7 +111,7 @@ func Test_extractPreferredChannelSlug(t *testing.T) {
 			args{
 				upstreamURI: "replicated://app-slug",
 			},
-			"stable", // default channel
+			"",
 			false,
 		},
 		{

pkg/license/multichannel.go

@@ -1,6 +1,9 @@
 package license
 
 import (
+	"fmt"
+	"strings"
+
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/kots/pkg/logger"
 	"github.com/replicatedhq/kots/pkg/replicatedapp"
@@ -40,11 +43,20 @@ func VerifyAndUpdateLicense(log *logger.CLILogger, license *kotsv1beta1.License,
 		return nil, nil
 	}
 	if isAirgap {
+		log.ActionWithSpinner("Verifying channel slug %q allowed by license", preferredChannelSlug)
 		if !canInstallFromChannel(preferredChannelSlug, license) {
-			return nil, errors.New("requested channel not found in supplied license")
+			log.FinishSpinnerWithError()
+			return license, errors.New(fmt.Sprintf("channel slug %q is not allowed by license", preferredChannelSlug))
+		}
+		log.FinishSpinner()
+		validChannels := []string{}
+		for _, channel := range license.Spec.Channels {
+			validChannels = append(validChannels, fmt.Sprintf("%s/%s", license.Spec.AppSlug, channel.ChannelSlug))
 		}
+		log.ChildActionWithoutSpinner(fmt.Sprintf("To install from an allowed channel, use one of the following: %s", strings.Join(validChannels, ", ")))
 		return license, nil
 	}
+
 	log.ActionWithSpinner("Checking for license update")
 	// we fetch the latest license to ensure that the license is up to date, before proceeding
 	updatedLicense, err := replicatedapp.GetLatestLicense(license, "")
@@ -53,8 +65,17 @@ func VerifyAndUpdateLicense(log *logger.CLILogger, license *kotsv1beta1.License,
 		return nil, errors.Wrap(err, "failed to get latest license")
 	}
 	log.FinishSpinner()
+
+	log.ActionWithSpinner("Verifying channel slug %q allowed by license", preferredChannelSlug)
 	if canInstallFromChannel(preferredChannelSlug, updatedLicense.License) {
+		log.FinishSpinner()
 		return updatedLicense.License, nil
 	}
-	return nil, errors.New("requested channel not found in latest license")
+	log.FinishSpinnerWithError()
+	validChannels := []string{}
+	for _, channel := range license.Spec.Channels {
+		validChannels = append(validChannels, fmt.Sprintf("%s/%s", license.Spec.AppSlug, channel.ChannelSlug))
+	}
+	log.ChildActionWithoutSpinner(fmt.Sprintf("To install from an allowed channel, use one of the following: %s", strings.Join(validChannels, ", ")))
+	return updatedLicense.License, errors.New(fmt.Sprintf("channel slug %q is not allowed by latest license", preferredChannelSlug))
 }