chore: fixed flanksource#29

files/files.go

@@ -7,10 +7,12 @@ import (
 	"compress/gzip"
 	"context"
 	"encoding/hex"
+	"errors"
 	"fmt"
 	"io"
 	"io/ioutil"
 	"math/rand"
+	"net/url"
 	"os"
 	"os/exec"
 	"path"
@@ -22,6 +24,16 @@ import (
 	"github.com/ulikunitz/xz"
 )
 
+//	Errors
+//
+var (
+	ErrExists      = errors.New("file already exist")
+	ErrNotExists   = errors.New("file doesn't exist")
+	ErrInvalidPath = errors.New("file path invalid")
+	ErrIsDir       = errors.New("path is a directory")
+	ErrInvalidURL  = errors.New("invalid url")
+)
+
 //GzipFile takes the path to a file and returns a Gzip comppressed byte slice
 func GzipFile(path string) ([]byte, error) {
 	var buf bytes.Buffer
@@ -316,14 +328,25 @@ func GetBaseName(filename string) string {
 
 // Getter gets a directory or file using the Hashicorp go-getter library
 // See https://github.com/hashicorp/go-getter
-func Getter(url, dst string) error {
+func Getter(source, dst string) error {
+
+	//	Validate the URL first.
+	url, err := url.ParseRequestURI(source)
+	if err != nil {
+		return err
+	}
+
 	pwd, _ := os.Getwd()
 
+	//	If the destination is empty,
+	//	choose the current working directory.
+	if dst == "" {
+		dst, _ = os.Getwd()
+	}
+
 	stashed := false
 	if Exists(dst + "/.git") {
 		cmd := exec.Command("git", "stash")
-		cmd.Dir = pwd
-
 		cmd.Dir = dst
 		cmd.Stderr = os.Stderr
 		cmd.Stdout = os.Stdout
@@ -335,14 +358,16 @@ func Getter(url, dst string) error {
 	}
 	client := &getter.Client{
 		Ctx:     context.TODO(),
-		Src:     url,
+		Src:     source,
 		Dst:     dst,
 		Pwd:     pwd,
 		Mode:    getter.ClientModeDir,
 		Options: []getter.ClientOption{},
 	}
+
 	logger.Infof("Downloading %s -> %s", url, dst)
-	err := client.Get()
+	err = client.Get()
+
 	if stashed {
 		cmd := exec.Command("git", "stash", "pop")
 		cmd.Dir = dst
@@ -359,3 +384,79 @@ func TempFileName(prefix, suffix string) string {
 	rand.Read(randBytes)
 	return filepath.Join(os.TempDir(), prefix+hex.EncodeToString(randBytes)+suffix)
 }
+
+//	Resolve File
+//
+//	If file location passed as argument is a valid,
+//	then it returns the contents of the file.
+//	Otherwise, an error.
+func ResolveFile(file string) (string, error) {
+
+	var payload string
+
+	//	Ensure it is a valid file path,
+	//	by ensuring there an extension suffixed at the end.
+	//
+	//	This will validate both a file in the filesystem,
+	//	as well as the URL source for a file.
+	if filepath.Ext(file) == "" {
+		return payload, ErrInvalidPath
+	}
+
+	//	Try to parse the file as a URL,
+	//	and go-get the file if it a valid URL.
+	//
+	//	For some reason, this inbuilt parser is broken
+	//	and it even matches relative paths that need not be URLs.
+	//	But we still need to parse the URL so that we can
+	//	validate the scheme to detect a URL.
+	url, err := url.ParseRequestURI(file)
+
+	//	Ensure the scheme is HTTP or HTTPS.
+	if err == nil &&
+		url.Scheme != "" &&
+		(strings.ToLower(url.Scheme) == "http" ||
+			strings.ToLower(url.Scheme) == "https") {
+
+		//	Try to go-get the file.
+		return payload, Getter(filepath.Dir(file), "")
+	}
+
+	//	Since, it is not a URL,
+	//	we must validate as a source in the filesystem.
+
+	//	Ensure the file exists.
+	if !Exists(file) {
+		return payload, ErrNotExists
+	}
+
+	data, err := os.ReadFile(file)
+	if err != nil {
+		return payload, err
+	}
+
+	//	Update the response payload.
+	payload = string(data)
+
+	return payload, nil
+}
+
+//	ResolveFiles
+//
+//	Calls ResolveFile(filepath) function on an array of files.
+func ResolveFiles(files []string) (map[string]string, error) {
+
+	var payload map[string]string
+
+	for _, source := range files {
+
+		response, err := ResolveFile(source)
+		if err != nil {
+			return nil, errors.New(strings.Join([]string{source, err.Error()}, " : "))
+		}
+
+		payload[source] = response
+	}
+
+	return payload, nil
+}

files/files_test.go

@@ -1,6 +1,8 @@
 package files
 
-import "testing"
+import (
+	"testing"
+)
 
 func TestIsValidPathType(t *testing.T) {
 	type args struct {
@@ -26,3 +28,27 @@ func TestIsValidPathType(t *testing.T) {
 		})
 	}
 }
+
+func TestResolveFile(t *testing.T) {
+	type args struct {
+		file string
+	}
+	tests := []struct {
+		name    string
+		args    args
+		wantErr bool
+	}{
+		{"directory", args{"/Users/mrinalwahal/go/src/github.com/flanksource/regen"}, true},
+		{"correctFile", args{"/Users/mrinalwahal/go/src/github.com/flanksource/regen/file.temp"}, false},
+		//	{"url", args{"https://github.com/mrinalwahal/portfolio/README.md"}, false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err := ResolveFile(tt.args.file)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("%v: error = %v, wantErr %v", tt.name, err, tt.wantErr)
+				return
+			}
+		})
+	}
+}

go.mod

@@ -3,26 +3,41 @@ module github.com/flanksource/commons
 go 1.13
 
 require (
+	contrib.go.opencensus.io/resource v0.1.1 // indirect
+	github.com/Azure/azure-amqp-common-go/v2 v2.1.0 // indirect
 	github.com/Masterminds/semver v1.5.0 // indirect
 	github.com/Masterminds/sprig v2.22.0+incompatible
 	github.com/antonmedv/expr v1.9.0
+	github.com/boltdb/bolt v1.3.1 // indirect
+	github.com/cpuguy83/go-md2man v1.0.10 // indirect
 	github.com/dustin/go-humanize v1.0.0
+	github.com/dustin/gojson v0.0.0-20160307161227-2e71ec9dd5ad // indirect
+	github.com/fullsailor/pkcs7 v0.0.0-20190404230743-d7302db945fa // indirect
 	github.com/ghodss/yaml v1.0.0
-	github.com/hairyhenderson/gomplate/v3 v3.6.0
+	github.com/go-ldap/ldap v3.0.2+incompatible // indirect
+	github.com/googleapis/gax-go v2.0.2+incompatible // indirect
+	github.com/hairyhenderson/gomplate/v3 v3.11.2
 	github.com/hashicorp/go-getter v1.4.1
-	github.com/hashicorp/vault/api v1.0.4
+	github.com/hashicorp/go.net v0.0.1 // indirect
+	github.com/hashicorp/vault/api v1.6.0
 	github.com/huandu/xstrings v1.3.2 // indirect
-	github.com/imdario/mergo v0.3.12 // indirect
-	github.com/kr/pretty v0.2.0
-	github.com/onsi/gomega v1.9.0
+	github.com/kr/pretty v0.2.1
+	github.com/mitchellh/gox v0.4.0 // indirect
+	github.com/mitchellh/iochan v1.0.0 // indirect
+	github.com/onsi/gomega v1.19.0
 	github.com/pkg/errors v0.9.1
-	github.com/sirupsen/logrus v1.7.0
-	github.com/smartystreets/assertions v1.0.0 // indirect
+	github.com/rainycape/unidecode v0.0.0-20150907023854-cb7f23ec59be // indirect
+	github.com/sirupsen/logrus v1.8.1
+	github.com/smartystreets/goconvey v1.6.4 // indirect
 	github.com/spf13/pflag v1.0.5
+	github.com/spf13/viper v1.3.2 // indirect
 	github.com/ulikunitz/xz v0.5.10
 	github.com/vbauerster/mpb/v5 v5.0.3
-	go.uber.org/zap v1.15.0
-	golang.org/x/crypto v0.0.0-20200317142112-1b76d66859c6
-	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15
-	gopkg.in/flanksource/yaml.v3 v3.1.0
+	github.com/zealic/xignore v0.3.3 // indirect
+	go.uber.org/zap v1.21.0
+	golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e
+	gopkg.in/asn1-ber.v1 v1.0.0-20181015200546-f715ec2f112d // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c
+	gopkg.in/src-d/go-git.v4 v4.13.1 // indirect
+	k8s.io/client-go v0.25.0 // indirect
 )