Rework gitutils package to make it testable

server/internal/git/client.go

@@ -0,0 +1,176 @@
+// Package git provides functionalities to interact with Git repositories, including cloning, pulling, committing, and pushing changes.
+package git
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing/transport/http"
+)
+
+// Config holds the configuration for a Git client
+type Config struct {
+	URL      string
+	Username string
+	Token    string
+	WorkDir  string
+}
+
+// Client defines the interface for Git operations
+type Client interface {
+	Clone() error
+	Pull() error
+	Commit(message string) error
+	Push() error
+	EnsureRepo() error
+}
+
+// client implements the Client interface
+type client struct {
+	Config
+	repo *git.Repository
+}
+
+// New creates a new Client instance
+// Parameters:
+// - url: the URL of the Git repository
+// - username: the username for the Git repository
+// - token: the access token for the Git repository
+// - workDir: the local directory to clone the repository to
+// Returns:
+// - Client: the Git client
+func New(url, username, token, workDir string) Client {
+	return &client{
+		Config: Config{
+			URL:      url,
+			Username: username,
+			Token:    token,
+			WorkDir:  workDir,
+		},
+	}
+}
+
+// Clone clones the Git repository to the local directory
+// Returns:
+// - error: any error that occurred during cloning
+func (c *client) Clone() error {
+	auth := &http.BasicAuth{
+		Username: c.Username,
+		Password: c.Token,
+	}
+
+	var err error
+	c.repo, err = git.PlainClone(c.WorkDir, false, &git.CloneOptions{
+		URL:      c.URL,
+		Auth:     auth,
+		Progress: os.Stdout,
+	})
+
+	if err != nil {
+		return fmt.Errorf("failed to clone repository: %w", err)
+	}
+
+	return nil
+}
+
+// Pull pulls the latest changes from the remote repository
+// Returns:
+// - error: any error that occurred during pulling
+func (c *client) Pull() error {
+	if c.repo == nil {
+		return fmt.Errorf("repository not initialized")
+	}
+
+	w, err := c.repo.Worktree()
+	if err != nil {
+		return fmt.Errorf("failed to get worktree: %w", err)
+	}
+
+	auth := &http.BasicAuth{
+		Username: c.Username,
+		Password: c.Token,
+	}
+
+	err = w.Pull(&git.PullOptions{
+		Auth:     auth,
+		Progress: os.Stdout,
+	})
+
+	if err != nil && err != git.NoErrAlreadyUpToDate {
+		return fmt.Errorf("failed to pull changes: %w", err)
+	}
+
+	return nil
+}
+
+// Commit commits the changes in the repository
+// Parameters:
+// - message: the commit message
+// Returns:
+// - error: any error that occurred during committing
+func (c *client) Commit(message string) error {
+	if c.repo == nil {
+		return fmt.Errorf("repository not initialized")
+	}
+
+	w, err := c.repo.Worktree()
+	if err != nil {
+		return fmt.Errorf("failed to get worktree: %w", err)
+	}
+
+	_, err = w.Add(".")
+	if err != nil {
+		return fmt.Errorf("failed to add changes: %w", err)
+	}
+
+	_, err = w.Commit(message, &git.CommitOptions{})
+	if err != nil {
+		return fmt.Errorf("failed to commit changes: %w", err)
+	}
+
+	return nil
+}
+
+// Push pushes the changes to the remote repository
+// Returns:
+// - error: any error that occurred during pushing
+func (c *client) Push() error {
+	if c.repo == nil {
+		return fmt.Errorf("repository not initialized")
+	}
+
+	auth := &http.BasicAuth{
+		Username: c.Username,
+		Password: c.Token,
+	}
+
+	err := c.repo.Push(&git.PushOptions{
+		Auth:     auth,
+		Progress: os.Stdout,
+	})
+
+	if err != nil && err != git.NoErrAlreadyUpToDate {
+		return fmt.Errorf("failed to push changes: %w", err)
+	}
+
+	return nil
+}
+
+// EnsureRepo ensures the local repository is up-to-date
+// Returns:
+// - error: any error that occurred during the operation
+func (c *client) EnsureRepo() error {
+	if _, err := os.Stat(filepath.Join(c.WorkDir, ".git")); os.IsNotExist(err) {
+		return c.Clone()
+	}
+
+	var err error
+	c.repo, err = git.PlainOpen(c.WorkDir)
+	if err != nil {
+		return fmt.Errorf("failed to open existing repository: %w", err)
+	}
+
+	return c.Pull()
+}