add pack stack subcommand

Signed-off-by: anshlykov <andrew.shlykov@ya.ru>
buildpacks · Nov 5, 2020 · 9cb8cb3 · 9cb8cb3
1 parent 80ed306
commit 9cb8cb3
Show file tree

Hide file tree

Showing 6 changed files with 171 additions and 63 deletions.
diff --git a/cmd/cmd.go b/cmd/cmd.go
@@ -9,6 +9,7 @@ import (
 	"github.com/buildpacks/pack/buildpackage"
 	"github.com/buildpacks/pack/internal/builder/writer"
 	"github.com/buildpacks/pack/internal/commands"
+	"github.com/buildpacks/pack/internal/commands/stack"
 	"github.com/buildpacks/pack/internal/config"
 	"github.com/buildpacks/pack/logging"
 )
@@ -95,6 +96,8 @@ func NewPackCommand(logger ConfigurableLogger) (*cobra.Command, error) {
 
 	rootCmd.AddCommand(commands.CompletionCommand(logger))
 
+	rootCmd.AddCommand(stack.NewStackCmd(logger))
+
 	rootCmd.Version = pack.Version
 	rootCmd.SetVersionTemplate(`{{.Version}}{{"\n"}}`)
 	rootCmd.SetOut(logging.GetWriterForLevel(logger, logging.InfoLevel))

diff --git a/internal/commands/stack/stack.go b/internal/commands/stack/stack.go
@@ -0,0 +1,18 @@
+package stack
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/buildpacks/pack/logging"
+)
+
+func NewStackCmd(logger logging.Logger) *cobra.Command {
+	command := cobra.Command{
+		Use:   "stack",
+		Short: "Displays stack information",
+		RunE:  nil,
+	}
+
+	command.AddCommand(newSuggestCmd(logger))
+	return &command
+}
diff --git a/internal/commands/stack/suggest.go b/internal/commands/stack/suggest.go
@@ -0,0 +1,82 @@
+package stack
+
+import (
+	"bytes"
+	"html/template"
+	"sort"
+
+	"github.com/spf13/cobra"
+
+	"github.com/buildpacks/pack/logging"
+)
+
+type suggestedStack struct {
+	ID          string
+	Description string
+	Maintainer  string
+	BuildImage  string
+	RunImage    string
+}
+
+var suggestedStacks = []suggestedStack{
+	{
+		ID:          "heroku-18",
+		Description: "The official Heroku stack based on Ubuntu 18.04",
+		Maintainer:  "Heroku",
+		BuildImage:  "heroku/pack:18-build",
+		RunImage:    "heroku/pack:18",
+	},
+	{
+		ID:          "io.buildpacks.stacks.bionic",
+		Description: "A minimal Paketo stack based on Ubuntu 18.04",
+		Maintainer:  "Paketo Project",
+		BuildImage:  "paketobuildpacks/build:base-cnb",
+		RunImage:    "paketobuildpacks/run:base-cnb",
+	},
+	{
+		ID:          "io.buildpacks.stacks.bionic",
+		Description: "A large Paketo stack based on Ubuntu 18.04",
+		Maintainer:  "Paketo Project",
+		BuildImage:  "paketobuildpacks/build:full-cnb",
+		RunImage:    "paketobuildpacks/run:full-cnb",
+	},
+	{
+		ID:          "io.paketo.stacks.tiny",
+		Description: "A tiny Paketo stack based on Ubuntu 18.04, similar to distroless",
+		Maintainer:  "Paketo Project",
+		BuildImage:  "paketobuildpacks/build:tiny-cnb",
+		RunImage:    "paketobuildpacks/run:tiny-cnb",
+	},
+}
+
+func newSuggestCmd(logger logging.Logger) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:     "suggest",
+		Args:    cobra.NoArgs,
+		Short:   "Display list of recommended stacks",
+		Example: "pack stacks suggest",
+		Run: func(*cobra.Command, []string) {
+			Suggest(logger)
+		},
+	}
+
+	return cmd
+}
+
+func Suggest(log logging.Logger) {
+	sort.Slice(suggestedStacks, func(i, j int) bool { return suggestedStacks[i].ID < suggestedStacks[j].ID })
+	tmpl := template.Must(template.New("").Parse(`Stacks maintained by the community:
+{{- range . }}
+
+    Stack ID: {{ .ID }}
+    Description: {{ .Description }}
+    Maintainer: {{ .Maintainer }}
+    Build Image: {{ .BuildImage }}
+    Run Image: {{ .RunImage }}
+{{- end }}
+`))
+
+	buf := &bytes.Buffer{}
+	tmpl.Execute(buf, suggestedStacks)
+	log.Info(buf.String())
+}
diff --git a/internal/commands/stack/suggest_test.go b/internal/commands/stack/suggest_test.go
@@ -0,0 +1,61 @@
+package stack
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/sclevine/spec"
+	"github.com/sclevine/spec/report"
+	"github.com/spf13/cobra"
+
+	"github.com/buildpacks/pack/internal/logging"
+	h "github.com/buildpacks/pack/testhelpers"
+)
+
+func TestSuggestStacksCommand(t *testing.T) {
+	spec.Run(t, "Commands", testSuggestStacksCommand, spec.Parallel(), spec.Report(report.Terminal{}))
+}
+
+func testSuggestStacksCommand(t *testing.T, when spec.G, it spec.S) {
+	var (
+		command *cobra.Command
+		outBuf  bytes.Buffer
+	)
+
+	it.Before(func() {
+		command = newSuggestCmd(logging.NewLogWithWriters(&outBuf, &outBuf))
+	})
+
+	when("#SuggestStacks", func() {
+		it("displays stack information", func() {
+			command.SetArgs([]string{})
+			h.AssertNil(t, command.Execute())
+			h.AssertEq(t, outBuf.String(), `Stacks maintained by the community:
+
+    Stack ID: heroku-18
+    Description: The official Heroku stack based on Ubuntu 18.04
+    Maintainer: Heroku
+    Build Image: heroku/pack:18-build
+    Run Image: heroku/pack:18
+
+    Stack ID: io.buildpacks.stacks.bionic
+    Description: A minimal Paketo stack based on Ubuntu 18.04
+    Maintainer: Paketo Project
+    Build Image: paketobuildpacks/build:base-cnb
+    Run Image: paketobuildpacks/run:base-cnb
+
+    Stack ID: io.buildpacks.stacks.bionic
+    Description: A large Paketo stack based on Ubuntu 18.04
+    Maintainer: Paketo Project
+    Build Image: paketobuildpacks/build:full-cnb
+    Run Image: paketobuildpacks/run:full-cnb
+
+    Stack ID: io.paketo.stacks.tiny
+    Description: A tiny Paketo stack based on Ubuntu 18.04, similar to distroless
+    Maintainer: Paketo Project
+    Build Image: paketobuildpacks/build:tiny-cnb
+    Run Image: paketobuildpacks/run:tiny-cnb
+`)
+		})
+	})
+}
diff --git a/internal/commands/suggest_stacks.go b/internal/commands/suggest_stacks.go
@@ -1,83 +1,26 @@
 package commands
 
 import (
-	"bytes"
-	"html/template"
-	"sort"
-
 	"github.com/spf13/cobra"
 
+	"github.com/buildpacks/pack/internal/commands/stack"
+
 	"github.com/buildpacks/pack/logging"
 )
 
