Code Review - Gerrit (Install)

Git을 사용하게 되면 따라오는 가장 유명한 도구들이 두 가지가 있다.
하나는 앞에서 살펴본 계정 관리를 위한 Gitolite,
다른 하나는 코드 리뷰를 위한 Gerrit 이다.

특징은 Gitolite, Gerrit 두 가지 모두 Git 전용의 도구들이다.

Google에서 사용하고 있는 코드 리뷰 도구라고 해서 Git의 인기와 함께 각광을 받고 있는 Gerrit !!!

"코드 리뷰" 도구 시장에는 아직 세상을 통일한 절대 막강 도구가 마땅히 없다.
야후에서 사용한다고 하여 유명한 "리뷰 보드(Review Board)"가 있지만, Git 지원은 아직 기본적인 수준이다.

현재 현장 분위기는 Git을 사용한다면 코드 리뷰는 당연히 Gerrit을 사용한다고 생각하고 있다.



이번 포스팅을 위해서 몇 일을 날려가며 엄청 고생을 했다.
아무리 생각해도 이런 빈약한 자료들을 가지고도 Gerrit을 셋팅해서 잘 사용하시는 분들은 전부 고수들인가보다.
범인 수준인 필자는 정말 엄청 개고생(?)을 해서야 겨우 Gerrit 화면을 볼 수 있었다.

하지만, 언제나 그렇지만 성공하고나서 보면... 별것도 아닌 수준이었는데....라는 생각이 든다 ^^



1. Ready

     - Gerrit을 사용하기 위해서는 다음의 조건이 필요하다.
          ▷ JDK          : version 1.6 이상
          ▷ Database  : Gerrit 내장 H2, 또는 MySQL, PostgreSQL

     - JDK 설치는 다음의 포스팅으로 따라하면 된다.
     - http://whatwant.tistory.com/438

     - Gerrit 자체도 두 가지 방식으로 다운로드 받을 수 있다.
          ▷ Binary  : Jenkins와 같이 *.war 파일로 다운로드 받을 수 있다.
          ▷ Source : 빌드하여 바이너리로 직접 만들 수 있다. Apache Maven으로 빌드할 수 있다.

     - 좋은건지 나쁜건지 모르겠지만, 버전업이 상당히 빠른 Gerrit이다.
     - 안전성을 올리기 위한 것이라면 그나마 괜찮은데, 기능적인 면까지 많이 바뀌는 버전업이라 부담스럽기도 하다.



2. Download

     - 굳이 빌드를 수행할 필요없이 *.war 파일로 다운로드 받자.

$ wget http://gerrit.googlecode.com/files/gerrit-2.4.2.war

     - 포스팅을 하던 중에 업그레이드가 계속 되어 결국 스크린샷도 새로 만들어야 했다는... ^^



3. PostgreSQL

     - 이 블로그를 계속 봐오신 분들이라면 아시겠지만, 개인적으로 PostgreSQL을 사랑하는 것을 아실것이다!
     - postgresql이 설치되어있지 않은 경우엔, 그냥 [ sudo apt-get install postgresql ] 실행하면 된다.

     - Gerrit을 위한 PostgreSQL 계정과 db를 만들어줘야 한다.

$ sudo su - postgres

$ createuser -A -D -P -E gerrit2
$ createdb -E UTF-8 -O gerrit2 reviewdb

$ exit

     - 위와 같이 깔끔하게 끝~



4. Gerrit User

     - 참고로 Gerrit의 현재 버전은 version 2.4.1 이다. 그래서 그런지 Gerrit도 그냥 부르지 않고, Gerrit2 라고 한다.
     - Gerrit2를 위한 계정을 하나 만들고 그 계정에 모두 맞추자.

$ sudo adduser gerrit2
$ sudo chown gerrit2.gerrit2 ./gerrit-2.4.2.war
$ sudo su gerrit2

     - "gerrit2" 계정을 만들고 gerrit-2.4.1.war 파일을 해당 계정 소유로 만든 후 gerrit2 계정으로 su하자.




5. apache

     - 이번에는 웹서버로 apache로 셋팅을 해보겠다.
     - 나중에 시간이 잠시나면 꼭 nginx 환경에서 다시 해보도록 하겠다.

 

