前提

前提

• 建立郵箱 [email protected]
• 建立郵箱 [email protected]

Gitlab配置

Gitlab已經配置了root賬戶的郵箱為[email protected]

為Gitlab的root使用者新增ssh金鑰

系統上建立admin使用者

$ sudo adduser admin

可以得到系統的使用者名稱admin和使用者自己設定的密碼

系統上登入admin賬戶，生成SSH金鑰

$ su - admin
$ ssh-keygen -C [email protected]
 

$ cat .ssh/id_rsa.pub
$ exit

在Gitlab系統上更新SSH公鑰

1. 用root賬號登入http://gitlab.zjc.com
2. 點選頁面右上角的Profile Settings - 點選左側的SSH Keys小鑰匙圖示 - 點選Add SSH Key。在Key對應的輸入框中輸入上段落$cat .ssh/id_rsa.pub顯示的公鑰全文，點選Title，應該會自動填充為[email protected]
   
   用了圈點Skitch，感覺萌萌噠

建立使用者user1，作為一般使用者

Gitlab上建立使用者user1

1. 進入註冊頁面，輸入註冊資訊，點選Sign up

   按鈕來註冊使用者user1。

   

2. 登入郵箱點選驗證連線，在Gitlab上成功建立user1賬號

Ubuntu系統上建立user1賬號，生成SSH祕鑰

$ sudo adduser user1
$ su - user1
$ ssh-keygen -C [email protected]
$ cat .ssh/id_rsa.pub
$ exit

用user1登入Gitlab，更新SSH公鑰

Gitlab建立組和專案，並配置user1身份

用root登入Gitlab，建立新Group為dev-group

在dev-group中建立新專案test-project1

點選 test-project1 工程介面左上的 dev-group

點選 Members

把 user1 作為 Reporter 身份新增到組 dev-group (Reporter可以下載程式碼但是沒上傳許可權)

用user1登入Gitlab，檢視新專案test-project1的git地址

地址為[email protected]:dev-group/test-project1.git

系統上登入user1，克隆工程，測試許可權

$ su - user1
$ cd ~
$ git clone [email protected]:dev-group/test-project1.git
$ exit

$ su - user1
$ cd ~/test-project1/
$ git config --global user.name 'user1'
$ git config --global user.email '[email protected]'
$ touch testfile
$ git add .
$ git commit -m 'user1 add testfile'
$ git push
$ exit

Gerrit配置

已經有了第一個賬戶admin並配置信箱為[email protected]

系統上登入admin，並獲取上步建立的公鑰

$ su - admin
$ cat ~/.ssh/id_rsa.pub
$ exit

用admin賬戶登入gerrit，更新SSH公鑰

為Gerrit系統建立使用者user1並配置

1. 使用htpasswd工具建立user1和密碼

   $ sudo -u gerrit -H htpasswd /home/gerrit/gerrit/etc/htpasswd.conf user1

2. 使用user1登入gerrit，更新信箱為[email protected]

3. 更新SSH公鑰 ([email protected]那個)

Jenkins配置

Jenkins系統已經建立了管理員賬戶jenkins並安裝了Gerrit Trigger外掛

配置jenkins使用者

1. 為Gerrit系統建立使用者jenkins
   $ sudo -u gerrit -H htpasswd /home/gerrit/gerrit/etc/htpasswd.conf jenkins

2. 為系統使用者jenkins建立ssh祕鑰，並檢視公鑰
   也可以用前面的su - jenkins登入後再操作。這樣就不用sudo -u jenkins -H字首了

   $ sudo -u jenkins -H ssh-keygen -C [email protected]
   $ sudo -u jenkins -H cat /home/jenkins/.ssh/id_rsa.pub

   

3. 用jenkins登入Gerrit更新郵箱並驗證

   • 此處有個問題，如果在安裝Jenkins系統前沒有建立jenkins使用者（安裝時候系統會自動建立）並且使用的Dovecot來接收郵件並且用預設配置。那麼要先查一下是否系統使用者jenkins的uid是否大於500，如果不是，需要修改配置檔案

   [email protected]:~$ id jenkins
   uid=122(jenkins) gid=131(jenkins) groups=131(jenkins)
   [email protected]:~$ sudo vim /etc/dovecot/conf.d/10-mail.conf

   然後修改first_valid_uid這個值

4. 用jenkins登入Gerrit，更新SSH公鑰為系統使用者jenkins的公鑰

Jenkins系統的SMTP設定 (根據具體情況配置)

主頁面->Manage Jenkins->Configure System

• Jenkins Location ->System Admin e-mail address : [email protected]

• E-mail Notification

  • SMTP server : mail.vzjc.com
  • Default user e-mail suffix : @vzjc.com
  • 勾選Use SMTP Authentication
  • User Name : [email protected]
  • Password : 輸入您設定的密碼
  • 勾選Use SSL
  • SMTP Port : 587
  • Reply-To Address : [email protected]
  • Charset : UTF-8
    
    
    
    • 勾選Test configuration by sending test e-mail，然後在出現的框中填[email protected]，測試如果出錯(好吧，如果用vzjc.com的郵件伺服器是肯定會出錯)Unrecognized SSL message, plaintext connection，則參考這個設定

