鉤子(hooks)—webhook

http://fighter.blog.51cto.com/1318618/1670667

https://www.lovelucy.info/auto-deploy-website-by-webhooks-of-github-and-gitlab.html

什麼是webhook?

wehook

A webhook is an API concept that's growing(激發) in popularity. As more and more of what we do on the web can be described by events, webhooks are becoming even more applicable. They're incredibly useful and a resource-light way to implement event reactions.

webhook是個在特定情況下觸發的一種api. 越來越多在web上的操作被描述為事件.

那個 Payload URL 上填上需要部署到的伺服器的網址，比方說 http://dev.lovelucy.info/incoming。然後之後每次有 push 事件 GitHub 都會主動往這個地址傳送一個 POST 請求，當然你也可以選擇任何事件都發個 POST 通知你。GitHub 還有個 Secret 的設定，就是一個字串，如果加上的話就在 POST 請求的 HTTP 頭中會帶一個 Hash 值做驗證密文，證明這個 POST 真是來自 GitHub，不然任何人都往那個地址 POST 忽悠你你都不知道誰是誰對吧……

what is events?

Events are at the core of webhooks. These webhooks fire whenever a certain action is taken on the repository, which your server's payload URL intercepts and acts upon.

事件是webhook的核心,當倉庫發生特定action會觸發webhook,

gitlab中解釋: Web 鉤子用於在專案發生相關事件時通知外部伺服器。

Git是在特定事件發生之前或之後執行特定指令碼程式碼功能（從概念上類比，就與監聽事件、觸發器之類的東西類似）。
Git Hooks就是那些在Git執行特定事件（如commit、push、receive等）後觸發執行的指令碼。
gitlab的web hooks跟git hook類似。也是當專案發生提交程式碼、提交tag等動作會自動去呼叫url，這個url可以是更新程式碼。或者其他操作。

配置目的：

由於系統屬於後臺介面系統，開發提交完git倉庫後要實時的部署到測試環境，這時候就需要用到gitlab的web hooks自動更新部署了。

客戶端：要自動更新的測試伺服器IP：192.168.1.2

服務端：Gitlab伺服器IP：192.168.1.1

Gitlab Version:     7.13.0.pre

GitLab-Shell  Version:     2.6.3

1、在客戶端上面配置apache配置檔案，為web hooks新增一個介面訪問

#vim /usr/local/apache/conf/httpd.conf
listen 81
<VirtualHost *:81>
          ServerAdmin localhost
          DocumentRoot "/www/gitlab_web"
       <Directory "/www/gitlab_web">
            Options -Indexes +FollowSymLinks
            AllowOverride None
            Order allow,deny
            Allow from all
          </Directory>
       RewriteEngine on
</VirtualHost>

2、在服務端gitlab上面為客戶端新增gitlab新賬號,然後將生成好的公鑰新增到gitlab好的賬號裡面(profile setting-->SSH  Keys -->add ssh key)

#su - webuser
#ssh-keygen -t rsa
進入專案目錄
#cd /path/project
初始化git倉庫 
#git clone [email protected]:test/test_api.git

3、在客戶端上面新增介面檔案

[[email protected] gitlab_web]# pwd
/www/gitlab_web
[[email protected] gitlab_web]# cat index.php 
<?php
//作為介面傳輸的時候認證的金鑰
$valid_token = 'd49dfa762268687eb2ca59498ce852';
//呼叫介面被允許的ip地址
$valid_ip = array('192.168.14.2','192.168.14.1','192.168.14.128');
$client_token = $_GET['token'];
$client_ip = $_SERVER['REMOTE_ADDR'];
$fs = fopen('./auto_hook.log', 'a');
fwrite($fs, 'Request on ['.date("Y-m-d H:i:s").'] from ['.$client_ip.']'.PHP_EOL);
if ($client_token !== $valid_token)
{
    echo "error 10001";
    fwrite($fs, "Invalid token [{$client_token}]".PHP_EOL);
    exit(0);
}
if ( ! in_array($client_ip, $valid_ip))
{
    echo "error 10002";
    fwrite($fs, "Invalid ip [{$client_ip}]".PHP_EOL);
    exit(0);
}
$json = file_get_contents('php://input');
$data = json_decode($json, true);
fwrite($fs, 'Data: '.print_r($data, true).PHP_EOL);
fwrite($fs, '======================================================================='.PHP_EOL);
$fs and fclose($fs);
//這裡也可以執行自定義的指令碼檔案update.sh，指令碼內容可以自己定義。
//exec("/bin/sh /root/updategit.sh");
exec("/bin/echo $valid_ip >>/tmp/webhook.txt");

4、訪問介面，測試介面是否成功

http://192.168.14.128:81/?token=d49dfa7622681425fbcbdd687eb2ca59498ce852

當然網頁是空白的.

5、檢視客戶端日誌

#cat /www/gitlab_web/auto_hook.log

=======================================================================
Request on [2015-07-03 14:05:02] from [112.122.112.112]
Data: 
=======================================================================

6、在服務端gitlab伺服器上面新增web hooks

admin area->projects->test/edit->WEB Hooks->add WEB Hooks

7、提交修改程式碼到gitlab倉庫，然後檢視日誌、檢視測試環境是否更新

#cat /www/gitlab_web/auto_hook.log

Request on [2015-07-03 14:13:37] from [12.123.12.3]
Data: Array
(
    [object_kind] => push
    [before] => e5988b5dce7a038
    [after] => d8ce92ac4ab4ba046dd
    [ref] => refs/heads/master
    [checkout_sha] => d8ceefd5c4ab4ba046dd
    [message] => 
    [user_id] => 7
    [user_name] => test
    [user_email] => [email protected]
    [project_id] => 3
    [repository] => Array
        (
            [name] => test_api
            [url] => [email protected]:test/test.api
            [description] => test.com product code
            [homepage] => http://xx./test_api
            [git_http_url] => http://xx./test_api 
            [git_ssh_url] => [email protected]:test.git
            [visibility_level] => 10
        )

    [commits] => Array
        (
            [0] => Array
                (
                    [id] => d8cec4ab4ba046dd
                    [message] => 測試gitlab的web hook介面。

                    [timestamp] => 2015-07-03T14:13:51+08:00
                    [url] => http://xxxx/test_api/commit/d8ce95c4ab4ba046dd
                    [author] => Array
                        (
                            [name] => test
                            [email] => [email protected]
                        )

                )

        )

    [total_commits_count] => 1
)

注意事項：

1、配置完成後。呼叫介面的時候沒有自動更新到測試環境。可以使用apache的執行使用者測試命令是否可以執行成功

#su - webuser

#cd /path/project

#git pull

2、如果apache的使用者無法執行命令或者無法更新git程式碼請檢查一下apache使用者的shell。

參考資料：