Geekly Articles each Day

GitHub、最新のソースコードからのWebサイトおよび自動テストサイト作成

この記事では、リポジトリのメインブランチからソースの最新バージョンを自動的に取得し、そこから共有ホスティングにプロジェクトをデプロイする方法に焦点を当てます。 昨日だけGitHubとGitに会ったことにすぐに注目したい。 したがって、この記事は経験のあるWebプログラマーにとってはささいなものに思えるかもしれません。 そして、Webプログラマーとしての旅を始めたばかりの人にとっては、それが役に立てば幸いです。


はじめに


小さな共有ホスティングWebサイトがあります。 完全なシェルアクセスはなく、スクリプトには一部の権限が制限されています。 たとえば、PHP システム関数とfile_get_contents関数は使用できません。 GitHubでリポジトリを作成し、変更を少し処理する方法を学び、ソースコードを更新したら、次に何をすべきかを考える時が来ました。 私は行動の変化を見たかったのですが、同時にメインサイトが機能し続けるようにしたかったのです。

私が利用できるスクリプト言語のうち、私はPHPしか知りません。 何を書くかの選択は自動的に行われました。 私のスクリプトは何らかの形でGitHubから更新通知を受信し、ソースコードをダウンロードする必要があることを理解しました。 development.mysite.comのサブドメインを作成し、そこに最新バージョンのソースをアップロードすることにしました。 さらに、GitHubと共有していないデータベースのパスワードを含むWebサイト構成ファイルがあります。 このファイルを機能させるには、ダウンロードしたソースに追加する必要があります。

したがって、プロセス全体を次の段階に分けることができます。


GitHub通知


ここではすべてが非常に簡単です。 GitHubはフックをサポートしています。 スクリプトのアドレスをPost-Receive URLに書き留めます 。それだけです。 リポジトリのメインブランチが変更されるたびに呼び出されます。 詳細については、 GitHubの Webサイトをご覧ください。 同時に、スクリプト内の最後のトランザクション（コミット）に関する情報を処理しません。

ソースをダウンロード


開発者には、コードをダウンロードするための2つのオプションがあります。


Github API

ソフトウェアインターフェイスを使用して、最後のコミットに関する情報を取得できます。 Tree SHA識別子が含まれています。 この識別子により、すべてのプロジェクトファイルのリストとコンテンツを順番に取得できます。

PHPでGitHub APIを使用する例は、David Walshのブログに記載されています。 そこからいくつかの便利な関数を取り、独自の関数を追加しましょう。 スクリプトを書き始めましょう。 すべてのパラメーターの最初
  1. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  2. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  3. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  4. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  5. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  6. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  8. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  9. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>
  10. <?php /* static settings */ $user = '<github_username>' ; $repo = '<github_reponame>' ; $user_repo = $user . '/' . $repo; $tree_base_url = "http://github.com/api/v2/json/tree/show/" . $user_repo; // path on the server where your repository will go $stage_dir = $_SERVER[ 'DOCUMENT_ROOT' ] . dirname($_SERVER[ 'SCRIPT_NAME' ]); ?>


スクリプトが置かれているディレクトリにソースコードのコピーが作成されます。 次に、Davidから覗いたアドレスでデータを取得する関数を挿入します。
  1. <？php
  2. / * URLを取得* /
  3. 関数 get_content_from_github（$ url）
  4. {
  5. $ ch = curl_init（）;
  6. curl_setopt（$ ch、CURLOPT_URL、$ url）;
  7. curl_setopt（$ ch、CURLOPT_RETURNTRANSFER、1）;
  8. curl_setopt（$ ch、CURLOPT_CONNECTTIMEOUT、1）;
  9. echo "取得：{$ url}" ;
  10. $ content = curl_exec（$ ch）;
  11. curl_close（$ ch）;
  12. $コンテンツを返します。
  13. }
  14. ？>


次に、 ツリーSHAを見つけてファイルのダウンロードを開始する機能があります。
  1. <？php
  2. 関数 get_repo_json（）
  3. {
  4. グローバル$ user、$ repo、$ user_repo、$ tree_base_url、$ stage_dir;
  6. $ json = array（）;
  7. $ list_commits_url = 'http://github.com/api/v2/json/commits/list/' $ user_repo。 '/マスター' ;
  9. echo "マスターブランチのURL：{$ list_commits_url} \ n <br>" ;
  10. $ json [ 'commit' ] = json_decode（get_content_from_github（$ list_commits_url）、 true ）;
  12. //最新のツリーのshaを取得します
  13. $ tree_sha = $ json [ 'commit' ] [ 'commits' ] [0] [ 'tree' ];
  14. echo "ツリーsha：{$ tree_sha} \ n <br>" ;
  15. $ cont_str = $ tree_base_url。 "/ {$ tree_sha}" ;
  16. $ base = json_decode（get_content_from_github（$ cont_str）、 true ）;
  18. //プロジェクト構造を出力します
  19. echo "<pre>" ;
  20. get_repo（$ base [ 'tree' ]、0、$ stage_dir）;
  21. echo "</ pre>" ;
  22. }
  23. ？>


