v3.0 (feat): add fs package to handle user directory and cmf inner directory

Author: Rodrigonavarro23

fs/fs.go

@@ -0,0 +1,66 @@
+package fs
+
+import (
+	"errors"
+	"io/ioutil"
+	"os"
+)
+
+// GetFileFromVirtualFSError vfs.ReadFileSync fail
+const GetFileFromVirtualFSError = "open file from vfs error"
+
+// GetFileFromFSError ioutil.ReadFile fail
+const GetFileFromFSError = "open file from user fs error"
+
+type fs struct {
+	vfs VFS
+}
+
+// VFS VirtualFS main object
+type VFS interface {
+	ReadFile(path string) ([]byte, error)
+}
+
+// FS file system interface
+type FS interface {
+	GetFileFromVirtualFS(path string) (string, error)
+	GetFileFromFS(path string) (string, error)
+	GetCurrentDirectory() (string, error)
+}
+
+// NewFs return new file system with virtual file system
+func NewFs(vfs VFS) FS {
+	return &fs{
+		vfs: vfs,
+	}
+}
+
+// GetFileFromVirtualFS return a file from virtual fs
+func (vfs *fs) GetFileFromVirtualFS(path string) (string, error) {
+	file, err := vfs.vfs.ReadFile(path)
+	if err != nil {
+		return "", errors.New(GetFileFromVirtualFSError)
+	}
+
+	return string(file), nil
+}
+
+// GetFileFromFS return a file from user fs
+func (vfs *fs) GetFileFromFS(path string) (string, error) {
+	file, err := ioutil.ReadFile(path)
+	if err != nil {
+		return "", errors.New(GetFileFromFSError)
+	}
+
+	return string(file), nil
+}
+
+// GetCurrentDirectory return user current directory
+func (vfs *fs) GetCurrentDirectory() (string, error) {
+	path, err := os.Getwd()
+	if err != nil {
+		return "", errors.New(GetFileFromFSError)
+	}
+
+	return path, nil
+}

fs/fs_test.go

@@ -0,0 +1,68 @@
+package fs_test
+
+import (
+	"errors"
+	"os"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"github.com/walmartdigital/commit-message-formatter/fs"
+	"github.com/walmartdigital/commit-message-formatter/mocks"
+)
+
+var ctrl *gomock.Controller
+
+func TestAll(t *testing.T) {
+	ctrl = gomock.NewController(t)
+	defer ctrl.Finish()
+
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "fs tests")
+}
+
+var _ = Describe("fs package", func() {
+	var (
+		fakeVFS *mocks.MockVFS
+	)
+
+	BeforeEach(func() {
+		fakeVFS = mocks.NewMockVFS(ctrl)
+	})
+
+	It("should return a file from VirtualFS", func() {
+		fakeVFS.EXPECT().ReadFile(gomock.Any().String()).Return([]byte{}, nil).Times(1)
+
+		vfs := fs.NewFs(fakeVFS)
+		file, err := vfs.GetFileFromVirtualFS(gomock.Any().String())
+
+		Expect(vfs).ToNot(BeNil())
+		Expect(err).To(BeNil())
+		Expect(file).To(Equal(""))
+	})
+
+	It("should not return a file from VirtualFS when readFile fails", func() {
+		fakeVFS.EXPECT().ReadFile(gomock.Any().String()).Return([]byte(""), errors.New(gomock.Any().String())).Times(1)
+
+		vfs := fs.NewFs(fakeVFS)
+		file, err := vfs.GetFileFromVirtualFS(gomock.Any().String())
+
+		Expect(vfs).ToNot(BeNil())
+		Expect(file).To(Equal(""))
+		Expect(err).To(Equal(errors.New(fs.GetFileFromVirtualFSError)))
+	})
+
+	It("should return a file from user FS", func() {
+
+		vfs := fs.NewFs(fakeVFS)
+		folder, _ := os.Getwd()
+		filePath := folder + "/fs.go"
+		file, err := vfs.GetFileFromFS(filePath)
+
+		Expect(vfs).ToNot(BeNil())
+		Expect(err).To(BeNil())
+		Expect(file).ToNot(Equal(""))
+	})
+})