$ sudo apt-get install apache2

     - 설치를 했으면 확인을 하자.

     - Gerrit에서는 웹서버의 proxy 기능을 요구한다.

 

$ sudo apt-get install libapache2-mod-proxy-html

     - apache2의 proxy 모듈을 추가로 설치를 해주고,

$ sudo a2enmod proxy
$ sudo a2enmod proxy_http
$ sudo service apache2 restart

     - 웹서버 준비는 여기까지 끝~



6. Gerrit Install

     - 이제 준비 작업은 모두 끝났다. 설치를 진행하면 된다.

     - Gerrit의 기본적인 구성은 Jenkins와 같은 *.war 파일 구동방식이다.
     - 차이가 있다면, init 과정이 있다는 점 정도?!

 

$ sudo su gerrit2
$ cd /srv/install/gerrit

     - 설치과정을 진행하기 전에 권한을 맞추기 위한 선행 준비를 먼저 하자.

$ java -jar ./gerrit-2.4.2.war init -d /srv/workspace/gerrit

     - 위에서 명시한 디렉토리는 gerrit2 계정 권한으로 미리 만들어 두었다.

*** Gerrit Code Review 2.4.2
***

Create '/srv/workspace/gerrit' [Y/n]?  (Enter)

*** Git Repositories
***

Location of Git repositories   [git]: repositories

*** SQL Database
***

Database server type           [H2/?]: ?
       Supported options are:
         h2
         postgresql
         mysql
         jdbc
Database server type           [H2/?]: postgresql
Server hostname                [localhost]: (Enter)
Server port                    [(POSTGRESQL default)]: (Enter)
Database name                  [reviewdb]: (Enter)
Database username              [gerrit2]: (Enter)
gerrit2's password             : (passwd)
              confirm password : (passwd)

     - 이어서 계속 진행하자.

*** User Authentication
***

Authentication method          [OPENID/?]: ?
       Supported options are:
         openid
         http
         http_ldap
         client_ssl_cert_ldap
         ldap
         ldap_bind
         custom_extension
         development_become_any_account
Authentication method          [OPENID/?]: http
Get username from custom HTTP header [y/N]? (Enter)
SSO logout URL                 : (Enter)

*** Email Delivery
***

SMTP server hostname           [localhost]: smtp.gmail.com
SMTP server port               [(default)]: 587
SMTP encryption                [NONE/?]: (Enter)
SMTP username                  [gerrit2]:  @gmail.com
   @gmail.com's password  : (passwd)
              confirm password : (passwd)

*** Container Process
***

Run as                         [gerrit2]: (Enter)
Java runtime                   [/usr/local/java/jdk1.7.0_05/jre]: (Enter)
Copy gerrit.war to /srv/workspace/gerrit/bin/gerrit.war [Y/n]? (Enter)
Copying gerrit.war to /srv/workspace/gerrit/bin/gerrit.war

     - 인증 방식은 [ http ]로 정했다.
     - SMTP 설정은 gmail을 활용하기로 정했다. (이메일 주소는 살짝 지웠다 ^^ 다 알겠지만서도...)

 

*** SSH Daemon
***

Listen on address              [*]: (Enter)
Listen on port                 [29418]: (Enter)

Gerrit Code Review is not shipped with Bouncy Castle Crypto v144
  If available, Gerrit can take advantage of features
  in the library, but will also function without it.
Download and install it now [Y/n]?
Downloading http://www.bouncycastle.org/download/bcprov-jdk16-144.jar ... OK
Checksum bcprov-jdk16-144.jar OK
Generating SSH host key ... rsa... dsa... done

*** HTTP Daemon
***