設定Gerrit Trigger

主頁面->Manage Jenkins->Gerrit Trigger->Add New Server

• Add New Server : Check4Gerrit
• 勾選 Gerrit Server With Default Configurations

• Hostname : review.zjc.com
• Username : jenkins
• E-mail : [email protected]

如果點選Test Connection後出現如圖所示的錯誤User jenkins has no capability to connect to Gerrit event stream.,這是因為因Jenkins 沒有許可權監聽 Gerrit 的 ‘Stream Events’，可如此配置

點選Test Connection，出現的字串為 success 則代表配置成功

點選下方的儲存按鈕來儲存設定

Gerrit 和 Jenkins 整合

讓 Gerrit 支援 Jenkins

如果安裝Gerrit時沒有或者沒有選擇新增Verified標籤功能[‘lable Verified’]，需要自己新增

$ su - admin
$ git init cfg; cd cfg
$ git config --global user.name 'admin'
$ git config --global user.email '[email protected]'
$ git remote add origin ssh://[email protected]:29418/All-Projects
$ git pull origin refs/meta/config
$ vim project.config

在檔案末新增

[label "Verified"]
    function = MaxWithBlock
    value = -1 Fails
    value =  0 No score
    value = +1 Verified

$ git commit -a -m 'Updated permissions'
$ git push origin HEAD:refs/meta/config

用admin登入Gerrit

現在提交的 Review 請求只有 Code Rivew 稽核，我們要求的是需要 Jenkins 的 Verified 和 Code Review 雙重保障，在 Projects 的 Access 欄裡，針對 Reference: refs/heads/ 項新增 Verified 功能

