Git name and email not properly reflect in commit message (#113)

When making a commit using the export command to a Git repository, the
configure name and email from the configuration file isn't properly
populating the git message.  That issue is addressed and the git commit
message is now properly updated.

This change also adds full unit testing for the runners repository
implementation.

Author: privateip

go.mod

@@ -53,6 +53,7 @@ require (
 	github.com/sourcegraph/conc v0.3.0 // indirect
 	github.com/spf13/afero v1.11.0 // indirect
 	github.com/spf13/cast v1.6.0 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
 	github.com/xanzy/ssh-agent v0.3.3 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect

go.sum

@@ -125,6 +125,7 @@ github.com/spf13/viper v1.19.0/go.mod h1:GQUN9bilAbhU/jgc1bKs99f/suXKeUMct8Adx5+
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
 github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=

internal/runners/adapters.go

@@ -35,9 +35,11 @@ func NewAdapterRunner(c client.Client, cfg *config.Config) *AdapterRunner {
 	}
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Reader Interface
-//
+/*
+******************************************************************************
+Reader Interface
+******************************************************************************
+*/
 
 // Get is the implementation of the command `get adapters`
 func (r *AdapterRunner) Get(in Request) (*Response, error) {
@@ -74,9 +76,11 @@ func (r *AdapterRunner) Describe(in Request) (*Response, error) {
 	}, nil
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Writer Interface
-//
+/*
+******************************************************************************
+Writer Interface
+******************************************************************************
+*/
 
 func (r *AdapterRunner) Create(in Request) (*Response, error) {
 	logger.Trace()
@@ -163,9 +167,11 @@ func (r *AdapterRunner) Clear(in Request) (*Response, error) {
 	return notImplemented(in)
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Editor Interface
-//
+/*
+******************************************************************************
+Editor Interface
+******************************************************************************
+*/
 
 // Edit implements the `edti adapter ...` command
 func (r *AdapterRunner) Edit(in Request) (*Response, error) {
@@ -193,9 +199,11 @@ func (r *AdapterRunner) Edit(in Request) (*Response, error) {
 	}, nil
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Copier Interface
-//
+/*
+******************************************************************************
+Copier Interface
+******************************************************************************
+*/
 
 func (r *AdapterRunner) Copy(in Request) (*Response, error) {
 	logger.Trace()
@@ -280,9 +288,11 @@ func (r *AdapterRunner) CopyTo(profile string, in any, replace bool) (any, error
 
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Importer Interface
-//
+/*
+******************************************************************************
+Importer Interface
+******************************************************************************
+*/
 
 // Import provides the implementation for `import adapter <filepath>`
 func (r *AdapterRunner) Import(in Request) (*Response, error) {
@@ -305,9 +315,11 @@ func (r *AdapterRunner) Import(in Request) (*Response, error) {
 	}, nil
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Exporter Interface
-//
+/*
+******************************************************************************
+Exporter Interface
+******************************************************************************
+*/
 
 // Export) provides the implementation for `export adapter <name>`
 func (r *AdapterRunner) Export(in Request) (*Response, error) {
@@ -333,7 +345,7 @@ func (r *AdapterRunner) Export(in Request) (*Response, error) {
 
 /*
 *******************************************************************************
-Inspector interfaceo
+Inspector interface
 *******************************************************************************
 */
 
@@ -352,9 +364,11 @@ func (r *AdapterRunner) Inspect(in Request) (*Response, error) {
 	}, nil
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Controller interface
-//
+/*
+*******************************************************************************
+Controller interface
+*******************************************************************************
+*/
 
 func (r *AdapterRunner) Start(in Request) (*Response, error) {
 	logger.Trace()
@@ -398,9 +412,11 @@ func (r *AdapterRunner) Restart(in Request) (*Response, error) {
 	}, nil
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Dumper Interface
-//
+/*
+*******************************************************************************
+Dumper interface
+*******************************************************************************
+*/
 
 // Dump implements the `dump adapters...` command
 func (r *AdapterRunner) Dump(in Request) (*Response, error) {
@@ -426,9 +442,11 @@ func (r *AdapterRunner) Dump(in Request) (*Response, error) {
 	}, nil
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Loader Interface
-//
+/*
+*******************************************************************************
+Loader interface
+*******************************************************************************
+*/
 
 // Load implements the `load adapters ...` command
 func (r *AdapterRunner) Load(in Request) (*Response, error) {
@@ -473,9 +491,11 @@ func (r *AdapterRunner) Load(in Request) (*Response, error) {
 	}, nil
 }
 
-//////////////////////////////////////////////////////////////////////////////
-// Private functions
-//
+/*
+*******************************************************************************
+Private functions
+*******************************************************************************
+*/
 
 func (r *AdapterRunner) importAdapter(in services.Adapter, replace bool) error {
 	logger.Trace()

internal/runners/exporter.go

@@ -86,7 +86,10 @@ func exportAssets(in Request, assets map[string]interface{}) error {
 			return e
 		}
 
-		repoPath, e = repo.Clone()
+		repoPath, e = repo.Clone(
+			&FileReaderImpl{},
+			&ClonerImpl{},
+		)
 		if e != nil {
 			return e
 		}

internal/runners/git.go

@@ -0,0 +1,69 @@
+// Copyright 2024 Itential Inc. All Rights Reserved
+// Unauthorized copying of this file, via any medium is strictly prohibited
+// Proprietary and confidential
+
+package runners
+
+import (
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+)
+
+// GitProviderImpl is the real implementation that uses go-git
+type GitProviderImpl struct{}
+
+func (p *GitProviderImpl) Open(path string) (GitRepository, error) {
+	repo, err := git.PlainOpen(path)
+	if err != nil {
+		return nil, err
+	}
+	return &GitRepositoryImpl{repo}, nil
+}
+
+// GitRepositoryImpl wraps go-git's Repository
+type GitRepositoryImpl struct {
+	repo *git.Repository
+}
+
+func (r *GitRepositoryImpl) Worktree() (GitWorktree, error) {
+	w, err := r.repo.Worktree()
+	if err != nil {
+		return nil, err
+	}
+	return &GitWorktreeImpl{w}, nil
+}
+
+func (r *GitRepositoryImpl) Push(opts *PushOptions) error {
+	return r.repo.Push(opts)
+}
+
+// GitWorktreeImpl wraps go-git's Worktree
+type GitWorktreeImpl struct {
+	w *git.Worktree
+}
+
+func (w *GitWorktreeImpl) AddGlob(pattern string) error {
+	return w.w.AddGlob(pattern)
+}
+
+func (w *GitWorktreeImpl) Status() (GitStatus, error) {
+	status, err := w.w.Status()
+	if err != nil {
+		return nil, err
+	}
+	return &GitStatusImpl{status}, nil
+}
+
+func (w *GitWorktreeImpl) Commit(msg string, opts *CommitOptions) (Hash, error) {
+	commitHash, err := w.w.Commit(msg, opts)
+	return plumbing.Hash(commitHash), err
+}
+
+// GitStatusImpl wraps go-git's Status object
+type GitStatusImpl struct {
+	status git.Status
+}
+
+func (s *GitStatusImpl) IsClean() bool {
+	return s.status.IsClean()
+}

internal/runners/importer.go

@@ -74,7 +74,7 @@ func importGetPathFromRequest(in Request) (string, error) {
 			return "", err
 		}
 
-		p, err := CloneRepository(r)
+		p, err := r.Clone(&FileReaderImpl{}, &ClonerImpl{})
 		if err != nil {
 			return "", err
 		}

internal/runners/interfaces.go

@@ -4,6 +4,11 @@
 
 package runners
 
+import (
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+)
+
 type Runner interface {
 }
 
@@ -55,3 +60,34 @@ type Dumper interface {
 type Loader interface {
 	Load(Request) (*Response, error)
 }
+
+type FileReader interface {
+	Read(path string) ([]byte, error)
+}
+
+type Cloner interface {
+	Clone(r RepositoryPayload) (string, error)
+}
+
+type GitRepository interface {
+	Worktree() (GitWorktree, error)
+	Push(options *PushOptions) error
+}
+
+type GitWorktree interface {
+	AddGlob(pattern string) error
+	Status() (GitStatus, error)
+	Commit(msg string, opts *CommitOptions) (Hash, error)
+}
+
+type GitStatus interface {
+	IsClean() bool
+}
+
+type GitProvider interface {
+	Open(path string) (GitRepository, error)
+}
+
+type PushOptions = git.PushOptions
+type CommitOptions = git.CommitOptions
+type Hash = plumbing.Hash

internal/runners/models.go

@@ -445,7 +445,10 @@ func (r *ModelRunner) Export(in Request) (*Response, error) {
 
 			var e error
 
-			repoPath, e = repo.Clone()
+			repoPath, e = repo.Clone(
+				&FileReaderImpl{},
+				&ClonerImpl{},
+			)
 			if e != nil {
 				return nil, e
 			}

internal/runners/prebuilts.go

@@ -352,7 +352,7 @@ func (r *PrebuiltRunner) Export(in Request) (*Response, error) {
 
 			var e error
 
-			repoPath, e = repo.Clone()
+			repoPath, e = repo.Clone(&FileReaderImpl{}, &ClonerImpl{})
 			if e != nil {
 				return nil, e
 			}

internal/runners/projects.go

@@ -359,7 +359,7 @@ func (r *ProjectRunner) Export(in Request) (*Response, error) {
 
 			var e error
 
-			repoPath, e = repo.Clone()
+			repoPath, e = repo.Clone(&FileReaderImpl{}, &ClonerImpl{})
 			if e != nil {
 				return nil, e
 			}