この関数はget_repo関数を呼び出し、すべてのプロジェクトディレクトリを再帰的に渡します。
  1. <？php
  2. 関数 get_repo（$オブジェクト、$レベル= 0、$ current_dir）
  3. {
  4. グローバル$ tree_base_url、$ user_repo;
  6. chdir（$ current_dir）;
  8. foreach （$個のオブジェクトとして ＆$ object ）
  9. {
  10. $ type = $ object [ 'type' ];
  11. $ sha = $ object [ 'sha' ];
  12. $ name = $ object [ 'name' ];
  14. //パディングを追加します
  15. echo str_pad（ "" 、$ level、 "\ t" ）;
  16. エコー$名。 "\ n" ;
  18. if （strcmp（$ type、 "tree" ）== 0）
  19. {
  20. mkdir（$ name）;
  22. $ new_dir = $ current_dir。 '/' $名前;
  24. $ tree = $ tree_base_url。 '/' $ sha;
  25. $ new_objects = json_decode（get_content_from_github（$ tree）、 true ）;
  27. get_repo（$ new_objects [ 'tree' ]、$ level + 1、$ new_dir）;
  29. //現在のディレクトリを元に戻す
  30. chdir（$ current_dir）;
  31. }
  32. 他に
  33. {
  34. //ファイルのコンテンツを取得します
  35. $ blob_url = "http://github.com/api/v2/json/blob/show/" 。 $ user_repo。 「/」 。 $ sha;
  36. $ data = get_content_from_github（$ blob_url）;
  38. $ filename = $ current_dir。 '/' $名前;
  39. file_put_contents（$ファイル名、$データ）;
  40. }
  41. }
  42. }
  43. ？>


追加情報なしで、すぐにファイルの内容を取得することは注目に値します。 したがって、他のAPI関数の呼び出しの場合のように、 json_decode関数を呼び出す必要はありません。

APIを介してソースを取得した結果

このスクリプトには、2つの重大な欠点があります。

さらに、プロジェクトを個別のファイルに送り込むというアイデアは、イデオロギー的に間違っているようです。

プロジェクトのメインブランチでアーカイブする

GitHubのボタンをつついて、アーカイブバージョンのソースファイルをダウンロードできることを発見しました。 このアプローチははるかに優れています！ ZipアーカイブまたはTarをダウンロードできます。 Zipを選択したのは、共有ホスティングで解凍する方が簡単だからです。 スクリプトを見てみましょう。
  1. <？php
  2. $ download = true ;
  3. $ unzip = true ;
  4. $ move = true ;
  6. $ stage_dir = $ _SERVER [ 'DOCUMENT_ROOT' ]。 dirname（$ _ SERVER [ 'SCRIPT_NAME' ]）;
  7. $ filepath = $ stage_dir。 '/' 'master.zip' ;
  9. echo "<pre>" ;
  10. ？>


変数download 、 unzip、およびmoveは、プログラムの進行を制御し、その一部を無効にできるようにします。 デバッグに使用できます。 たとえば、アーカイブが既にダウンロードされているが、解凍されていない場合、再度ダウンロードしても意味がありません。
  1. <？php
  2. if （$ダウンロード）
  3. {
  4. $ url = "http://github.com/ <your_github_username> / <your_github_repo_name> / zipball / master" ;
  6. $ ch = curl_init（）;
  7. curl_setopt（$ ch、CURLOPT_URL、$ url）;
  8. curl_setopt（$ ch、CURLOPT_RETURNTRANSFER、1）;
  9. curl_setopt（$ ch、CURLOPT_CONNECTTIMEOUT、1）;
  10. echo "取得：{$ url} \ n" ;
  11. $ content = curl_exec（$ ch）;
  12. echo "Got \" {$ content} \ "\ n" ;
  13. curl_close（$ ch）;
  15. $ dom = new DOMDocument（）;
  16. @ $ dom-> loadHTML（$ content）;
  18. $ xpath = new DOMXPath（$ dom）;
  19. $ hrefs = $ xpath-> evaluate（ "/ html / body // a" ）;
  21. $ href = $ hrefs->アイテム（0）;
  22. $ zipurl = $ href-> getAttribute（ 'href' ）;
  23. echo "Zip url：{$ zipurl} \ n" ;
  25. $ data = http_get_file（$ zipurl）;
  26. if （substr（$ data、 "http：//" ））
  27. {
  28. $ data = http_get_file（$ data）;
  29. }
  31. file_put_contents（$ファイルパス、$データ）;
  32. }
  33. ？>


