Merge pull request #2617 from marlon-gamez/refactor

refactor code used by pkg/skaffold/runner/generate_pipeline.go

pkg/skaffold/generate_pipeline/generate_pipeline.go

@@ -0,0 +1,215 @@
+/*
+Copyright 2019 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 generatepipeline
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"io"
+	"os"
+	"os/exec"
+
+	"github.com/ghodss/yaml"
+	"github.com/pkg/errors"
+
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/pipeline"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/version"
+
+	tekton "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1alpha1"
+	corev1 "k8s.io/api/core/v1"
+)
+
+func Yaml(out io.Writer, config *latest.SkaffoldConfig) (*bytes.Buffer, error) {
+	// Generate git resource for pipeline
+	gitResource, err := generateGitResource()
+	if err != nil {
+		return nil, errors.Wrap(err, "generating git resource for pipeline")
+	}
+
+	// Generate build task for pipeline
+	var tasks []*tekton.Task
+	taskBuild, err := generateBuildTask(config.Pipeline.Build)
+	if err != nil {
+		return nil, errors.Wrap(err, "generating build task")
+	}
+	tasks = append(tasks, taskBuild)
+
+	// Generate deploy task for pipeline
+	taskDeploy, err := generateDeployTask(config.Pipeline.Deploy)
+	if err != nil {
+		return nil, errors.Wrap(err, "generating deploy task")
+	}
+	tasks = append(tasks, taskDeploy)
+
+	// Generate pipeline from git resource and tasks
+	pipeline, err := generatePipeline(tasks)
+	if err != nil {
+		return nil, errors.Wrap(err, "generating tekton pipeline")
+	}
+
+	// json.Marshal all pieces of pipeline, then convert all jsons to yamls
+	var jsons [][]byte
+	bGitResource, err := json.Marshal(gitResource)
+	if err != nil {
+		return nil, errors.Wrap(err, "marshaling git resource")
+	}
+	jsons = append(jsons, bGitResource)
+	for _, task := range tasks {
+		bTask, err := json.Marshal(task)
+		if err != nil {
+			return nil, errors.Wrap(err, "marshaling task")
+		}
+		jsons = append(jsons, bTask)
+	}
+	bPipeline, err := json.Marshal(pipeline)
+	if err != nil {
+		return nil, errors.Wrap(err, "marshaling pipeline")
+	}
+	jsons = append(jsons, bPipeline)
+
+	output := bytes.NewBuffer([]byte{})
+	for _, item := range jsons {
+		itemYaml, err := yaml.JSONToYAML(item)
+		if err != nil {
+			return nil, errors.Wrap(err, "converting jsons to yamls")
+		}
+		output.Write(append(itemYaml, []byte("---\n")...))
+	}
+	return output, nil
+}
+
+func generateGitResource() (*tekton.PipelineResource, error) {
+	// Get git repo url
+	gitURL := os.Getenv("PIPELINE_GIT_URL")
+	if gitURL == "" {
+		getGitRepo := exec.Command("git", "config", "--get", "remote.origin.url")
+		bGitRepo, err := getGitRepo.Output()
+		if err != nil {
+			return nil, errors.Wrap(err, "getting git repo from git config")
+		}
+		gitURL = string(bGitRepo)
+	}
+
+	return pipeline.NewGitResource("source-git", gitURL), nil
+}
+
+func generateBuildTask(buildConfig latest.BuildConfig) (*tekton.Task, error) {
+	if len(buildConfig.Artifacts) == 0 {
+		return nil, errors.New("no artifacts to build")
+	}
+
+	skaffoldVersion := os.Getenv("PIPELINE_SKAFFOLD_VERSION")
+	if skaffoldVersion == "" {
+		skaffoldVersion = version.Get().Version
+	}
+
+	resources := []tekton.TaskResource{
+		{
+			Name: "source",
+			Type: tekton.PipelineResourceTypeGit,
+		},
+	}
+	steps := []corev1.Container{
+		{
+			Name:       "run-build",
+			Image:      fmt.Sprintf("gcr.io/k8s-skaffold/skaffold:%s", skaffoldVersion),
+			WorkingDir: "/workspace/source",
+			Command:    []string{"skaffold"},
+			Args: []string{"build",
+				"--filename", "skaffold.yaml",
+				"--profile", "oncluster",
+				"--file-output", "build.out",
+			},
+		},
+	}
+
+	return pipeline.NewTask("skaffold-build", resources, steps), nil
+}
+
+func generateDeployTask(deployConfig latest.DeployConfig) (*tekton.Task, error) {
+	if deployConfig.HelmDeploy == nil && deployConfig.KubectlDeploy == nil && deployConfig.KustomizeDeploy == nil {
+		return nil, errors.New("no Helm/Kubectl/Kustomize deploy config")
+	}
+
+	skaffoldVersion := os.Getenv("PIPELINE_SKAFFOLD_VERSION")
+	if skaffoldVersion == "" {
+		skaffoldVersion = version.Get().Version
+	}
+
+	resources := []tekton.TaskResource{
+		{
+			Name: "source",
+			Type: tekton.PipelineResourceTypeGit,
+		},
+	}
+	steps := []corev1.Container{
+		{
+			Name:       "run-deploy",
+			Image:      fmt.Sprintf("gcr.io/k8s-skaffold/skaffold:%s", skaffoldVersion),
+			WorkingDir: "/workspace/source",
+			Command:    []string{"skaffold"},
+			Args: []string{
+				"deploy",
+				"--filename", "skaffold.yaml",
+				"--profile", "oncluster",
+				"--build-artifacts", "build.out",
+			},
+		},
+	}
+
+	return pipeline.NewTask("skaffold-deploy", resources, steps), nil
+}
+
+func generatePipeline(tasks []*tekton.Task) (*tekton.Pipeline, error) {
+	if len(tasks) == 0 {
+		return nil, errors.New("no tasks to add to pipeline")
+	}
+
+	resources := []tekton.PipelineDeclaredResource{
+		{
+			Name: "source-repo",
+			Type: tekton.PipelineResourceTypeGit,
+		},
+	}
+	// Create tasks in pipeline spec for all corresponding tasks
+	pipelineTasks := make([]tekton.PipelineTask, 0)
+	for i, task := range tasks {
+		pipelineTask := tekton.PipelineTask{
+			Name: fmt.Sprintf("%s-task", task.Name),
+			TaskRef: tekton.TaskRef{
+				Name: task.Name,
+			},
+			RunAfter: []string{},
+			Resources: &tekton.PipelineTaskResources{
+				Inputs: []tekton.PipelineTaskInputResource{
+					{
+						Name:     "source",
+						Resource: "source-repo",
+					},
+				},
+			},
+		}
+		if i > 0 {
+			pipelineTask.RunAfter = []string{pipelineTasks[i-1].Name}
+		}
+		pipelineTasks = append(pipelineTasks, pipelineTask)
+	}
+
+	return pipeline.NewPipeline("skaffold-pipeline", resources, pipelineTasks), nil
+}

pkg/skaffold/runner/generate_pipeline_test.go → pkg/skaffold/generate_pipeline/generate_pipeline_test.go

@@ -14,10 +14,9 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package runner
+package generatepipeline
 
 import (
-	"io/ioutil"
 	"testing"
 
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
@@ -227,53 +226,3 @@ func TestGenerateDeployTask(t *testing.T) {
 		})
 	}
 }
-
-func TestGenerateProfile(t *testing.T) {
-	var tests = []struct {
-		description     string
-		skaffoldConfig  *latest.SkaffoldConfig
-		expectedProfile *latest.Profile
-		responses       []string
-		shouldErr       bool
-	}{
-		{
-			description: "successful profile generation",
-			skaffoldConfig: &latest.SkaffoldConfig{
-				Pipeline: latest.Pipeline{
-					Build: latest.BuildConfig{
-						Artifacts: []*latest.Artifact{
-							{
-								ImageName: "test",
-							},
-						},
-					},
-				},
-			},
-			expectedProfile: &latest.Profile{
-				Name: "oncluster",
-				Pipeline: latest.Pipeline{
-					Build: latest.BuildConfig{
-						Artifacts: []*latest.Artifact{
-							{
-								ImageName: "test-pipeline",
-							},
-						},
-						BuildType: latest.BuildType{
-							Cluster: &latest.ClusterDetails{
-								PullSecretName: "kaniko-secret",
-							},
-						},
-					},
-				},
-			},
-			shouldErr: false,
-		},
-	}
-
-	for _, test := range tests {
-		testutil.Run(t, test.description, func(t *testutil.T) {
-			profile, err := generateProfile(ioutil.Discard, test.skaffoldConfig)
-			t.CheckErrorAndDeepEqual(test.shouldErr, err, test.expectedProfile, profile)
-		})
-	}
-}