adding parser and util tests

Signed-off-by: Michael Hoang <[email protected]>

Author: mike-hoang

pkg/devfile/parser/parse.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"github.com/devfile/api/v2/pkg/attributes"
+	registryLibrary "github.com/devfile/registry-support/registry-library/library"
 	"io/ioutil"
 	"net/url"
 	"os"
@@ -23,8 +24,6 @@ import (
 
 	"reflect"
 
-	registryLibrary "github.com/devfile/registry-support/registry-library/library"
-
 	v1 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	apiOverride "github.com/devfile/api/v2/pkg/utils/overriding"
 	"github.com/devfile/api/v2/pkg/validation"
@@ -402,14 +401,17 @@ func parseFromRegistry(importReference v1.ImportReference, resolveCtx *resolutio
 	id := importReference.Id
 	registryURL := importReference.RegistryUrl
 	destDir := "."
-	tempDir, err := ioutil.TempDir("", "")
+
+	// contains the downloaded stack from the registry
+	tempDir, _ := ioutil.TempDir("", "")
 	defer os.RemoveAll(tempDir)
 
 	if registryURL != "" {
-		err = registryLibrary.PullStackFromRegistry(registryURL, id, tempDir, registryLibrary.RegistryOptions{})
-		err = util.CopyAllDirFiles(tempDir, destDir)
-
-		devfileContent, err := ioutil.ReadFile(path.Join(tempDir, "devfile.yaml"))
+		err = getStackFromRegistry(id, registryURL, tempDir, destDir)
+		if err != nil {
+			return DevfileObj{}, err
+		}
+		devfileContent, err := getDevfileFromDir(tempDir)
 		if err != nil {
 			devfileContent, err = getDevfileFromRegistry(id, registryURL, importReference.Version)
 			if err != nil {
@@ -426,10 +428,11 @@ func parseFromRegistry(importReference v1.ImportReference, resolveCtx *resolutio
 
 	} else if tool.registryURLs != nil {
 		for _, registryURL := range tool.registryURLs {
-			err = registryLibrary.PullStackFromRegistry(registryURL, id, tempDir, registryLibrary.RegistryOptions{})
-			err = util.CopyAllDirFiles(tempDir, destDir)
-
-			devfileContent, err := ioutil.ReadFile(path.Join(tempDir, "devfile.yaml"))
+			err = getStackFromRegistry(id, registryURL, tempDir, destDir)
+			if err != nil {
+				return DevfileObj{}, err
+			}
+			devfileContent, err := getDevfileFromDir(tempDir)
 			if err != nil {
 				devfileContent, err = getDevfileFromRegistry(id, registryURL, importReference.Version)
 			}
@@ -451,6 +454,24 @@ func parseFromRegistry(importReference v1.ImportReference, resolveCtx *resolutio
 	return DevfileObj{}, fmt.Errorf("failed to get id: %s from registry URLs provided", id)
 }
 
+func getStackFromRegistry(id, registryURL, stackDir, destDir string) error {
+	if !strings.HasPrefix(registryURL, "http://") && !strings.HasPrefix(registryURL, "https://") {
+		return fmt.Errorf("the provided registryURL: %s is not a valid URL", registryURL)
+	}
+	registryLibrary.PullStackFromRegistry(registryURL, id, stackDir, registryLibrary.RegistryOptions{})
+	util.CopyAllDirFiles(stackDir, destDir)
+
+	return nil
+}
+
+func getDevfileFromDir(dir string) ([]byte, error) {
+	devfileContent, err := ioutil.ReadFile(path.Join(dir, "devfile.yaml"))
+	if err != nil {
+		return nil, fmt.Errorf("failed to get devfile from stack registry")
+	}
+	return devfileContent, err
+}
+
 func getDevfileFromRegistry(id, registryURL, version string) ([]byte, error) {
 	if !strings.HasPrefix(registryURL, "http://") && !strings.HasPrefix(registryURL, "https://") {
 		return nil, fmt.Errorf("the provided registryURL: %s is not a valid URL", registryURL)

pkg/devfile/parser/parse_test.go

@@ -20,6 +20,7 @@ import (
 	"net/http/httptest"
 	"os"
 	"path"
+	"path/filepath"
 	"reflect"
 	"sigs.k8s.io/yaml"
 	"strings"
@@ -4317,6 +4318,52 @@ func Test_parseFromRegistry(t *testing.T) {
 	}
 }
 
+func Test_getDevfileFromDir(t *testing.T) {
+	tempDir, err := ioutil.TempDir("", "")
+	if err != nil {
+		t.Errorf("Failed to create temp dir: %s, error: %v", tempDir, err)
+	}
+	defer os.RemoveAll(tempDir)
+
+	devfile := filepath.Join(tempDir, "devfile.yaml")
+	if err := ioutil.WriteFile(devfile, []byte(""), 0666); err != nil {
+		t.Errorf("Failed to create temp devfile, error: %v", err)
+	}
+
+	missingDevfileDir := "no/devfile/here"
+
+	tests := []struct {
+		name    string
+		dir     string
+		wantErr bool
+	}{
+		{
+			name:    "should be able to get devfile from dir",
+			dir:     tempDir,
+			wantErr: false,
+		},
+		{
+			name:    "should fail if directory doesn't have devfile",
+			dir:     missingDevfileDir,
+			wantErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gotErr := false
+			_, err = getDevfileFromDir(tt.dir)
+			if err != nil {
+				gotErr = true
+			}
+
+			if !reflect.DeepEqual(gotErr, tt.wantErr) {
+				t.Errorf("Got error: %t, want error: %t", gotErr, tt.wantErr)
+			}
+		})
+	}
+}
+
 func Test_parseFromKubeCRD(t *testing.T) {
 	const (
 		namespace  = "default"

pkg/util/util_test.go

@@ -0,0 +1,85 @@
+//
+// Copyright 2021-2022 Red Hat, Inc.
+//
+// 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 util
+
+import (
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"reflect"
+	"testing"
+)
+
+// copied from https://github.com/redhat-developer/odo/blob/main/pkg/util/util_test.go#L1618
+func TestCopyFile(t *testing.T) {
+	// Create temp dir
+	tempDir, err := ioutil.TempDir("", "")
+	if err != nil {
+		t.Errorf("Failed to create temp dir: %s, error: %v", tempDir, err)
+	}
+
+	// Create temp file under temp dir as source file
+	tempFile, err := ioutil.TempFile(tempDir, "")
+	if err != nil {
+		t.Errorf("Failed to create temp file: %s, error: %v", tempFile.Name(), err)
+	}
+	defer tempFile.Close()
+
+	srcPath := tempFile.Name()
+	fakePath := "!@#/**"
+	dstPath := filepath.Join(tempDir, "dstFile")
+	info, _ := os.Stat(srcPath)
+
+	tests := []struct {
+		name    string
+		srcPath string
+		dstPath string
+		wantErr bool
+	}{
+		{
+			name:    "should be able to copy file to destination path",
+			srcPath: srcPath,
+			dstPath: dstPath,
+			wantErr: false,
+		},
+		{
+			name:    "should fail if source path is invalid",
+			srcPath: fakePath,
+			dstPath: dstPath,
+			wantErr: true,
+		},
+		{
+			name:    "should fail if destination path is invalid",
+			srcPath: srcPath,
+			dstPath: fakePath,
+			wantErr: true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gotErr := false
+			err = CopyFile(tt.srcPath, tt.dstPath, info)
+			if err != nil {
+				gotErr = true
+			}
+
+			if !reflect.DeepEqual(gotErr, tt.wantErr) {
+				t.Errorf("Got error: %t, want error: %t", gotErr, tt.wantErr)
+			}
+		})
+	}
+}