feat: improve local UX with up --create-cluster and --watch by default

This also updates the CI tests to improve test coverage of the create-cluster code paths.

Signed-off-by: Nick Mitchell <[email protected]>

Author: starpit

.github/workflows/actions.yml

@@ -27,10 +27,12 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - name: Create k8s Kind Cluster
-      uses: helm/[email protected]
-      with:
-        install_only: true
+    # we will also be testing installing kind, so we don't want to do
+    # this as part of the github action workflow
+    #- name: Create k8s Kind Cluster
+    #  uses: helm/[email protected]
+    #  with:
+    #    install_only: true
 
     - name: Setup
       run: ./tests/bin/travis/setup.sh

cmd/subcommands/init/local.go

@@ -6,17 +6,19 @@ import (
 )
 
 func NewInitLocalCmd() *cobra.Command {
+	var buildFlag bool
 	var verboseFlag bool
 
 	var cmd = &cobra.Command{
 		Use:   "local",
 		Short: "Initialize a local control plane",
 		Long:  "Initialize a local control plane",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return initialize.Local(initialize.InitLocalOptions{Verbose: verboseFlag})
+			return initialize.Local(initialize.InitLocalOptions{BuildImages: buildFlag, Verbose: verboseFlag})
 		},
 	}
 
-	cmd.Flags().BoolVarP(&verboseFlag, "verbose", "v", verboseFlag, "Verbose output")
+	cmd.Flags().BoolVarP(&buildFlag, "build-images", "b", false, "Also build Lunchpail support images")
+	cmd.Flags().BoolVarP(&verboseFlag, "verbose", "v", false, "Verbose output")
 	return cmd
 }

cmd/subcommands/up.go

@@ -5,6 +5,8 @@ import (
 	"lunchpail.io/pkg/be"
 	"lunchpail.io/pkg/boot"
 	"lunchpail.io/pkg/fe/linker"
+	initialize "lunchpail.io/pkg/lunchpail/init"
+	"lunchpail.io/pkg/util"
 
 	"github.com/spf13/cobra"
 )
@@ -36,7 +38,8 @@ func addAssemblyOptions(cmd *cobra.Command) *assembly.Options {
 func newUpCmd() *cobra.Command {
 	var verboseFlag bool
 	var dryrunFlag bool
-	var watchFlag bool
+	watchFlag := false
+	var createCluster bool
 	var createNamespace bool
 
 	var cmd = &cobra.Command{
@@ -45,14 +48,29 @@ func newUpCmd() *cobra.Command {
 		Long:  "Deploy the application",
 	}
 
+	if util.StdoutIsTty() {
+		// default to watch if we are connected to a TTY
+		watchFlag = true
+	}
+
 	cmd.Flags().SortFlags = false
 	appOpts := addAssemblyOptions(cmd)
 	cmd.Flags().BoolVarP(&dryrunFlag, "dry-run", "", false, "Emit application yaml to stdout")
 	cmd.Flags().BoolVarP(&verboseFlag, "verbose", "v", false, "Verbose output")
-	cmd.Flags().BoolVarP(&watchFlag, "watch", "w", false, "After deployment, watch for status updates")
-	cmd.Flags().BoolVarP(&createNamespace, "create-namespace", "N", false, "Create a new Kubernetes namespace")
+	cmd.Flags().BoolVarP(&watchFlag, "watch", "w", watchFlag, "After deployment, watch for status updates")
+	cmd.Flags().BoolVarP(&createCluster, "create-cluster", "I", false, "Create a new (local) Kubernetes cluster, if needed")
+	cmd.Flags().BoolVarP(&createNamespace, "create-namespace", "N", false, "Create a new Kubernetes namespace, if needed")
 
 	cmd.RunE = func(cmd *cobra.Command, args []string) error {
+		if appOpts.TargetPlatform == be.Kubernetes && createCluster {
+			if err := initialize.Local(initialize.InitLocalOptions{BuildImages: false, Verbose: verboseFlag}); err != nil {
+				return err
+			}
+
+			// if we were asked to create a cluster, then certainly we will want to create a namespace
+			createNamespace = true
+		}
+
 		overrideValues, err := cmd.Flags().GetStringSlice("set")
 		if err != nil {
 			return err

hack/init.sh

@@ -9,4 +9,4 @@ if [ ! -f /tmp/lunchpail ]
 then "$TOP"/hack/setup/cli.sh /tmp/lunchpail
 fi
 
-/tmp/lunchpail init local
+/tmp/lunchpail init local --build-images

pkg/lunchpail/init/kind.go

@@ -64,7 +64,7 @@ func createKindCluster() error {
 			args = append(args, "/tmp/kindhack.yaml")
 		}
 
-		fmt.Printf("Creating kind cluster " + lunchpail.LocalClusterName)
+		fmt.Printf("Creating kind cluster %s\n", lunchpail.LocalClusterName)
 
 		cmd := exec.Command("kind", args...)
 		cmd.Stdout = os.Stdout

pkg/lunchpail/init/local.go

@@ -8,7 +8,8 @@ import (
 )
 
 type InitLocalOptions struct {
-	Verbose bool
+	BuildImages bool
+	Verbose     bool
 }
 
 func Local(opts InitLocalOptions) error {
@@ -37,7 +38,13 @@ func Local(opts InitLocalOptions) error {
 		return err
 	}
 
-	bopts := build.BuildOptions{}
-	bopts.Verbose = opts.Verbose
-	return images.Build(bopts)
+	if opts.BuildImages {
+		bopts := build.BuildOptions{}
+		bopts.Verbose = opts.Verbose
+		if err := images.Build(bopts); err != nil {
+			return err
+		}
+	}
+
+	return nil
 }

pkg/util/term.go

@@ -0,0 +1,11 @@
+package util
+
+import "os"
+
+func StdoutIsTty() bool {
+	if fileInfo, _ := os.Stdout.Stat(); (fileInfo.Mode() & os.ModeCharDevice) != 0 {
+		return true
+	} else {
+		return false
+	}
+}

tests/bin/deploy-tests.sh

@@ -72,7 +72,6 @@ repo_secret="" # e.g. user:pat@https://github.mycompany.com
                $repo_secret \
                $2
 
-echo "!!!!!!!!!!!!!!!XXXXXXXXXXXXXXXXXXXXXXX $2"
 if [[ -d "$2" ]] && [[ -f "$2"/version ]]
 then
     # Check that app version passes through

tests/bin/travis/setup.sh

@@ -1,11 +1,8 @@
 #!/usr/bin/env bash
 
-set -e
-set -o pipefail
+set -eo pipefail
 
-# ibm travis currently runs ubuntu 20, for which there are no podman
-# v4 builds. We rely on v4 for the `podman machine init --rootful`
-# option
+# Keeping this here, in case we want to test podman in CI.
 # if ! which podman >& /dev/null
 # then
 #     echo "Installing podman"