• Projects -> List -> All-Projects
• Projects -> Access -> Edit -> 找到 Reference: refs/heads/* 項 -> Add Permission -> Label Verified -> Group Name 裡輸入 Non-Interactive Users -> 回車 或者 點選Add 按鈕 -> 在最下面點選 Save Changes 儲存更改

Gitlab上設定test-project1工程

前面我們在Gitlab上搭建了一個 test-project1 的工程，普通使用者是沒有辦法去 push 的，只能使用 git review 命令提交. 而 git review 命令需要 .gitreview 檔案存在於專案目錄裡。

用 admin使用者新增.gitreview 檔案

$ su - admin
$ git clone [email protected]:dev-group/test-project1.git
$ cd test-project1
$ vim .gitreview

檔案內容為：

[gerrit]
host=review.zjc.com
port=29418
project=test-project1.git

新增.gitreview到版本庫

$ git add .gitreview
$ git config --global user.name 'admin'
$ git config --global user.email '[email protected]'
$ git commit .gitreview -m 'add .gitreview file by admin.'
$ git push origin master
$ exit

用 admin使用者新增.testr.conf 檔案

Python 程式碼我使用了 testr，需要先安裝 testr 命令

$ sudo apt-get install python-pip
$ sudo pip install testrepository

在 test-project1 這個專案中新增 .testr.conf 檔案

$ su - admin
$ cd test-project1
$ vim .testr.conf

檔案內容為：

[DEFAULT]
test_command=OS_STDOUT_CAPTURE=1 OS_STDERR_CAPTURE=1 OS_TEST_TIMEOUT=60 ${PYTHON:-python} -m subunit.run discover -t ./ ./ $LISTOPT $IDOPTION
test_id_option=--load-list $IDFILE
test_list_option=—list

提交到版本庫中

$ git add .testr.conf
$ git commit .testr.conf -m 'add .testr.conf file by admin'
$ git push origin master
$ exit

Gerrit上設定 test-project1工程

在 Gerrit 上建立 test-project1 專案

要知道 review 是在 gerrit 上，而 gerrit 上現在是沒有專案的，想讓 gitlab 上的專案能在 gerrit 上 review 的話，必須在 gerrit 上建立相同的專案，並有相同的倉庫檔案.

用 admin 使用者在 Gerrit 上建立 test-project1 專案

$ su - admin
$ ssh -p 29418 [email protected] gerrit create-project test-project1
$ exit

clone –bare Gitlab 上的倉庫到 Gerrit

因為gerrit使用者無訪問gitlab的許可權。所以要先看是否gerrit使用者下已經存在了id_rsa金鑰，如果沒有則建立，然後把公鑰加入到gitlab的admin賬戶上（這裡加到 admin 賬戶上，是因為後面Gerrit系統還會有個複製 git 庫到 Gitlab的功能，需要管理員許可權）

賦予gerrit使用者訪問 test-project1 的許可權

$ sudo -u gerrit -H ls /home/gerrit/.ssh
$ sudo -u gerrit -H ssh-keygen -C [email protected]
$ sudo -u gerrit -H cat /home/gerrit/.ssh/id_rsa.pub

• 

• 用 root 登入Gitlab，把公鑰新增到 admin 的SSH Key上 - 額，這是因為，Gerrit使用gerrit使用者身份執行的，而Gerrit得git庫複製功能需要許可權複製到Gitlab上

以 gerrit身份克隆 test-project1

$ cd /home/gerrit/gerrit/git
$ sudo -u gerrit -H rm -fr test-project1.git
$ sudo -u gerrit -H  git clone --bare [email protected]:dev-group/test-project1.git

同步 Gerrit 的 test-project1 專案到 Gitlab 上的 test-project1 專案目錄中

當用戶 git review 後，程式碼通過 jenkins 測試、人工 review 後，程式碼只是 merge 到了 Gerrit 的 test-project1 專案中，並沒有 merge 到 Gitlab 的 test-project1 專案中，所以需要當 Gerrit test-project1 專案倉庫有變化時自動同步到 Gitlab 的 test-project1 專案倉庫中。Gerrit 自帶一個 Replication 功能，同時我們在安裝 Gerrit 時候預設安裝了這個 Plugin。現在只需要新增一個 replication.config 給 Gerrit

$ sudo -u gerrit -H vim /home/gerrit/gerrit/etc/replication.config

檔案內容為：

[remote "test-project1"]
  # Gerrit 上要同步專案的名字      
  projects = test-project1
  url = git@gitlab.zjc.com:dev-group/test-project1.git
  push = +refs/heads/*:refs/heads/*
  push = +refs/tags/*:refs/tags/*
  push = +refs/changes/*:refs/changes/*
  threads = 3

設定gerrit使用者的 ~/.ssh/config

$ sudo -u gerrit -H vim /home/gerrit/.ssh/config

檔案內容為：

Host gitlab.zjc.com:
    IdentityFile ~/.ssh/id_rsa
    PreferredAuthentications publickey

在gerrit使用者的~/.ssh/known_hosts 中，給 gitlab.zjc.com 新增 rsa 金鑰

$ sudo -u gerrit -H sh -c "ssh-keyscan -t rsa gitlab.zjc.com >> /home/gerrit/.ssh/known_hosts"
$ sudo -u gerrit -H sh -c "ssh-keygen -H -f /home/gerrit/.ssh/known_hosts"

重新啟動 Gerrit 服務

$ sudo /etc/init.d/gerrit restart

Gerrit 的複製功能配置完畢

在 gerrit 文件中有一個 ${name} 變數用來複制 Gerrit 的所有專案，這裡並不需要。如果有多個專案需要複製，則在 replication.config 中新增多個 [remote ….] 欄位即可。務必按照上面步驟配置複製功能。

在 Jenkins 上對 test-project1 專案建立構建任務

Jenkins上安裝git外掛

安裝 Git Plugin

• Manage Jenkins -> Manage Plugins -> Avalabile -> 安裝 Git Plugin

Jenkins上建立專案

新增 test-project1工程

• 用 jenkins 登入 Jenkins http://jenkins.zjc.com
• New Item頁面設定
  
  • Item name : test-project1
  • Freestyle project
    

• Git頁面設定
  

  • Source Code Management : Git
  • Branches to build : origin/$GERRIT_BRANCH
  • Build Triggers : Gerrit event
  • 
  • 按下文來配置，上面的無效 - 來自 這裡
    

  To get the Git Plugin to download your change; set Refspec to $GERRIT_REFSPEC and the Choosing strategy to Gerrit Trigger. You may also need to set 'Branches to build' to $GERRIT_BRANCH.  本系統中可用的是下面的配置 If this does not work for you set Refspec to refs/changes/*:refs/changes/* and 'Branches to build' to $GERRIT_REFSPEC 
  
  Note: Be aware that $GERRIT_BRANCH and $GERRIT_REFSPEC are not set in the Ref Updated case. If you want to trigger a build, you can set Refspec and 'Branches to build' to $GERRIT_REFNAME.

• 這裡 Choose a Server 選的是 Any Server 因為只有一個伺服器 Check4Gerrit, 所以要確保這個伺服器是 Enable 狀態。可以去伺服器那裡去檢查一下看看

• 

Gerrit Event頁面設定

• Trigger on : 點選 Add 分別新增 Patchset Created 和 Draft Published
• Dynamic Trigger Configuration
  
  • Pattern : test-project1
  • Branches : master
• 
  

Build頁面設定

• Add build step -> Execute shell
  cd $WORKSPACE
[ ! -e .testrepository ] && testr init
testr run
• 
  

測試

系統上 用 user1 提交一個更改

1. 用 user1 登入
2. 刪除目錄 test-project1
3. 克隆 test-project1 工程
4. 進入 test-project1 目錄
5. 新增檔案、提交
6. git review 增加 review 到Gerrit

$ su - user1
$ rm -rf test-project1/
$ git clone [email protected]:dev-group/test-project1.git
$ cd test-project1/
$ touch testfile
$ git add .
$ git commit -m 'add by user1'
$ git review
$ exit

我的環境還有一個問題 第一次 git review沒有問題，但是如果用 git commit --amend修改了提交資訊，再次 git reivew機會出現error: unpack failed: error Missing tree的錯誤，折中解決方案看這裡

用 admin 登入 Gerrit 系統，通過驗證，提交

登入 Gitlab

檢視 test-project1 工程，可以看到新增加檔案操作已經同步過來了

參考