feat(golang-rewrite): move all Git code to git package

* Move plugins/git package to /git.
* Update repoer interface in pluginindex package to match interface in git package
* Use git package's Repo struct in pluginindex package

Author: Stratus3D

plugins/git/git.go renamed to git/git.go

@@ -1,5 +1,5 @@
 // Package git contains all the Git operations that can be applied to asdf
-// plugins
+// Git repositories like the plugin index repo and individual asdf plugins.
 package git
 
 import (
@@ -10,34 +10,36 @@ import (
 	"github.com/go-git/go-git/v5/plumbing"
 )
 
-const remoteName = "origin"
+// DefaultRemoteName for Git repositories in asdf
+const DefaultRemoteName = "origin"
 
-// Plugin is a struct to contain the plugin Git details
-type Plugin struct {
-	directory string
-}
-
-// PluginOps is an interface for operations that can be applied to asdf plugins.
+// Repoer is an interface for operations that can be applied to asdf plugins.
 // Right now we only support Git, but in the future we might have other
 // mechanisms to install and upgrade plugins. asdf doesn't require a plugin
 // to be a Git repository when asdf uses it, but Git is the only way to install
 // and upgrade plugins. If other approaches are supported this will be
 // extracted into the `plugins` module.
-type PluginOps interface {
+type Repoer interface {
 	Clone(pluginURL string) error
 	Head() (string, error)
 	RemoteURL() (string, error)
 	Update(ref string) (string, error)
 }
 
-// NewPlugin builds a new Plugin instance
-func NewPlugin(directory string) Plugin {
-	return Plugin{directory: directory}
+// Repo is a struct to contain the Git repository details
+type Repo struct {
+	Directory string
+	URL       string
+}
+
+// NewRepo builds a new Repo instance
+func NewRepo(directory string) Repo {
+	return Repo{Directory: directory}
 }
 
 // Clone installs a plugin via Git
-func (g Plugin) Clone(pluginURL string) error {
-	_, err := git.PlainClone(g.directory, false, &git.CloneOptions{
+func (r Repo) Clone(pluginURL string) error {
+	_, err := git.PlainClone(r.Directory, false, &git.CloneOptions{
 		URL: pluginURL,
 	})
 	if err != nil {
@@ -48,8 +50,8 @@ func (g Plugin) Clone(pluginURL string) error {
 }
 
 // Head returns the current HEAD ref of the plugin's Git repository
-func (g Plugin) Head() (string, error) {
-	repo, err := gitOpen(g.directory)
+func (r Repo) Head() (string, error) {
+	repo, err := gitOpen(r.Directory)
 	if err != nil {
 		return "", err
 	}
@@ -63,8 +65,8 @@ func (g Plugin) Head() (string, error) {
 }
 
 // RemoteURL returns the URL of the default remote for the plugin's Git repository
-func (g Plugin) RemoteURL() (string, error) {
-	repo, err := gitOpen(g.directory)
+func (r Repo) RemoteURL() (string, error) {
+	repo, err := gitOpen(r.Directory)
 	if err != nil {
 		return "", err
 	}
@@ -79,8 +81,8 @@ func (g Plugin) RemoteURL() (string, error) {
 
 // Update updates the plugin's Git repository to the ref if provided, or the
 // latest commit on the current branch
-func (g Plugin) Update(ref string) (string, error) {
-	repo, err := gitOpen(g.directory)
+func (r Repo) Update(ref string) (string, error) {
+	repo, err := gitOpen(r.Directory)
 	if err != nil {
 		return "", err
 	}
@@ -107,7 +109,7 @@ func (g Plugin) Update(ref string) (string, error) {
 		checkoutOptions = git.CheckoutOptions{Hash: plumbing.NewHash(ref), Force: true}
 	}
 
-	fetchOptions := git.FetchOptions{RemoteName: remoteName, Force: true, RefSpecs: []config.RefSpec{
+	fetchOptions := git.FetchOptions{RemoteName: DefaultRemoteName, Force: true, RefSpecs: []config.RefSpec{
 		config.RefSpec(ref + ":" + ref),
 	}}
 

plugins/git/git_test.go renamed to git/git_test.go

@@ -21,7 +21,7 @@ func TestPluginClone(t *testing.T) {
 		tempDir := t.TempDir()
 		directory := filepath.Join(tempDir, testPluginName)
 
-		plugin := NewPlugin(directory)
+		plugin := NewRepo(directory)
 		err := plugin.Clone("foobar")
 
 		assert.ErrorContains(t, err, "unable to clone plugin: repository not found")
@@ -31,7 +31,7 @@ func TestPluginClone(t *testing.T) {
 		tempDir := t.TempDir()
 		directory := filepath.Join(tempDir, testPluginName)
 
-		plugin := NewPlugin(directory)
+		plugin := NewRepo(directory)
 		err := plugin.Clone(testRepo)
 
 		assert.Nil(t, err)
@@ -50,7 +50,7 @@ func TestPluginHead(t *testing.T) {
 	tempDir := t.TempDir()
 	directory := filepath.Join(tempDir, testPluginName)
 
-	plugin := NewPlugin(directory)
+	plugin := NewRepo(directory)
 
 	err := plugin.Clone(testRepo)
 	assert.Nil(t, err)
@@ -64,7 +64,7 @@ func TestPluginRemoteURL(t *testing.T) {
 	tempDir := t.TempDir()
 	directory := filepath.Join(tempDir, testPluginName)
 
-	plugin := NewPlugin(directory)
+	plugin := NewRepo(directory)
 
 	err := plugin.Clone(testRepo)
 	assert.Nil(t, err)
@@ -78,14 +78,14 @@ func TestPluginUpdate(t *testing.T) {
 	tempDir := t.TempDir()
 	directory := filepath.Join(tempDir, testPluginName)
 
-	plugin := NewPlugin(directory)
+	plugin := NewRepo(directory)
 
 	err := plugin.Clone(testRepo)
 	assert.Nil(t, err)
 
 	t.Run("returns error when plugin with name does not exist", func(t *testing.T) {
 		nonexistantPath := filepath.Join(tempDir, "nonexistant")
-		nonexistantPlugin := NewPlugin(nonexistantPath)
+		nonexistantPlugin := NewRepo(nonexistantPath)
 		updatedToRef, err := nonexistantPlugin.Update("")
 
 		assert.NotNil(t, err)
@@ -100,7 +100,7 @@ func TestPluginUpdate(t *testing.T) {
 		err := os.MkdirAll(badPluginDir, 0o777)
 		assert.Nil(t, err)
 
-		badPlugin := NewPlugin(badPluginDir)
+		badPlugin := NewRepo(badPluginDir)
 
 		updatedToRef, err := badPlugin.Update("")
 

pluginindex/pluginindex.go

@@ -3,15 +3,13 @@
 package pluginindex
 
 import (
-	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
 	"time"
 
-	"github.com/go-git/go-git/v5"
-	"github.com/go-git/go-git/v5/config"
-	"github.com/go-git/go-git/v5/plumbing"
+	"asdf/git"
+
 	"gopkg.in/ini.v1"
 )
 
@@ -20,90 +18,22 @@ const (
 	repoUpdatedFilename = "repo-updated"
 )
 
-type repoer interface {
-	Install() error
-	Update() error
-}
-
-type gitRepoIndex struct {
-	directory string
-	URL       string
-}
-
-func (g *gitRepoIndex) Install() error {
-	opts := git.CloneOptions{
-		URL: g.URL,
-	}
-
-	if _, err := git.PlainClone(g.directory, false, &opts); err != nil {
-		return fmt.Errorf("unable to clone: %w", err)
-	}
-
-	return nil
-}
-
-func (g *gitRepoIndex) Update() error {
-	repo, err := git.PlainOpen(g.directory)
-	if err != nil {
-		return fmt.Errorf("unable to open plugin Git repository: %w", err)
-	}
-
-	var checkoutOptions git.CheckoutOptions
-
-	// If no ref is provided checkout latest commit on current branch
-	head, err := repo.Head()
-	if err != nil {
-		return fmt.Errorf("unable to get repo HEAD: %w", err)
-	}
-
-	if !head.Name().IsBranch() {
-		return fmt.Errorf("not on a branch, unable to update")
-	}
-
-	// If on a branch checkout the latest version of it from the remote
-	branch := head.Name()
-	ref := branch.String()
-	checkoutOptions = git.CheckoutOptions{Branch: branch, Force: true}
-
-	fetchOptions := git.FetchOptions{RemoteName: "origin", Force: true, RefSpecs: []config.RefSpec{
-		config.RefSpec(ref + ":" + ref),
-	}}
-
-	if err = repo.Fetch(&fetchOptions); err != nil && !errors.Is(err, git.NoErrAlreadyUpToDate) {
-		return fmt.Errorf("unable to fetch from remote: %w", err)
-	}
-
-	worktree, err := repo.Worktree()
-	if err != nil {
-		return fmt.Errorf("unable to open worktree: %w", err)
-	}
-
-	err = worktree.Checkout(&checkoutOptions)
-	if err != nil {
-		return fmt.Errorf("unable to checkout commit: %w", err)
-	}
-
-	_, err = repo.ResolveRevision(plumbing.Revision("HEAD"))
-	if err != nil {
-		return fmt.Errorf("unable to get new HEAD: %w", err)
-	}
-	return nil
-}
-
 // PluginIndex is a struct representing the user's preferences for plugin index
 // and the plugin index on disk.
 type PluginIndex struct {
-	repo                  repoer
+	repo                  git.Repoer
 	directory             string
+	url                   string
 	disableUpdate         bool
 	updateDurationMinutes int
 }
 
 // New initializes a new PluginIndex instance with the options passed in.
-func New(directory string, disableUpdate bool, updateDurationMinutes int, repo repoer) PluginIndex {
+func New(directory, url string, disableUpdate bool, updateDurationMinutes int, repo git.Repoer) PluginIndex {
 	return PluginIndex{
 		repo:                  repo,
 		directory:             directory,
+		url:                   url,
 		disableUpdate:         disableUpdate,
 		updateDurationMinutes: updateDurationMinutes,
 	}
@@ -125,7 +55,7 @@ func (p PluginIndex) Refresh() (bool, error) {
 
 	if len(files) == 0 {
 		// directory empty, clone down repo
-		err := p.repo.Install()
+		err := p.repo.Clone(p.url)
 		if err != nil {
 			return false, err
 		}
@@ -150,7 +80,9 @@ func (p PluginIndex) Refresh() (bool, error) {
 }
 
 func (p PluginIndex) doUpdate() (bool, error) {
-	err := p.repo.Update()
+	// pass in empty string as we want the repo to figure out what the latest
+	// commit is
+	_, err := p.repo.Update("")
 	if err != nil {
 		return false, err
 	}