Behind reverse proxy           [y/N]? (Enter)
Use SSL (https://)             [y/N]? (Enter)
Listen on address              [*]: (Enter)
Listen on port                 [8080]: (Enter)

Initialized /srv/workspace/gerrit
Executing /srv/workspace/gerrit/bin/gerrit.sh start
Starting Gerrit Code Review: OK
Waiting for server to start ... OK
Opening browser ...
No protocol specified

     - 나중에 설정 내용은 변경할 수 있으므로 최대한 기본값으로 정했다.

     - 그런데, 마지막 줄이 마음에 걸린다. [ No protocol specified ]




7. Configuration

     - 여기에서 바로 Gerrit이 실행되면 좋겠는데, 몇 가지 더 설정할 것들이 많다.

     - 앞에서도 언급을 했지만, 우리는 Apache의 Proxy를 활용하여 Gerrit을 띄울 것이다.
     - 그리고 Apache의 http authentication을 적용할 것이다.

     - 우선 관리자 계정 하나를 만들어 넣자.

$ sudo su gerrit2
$ htpasswd -c /srv/workspace/gerrit/etc/passwords "admin"

     - 앞의 설치 과정을 통해 만들어진 gerrit site 의 etc 디렉토리에 passwords 파일을 생성하는 것이다.
     - 앞으로 Gerrit 웹페이지는 이 파일을 이용하여 인증을 하게 된다.

     - Apache의 VirtualHost도 설정을 해주자.

$ sudo nano /etc/apache2/sites-available/gerrit2

<VirtualHost *:8081>
        ServerName localhost

        ProxyRequests Off
        ProxyVia Off
        ProxyPreserveHost On

        <Proxy *>
                Order deny,allow
                Allow from all
        </Proxy>

        <Location /login/>
                AuthType Basic
                AuthName "Gerrit Code Review"
                Require valid-user
                AuthUserFile /srv/workspace/gerrit/etc/passwords
        </Location>

        ProxyPass / http://127.0.0.1:8080/
</VirtualHost>

     - 위에서 각 포트가 중요한데, VirtualHost 에서는 8081 포트를 사용하고
     - Proxy에서는 8080 포트를 사용한다.

     - 추가로 sites-enabled 디렉토리에 동적링크도 만들어주자.

$ cd /etc/apache2/sites-enabled
$ sudo ln -s ../sites-available/gerrit2 ./001-gerrit2

     - 위와 같이 설정을 하였으면 Apache의 port 설정에도 추가해줘야 한다.

$ sudo nano /etc/apache2/ports.conf

NameVirtualHost *:8081
Listen 8081

     - 위와 같이 8081 포트에 대해서 설정을 추가로 적어주면 된다.

     - gerrit 의 설정값도 다시 한 번 살펴봐야 한다.

$ sudo su gerrit2
$ nano /srv/workspace/gerrit2/etc/gerrit.config

[gerrit]
        basePath = repositories
        canonicalWebUrl = http://localhost:8081/

[database]
        type = POSTGRESQL
        hostname = localhost
        database = reviewdb
        username = gerrit2

[auth]
        type = HTTP

[sendemail]
        smtpServer = smtp.gmail.com
        smtpServerPort = 587
        smtpUser =     @gmail.com

[container]
        user = gerrit2
        javaHome = /usr/local/java/jdk1.7.0_05/jre

[sshd]
        listenAddress = *:29418

[httpd]
        listenUrl = proxy-http://127.0.0.1:8080/

[cache]
        directory = cache

     - 위에서 빨간색으로 표시한 부분만 수정, 추가하면 된다.



8. restart

     - 재시작을 한 번 해보자.

$ sudo su gerrit2
$ cd /srv/workspace/gerrit/
$ ./bin/gerrit.sh restart

     - 이제 웹으로 확인을 해보자.

     - [ http://localhost:8081 ] 주소로 접속을 하면 위와 같이 이름과 암호를 물어본다.
     - 앞에서 "htpasswd"로 만든 계정을 이용해서 로그인하면 된다.

     - 드디어 길고 긴 과정을 거쳐서 gerrit의 화면이 나왔다.



9. Sign Out

     - 이렇게 설치를 했는데, 가장 원초적인 문제가 있다. 바로 [ Sign Out ]이 동작하지를 않는다.

     - 앞에서 [ gerrit.conf ] 파일을 수정할 때 넣은 [ canonicalWebUrl = http://localhost:8081/ ] 때문에 발생했다.
     - 하지만, 그 부분을 없애면 기본적인 동작도 하지 않는다.

     - 이 부분에 대한 해결책은 아직 찾지 못했다.
     - 찾게 되는 즉시 업데이트하도록 하겠다.