Merge pull request #774 from ZhuGongpu/feature-226

Support generating Cloud Build pipelines

Author: Liujingfang1

internal/cmdexport/cmdexport.go

@@ -18,6 +18,8 @@ package cmdexport
 import (
 	"fmt"
 	"os"
+	"path"
+	"strings"
 
 	"github.com/GoogleContainerTools/kpt/internal/cmdexport/orchestrators"
 	"github.com/GoogleContainerTools/kpt/internal/cmdexport/types"
@@ -30,7 +32,7 @@ func ExportCommand() *cobra.Command {
 	return GetExportRunner().Command
 }
 
-// Create a ExportRunner instance and wire it to the corresponding Command.
+// GetExportRunner creates a ExportRunner instance and wires it to the corresponding Command.
 func GetExportRunner() *ExportRunner {
 	r := &ExportRunner{PipelineConfig: &types.PipelineConfig{}}
 	c := &cobra.Command{
@@ -51,6 +53,10 @@ func GetExportRunner() *ExportRunner {
 				{
 					r.Pipeline = new(orchestrators.GitHubActions)
 				}
+			case "cloud-build":
+				{
+					r.Pipeline = new(orchestrators.CloudBuild)
+				}
 			default:
 				return fmt.Errorf("unsupported orchestrator %v", r.Orchestrator)
 			}
@@ -81,9 +87,17 @@ type ExportRunner struct {
 	Pipeline orchestrators.Pipeline
 }
 
-// Generate the pipeline and write it into a file or stdout.
+// runE generates the pipeline and writes it into a file or stdout.
 func (r *ExportRunner) runE(c *cobra.Command, args []string) error {
-	pipeline := r.Pipeline.Init(r.PipelineConfig).Generate()
+	if err := r.checkFnPaths(); err != nil {
+		return err
+	}
+
+	pipeline, e := r.Pipeline.Init(r.PipelineConfig).Generate()
+
+	if e != nil {
+		return e
+	}
 
 	if r.OutputFilePath != "" {
 		fo, err := os.Create(r.OutputFilePath)
@@ -99,3 +113,35 @@ func (r *ExportRunner) runE(c *cobra.Command, args []string) error {
 
 	return err
 }
+
+// checkPaths checks if fnPaths exist within the current directory.
+func (r *ExportRunner) checkFnPaths() error {
+	cwd, err := os.Getwd()
+	if err != nil {
+		return err
+	}
+	cwd = fmt.Sprintf("%s%s", cwd, string(os.PathSeparator))
+
+	for _, fnPath := range r.FnPaths {
+		p := fnPath
+		if !path.IsAbs(p) {
+			p = path.Join(cwd, p)
+		}
+
+		if !strings.HasPrefix(p, cwd) {
+			return fmt.Errorf(
+				"function path (%s) is not within the current working directory",
+				fnPath,
+			)
+		}
+
+		if _, err := os.Stat(p); os.IsNotExist(err) {
+			return fmt.Errorf(
+				`function path (%s) does not exist`,
+				fnPath,
+			)
+		}
+	}
+
+	return nil
+}

internal/cmdexport/cmdexport_test.go

@@ -25,16 +25,23 @@ import (
 	"gotest.tools/assert"
 )
 
-var tempDir, _ = ioutil.TempDir("", "kpt-fn-export-test")
+// Use file path as key, and content as value.
+type files map[string]string
 
 type TestCase struct {
 	description string
 	params      []string
 	expected    string
 	err         string
+	files       files
 }
 
 var testCases = []TestCase{
+	{
+		description: "fails on not providing enough args",
+		params:      []string{"github-actions"},
+		err:         "accepts 2 args, received 1",
+	},
 	{
 		description: "fails on an unsupported orchestrator",
 		params:      []string{"random-orchestrator", "."},
@@ -65,7 +72,7 @@ jobs:
 			"github-actions",
 			".",
 			"--output",
-			filepath.Join(tempDir, "main.yaml"),
+			"main.yaml",
 		},
 		expected: `
 name: kpt
@@ -85,7 +92,10 @@ jobs:
 	},
 	{
 		description: "exports a GitHub Actions pipeline with --fn-path",
-		params:      []string{"github-actions", ".", "--fn-path", "functions/"},
+		files: map[string]string{
+			"function.yaml": "",
+		},
+		params: []string{"github-actions", ".", "--fn-path", "function.yaml"},
 		expected: `
 name: kpt
 on:
@@ -99,14 +109,96 @@ jobs:
           - name: Run all kpt functions
             uses: docker://gongpu/kpt:latest
             with:
-                args: fn run . --fn-path functions/
+                args: fn run . --fn-path function.yaml
 `,
 	},
+	{
+		description: "exports a Cloud Build pipeline with --fn-path",
+		files: map[string]string{
+			"functions/function.yaml": "",
+		},
+		params: []string{
+			"cloud-build",
+			".",
+			"--fn-path",
+			"functions/",
+			"--output",
+			"cloudbuild.yaml",
+		},
+		expected: `
+steps:
+  - name: gongpu/kpt:latest
+    args:
+      - fn
+      - run
+      - .
+      - --fn-path
+      - functions/
+`,
+	},
+	{
+		description: "fails to export a Cloud Build pipeline with non-exist function path",
+		params: []string{
+			"cloud-build",
+			".",
+			"--fn-path",
+			"functions.yaml",
+			"--output",
+			"cloudbuild.yaml",
+		},
+		err: "function path (functions.yaml) does not exist",
+	},
+	{
+		description: "fails to export a Cloud Build pipeline with outside function path",
+		params: []string{
+			"cloud-build",
+			".",
+			"--fn-path",
+			"../functions/functions.yaml",
+			"--output",
+			"cloudbuild.yaml",
+		},
+		err: "function path (../functions/functions.yaml) is not within the current working directory",
+	},
+}
+
+func setupTempDir(files files) (dir string, err error) {
+	tempDir, err := ioutil.TempDir("", "kpt-fn-export-test")
+	if err != nil {
+		return "", err
+	}
+
+	for p, content := range files {
+		p = filepath.Join(tempDir, p)
+
+		err = os.MkdirAll(
+			filepath.Dir(p),
+			0755, // drwxr-xr-x
+		)
+		if err != nil {
+			return "", nil
+		}
+
+		err = ioutil.WriteFile(
+			p,
+			[]byte(content),
+			0644, // -rw-r--r--
+		)
+		if err != nil {
+			return "", err
+		}
+	}
+
+	return tempDir, nil
 }
 
 func TestCmdExport(t *testing.T) {
 	for i := range testCases {
 		testCase := testCases[i]
+		tempDir, err := setupTempDir(testCase.files)
+		assert.NilError(t, err)
+		err = os.Chdir(tempDir)
+		assert.NilError(t, err)
 
 		t.Run(testCase.description, func(t *testing.T) {
 			r := GetExportRunner()
@@ -136,7 +228,7 @@ func TestCmdExport(t *testing.T) {
 				assert.Equal(t, expected, actual)
 			}
 		})
-	}
 
-	_ = os.RemoveAll(tempDir)
+		_ = os.RemoveAll(tempDir)
+	}
 }

internal/cmdexport/orchestrators/cloudbuild.go

@@ -0,0 +1,59 @@
+// Copyright 2020 Google LLC
+//
+// 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 orchestrators
+
+import (
+	"github.com/GoogleContainerTools/kpt/internal/cmdexport/types"
+	"sigs.k8s.io/kustomize/kyaml/yaml"
+)
+
+// CloudBuild is a simplified representation of Cloud Build config.
+// @see https://cloud.google.com/cloud-build/docs/build-config
+type CloudBuild struct {
+	Steps []CloudBuildStep `yaml:",omitempty"`
+}
+
+type CloudBuildStep struct {
+	Name string   `yaml:",omitempty"`
+	Args []string `yaml:",omitempty"`
+}
+
+func (p *CloudBuild) Init(config *types.PipelineConfig) Pipeline {
+	step := CloudBuildStep{}
+	step.Name = KptImage
+	step.Args = []string{
+		"fn",
+		"run",
+		config.Dir,
+	}
+
+	if fnPaths := config.FnPaths; len(fnPaths) > 0 {
+		step.Args = append(
+			step.Args,
+			append(
+				[]string{"--fn-path"},
+				fnPaths...
+			)...
+		)
+	}
+
+	p.Steps = []CloudBuildStep{step}
+
+	return p
+}
+
+func (p *CloudBuild) Generate() (out []byte, err error) {
+	return yaml.Marshal(p)
+}

internal/cmdexport/orchestrators/cloudbuild_test.go

@@ -0,0 +1,75 @@
+// Copyright 2020 Google LLC
+//
+// 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 orchestrators
+
+import "github.com/GoogleContainerTools/kpt/internal/cmdexport/types"
+
+var cloudBuildTestCases = []testCase{
+	{
+		description: "generates a Cloud Build pipeline",
+		config: &types.PipelineConfig{
+			Dir:     ".",
+			FnPaths: nil,
+		},
+		expected: `
+steps:
+  - name: gongpu/kpt:latest
+    args:
+      - fn
+      - run
+      - .
+`,
+	},
+	{
+		description: "generates a Cloud Build pipeline with --fn-path",
+		config: &types.PipelineConfig{
+			Dir:     "resources",
+			FnPaths: []string{"config/function.yaml"},
+		},
+		expected: `
+steps:
+  - name: gongpu/kpt:latest
+    args:
+      - fn
+      - run
+      - resources
+      - --fn-path
+      - config/function.yaml
+`,
+	},
+	{
+		description: "generates a Cloud Build pipeline with multiple --fn-path",
+		config: &types.PipelineConfig{
+			Dir:     "resources",
+			FnPaths: []string{"config/function1.yaml", "config/function2.yaml"},
+		},
+		expected: `
+steps:
+  - name: gongpu/kpt:latest
+    args:
+      - fn
+      - run
+      - resources
+      - --fn-path
+      - config/function1.yaml
+      - config/function2.yaml
+`,
+	},
+}
+
+var cloudBuildTestSuite = testSuite{
+	pipeline:  &CloudBuild{},
+	testCases: cloudBuildTestCases,
+}

internal/cmdexport/orchestrators/githubactions.go

@@ -22,7 +22,7 @@ import (
 	"sigs.k8s.io/kustomize/kyaml/yaml"
 )
 
-// Represent a GitHub Actions workflow.
+// GitHubActions represents a GitHub Actions workflow.
 // @see https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions
 type GitHubActions struct {
 	Name string                          `yaml:",omitempty"`
@@ -82,8 +82,6 @@ func (p *GitHubActions) Init(config *types.PipelineConfig) Pipeline {
 	return p
 }
 
-func (p *GitHubActions) Generate() []byte {
-	data, _ := yaml.Marshal(p)
-
-	return data
+func (p *GitHubActions) Generate() (out []byte, err error) {
+	return yaml.Marshal(p)
 }