add command skaffold inspect build-env add local (#5944)

Author: gsquared94

cmd/skaffold/app/cmd/cmd.go

@@ -284,14 +284,14 @@ func isHouseKeepingMessagesAllowed(cmd *cobra.Command) bool {
 	if cmd.Annotations == nil {
 		return false
 	}
-	return cmd.Annotations[HouseKeepingMessagesAllowedAnnotation] == "true"
+	return cmd.Annotations[HouseKeepingMessagesAllowedAnnotation] == fmt.Sprintf("%t", true)
 }
 
 func allowHouseKeepingMessages(cmd *cobra.Command) {
 	if cmd.Annotations == nil {
 		cmd.Annotations = make(map[string]string)
 	}
-	cmd.Annotations[HouseKeepingMessagesAllowedAnnotation] = "true"
+	cmd.Annotations[HouseKeepingMessagesAllowedAnnotation] = fmt.Sprintf("%t", true)
 }
 
 func preReleaseVersion(s string) bool {

cmd/skaffold/app/cmd/inspect_build_env.go

@@ -23,6 +23,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/inspect"
 	buildEnv "github.com/GoogleContainerTools/skaffold/pkg/skaffold/inspect/buildEnv"
 )
@@ -34,6 +35,12 @@ var buildEnvFlags = struct {
 	timeout     string
 	concurrency int
 
+	// Local
+	push             config.BoolOrUndefined
+	tryImportMissing config.BoolOrUndefined
+	useDockerCLI     config.BoolOrUndefined
+	useBuildkit      config.BoolOrUndefined
+
 	// Google Cloud Build
 	projectID   string
 	diskSizeGb  int64
@@ -74,7 +81,7 @@ func cmdBuildEnvAdd() *cobra.Command {
 	return NewCmd("add").
 		WithDescription("Add a new build environment to the default pipeline or to a new or existing profile.").
 		WithPersistentFlagAdder(cmdBuildEnvAddFlags).
-		WithCommands(cmdBuildEnvAddGcb(), cmdBuildEnvAddCluster())
+		WithCommands(cmdBuildEnvAddLocal(), cmdBuildEnvAddGcb(), cmdBuildEnvAddCluster())
 }
 
 func cmdBuildEnvAddGcb() *cobra.Command {
@@ -89,6 +96,18 @@ Use the '--module' filter to specify the individual module to target. Otherwise,
 		NoArgs(addGcbBuildEnv)
 }
 
+func cmdBuildEnvAddLocal() *cobra.Command {
+	return NewCmd("local").
+		WithDescription("Add a new Local build environment definition").
+		WithLongDescription(`Add a new Local build environment definition.
+Without the '--profile' flag the new environment definition is added to the default pipeline. With the '--profile' flag it will create a new profile with this build env definition. 
+In these respective scenarios, it will fail if the build env definition for the default pipeline or the named profile already exists. To override an existing definition use 'skaffold inspect build-env modify' command instead. 
+Use the '--module' filter to specify the individual module to target. Otherwise, it'll be applied to all modules defined in the target file. Also, with the '--profile' flag if the target config imports other configs as dependencies, then the new profile will be recursively created in all the imported configs also.`).
+		WithExample("Add a new profile named 'local' targeting the local build environment with option to push images and using buildkit", "inspect build-env add local --profile local --push true --useBuildkit true -f skaffold.yaml").
+		WithFlagAdder(cmdBuildEnvLocalFlags).
+		NoArgs(addLocalBuildEnv)
+}
+
 func cmdBuildEnvAddCluster() *cobra.Command {
 	return NewCmd("cluster").
 		WithDescription("Add a new Cluster build environment definition").
@@ -105,6 +124,10 @@ func listBuildEnv(ctx context.Context, out io.Writer) error {
 	return buildEnv.PrintBuildEnvsList(ctx, out, printBuildEnvsListOptions())
 }
 
+func addLocalBuildEnv(ctx context.Context, out io.Writer) error {
+	return buildEnv.AddLocalBuildEnv(ctx, out, localBuildEnvOptions())
+}
+
 func addGcbBuildEnv(ctx context.Context, out io.Writer) error {
 	return buildEnv.AddGcbBuildEnv(ctx, out, addGcbBuildEnvOptions())
 }
@@ -117,6 +140,20 @@ func cmdBuildEnvAddFlags(f *pflag.FlagSet) {
 	f.StringVarP(&buildEnvFlags.profile, "profile", "p", "", `Profile name to add the new build env definition in. If the profile name doesn't exist then the profile will be created in all the target configs. If this flag is not specified then the build env is added to the default pipeline of the target configs.`)
 }
 
+func cmdBuildEnvLocalFlags(f *pflag.FlagSet) {
+	var flags []*pflag.Flag
+	flags = append(flags, f.VarPF(&buildEnvFlags.push, "push", "", `Set to true to push images to a registry`))
+	flags = append(flags, f.VarPF(&buildEnvFlags.tryImportMissing, "tryImportMissing", "", `Set to true to to attempt importing artifacts from Docker (either a local or remote registry) if not in the build cache`))
+	flags = append(flags, f.VarPF(&buildEnvFlags.useDockerCLI, "useDockerCLI", "", `Set to true to use 'docker' command-line interface instead of Docker Engine APIs`))
+	flags = append(flags, f.VarPF(&buildEnvFlags.useBuildkit, "useBuildkit", "", `Set to true to use BuildKit to build Docker images`))
+	f.IntVar(&buildEnvFlags.concurrency, "concurrency", -1, `number of artifacts to build concurrently. 0 means "no-limit"`)
+
+	// support *bool flags without a value to be interpreted as `true`; like `--push` instead of `--push=true`
+	for _, f := range flags {
+		f.NoOptDefVal = "true"
+	}
+}
+
 func cmdBuildEnvAddGcbFlags(f *pflag.FlagSet) {
 	f.StringVar(&buildEnvFlags.projectID, "projectId", "", `ID of the Cloud Platform Project.`)
 	f.Int64Var(&buildEnvFlags.diskSizeGb, "diskSizeGb", 0, `Disk size of the VM that runs the build`)
@@ -162,6 +199,23 @@ func printBuildEnvsListOptions() inspect.Options {
 		},
 	}
 }
+
+func localBuildEnvOptions() inspect.Options {
+	return inspect.Options{
+		Filename:  inspectFlags.fileName,
+		OutFormat: inspectFlags.outFormat,
+		Modules:   inspectFlags.modules,
+		BuildEnvOptions: inspect.BuildEnvOptions{
+			Profile:          buildEnvFlags.profile,
+			Push:             buildEnvFlags.push.Value(),
+			TryImportMissing: buildEnvFlags.tryImportMissing.Value(),
+			UseDockerCLI:     buildEnvFlags.useDockerCLI.Value(),
+			UseBuildkit:      buildEnvFlags.useBuildkit.Value(),
+			Concurrency:      buildEnvFlags.concurrency,
+		},
+	}
+}
+
 func addGcbBuildEnvOptions() inspect.Options {
 	return inspect.Options{
 		Filename:  inspectFlags.fileName,
@@ -177,6 +231,7 @@ func addGcbBuildEnvOptions() inspect.Options {
 		},
 	}
 }
+
 func addClusterBuildEnvOptions() inspect.Options {
 	return inspect.Options{
 		Filename:  inspectFlags.fileName,

pkg/skaffold/inspect/buildEnv/add_local.go

@@ -0,0 +1,92 @@
+/*
+Copyright 2021 The Skaffold Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package inspect
+
+import (
+	"context"
+	"io"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/inspect"
+	latestV1 "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest/v1"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/util"
+)
+
+func AddLocalBuildEnv(ctx context.Context, out io.Writer, opts inspect.Options) error {
+	formatter := inspect.OutputFormatter(out, opts.OutFormat)
+	cfgs, err := inspect.ConfigSetFunc(config.SkaffoldOptions{ConfigurationFile: opts.Filename, ConfigurationFilter: opts.Modules, SkipConfigDefaults: true, MakePathsAbsolute: util.BoolPtr(false)})
+	if err != nil {
+		return formatter.WriteErr(err)
+	}
+	if opts.Profile == "" {
+		// empty profile flag implies that the new build env needs to be added to the default pipeline.
+		// for these cases, don't add the new env definition to any configs imported as dependencies.
+		cfgs = cfgs.SelectRootConfigs()
+		for _, cfg := range cfgs {
+			if cfg.Build.LocalBuild != nil && (*cfg.Build.LocalBuild != latestV1.LocalBuild{}) {
+				return formatter.WriteErr(inspect.BuildEnvAlreadyExists(inspect.BuildEnvs.Local, cfg.SourceFile, ""))
+			}
+			cfg.Build.LocalBuild = constructLocalDefinition(cfg.Build.LocalBuild, opts.BuildEnvOptions)
+			cfg.Build.GoogleCloudBuild = nil
+			cfg.Build.Cluster = nil
+		}
+	} else {
+		for _, cfg := range cfgs {
+			index := -1
+			for i := range cfg.Profiles {
+				if cfg.Profiles[i].Name == opts.Profile {
+					index = i
+					break
+				}
+			}
+			if index < 0 {
+				index = len(cfg.Profiles)
+				cfg.Profiles = append(cfg.Profiles, latestV1.Profile{Name: opts.Profile})
+			}
+			if cfg.Profiles[index].Build.LocalBuild != nil && (*cfg.Profiles[index].Build.LocalBuild != latestV1.LocalBuild{}) {
+				return formatter.WriteErr(inspect.BuildEnvAlreadyExists(inspect.BuildEnvs.Local, cfg.SourceFile, opts.Profile))
+			}
+			cfg.Profiles[index].Build.LocalBuild = constructLocalDefinition(cfg.Profiles[index].Build.LocalBuild, opts.BuildEnvOptions)
+			cfg.Profiles[index].Build.GoogleCloudBuild = nil
+			cfg.Profiles[index].Build.Cluster = nil
+		}
+	}
+	return inspect.MarshalConfigSet(cfgs)
+}
+
+func constructLocalDefinition(existing *latestV1.LocalBuild, opts inspect.BuildEnvOptions) *latestV1.LocalBuild {
+	var b latestV1.LocalBuild
+	if existing != nil {
+		b = *existing
+	}
+	if opts.Concurrency >= 0 {
+		b.Concurrency = util.IntPtr(opts.Concurrency)
+	}
+	if opts.Push != nil {
+		b.Push = opts.Push
+	}
+	if opts.TryImportMissing != nil {
+		b.TryImportMissing = *opts.TryImportMissing
+	}
+	if opts.UseDockerCLI != nil {
+		b.UseDockerCLI = *opts.UseDockerCLI
+	}
+	if opts.UseBuildkit != nil {
+		b.UseBuildkit = *opts.UseBuildkit
+	}
+	return &b
+}