go-gerrit：Golang Gerrit客户端库使用指南

go-gerrit 是一个用于与 Gerrit 代码审查系统交互的 Golang 客户端库。它提供了方便的 API 来执行各种 Gerrit 操作，如查询变更、提交评论、管理账户等。

安装

首先安装 go-gerrit 库：

go get github.com/andygrunwald/go-gerrit

基本使用

1. 创建客户端连接

package main

import (
	"fmt"
	"log"
	"github.com/andygrunwald/go-gerrit"
)

func main() {
	// 创建匿名客户端
	client, err := gerrit.NewClient("https://gerrit-review.googlesource.com", nil)
	if err != nil {
		log.Fatal(err)
	}

	// 或者使用基本认证
	client, err = gerrit.NewClient(
		"https://your-gerrit-instance.com",
		&gerrit.BasicAuth{
			Username: "your-username",
			Password: "your-password-or-http-token",
		},
	)
	if err != nil {
		log.Fatal(err)
	}
}

2. 查询变更列表

func listChanges(client *gerrit.Client) {
	opt := &gerrit.QueryChangeOptions{
		QueryOptions: gerrit.QueryOptions{
			Limit: 10, // 限制返回结果数量
		},
	}
	changes, _, err := client.Changes.QueryChanges(opt)
	if err != nil {
		log.Fatal(err)
	}

	for _, change := range *changes {
		fmt.Printf("ID: %s, Project: %s, Subject: %s\n", 
			change.ID, change.Project, change.Subject)
	}
}

3. 获取特定变更详情

func getChangeDetail(client *gerrit.Client, changeID string) {
	change, _, err := client.Changes.GetChangeDetail(changeID, &gerrit.ChangeOptions{
		AdditionalFields: []string{"LABELS", "DETAILED_ACCOUNTS"},
	})
	if err != nil {
		log.Fatal(err)
	}

	fmt.Printf("Change %s:\n", change.ID)
	fmt.Printf("Status: %s\n", change.Status)
	fmt.Printf("Owner: %s (%s)\n", change.Owner.Name, change.Owner.Email)
	fmt.Printf("Current Revision: %s\n", change.CurrentRevision)
}

4. 提交代码审查评论

func postReview(client *gerrit.Client, changeID, revisionID string) {
	reviewInput := &gerrit.ReviewInput{
		Message: "Looks good to me, but needs minor fixes.",
		Labels: map[string]string{
			"Code-Review": "+1",
		},
		Comments: map[string][]gerrit.CommentInput{
			"src/main.go": {
				{
					Line:    42,
					Message: "Consider using a constant here instead of magic number.",
				},
			},
		},
	}

	_, _, err := client.Changes.SetReview(changeID, revisionID, reviewInput)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("Review submitted successfully")
}

5. 创建新变更

func createChange(client *gerrit.Client) {
	changeInput := &gerrit.ChangeInput{
		Project:        "my-project",
		Branch:        "master",
		Subject:       "Implement new feature X",
		Status:        "NEW",
		WorkInProgress: true,
	}

	newChange, _, err := client.Changes.CreateChange(changeInput)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Created new change: %s\n", newChange.ID)
}

高级功能

1. 使用 SSH 认证

func sshClient() {
	client, err := gerrit.NewSSHClient(
		"gerrit.example.com:29418",
		"/path/to/private/key",
		"your-username",
	)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Close()

	// 使用SSH客户端执行命令...
}

2. 处理分页结果

func paginatedChanges(client *gerrit.Client) {
	opt := &gerrit.QueryChangeOptions{
		QueryOptions: gerrit.QueryOptions{
			Limit:  50,
			Skip:   0,
			Sort:   "updated",
			Option: []string{"LABELS"},
		},
	}

	for {
		changes, resp, err := client.Changes.QueryChanges(opt)
		if err != nil {
			log.Fatal(err)
		}

		for _, change := range *changes {
			fmt.Printf("%s: %s\n", change.ID, change.Subject)
		}

		if len(*changes) < opt.Limit {
			break
		}
		opt.Skip += opt.Limit
	}
}

3. 监听事件流

func streamEvents(client *gerrit.Client) {
	events := make(chan *gerrit.Event)
	done := make(chan struct{})

	go func() {
		err := client.Events.StreamEvents(events, done, &gerrit.StreamEventsOptions{
			SSH: true, // 使用SSH流
		})
		if err != nil {
			log.Fatal(err)
		}
	}()

	for event := range events {
		switch event.Type {
		case "patchset-created":
			fmt.Printf("New patchset created for change %s\n", event.Change.Number)
		case "comment-added":
			fmt.Printf("New comment on change %s by %s\n", 
				event.Change.Number, event.Author.Name)
		}
	}
}

最佳实践

1. 错误处理：Gerrit API 可能返回各种错误，始终检查错误响应
2. 认证管理：使用 HTTP 令牌而非密码，并妥善保管
3. 速率限制：避免过频繁的 API 调用，Gerrit 可能有速率限制
4. 上下文使用：对于长时间运行的操作，使用 context 进行超时控制

go-gerrit 提供了完整的 Gerrit REST API 覆盖，更多功能可以参考其官方文档。