feat: new SCM: gerrit (#565)

Author: dacofr

cmd/other.go

@@ -37,11 +37,13 @@ func getToken(flag *flag.FlagSet) (string, error) {
 			token = ght
 		} else if ght := os.Getenv("BITBUCKET_CLOUD_WORKSPACE_TOKEN"); ght != "" {
 			token = ght
+		} else if ght := os.Getenv("GERRIT_TOKEN"); ght != "" {
+			token = ght
 		}
 	}
 
 	if token == "" {
-		return "", errors.New("either the --token flag or the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN/BITBUCKET_CLOUD_APP_PASSWORD/BITBUCKET_CLOUD_WORKSPACE_TOKEN environment variable has to be set")
+		return "", errors.New("either the --token flag or the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN/BITBUCKET_CLOUD_APP_PASSWORD/BITBUCKET_CLOUD_WORKSPACE_TOKEN/GERRIT_TOKEN environment variable has to be set")
 	}
 
 	return token, nil

cmd/platform.go

@@ -10,6 +10,7 @@ import (
 	"github.com/lindell/multi-gitter/internal/multigitter"
 	"github.com/lindell/multi-gitter/internal/scm/bitbucketcloud"
 	"github.com/lindell/multi-gitter/internal/scm/bitbucketserver"
+	"github.com/lindell/multi-gitter/internal/scm/gerrit"
 	"github.com/lindell/multi-gitter/internal/scm/gitea"
 	"github.com/lindell/multi-gitter/internal/scm/github"
 	"github.com/lindell/multi-gitter/internal/scm/gitlab"
@@ -22,10 +23,10 @@ import (
 func configurePlatform(cmd *cobra.Command) {
 	flags := cmd.Flags()
 
-	flags.StringP("base-url", "g", "", "Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket.")
+	flags.StringP("base-url", "g", "", "Base URL of the target platform, needs to be changed for GitHub enterprise, a self-hosted GitLab instance, Gitea or BitBucket, Gerrit.")
 	flags.BoolP("insecure", "", false, "Insecure controls whether a client verifies the server certificate chain and host name. Used only for Bitbucket server.")
 	flags.StringP("username", "u", "", "The Bitbucket server username.")
-	flags.StringP("token", "T", "", "The personal access token for the targeting platform. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN/BITBUCKET_CLOUD_APP_PASSWORD/BITBUCKET_CLOUD_WORKSPACE_TOKEN environment variable.")
+	flags.StringP("token", "T", "", "The personal access token for the targeting platform. Can also be set using the GITHUB_TOKEN/GITLAB_TOKEN/GITEA_TOKEN/BITBUCKET_SERVER_TOKEN/BITBUCKET_CLOUD_APP_PASSWORD/BITBUCKET_CLOUD_WORKSPACE_TOKEN/GERRIT_TOKEN environment variable.")
 	flags.StringP("auth-type", "", "app-password", `The authentication type. Used only for Bitbucket cloud. Available values: app-password, workspace-token.`)
 	_ = cmd.RegisterFlagCompletionFunc("auth-type", func(cmd *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"app-password", "workspace-token"}, cobra.ShellCompDirectiveNoFileComp
@@ -43,7 +44,7 @@ func configurePlatform(cmd *cobra.Command) {
 	flags.BoolP("ssh-auth", "", false, `Use SSH cloning URL instead of HTTPS + token. This requires that a setup with ssh keys that have access to all repos and that the server is already in known_hosts.`)
 	flags.BoolP("skip-forks", "", false, `Skip repositories which are forks.`)
 
-	flags.StringP("platform", "p", "github", "The platform that is used. Available values: github, gitlab, gitea, bitbucket_server, bitbucket_cloud. Note: bitbucket_cloud is in Beta")
+	flags.StringP("platform", "p", "github", "The platform that is used. Available values: github, gitlab, gitea, bitbucket_server, bitbucket_cloud, gerrit. Note: bitbucket_cloud is in Beta")
 	_ = cmd.RegisterFlagCompletionFunc("platform", func(cmd *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"github", "gitlab", "gitea", "bitbucket_server", "bitbucket_cloud"}, cobra.ShellCompDirectiveDefault
 	})
@@ -123,6 +124,8 @@ func getVersionController(flag *flag.FlagSet, verifyFlags bool, readOnly bool) (
 		return createBitbucketServerClient(flag, verifyFlags)
 	case "bitbucket_cloud":
 		return createBitbucketCloudClient(flag, verifyFlags)
+	case "gerrit":
+		return createGerritClient(flag, verifyFlags)
 	default:
 		return nil, fmt.Errorf("unknown platform: %s", platform)
 	}
@@ -392,6 +395,28 @@ func createBitbucketServerClient(flag *flag.FlagSet, verifyFlags bool) (multigit
 	return vc, nil
 }
 
+func createGerritClient(flag *flag.FlagSet, _ bool) (multigitter.VersionController, error) {
+	username, _ := flag.GetString("username")
+	if username == "" {
+		return nil, errors.New("no username set")
+	}
+
+	gerritBaseURL, _ := flag.GetString("base-url")
+	if gerritBaseURL == "" {
+		return nil, errors.New("no base-url set")
+	}
+
+	repoSearch, _ := flag.GetString("repo-search")
+
+	token, err := getToken(flag)
+	if err != nil {
+		return nil, err
+	}
+
+	vc, err := gerrit.New(username, token, gerritBaseURL, repoSearch)
+	return vc, err
+}
+
 // versionControllerCompletion is a helper function to allow for easier implementation of Cobra autocompletions that depend on a version controller
 func versionControllerCompletion(cmd *cobra.Command, flagName string, fn func(vc multigitter.VersionController, toComplete string) ([]string, error)) {
 	_ = cmd.RegisterFlagCompletionFunc(flagName, func(cmd *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective) {

go.mod

@@ -4,6 +4,7 @@ go 1.23.3
 
 require (
 	code.gitea.io/sdk/gitea v0.21.0
+	github.com/andygrunwald/go-gerrit v1.1.0
 	github.com/eiannone/keyboard v0.0.0-20220611211555-0d226195f203
 	github.com/gfleury/go-bitbucket-v1 v0.0.0-20240917142304-df385efaac68
 	github.com/go-git/go-git/v5 v5.16.2

go.sum

@@ -10,6 +10,10 @@ github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERo
 github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
 github.com/ProtonMail/go-crypto v1.1.6 h1:ZcV+Ropw6Qn0AX9brlQLAUXfqLBc7Bl+f/DmNxpLfdw=
 github.com/ProtonMail/go-crypto v1.1.6/go.mod h1:rA3QumHc/FZ8pAHreoekgiAbzpNsfQAosU5td4SnOrE=
+github.com/andygrunwald/go-gerrit v1.0.0 h1:TrRGbso70QjJcXPC4kkLiKQrAfCBoBV+cBs7NrJxeno=
+github.com/andygrunwald/go-gerrit v1.0.0/go.mod h1:SeP12EkHZxEVjuJ2HZET304NBtHGG2X6w2Gzd0QXAZw=
+github.com/andygrunwald/go-gerrit v1.1.0 h1:+svCkLj2kkrClYWZhynSCOizAoCjw8uZJhRs+x3nbAs=
+github.com/andygrunwald/go-gerrit v1.1.0/go.mod h1:SeP12EkHZxEVjuJ2HZET304NBtHGG2X6w2Gzd0QXAZw=
 github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be h1:9AeTilPcZAjCFIImctFaOjnTIavg87rW78vTPkQqLI8=
 github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be/go.mod h1:ySMOLuWl6zY27l47sB3qLNK6tF2fkHG55UZxx8oIVo4=
 github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=

internal/git/cmdgit/git.go

@@ -140,12 +140,16 @@ func (g *Git) BranchExist(remoteName, branchName string) (bool, error) {
 }
 
 // Push the committed changes to the remote
-func (g *Git) Push(ctx context.Context, remoteName string, force bool) error {
+func (g *Git) Push(ctx context.Context, remoteName, remoteReference string, force bool) error {
 	args := []string{"push", "--no-verify", remoteName}
 	if force {
 		args = append(args, "--force")
 	}
-	args = append(args, "HEAD")
+	refSpec := "HEAD"
+	if remoteReference != "" {
+		refSpec = refSpec + ":" + remoteReference
+	}
+	args = append(args, refSpec)
 
 	cmd := exec.CommandContext(ctx, "git", args...)
 	_, err := g.run(cmd)

internal/git/gogit/git.go

@@ -205,10 +205,23 @@ func (g *Git) BranchExist(remoteName, branchName string) (bool, error) {
 }
 
 // Push the committed changes to the remote
-func (g *Git) Push(ctx context.Context, remoteName string, force bool) error {
+func (g *Git) Push(ctx context.Context, remoteName, remoteReference string, force bool) error {
+	var refSpecs []config.RefSpec
+
+	if remoteReference != "" {
+		// go-git doesn't support refSpec like HEAD:<name>, so first we need to resolve SHA1 commit related to HEAD
+		head, err := g.repo.Head()
+		if err != nil {
+			return errors.Wrap(err, "Unable to get HEAD")
+		}
+		refSpecs = []config.RefSpec{
+			config.RefSpec(head.Hash().String() + ":" + remoteReference),
+		}
+	}
 	return g.repo.PushContext(ctx, &git.PushOptions{
 		RemoteName: remoteName,
 		Force:      force,
+		RefSpecs:   refSpecs,
 	})
 }
 

internal/multigitter/run.go

@@ -35,6 +35,18 @@ type VersionController interface {
 	ForkRepository(ctx context.Context, repo scm.Repository, newOwner string) (scm.Repository, error)
 }
 
+type VersionControllerEnhanceCommit interface {
+	EnhanceCommit(ctx context.Context, repo scm.Repository, branchName string, commitMessage string) (string, error)
+}
+
+type VersionControllerFeatureBranchExist interface {
+	FeatureBranchExist(ctx context.Context, repo scm.Repository, branchName string) (bool, error)
+}
+
+type VersionControllerRemoteReference interface {
+	RemoteReference(baseBranch string, featureBranch string, skipPullRequest bool, pushOnly bool) string
+}
+
 // Runner contains fields to be able to do the run
 type Runner struct {
 	VersionController VersionController
@@ -285,7 +297,8 @@ func (r *Runner) runSingleRepo(ctx context.Context, repo scm.Repository) (scm.Pu
 		return nil, errNoChange
 	}
 
-	err = sourceController.Commit(r.CommitAuthor, r.CommitMessage)
+	commitMessage := r.enhanceCommitMessage(ctx, repo)
+	err = sourceController.Commit(r.CommitAuthor, commitMessage)
 	if err != nil {
 		return nil, err
 	}
@@ -324,7 +337,7 @@ func (r *Runner) runSingleRepo(ctx context.Context, repo scm.Repository) (scm.Pu
 	// Determine if a branch already exists and (depending on the conflict strategy) skip making changes
 	featureBranchExist := false
 	if !r.SkipPullRequest && !r.PushOnly {
-		featureBranchExist, err = sourceController.BranchExist(remoteName, r.FeatureBranch)
+		featureBranchExist, err = r.featureBranchExist(ctx, repo, remoteName, sourceController)
 		if err != nil {
 			return nil, errors.Wrap(err, "could not verify if branch already exists")
 		} else if featureBranchExist && r.ConflictStrategy == ConflictStrategySkip {
@@ -341,7 +354,8 @@ func (r *Runner) runSingleRepo(ctx context.Context, repo scm.Repository) (scm.Pu
 	forcePush := featureBranchExist && r.ConflictStrategy == ConflictStrategyReplace
 
 	if !r.APIPush {
-		err = sourceController.Push(ctx, remoteName, forcePush)
+		remoteReference := r.remoteReference(baseBranch, r.FeatureBranch)
+		err = sourceController.Push(ctx, remoteName, remoteReference, forcePush)
 		if err != nil {
 			return nil, errors.Wrap(err, "could not push changes")
 		}
@@ -372,6 +386,31 @@ func (r *Runner) runSingleRepo(ctx context.Context, repo scm.Repository) (scm.Pu
 	return r.ensurePullRequestExists(ctx, log, repo, prRepo, baseBranch, featureBranchExist)
 }
 
+func (r *Runner) enhanceCommitMessage(ctx context.Context, repo scm.Repository) string {
+	vcs, ok := r.VersionController.(VersionControllerEnhanceCommit)
+	if ok {
+		commitMessage, _ := vcs.EnhanceCommit(ctx, repo, r.FeatureBranch, r.CommitMessage)
+		return commitMessage
+	}
+	return r.CommitMessage
+}
+
+func (r *Runner) featureBranchExist(ctx context.Context, repo scm.Repository, remoteName string, sourceController Git) (bool, error) {
+	vcs, ok := r.VersionController.(VersionControllerFeatureBranchExist)
+	if ok {
+		return vcs.FeatureBranchExist(ctx, repo, r.FeatureBranch)
+	}
+	return sourceController.BranchExist(remoteName, r.FeatureBranch)
+}
+
+func (r *Runner) remoteReference(baseBranch string, featureBranch string) string {
+	vcs, ok := r.VersionController.(VersionControllerRemoteReference)
+	if ok {
+		return vcs.RemoteReference(baseBranch, featureBranch, r.SkipPullRequest, r.PushOnly)
+	}
+	return ""
+}
+
 func (r *Runner) ensurePullRequestExists(ctx context.Context, log log.FieldLogger, repo scm.Repository, prRepo scm.Repository, baseBranch string, featureBranchExist bool) (scm.PullRequest, error) {
 	if r.SkipPullRequest {
 		return nil, nil

internal/multigitter/shared.go

@@ -32,7 +32,7 @@ type Git interface {
 	Changes() (bool, error)
 	Commit(commitAuthor *git.CommitAuthor, commitMessage string) error
 	BranchExist(remoteName, branchName string) (bool, error)
-	Push(ctx context.Context, remoteName string, force bool) error
+	Push(ctx context.Context, remoteName, remoteReference string, force bool) error
 	AddRemote(name, url string) error
 }
 

internal/scm/gerrit/change.go

@@ -0,0 +1,57 @@
+package gerrit
+
+import (
+	"fmt"
+	"github.com/lindell/multi-gitter/internal/scm"
+
+	gogerrit "github.com/andygrunwald/go-gerrit"
+)
+
+type change struct {
+	id       string
+	project  string
+	branch   string
+	number   int
+	changeID string
+	status   scm.PullRequestStatus
+	webURL   string
+}
+
+func (r change) String() string {
+	return fmt.Sprintf("%d: %s", r.number, r.project)
+}
+
+func (r change) Status() scm.PullRequestStatus {
+	return r.status
+}
+
+func (r change) URL() string {
+	return r.webURL
+}
+
+func convertChange(changeInfo gogerrit.ChangeInfo, baseURL string) scm.PullRequest {
+	status := scm.PullRequestStatusUnknown
+
+	if changeInfo.Submittable {
+		status = scm.PullRequestStatusSuccess
+	} else {
+		switch changeInfo.Status {
+		case "NEW":
+			status = scm.PullRequestStatusPending
+		case "MERGED":
+			status = scm.PullRequestStatusMerged
+		case "ABANDONED":
+			status = scm.PullRequestStatusClosed
+		}
+	}
+
+	return change{
+		id:       changeInfo.ID,
+		project:  changeInfo.Project,
+		branch:   changeInfo.Branch,
+		number:   changeInfo.Number,
+		changeID: changeInfo.ChangeID,
+		status:   status,
+		webURL:   fmt.Sprintf("%s/c/%s/+/%d", baseURL, changeInfo.Project, changeInfo.Number),
+	}
+}