add skaffold inspect build-env command (#5792)

* add `skaffold inspect build-env` command

* fix typo

cmd/skaffold/app/cmd/inspect.go

@@ -26,6 +26,7 @@ var inspectFlags = struct {
 	outFormat string
 	modules   []string
 	buildEnv  string
+	profiles  []string
 }{
 	fileName: "skaffold.yaml",
 }
@@ -35,7 +36,7 @@ func NewCmdInspect() *cobra.Command {
 		WithDescription("Helper commands for Cloud Code IDEs to interact with and modify skaffold configuration files.").
 		WithPersistentFlagAdder(cmdInspectFlags).
 		Hidden().
-		WithCommands(cmdModules(), cmdProfiles())
+		WithCommands(cmdModules(), cmdProfiles(), cmdBuildEnv())
 }
 
 func cmdInspectFlags(f *pflag.FlagSet) {

cmd/skaffold/app/cmd/inspect_build_env.go

@@ -0,0 +1,54 @@
+/*
+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 cmd
+
+import (
+	"context"
+	"io"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/inspect"
+)
+
+func cmdBuildEnv() *cobra.Command {
+	return NewCmd("build-env").
+		WithDescription("Interact with skaffold build environment definitions.").
+		WithPersistentFlagAdder(cmdBuildEnvFlags).
+		WithCommands(cmdBuildEnvList())
+}
+
+func cmdBuildEnvList() *cobra.Command {
+	return NewCmd("list").
+		WithExample("Get list of target build environments with activated profiles p1 and p2", "inspect build-env list -p p1,p2 --format json").
+		WithDescription("Print the list of active build environments.").
+		WithFlagAdder(cmdBuildEnvListFlags).
+		NoArgs(listBuildEnv)
+}
+
+func listBuildEnv(ctx context.Context, out io.Writer) error {
+	return inspect.PrintBuildEnvsList(ctx, out, inspect.Options{Filename: inspectFlags.fileName, OutFormat: inspectFlags.outFormat, Modules: inspectFlags.modules, BuildEnvOptions: inspect.BuildEnvOptions{Profiles: inspectFlags.profiles}})
+}
+
+func cmdBuildEnvFlags(f *pflag.FlagSet) {
+	f.StringSliceVarP(&inspectFlags.modules, "module", "m", nil, "Names of modules to filter target action by.")
+}
+
+func cmdBuildEnvListFlags(f *pflag.FlagSet) {
+	f.StringSliceVarP(&inspectFlags.profiles, "profile", "p", nil, `Profile names to activate`)
+}

pkg/skaffold/inspect/build_env.go

@@ -0,0 +1,53 @@
+/*
+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/util"
+)
+
+type buildEnvList struct {
+	BuildEnvs []buildEnvEntry `json:"build_envs"`
+}
+
+type buildEnvEntry struct {
+	Type   string `json:"type"`
+	Path   string `json:"path"`
+	Module string `json:"module,omitempty"`
+}
+
+func PrintBuildEnvsList(ctx context.Context, out io.Writer, opts Options) error {
+	formatter := getOutputFormatter(out, opts.OutFormat)
+	cfgs, err := getConfigSetFunc(config.SkaffoldOptions{ConfigurationFile: opts.Filename, Profiles: opts.Profiles})
+	if err != nil {
+		return formatter.WriteErr(err)
+	}
+
+	l := &buildEnvList{BuildEnvs: []buildEnvEntry{}}
+	for _, c := range cfgs {
+		if len(opts.Modules) > 0 && !util.StrSliceContains(opts.Modules, c.Metadata.Name) {
+			continue
+		}
+		buildEnv := GetBuildEnv(&c.Build.BuildType)
+		l.BuildEnvs = append(l.BuildEnvs, buildEnvEntry{Type: string(buildEnv), Path: c.SourceFile, Module: c.Metadata.Name})
+	}
+	return formatter.Write(l)
+}

pkg/skaffold/inspect/build_env_test.go

@@ -0,0 +1,121 @@
+/*
+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 (
+	"bytes"
+	"context"
+	"errors"
+	"fmt"
+	"testing"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/parser"
+	sErrors "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/errors"
+	v1 "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest/v1"
+	"github.com/GoogleContainerTools/skaffold/testutil"
+)
+
+func TestPrintBuildEnvsList(t *testing.T) {
+	tests := []struct {
+		description string
+		profiles    []string
+		module      []string
+		err         error
+		expected    string
+	}{
+		{
+			description: "print all build environments",
+			expected: `{"build_envs":[` +
+				`{"type":"local","path":"path/to/cfg1","module":"cfg1"},` +
+				`{"type":"googleCloudBuild","path":"path/to/cfg2","module":"cfg2"}` +
+				"]}\n",
+		},
+		{
+			description: "print all build environments for one module",
+			expected: `{"build_envs":[` +
+				`{"type":"local","path":"path/to/cfg1","module":"cfg1"}` +
+				"]}\n",
+			module: []string{"cfg1"},
+		},
+		{
+			description: "print all build environments for two activated profiles",
+
+			expected: `{"build_envs":[` +
+				`{"type":"cluster","path":"path/to/cfg1","module":"cfg1"},` +
+				`{"type":"local","path":"path/to/cfg2","module":"cfg2"}` +
+				"]}\n",
+			profiles: []string{"local", "cluster"},
+		},
+		{
+			description: "print all build environments for one module and an activated profile",
+
+			expected: `{"build_envs":[` +
+				`{"type":"cluster","path":"path/to/cfg1","module":"cfg1"}` +
+				"]}\n",
+			module:   []string{"cfg1"},
+			profiles: []string{"cluster"},
+		},
+		{
+			description: "actionable error",
+			err:         sErrors.MainConfigFileNotFoundErr("path/to/skaffold.yaml", fmt.Errorf("failed to read file : %q", "skaffold.yaml")),
+			expected:    `{"errorCode":"CONFIG_FILE_NOT_FOUND_ERR","errorMessage":"unable to find configuration file \"path/to/skaffold.yaml\": failed to read file : \"skaffold.yaml\". Check that the specified configuration file exists at \"path/to/skaffold.yaml\"."}` + "\n",
+		},
+		{
+			description: "generic error",
+			err:         errors.New("some error occurred"),
+			expected:    `{"errorCode":"UNKNOWN_ERROR","errorMessage":"some error occurred"}` + "\n",
+		},
+	}
+
+	for _, test := range tests {
+		testutil.Run(t, test.description, func(t *testutil.T) {
+			configSet := parser.SkaffoldConfigSet{
+				&parser.SkaffoldConfigEntry{SkaffoldConfig: &v1.SkaffoldConfig{
+					Metadata: v1.Metadata{Name: "cfg1"},
+					Pipeline: v1.Pipeline{Build: v1.BuildConfig{BuildType: v1.BuildType{LocalBuild: &v1.LocalBuild{}}}},
+					Profiles: []v1.Profile{
+						{Name: "cluster", Pipeline: v1.Pipeline{Build: v1.BuildConfig{BuildType: v1.BuildType{Cluster: &v1.ClusterDetails{}}}}},
+					}}, SourceFile: "path/to/cfg1"},
+				&parser.SkaffoldConfigEntry{SkaffoldConfig: &v1.SkaffoldConfig{
+					Metadata: v1.Metadata{Name: "cfg2"},
+					Pipeline: v1.Pipeline{Build: v1.BuildConfig{BuildType: v1.BuildType{GoogleCloudBuild: &v1.GoogleCloudBuild{}}}},
+					Profiles: []v1.Profile{
+						{Name: "local", Pipeline: v1.Pipeline{Build: v1.BuildConfig{BuildType: v1.BuildType{LocalBuild: &v1.LocalBuild{}}}}},
+					}}, SourceFile: "path/to/cfg2"},
+			}
+			t.Override(&getConfigSetFunc, func(config.SkaffoldOptions) (parser.SkaffoldConfigSet, error) {
+				// mock profile activation
+				for _, c := range configSet {
+					for _, pName := range test.profiles {
+						for _, profile := range c.Profiles {
+							if profile.Name != pName {
+								continue
+							}
+							c.Build.BuildType = profile.Build.BuildType
+						}
+					}
+				}
+				return configSet, test.err
+			})
+			var buf bytes.Buffer
+			err := PrintBuildEnvsList(context.Background(), &buf, Options{OutFormat: "json", Modules: test.module, BuildEnvOptions: BuildEnvOptions{Profiles: test.profiles}})
+			t.CheckNoError(err)
+			t.CheckDeepEqual(test.expected, buf.String())
+		})
+	}
+}

pkg/skaffold/inspect/profiles.go

@@ -47,7 +47,7 @@ func PrintProfilesList(ctx context.Context, out io.Writer, opts Options) error {
 			continue
 		}
 		for _, p := range c.Profiles {
-			if !opts.BuildEnv.MatchesConfig(&p.Build.BuildType) {
+			if opts.BuildEnv != BuildEnvs.Unspecified && GetBuildEnv(&p.Build.BuildType) != opts.BuildEnv {
 				continue
 			}
 			l.Profiles = append(l.Profiles, profileEntry{Name: p.Name, Path: c.SourceFile, Module: c.Metadata.Name})

pkg/skaffold/inspect/types.go

@@ -31,6 +31,7 @@ type Options struct {
 	Modules []string
 
 	ProfilesOptions
+	BuildEnvOptions
 }
 
 // ProfilesOptions holds flag values for various `skaffold inspect profiles` commands
@@ -39,6 +40,12 @@ type ProfilesOptions struct {
 	BuildEnv BuildEnv
 }
 
+// BuildEnvOptions holds flag values for various `skaffold inspect build-env` commands
+type BuildEnvOptions struct {
+	// Profiles is the slice of profile names to activate.
+	Profiles []string
+}
+
 type BuildEnv string
 
 var (
@@ -53,17 +60,13 @@ var (
 	}
 )
 
-func (b BuildEnv) MatchesConfig(t *latest_v1.BuildType) bool {
-	switch b {
-	case BuildEnvs.Local:
-		return t.LocalBuild != nil
-	case BuildEnvs.GoogleCloudBuild:
-		return t.GoogleCloudBuild != nil
-	case BuildEnvs.Cluster:
-		return t.Cluster != nil
-	case BuildEnvs.Unspecified:
-		return true
+func GetBuildEnv(t *latest_v1.BuildType) BuildEnv {
+	switch {
+	case t.Cluster != nil:
+		return BuildEnvs.Cluster
+	case t.GoogleCloudBuild != nil:
+		return BuildEnvs.GoogleCloudBuild
 	default:
-		return false
+		return BuildEnvs.Local
 	}
 }