-type suggestedStack struct {
-	ID          string
-	Description string
-	Maintainer  string
-	BuildImage  string
-	RunImage    string
-}
-
-var suggestedStacks = []suggestedStack{
-	{
-		ID:          "heroku-18",
-		Description: "The official Heroku stack based on Ubuntu 18.04",
-		Maintainer:  "Heroku",
-		BuildImage:  "heroku/pack:18-build",
-		RunImage:    "heroku/pack:18",
-	},
-	{
-		ID:          "io.buildpacks.stacks.bionic",
-		Description: "A minimal Paketo stack based on Ubuntu 18.04",
-		Maintainer:  "Paketo Project",
-		BuildImage:  "paketobuildpacks/build:base-cnb",
-		RunImage:    "paketobuildpacks/run:base-cnb",
-	},
-	{
-		ID:          "io.buildpacks.stacks.bionic",
-		Description: "A large Paketo stack based on Ubuntu 18.04",
-		Maintainer:  "Paketo Project",
-		BuildImage:  "paketobuildpacks/build:full-cnb",
-		RunImage:    "paketobuildpacks/run:full-cnb",
-	},
-	{
-		ID:          "io.paketo.stacks.tiny",
-		Description: "A tiny Paketo stack based on Ubuntu 18.04, similar to distroless",
-		Maintainer:  "Paketo Project",
-		BuildImage:  "paketobuildpacks/build:tiny-cnb",
-		RunImage:    "paketobuildpacks/run:tiny-cnb",
-	},
-}
-
 func SuggestStacks(logger logging.Logger) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "suggest-stacks",
 		Args:    cobra.NoArgs,
 		Short:   "Display list of recommended stacks",
 		Example: "pack suggest-stacks",
 		Run: func(*cobra.Command, []string) {
-			suggestStacks(logger)
+			logger.Warn("Command 'pack suggest-stacks' has been deprecated, please use 'pack stack suggest' instead")
+			stack.Suggest(logger)
 		},
+		Hidden: true,
 	}
 
 	AddHelpFlag(cmd, "suggest-stacks")
 	return cmd
 }
-
-func suggestStacks(log logging.Logger) {
-	sort.Slice(suggestedStacks, func(i, j int) bool { return suggestedStacks[i].ID < suggestedStacks[j].ID })
-	tmpl := template.Must(template.New("").Parse(`Stacks maintained by the community:
-{{- range . }}
-
-    Stack ID: {{ .ID }}
-    Description: {{ .Description }}
-    Maintainer: {{ .Maintainer }}
-    Build Image: {{ .BuildImage }}
-    Run Image: {{ .RunImage }}
-{{- end }}
-`))
-
-	buf := &bytes.Buffer{}
-	tmpl.Execute(buf, suggestedStacks)
-	log.Info(buf.String())
-}
diff --git a/internal/commands/suggest_stacks_test.go b/internal/commands/suggest_stacks_test.go
@@ -31,7 +31,8 @@ func testSuggestStacksCommand(t *testing.T, when spec.G, it spec.S) {
 		it("displays stack information", func() {
 			command.SetArgs([]string{})
 			h.AssertNil(t, command.Execute())
-			h.AssertEq(t, outBuf.String(), `Stacks maintained by the community:
+			h.AssertEq(t, outBuf.String(), "\x1b\x5b\x33\x33\x3b\x31\x6dWarning: \x1b\x5b\x30\x6dCommand 'pack suggest-stacks' has been deprecated, please use 'pack stack suggest' instead\n"+
+				`Stacks maintained by the community:
 
     Stack ID: heroku-18
     Description: The official Heroku stack based on Ubuntu 18.04