Merge pull request #2149 from dgageot/remove-duplicate-test-helper

Use testutil.NewTempDir() instead

Author: tejal29

pkg/skaffold/initializer/kubectl/kubectl_test.go

@@ -17,16 +17,17 @@ limitations under the License.
 package kubectl
 
 import (
-	"io/ioutil"
-	"os"
 	"testing"
 
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
 	"github.com/GoogleContainerTools/skaffold/testutil"
 )
 
 func TestGenerateKubeCtlPipeline(t *testing.T) {
-	content := []byte(`apiVersion: v1
+	tmpDir, delete := testutil.NewTempDir(t)
+	defer delete()
+
+	tmpDir.Write("deployment.yaml", `apiVersion: v1
 kind: Pod
 metadata:
   name: getting-started
@@ -35,8 +36,12 @@ spec:
   - name: getting-started
     image: gcr.io/k8s-skaffold/skaffold-example
 `)
-	filename := testutil.CreateTempFileWithContents(t, "", "deployment.yaml", content)
-	defer os.Remove(filename) // clean up
+	filename := tmpDir.Path("deployment.yaml")
+
+	k, err := New([]string{filename})
+	if err != nil {
+		t.Fatal("failed to create a pipeline")
+	}
 
 	expectedConfig := latest.DeployConfig{
 		DeployType: latest.DeployType{
@@ -45,54 +50,48 @@ spec:
 			},
 		},
 	}
-	actual := latest.DeployConfig{}
-	k, err := New([]string{filename})
-	if k != nil {
-		actual = k.GenerateDeployConfig()
-	}
-	testutil.CheckErrorAndDeepEqual(t, false, err, expectedConfig, actual)
+	testutil.CheckDeepEqual(t, expectedConfig, k.GenerateDeployConfig())
 }
 
 func TestParseImagesFromKubernetesYaml(t *testing.T) {
-	validContent := []byte(`apiVersion: v1
+	tests := []struct {
+		description string
+		contents    string
+		images      []string
+		shouldErr   bool
+	}{
+		{
+			description: "incorrect k8 yaml",
+			contents: `no apiVersion: t
+kind: Pod`,
+			images:    nil,
+			shouldErr: true,
+		},
+		{
+			description: "correct k8 yaml",
+			contents: `apiVersion: v1
 kind: Pod
 metadata:
   name: getting-started
 spec:
   containers:
   - name: getting-started
-    image: gcr.io/k8s-skaffold/skaffold-example`)
-	tests := []struct {
-		name     string
-		contents []byte
-		images   []string
-		err      bool
-	}{
-		{
-			name: "incorrect k8 yaml",
-			contents: []byte(`no apiVersion: t
-kind: Pod`),
-			images: nil,
-			err:    true,
-		},
-		{
-			name:     "correct k8 yaml",
-			contents: validContent,
-			images:   []string{"gcr.io/k8s-skaffold/skaffold-example"},
-			err:      false,
+    image: gcr.io/k8s-skaffold/skaffold-example`,
+			images:    []string{"gcr.io/k8s-skaffold/skaffold-example"},
+			shouldErr: false,
 		},
 	}
 
-	tmpDir, err := ioutil.TempDir("", "test")
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer os.Remove(tmpDir) // clean up
 	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			tmpFile := testutil.CreateTempFileWithContents(t, tmpDir, "deployment.yaml", test.contents)
-			images, err := parseImagesFromKubernetesYaml(tmpFile)
-			testutil.CheckErrorAndDeepEqual(t, test.err, err, test.images, images)
+		t.Run(test.description, func(t *testing.T) {
+			tmpDir, delete := testutil.NewTempDir(t)
+			defer delete()
+
+			tmpDir.Write("deployment.yaml", test.contents)
+
+			images, err := parseImagesFromKubernetesYaml(tmpDir.Path("deployment.yaml"))
+
+			testutil.CheckErrorAndDeepEqual(t, test.shouldErr, err, test.images, images)
 		})
 	}
 }

pkg/skaffold/initializer/util_test.go

@@ -17,7 +17,6 @@ limitations under the License.
 package initializer
 
 import (
-	"os"
 	"testing"
 
 	"github.com/GoogleContainerTools/skaffold/testutil"
@@ -62,40 +61,42 @@ func TestIsSupportedKubernetesFileExtension(t *testing.T) {
 
 func TestIsSkaffoldConfig(t *testing.T) {
 	tests := []struct {
-		name     string
-		contents []byte
-		expected bool
+		description string
+		contents    string
+		isValid     bool
 	}{
 		{
-			name: "valid skaffold config",
-			contents: []byte(`apiVersion: skaffold/v1beta6
+			description: "valid skaffold config",
+			contents: `apiVersion: skaffold/v1beta6
 kind: Config
 deploy:
-  kustomize: {}`),
-			expected: true,
+  kustomize: {}`,
+			isValid: true,
 		},
 		{
-			name:     "not a valid format",
-			contents: []byte("test"),
-			expected: false,
+			description: "not a valid format",
+			contents:    "test",
+			isValid:     false,
 		},
 		{
-			name: "invalid skaffold config version",
-			contents: []byte(`apiVersion: skaffold/v2beta1
+			description: "invalid skaffold config version",
+			contents: `apiVersion: skaffold/v2beta1
 kind: Config
 deploy:
-  kustomize: {}`),
-			expected: false,
+  kustomize: {}`,
+			isValid: false,
 		},
 	}
 	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			filename := testutil.CreateTempFileWithContents(t, "", "skaffold.yaml", test.contents)
-			defer os.Remove(filename) // clean up
-			if IsSkaffoldConfig(filename) != test.expected {
-				t.Errorf("expected to see %t for\n%s. but instead got %t", test.expected,
-					test.contents, !test.expected)
-			}
+		t.Run(test.description, func(t *testing.T) {
+			tmpDir, delete := testutil.NewTempDir(t)
+			defer delete()
+
+			tmpDir.Write("skaffold.yaml", test.contents)
+
+			isValid := IsSkaffoldConfig(tmpDir.Path("skaffold.yaml"))
+
+			testutil.CheckDeepEqual(t, test.isValid, isValid)
 		})
 	}
 }

testutil/util.go

@@ -19,7 +19,6 @@ package testutil
 import (
 	"errors"
 	"fmt"
-	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
 	"os"
@@ -156,20 +155,3 @@ func ServeFile(t *testing.T, content []byte) (url string, tearDown func()) {
 
 	return ts.URL, ts.Close
 }
-
-// CreateTempFileWithContents creates a temporary file in the dir specified or
-// os.TempDir by default with contents mentioned.
-func CreateTempFileWithContents(t *testing.T, dir string, name string, content []byte) string {
-	t.Helper()
-	tmpfile, err := ioutil.TempFile(dir, name)
-	if err != nil {
-		t.Fatal(err)
-	}
-	if _, err := tmpfile.Write(content); err != nil {
-		t.Fatal(err)
-	}
-	if err := tmpfile.Close(); err != nil {
-		t.Fatal(err)
-	}
-	return tmpfile.Name()
-}