revise remote add and delete operations with new test suites and validations

Author: neel1996

git/remote/git_remote_add.go

@@ -1,14 +1,14 @@
 package remote
 
 import (
+	"errors"
 	"fmt"
 	git2go "github.com/libgit2/git2go/v31"
 	"github.com/neel1996/gitconvex/global"
-	"github.com/neel1996/gitconvex/graph/model"
 )
 
 type Add interface {
-	NewRemote() *model.RemoteMutationResult
+	NewRemote() error
 }
 
 type addRemote struct {
@@ -18,20 +18,36 @@ type addRemote struct {
 }
 
 // NewRemote adds a new remote to the target git repo
-func (a addRemote) NewRemote() *model.RemoteMutationResult {
-	repo := a.repo
-	remoteName := a.remoteName
-	remoteURL := a.remoteURL
-
-	remote, err := repo.Remotes.Create(remoteName, remoteURL)
+func (a addRemote) NewRemote() error {
+	if validationErr := a.validateRemoteFields(); validationErr != nil {
+		logger.Log(validationErr.Error(), global.StatusError)
+		return validationErr
+	}
 
+	remote, err := a.repo.Remotes.Create(a.remoteName, a.remoteURL)
 	if err != nil {
 		logger.Log("Remote addition Failed -> "+err.Error(), global.StatusError)
-		return &model.RemoteMutationResult{Status: global.RemoteAddError}
+		return err
 	}
 
 	logger.Log(fmt.Sprintf("New remote %s added to the repo", remote.Name()), global.StatusInfo)
-	return &model.RemoteMutationResult{Status: global.RemoteAddSuccess}
+	return nil
+}
+
+func (a addRemote) validateRemoteFields() error {
+	if a.repo == nil {
+		return errors.New("repo is nil")
+	}
+
+	if a.remoteName == "" {
+		return errors.New("remote name cannot be empty")
+	}
+
+	if a.remoteURL == "" {
+		return errors.New("remote URL is empty")
+	}
+
+	return nil
 }
 
 func NewAddRemote(repo *git2go.Repository, remoteName string, remoteURL string) Add {

git/remote/git_remote_add_test.go

@@ -0,0 +1,50 @@
+package remote
+
+import (
+	"fmt"
+	git2go "github.com/libgit2/git2go/v31"
+	"github.com/stretchr/testify/suite"
+	"os"
+	"testing"
+)
+
+type RemoteAddTestSuite struct {
+	suite.Suite
+	addRemote Add
+}
+
+func TestRemoteAddTestSuite(t *testing.T) {
+	suite.Run(t, new(RemoteAddTestSuite))
+}
+
+func (suite *RemoteAddTestSuite) SetupTest() {
+	r, err := git2go.OpenRepository(os.Getenv("GITCONVEX_TEST_REPO"))
+	if err != nil {
+		fmt.Println(err)
+	}
+	suite.addRemote = NewAddRemote(r, "new_origin", "https://github.com/neel1996/gitconvex-test.git")
+}
+
+func (suite *RemoteAddTestSuite) TestAddNewRemote_WhenNewRemoteIsAdded_ShouldReturnNoError() {
+	err := suite.addRemote.NewRemote()
+
+	suite.Nil(err)
+}
+
+func (suite *RemoteAddTestSuite) TestAddNewRemote_WhenRequiredFieldsAreEmpty_ShouldReturnError() {
+	suite.addRemote = NewAddRemote(nil, "", "")
+
+	err := suite.addRemote.NewRemote()
+
+	suite.NotNil(err)
+}
+
+func (suite *RemoteAddTestSuite) TestAddNewRemote_WhenRemoteCreationFails_ShouldReturnError() {
+	r, _ := git2go.OpenRepository(os.Getenv("GITCONVEX_TEST_REPO"))
+
+	suite.addRemote = NewAddRemote(r, "new_origin", "https://github.com/neel1996/gitconvex-test.git")
+
+	err := suite.addRemote.NewRemote()
+
+	suite.NotNil(err)
+}

git/remote/git_remote_delete.go

@@ -1,33 +1,45 @@
 package remote
 
 import (
+	"errors"
 	"fmt"
 	git2go "github.com/libgit2/git2go/v31"
 	"github.com/neel1996/gitconvex/global"
-	"github.com/neel1996/gitconvex/graph/model"
 )
 
 type Delete interface {
-	DeleteRemote() *model.RemoteMutationResult
+	DeleteRemote() error
 }
 
 type deleteRemote struct {
 	repo       *git2go.Repository
 	remoteName string
 }
 
-func (d deleteRemote) DeleteRemote() *model.RemoteMutationResult {
-	remoteToBeDeleted := d.remoteName
-
-	deletionError := &model.RemoteMutationResult{Status: global.RemoteDeleteError}
+// DeleteRemote deletes the remote based on the specified remoteName
+func (d deleteRemote) DeleteRemote() error {
+	if validationError := d.validateRemoteFields(); validationError != nil {
+		return validationError
+	}
 
 	err := d.deleteSelectedRemote(d.remoteName)
 	if err != nil {
-		logger.Log(fmt.Sprintf("Remote => %s cannot be found in the repo", remoteToBeDeleted), global.StatusError)
-		return deletionError
+		logger.Log(fmt.Sprintf("Remote => %s cannot be found in the repo", d.remoteName), global.StatusError)
+		return err
+	}
+
+	return nil
+}
+
+func (d deleteRemote) validateRemoteFields() error {
+	if d.repo == nil {
+		return errors.New("repo is nil")
 	}
 
-	return &model.RemoteMutationResult{Status: global.RemoteDeleteSuccess}
+	if d.remoteName == "" {
+		return errors.New("remote name cannot be empty")
+	}
+	return nil
 }
 
 func (d *deleteRemote) deleteSelectedRemote(remoteEntry string) error {
@@ -41,7 +53,7 @@ func (d *deleteRemote) deleteSelectedRemote(remoteEntry string) error {
 	return nil
 }
 
-func NewDeleteRemoteInterface(repo *git2go.Repository, remoteName string) Delete {
+func NewDeleteRemote(repo *git2go.Repository, remoteName string) Delete {
 	return deleteRemote{
 		repo:       repo,
 		remoteName: remoteName,

git/remote/git_remote_delete_test.go

@@ -0,0 +1,50 @@
+package remote
+
+import (
+	"fmt"
+	git2go "github.com/libgit2/git2go/v31"
+	"github.com/stretchr/testify/suite"
+	"os"
+	"testing"
+)
+
+type RemoteDeleteTestSuite struct {
+	suite.Suite
+	deleteRemote Delete
+}
+
+func TestRemoteDeleteTestSuite(t *testing.T) {
+	suite.Run(t, new(RemoteDeleteTestSuite))
+}
+
+func (suite *RemoteDeleteTestSuite) SetupTest() {
+	r, err := git2go.OpenRepository(os.Getenv("GITCONVEX_TEST_REPO"))
+	if err != nil {
+		fmt.Println(err)
+	}
+	suite.deleteRemote = NewDeleteRemote(r, "new_origin")
+}
+
+func (suite *RemoteDeleteTestSuite) TestDeleteNewRemote_WhenNewRemoteIsDeleted_ShouldReturnNoError() {
+	err := suite.deleteRemote.DeleteRemote()
+
+	suite.Nil(err)
+}
+
+func (suite *RemoteDeleteTestSuite) TestDeleteNewRemote_WhenRequiredFieldsAreEmpty_ShouldReturnError() {
+	suite.deleteRemote = NewDeleteRemote(nil, "")
+
+	err := suite.deleteRemote.DeleteRemote()
+
+	suite.NotNil(err)
+}
+
+func (suite *RemoteDeleteTestSuite) TestDeleteNewRemote_WhenRemoteDeletionFails_ShouldReturnError() {
+	r, _ := git2go.OpenRepository(os.Getenv("GITCONVEX_TEST_REPO"))
+
+	suite.deleteRemote = NewDeleteRemote(r, "new_origin")
+
+	err := suite.deleteRemote.DeleteRemote()
+
+	suite.NotNil(err)
+}