Gerrit Code Review詳解

一、Gerrit Code Review是什麼？

Gerrit Code Review是一個基於Git的Web代碼審查工具。它提供了一種功能強大的審查方式，可分析提交的代碼並允許團隊對其進行一系列的評論和修改，最終生成高質量的代碼。

通過Gerrit Code Review，代碼編輯人員可以將本地分支上的代碼提交到Gerrit伺服器，然後由團隊成員進行代碼審查。這個過程中，審查人員對代碼進行評級、評論和修改，然後向提交者提供有關代碼改進的反饋。最終，Gerrit伺服器將評審後的代碼集成到主分支。

二、Gerrit Code Review的特性是什麼？

1、Git標準化：Gerrit Code Review是基於Git的，遵循了Git相關標準，如提交信息描述和分支名規範等。

2、代碼審查工作流：Gerrit Code Review提供了一個完整的代碼審查工作流，包括撰寫提交說明、任務跟蹤、機器人觸發、靜態代碼分析等功能。

3、可自定義的代碼審查規則：Gerrit允許你定義自己的代碼審查規則，如不允許從特定分支合併、必須使用特定的庫或者代碼格式等。

4、內置代碼審查小組：Gerrit可以為您構建一個團隊，管理代碼審核人員和修復人員的任務。

5、REST API支持：Gerrit提供REST API，可以通過它與其他工具交互。

三、Gerrit Code Review的安裝與使用

Gerrit Code Review的安裝需要藉助Puppet，而使用則非常簡單。

1、安裝Gerrit Code Review

首先，需要安裝Puppet並將其配置為能夠與您的伺服器進行通信。接下來，請遵循以下步驟：

// 安裝Gerrit Code Review
sudo apt-get install -y gerrit

// 生成ssh密鑰對
ssh-keygen -t rsa -N "" -f ~/.ssh/id_rsa

// 將生成的公鑰複製到Gerrit伺服器上
scp ~/.ssh/id_rsa.pub user@server:/tmp/

接下來，可以在位於/tmp/的伺服器上使用SSH將公鑰添加到Gerrit Code Review的訪問控制列表中：

ssh user@server
sudo su - gerrit2
ssh-keygen -t rsa -N "" -f ~/id_rsa
cat /tmp/id_rsa.pub | ssh -p 29418 user@server "gerrit create-account --ssh-key - dev"

2、使用Gerrit Code Review

使用Gerrit Code Review，您需要在本地分支上提交需要審核的代碼，並將其推送到伺服器。

// 克隆Gerrit伺服器的repository
git clone ssh://user@server:29418/[project_name].git
cd [project_name]
//例如，git clone ssh://dev@localhost:29418/example.git

// 提交您的本地代碼更改到Gerrit伺服器上，進行審核
git push origin HEAD:refs/for/master

此時可以登錄Gerrit頁面查看代碼審核的結果。

四、Gerrit Code Review的擴展與集成

作為一個開放源代碼的工具，Gerrit Code Review可以與其他工具和服務創建集成，例如Jenkins、Gitlab、Jira和Github等。

1、與Jenkins集成

Gerrit Code Review可以與Jenkins集成，使得您可以在進行代碼審查後進行自動化測試和部署。

// 安裝Gerrit Trigger插件
Jenkins -> Manage Jenkins -> Manage Plugins -> Available -> Gerrit Trigger

// 配置Gerrit參數
Jenkins -> Manage Jenkins -> Configure System -> Gerrit Trigger -> Server列表

// 配置Jenkins Job
Jenkins -> [Project] -> Configure -> Build Triggers -> Gerrit Trigger -> 監聽Gerrit操作

2、與Gitlab集成

通過與Gitlab集成，您可以實現Gerrit對Gitlab的認證和授權，使得在Gitlab平台上進行的提交、修改和合併請求都將進入Gerrit審核流程。

// 啟用Gerrit服務的外部認證
修改/etc/gerrit.config, 增加如下內容
[auth]
		type = HTTP
		projectOwnerGroups = Administrators

sudo /etc/init.d/gerrit restart


// 配置Gitlab參數
1. 認證配置
Admin -> Applications -> New Application -> Fill the fields -> 回調URL填:http://gerrit.example.com:8080/login/
2. 項目訪問控制配置
Project -> Settings -> Integration -> Services -> Gerrit Code Review

3、與Jira集成

通過與Jira集成，您可以直接從Gerrit Code Review跟蹤代碼的bug和故障問題，以及將Jira提供的問題跟蹤集成到代碼審查流程中。

// 安裝Jira插件
插件列表 -> 已安裝插件 -> 找到"JIRA Software Aplications Plugin" -> 保存並啟用

// 配置Jira參數
重新啟動Gerrit服務並按照以下步驟進行配置：
Gerrit -> 項目頁面 -> Project-Settings -> Integrations -> Jira and Jira Software -> Server settings

4、與Github集成

通過與Github集成，您可以將Github上的代碼庫複製到Gerrit伺服器，並將其視為Gerrit託管的項目。

// 安裝Github插件
Jenkins -> Manage Jenkins -> Manage Plugins -> Available -> Github -> 安裝

// 配置Github相關信息
Jenkins -> Manage Jenkins -> Configure System -> Github -> Add a Github server -> 配置API token和Credentials

// 配置Jenkins Job
Jenkins -> [Project] -> Configure -> Source Code Management -> Git -> Repository URL填GitHub的項目地址

五、總結

Gerrit Code Review是一款功能強大的開源代碼審查工具，它提供了一個完整的工作流程和自定義的審查規則，硬實力上極大提高了代碼質量，具有廣泛的擴展與集成能力。