GitHubはいくつかのリダイレクトを行いますが、何らかの理由でCURLで実行されません。 したがって、その助けを借りて、最初のリダイレクトのアドレスを見つけて、それを通過しようとします。 別のリダイレクトアドレスを取得し、最後に貴重なアーカイブを取得します。 上記のコードで使用されているhttp_get_file関数：
  1. <？php
  2. 関数 http_get_file（$ url）
  3. {
  4. $ url_stuff = parse_url（$ url）;
  5. $ port = isset（$ url_stuff [ 'port' ]）？ $ url_stuff [ 'port' ]：80;
  7. $ path = $ url_stuff [ 'path' ];
  8. $ last = $ path [strlen（$ path）-1];
  9. if （strcmp（$ last、 "_" ）== 0）
  10. {
  11. $ path = substr_replace（$ path、 "" 、-1）;
  12. }
  14. $ fp = fsockopen（$ url_stuff [ 'host' ]、$ port）;
  16. $ query = 'GET' 。 $パス。 "HTTP / 1.0 \ n" ;
  17. $ query。= 'Host：' 。 $ url_stuff [ 'host' ];
  18. $ query。= "\ n \ n" ;
  20. fwrite（$ fp、$ query）;
  22. while （$ line = fread（$ fp、1024））
  23. {
  24. $ buffer。= $ line;
  25. }
  26. if （preg_match（ '/ ^ Location：（。+？）$ / m' 、$ buffer、$ matches））
  27. {
  28. $マッチ[1]を返します。
  29. }
  31. preg_match（ '/ Content-Length：（[0-9] +）/' 、$バッファー、$パーツ）;
  32. return substr（$バッファー、-$パーツ[1]）;
  33. }
  34. ？>


奇妙な機能が発見されました。 実際のアーカイブを指す最後のアドレスでparse_url関数を実行した後、ファイル名の最後にアンダースコアが追加されます。

アーカイブを解凍します。
  1. <？php
  2. if （$解凍）
  3. {
  4. echo "アーカイブの圧縮解除... \ n" ;
  5. $ zip = 新しい ZipArchive;
  6. $ res = $ zip-> open（$ filepath）;
  7. if （$ res === TRUE）
  8. {
  9. $ zip-> extractTo（$ stage_dir）;
  10. $ zip-> close（）;
  11. echo "完了！\ n" ;
  12. } その他
  13. {
  14. echo "失敗\ n" ;
  15. exit（1）;
  16. }
  17. }
  18. ？>


アーカイブ内では、ユーザー名、リポジトリ名、SHAのコミットコードで構成される名前のフォルダーを待機しています。 そして、このフォルダー内にプロジェクトファイルがあります。 このコードフォルダーがあります。 次のステップでは、 コードフォルダーをより高いレベルに移動します。 これは、サブドメインマッピングが正しく機能するために必要です。 サブドメインは、たとえば/ public_html / developmentフォルダーに構成されます。 アーカイブは/ public_html / development / <user> _ <repo> _ <sha> / <files>に解凍されます 。
  1. <？php
  2. if （$移動）
  3. {
  4. $ files = scandir（$ stage_dir）;
  5. $ match_array = preg_grep（ '/ <user_name> * /' 、$ files）;
  6. if （is_array（$ match_array））
  7. {
  8. //すべてのディレクトリがあれば削除します
  9. delete_directory（ "code" ）;
  10. $ dir_name = current（$ match_array）;
  11. $ rep_dir = $ dir_name。 「/コード」 ;
  12. echo "{$ rep_dir}をコードに移動してみてください\ n" ;
  13. rename（$ rep_dir、 "code" ）;
  14. rmdir（$ dir_name）;
  15. echo "ファイルの移動を完了しました\ n" ;
  16. }
  17. }
  19. 関数 delete_directory（$ dirname）
  20. {
  21. if （is_dir（$ dirname））
  22. $ dir_handle = opendir（$ dirname）;
  23. if （！$ dir_handle）
  24. falseを 返し ます 。
  25. while （$ file = readdir（$ dir_handle））
  26. {
  27. if （$ file！= "。" && $ file！= ".." ）
  28. {
  29. if （！is_dir（$ dirname。 " /"。$ file））
  30. unlink（$ dirname。 " /"。$ file）;
  31. 他に
  32. delete_directory（$ dirname。 ' /'。$ file）;
  33. }
  34. }
  35. closedir（$ dir_handle）;
  36. rmdir（$ dirname）;
  37. }
  38. ？>


最後に、 / public_html / development /フォルダーにある構成ファイルをコピーします
  1. <？php
  2. copy（ "config.php" 、 "<new_path> /core.php" ）;
  3. echo "すべてのジョブが完了しました！\ n" ;
  4. echo "</ pre>" ;
  5. ？>
*このソースコードは、 ソースコードハイライターで強調表示されました。


アーカイブされたソースコードをダウンロードするスクリプトの結果

スクリプトは必要なことを行います！ =）

おわりに


この記事では、ソースコードがGitHubシステムに保存されているWebサイトのテストソフトウェア環境を作成する方法を検討しました。 提案されたアプローチは、将来的に組み合わせることができます。 まず、アーカイブをダウンロードしてリポジトリの完全なコピーを作成し、最後のコミットでどのファイルが変更されたかを追跡し、それらのみを更新します。

テストソフトウェア環境を作成するために適用したソリューションは理想的ではない場合があります。 他の人がどのようにそれをしているのか知りたいです。 あなたの知識を共有してください！

PSこの記事は、 ダイブ habrayuzerの支援を受けて公開されました。 よろしくお願いします！

Source: https://habr.com/ru/post/J83235/

More articles:


All Articles