BuildBotを使用した継続的インテグレーションの実装例

（画像による コンピュータ化者 から ピクサベイ）

Привет！

私の名前は エフゲニー・チェルキン, 私は鉱山会社の開発チームのプログラマーです。 ポリメタル.

大規模なプロジェクトを開始するとき、「プロジェクトを維持するにはどのソフトウェアを使用するのが最適か?」と考え始めます。 IT プロジェクトは、次のバージョンをリリースするまでにいくつかの段階を経ます。 これらの段階の連鎖が自動化されると良いでしょう。 IT プロジェクト自体の新しいバージョンをリリースする自動化されたプロセスは、 継続的インテグレーション. ビルドボット このプロセスを実装する際に、私たちにとって優れたアシスタントであることがわかりました。

この記事では、可能性の概要を提供することにしました ビルドボット。 このソフトウェアには何ができるのでしょうか? 彼にどのようにアプローチし、彼と通常の効果的な仕事関係を築くにはどうすればよいでしょうか? 自分のマシン上でプロジェクトを構築してテストするための実用的なサービスを作成することで、私たちの経験を自分で適用することができます。

ページ内容

ページ内容

1.なぜBuildBotなのか?
2. BuildMaster主導のコンセプト
3. インストール
4. 最初のステップ

5. 設定。 ステップバイステップのレシピ

5.1 ビルドマスター構成
5.2労働者
5.3 変更ソース
5.4 スケジューラー

5.5 ビルドファクトリー
5.6ビルダー

6. 独自の構成の例

6.1 master.cfg に向かう途中
6.2 svn の操作
6.3 あなたへの手紙: 記者には宣言する権限がある

やった！ おめでとう

1.なぜBuildBotなのか?

以前、habr-e で実装に関する記事を見つけました。 継続的インテグレーション を使用して ビルドボット。 例えば これです 最も有益だと思いました。 別の例もあります - より単純な。 これらの記事は味付けすることができます マニュアルからの例と それ 後は英語で。 クーペは良い出発点になります。 これらの記事を読むと、おそらくすぐに何かが欲しくなるでしょう。 ビルドボット する。

停止！ 実際にプロジェクトで使用した人はいますか? そうです 多くの それを自分たちのタスクに適用しました。 見つかる 例 使用 ビルドボット Google コード アーカイブにもあります。

では、人々が使用しているロジックは何ですか ビルドボット? 結局のところ、他にもツールがあります。 クルーズコントロール и ジェンキンズ。 私はこう答えます。 ほとんどのタスクでは ジェンキンズ そして真実だけで十分だろう。 その順番で、 ビルドボット - より適応性が高く、問題はそこでも同じように簡単に解決されます。 ジェンキンズ。 選択はあなた次第です。 しかし、開発対象プロジェクト用のツールを探しているのですから、簡単な手順から対話性と独自のインターフェイスを備えたビルド システムを取得できるツールを選択してみてはいかがでしょうか。

ターゲット プロジェクトが Python で記述されている場合、「プロジェクトで使用される言語に関して明確なインターフェイスを備えた統合システムを選択してはどうでしょうか?」という疑問が生じます。 そして今度はメリットを紹介します ビルドボット.

ということで、私たちの「器楽四重奏団」。 私自身、XNUMXつの特徴を特定しました ビルドボット:

1. GPLライセンスに基づくオープンソースフレームワークです
2. これは、構成ツールとしての Python の使用と必要なアクションの説明です。
3. これは、組み立てが行われるマシンからの応答を受け取る機会です。
4. 最後に、これらはホストの最小要件です。 デプロイには Python とTwisted が必要ですが、仮想マシンや Java マシンは必要ありません。

2. BuildMaster主導のコンセプト

タスク分散アーキテクチャの中心となるのは、 ビルドマスター。 それは次のようなサービスです。

• 追跡します プロジェクトのソースツリーの変更
• 送る プロジェクトをビルドしてテストするために Worker サービスによって実行される必要があるコマンド
• 通知する ユーザーがとったアクションの結果について

ビルドマスター ファイル経由で設定 マスター.cfg。 このファイルはルートにあります ビルドマスター。 このルートがどのように作成されるかを後で説明します。 ファイル自体 マスター.cfg 呼び出しを使用する Python スクリプトが含まれています ビルドボット.

次に重要なオブジェクト ビルドボット これは、名前を持っています ワーカー。 このサービスは、別の OS を搭載した別のホスト上で起動できます。あるいは、 ビルドマスター。 独自のパッケージと変数を備えた特別に準備された仮想環境に存在することもできます。 これらの仮想環境は、次のような Python ユーティリティを使用して準備できます。 仮想環境、venv.

ビルドマスター コマンドを全員にブロードキャストします ワーカー-y、そして彼は順番にそれらを満たします。 つまり、プロジェクトの構築とテストのプロセスを続行できることがわかります。 ワーカー-e は Windows を実行し、別の Worker では Linux を実行します。

チェックアウト プロジェクトのソースコードはそれぞれに発生します ワーカーええ。

3. インストール

じゃ、行こう。 ホストとして Ubuntu 18.04 を使用します。 その上にXNUMXつ置きます ビルドマスター-aとXNUMX ワーカー-a. ただし、最初に python3.7 をインストールする必要があります。

sudo apt-get update
sudo apt-get install python3.7

3.7.2 の代わりに Python3.7.1 が必要な場合は、次の手順を実行できます。

sudo apt-get update
sudo apt-get software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get install python3.7
sudo ln -fs /usr/bin/python3.7 /usr/bin/python3
pip3 install --upgrade pip

次のステップはインストールです ツイートしました и ビルドボット、追加機能を使用できるようにするパッケージも含まれます。 ビルドボット-そして。

/*Все что под sudo будет установленно для всех пользователей в директорию /usr/local/lib/python3.7/dist-packages*/

#На хосте который производит мониторинг Worker-ов 
sudo pip install twisted #Библиотека twisted
sudo pip install buildbot #BuildMaster
#Дополнительный функционал
pip install pysqlite3 #Устанавливаем базу sqllite в учебных целях
pip install jinja2 #framework наподобие django, для web и для почтовых рассыллок
pip install autobahn #Web cокеты для связи BuildMaster->Worker
pip install sqlalchemy sqlalchemy-migrate #Для отображения схемы базы данных
#Для Web отображения BuildBot-a
pip install buildbot-www buildbot-grid-view buildbot-console-view buildbot-waterfall-view
pip install python-dateutil #Отображение дат в web
#На стороне хоста который непосредственно осуществляет сборку и тестирование 
pip install buildbot-worker #Worker
#Дополнительный функционал
sudo pip install virtualenv #Виртуальная среда 

4. 最初のステップ

作成する時間 ビルドマスター。 それは私たちのフォルダーにあります /ホーム/ハブ/マスター.

mkdir master
buildbot create-master master # Собственно сдесь и создаем

次のステップ。 作成しましょう ワーカー。 それは私たちのフォルダーにあります /ホーム/ハブ/ワーカー.

mkdir worker
buildbot-worker create-worker --umask=0o22 --keepalive=60 worker localhost:4000 yourWorkerName password

走るとき ワーカー、デフォルトでは、次の場所に作成されます。 /ホーム/ハブ/ワーカー で指定したプロジェクト名のフォルダー マスター.cfg。 そして、プロジェクトの名前のフォルダーにディレクトリが作成されます ビルド、これからもやっていきます チェックアウト。 の作業ディレクトリ ワーカー-そしてそれはディレクトリになります /home/habr/yourProject/build.

「黄金の鍵」
さて、前の段落で書いたスクリプトは次のとおりです。 Master から要求します ワーカー-このディレクトリでリモートで実行された場合、スクリプトには実行権限がないため、実行されません。 状況を修正するにはキーが必要です --umask=0o22、このディレクトリへの書き込みは禁止されますが、起動権限は保持されます。 必要なのはそれだけです。

ビルドマスター и ワーカー 相互に接続を確立します。 切れてしまうこともあるし、 ワーカー からの応答をしばらく待ちます ビルドマスター-A. 応答がない場合は、接続が再開されます。 鍵 --キープアライブ=60 その後の時間を示すだけで十分です 接続する 再起動します。

5. 設定。 ステップバイステップのレシピ

設定 ビルドマスター コマンドを実行したマシン側で実行されます 作成マスター。 私たちの場合、これはディレクトリです /ホーム/ハブ/マスター。 設定ファイル マスター.cfg まだ存在しませんが、コマンド自体がすでにファイルを作成しています マスター.cmg.サンプル。 名前を変更する必要があります マスター.cfg.サンプル в マスター.cfg

mv master.cfg.sample master.cfg

これを開いてみましょう マスター.cfg。 そして、それが何で構成されているかを見てみましょう。 その後、独自の設定ファイルを作成してみましょう。

マスター.cfg

c['change_source'] = []
c['change_source'].append(changes.GitPoller(
    'git://github.com/buildbot/hello-world.git',
         workdir='gitpoller-workdir', branch='master',
         pollInterval=300))
                        
c['schedulers'] = []
c['schedulers'].append(schedulers.SingleBranchScheduler(
        name="all",
        change_filter=util.ChangeFilter(branch='master'),
        treeStableTimer=None,
        builderNames=["runtests"]))
c['schedulers'].append(schedulers.ForceScheduler(
        name="force",
        builderNames=["runtests"]))
                        
factory = util.BuildFactory()
                        
factory.addStep(steps.Git(repourl='git://github.com/buildbot/hello-world.git', mode='incremental'))
factory.addStep(steps.ShellCommand(command=["trial", "hello"],
                                   env={"PYTHONPATH": "."}))
                        
c['builders'] = []
c['builders'].append(
    util.BuilderConfig(name="runtests",
    workernames=["example-worker"],
    factory=factory))
                         
c['services'] = []
                        
c['title'] = "Hello World CI"
c['titleURL'] = "https://buildbot.github.io/hello-world/"
                        
                        
c['buildbotURL'] = "http://localhost:8010/"
                        
c['www'] = dict(port=8010,
                plugins=dict(waterfall_view={}, console_view={}, grid_view={}))
                        
c['db'] = {
    'db_url' : "sqlite:///state.sqlite",
}

5.1 ビルドマスター構成

c = BuildmasterConfig = {} 

ビルドマスター構成 — 設定ファイルの基本辞書。 構成ファイルに含める必要があります。 使いやすくするために、構成コードにエイリアスが導入されています。 「c」。 タイトル キーの в c["キーからの距離"] との対話のための固定要素です ビルドマスター。 各キーについて、対応するオブジェクトが値として置き換えられます。

5.2労働者

c['workers'] = [worker.Worker("example-worker", "pass")]

今回ご案内するのは、 ビルドマスター-y のリスト ワーカー-s。 自分自身 ワーカー 私たちが作った 上記、を示します あなた、従業員の名前 и password。 代わりにそれらを指定する必要があります 例の労働者 и パス .

5.3 変更ソース

c['change_source'] = []
c['change_source'].append(changes.GitPoller(
                            'git://github.com/buildbot/hello-world.git',
                             workdir='gitpoller-workdir', branch='master',
                             pollInterval=300))                

キーによる 変更元 Dictionary c を使用すると、プロジェクトのソース コードを含むリポジトリをポーリングするオブジェクトを配置するリストにアクセスできます。 この例では、特定の間隔でポーリングされる Git リポジトリを使用します。

最初の引数はリポジトリへのパスです。

作業ディレクトリ は横にあるフォルダーへのパスを表します ワーカー- パスに対する相対値 /home/habr/worker/yourProject/build git はリポジトリのローカル バージョンを保存します。

ブランチ リポジトリ内の従うべき特定のブランチが含まれています。

ポーリング間隔 その後の秒数が含まれます ビルドマスター 変更がないかリポジトリをポーリングします。

プロジェクトのリポジトリへの変更を追跡するには、いくつかの方法があります。

最も簡単な方法は ポーリング、これは次のことを意味します ビルドマスター リポジトリを使用してサーバーを定期的にポーリングします。 もし コミット リポジトリ内の変更を反映してから、 ビルドマスター 多少の遅れを伴いながら内部オブジェクトを作成します 変更する そしてそれをイベントハンドラーに送信します スケジューラ, これにより、プロジェクトをビルドしてテストする手順が開始されます。 ワーカー-e。 これらの手順の中で示されるのは、 update リポジトリ。 まさにオン ワーカーこれにより、リポジトリのローカル コピーが作成されます。 このプロセスの詳細については、次の XNUMX つのセクションで説明します。 (5.4 и 5.5).

リポジトリへの変更を追跡するさらに洗練された方法は、リポジトリをホストしているサーバーからメッセージを直接送信することです。 ビルドマスター- プロジェクトのソースコードの変更について。 この場合、開発者が作成するとすぐに、 コミット、プロジェクト リポジトリを持つサーバーがメッセージを送信します。 ビルドマスター-y。 そして彼は今度はオブジェクトを作成することでそれを傍受します PB変更ソース。 次に、このオブジェクトはに転送されます スケジューラこれにより、プロジェクトをビルドしてテストする手順がアクティブになります。 このメソッドの重要な部分は、 フック-リポジトリ内のサーバー スクリプト。 スクリプト内で フック-a、次の場合のアクションの処理を担当します。 コミット-e、ユーティリティを呼び出す必要があります 送信変更 そしてネットワークアドレスを指定します ビルドマスター-A. リッスンするネットワーク ポートも指定する必要があります。 PB変更ソース. PB変更ソースちなみに、 は一部です ビルドマスター-A. この方法には許可が必要です 管理人-a プロジェクト リポジトリが配置されているサーバー上で。 まずリポジトリのバックアップを作成する必要があります。

5.4 スケジューラー

c['schedulers'] = []
c['schedulers'].append(schedulers.SingleBranchScheduler(
        name="all",
        change_filter=util.ChangeFilter(branch='master'),
        treeStableTimer=None,
        builderNames=["runtests"]))
c['schedulers'].append(schedulers.ForceScheduler(
        name="force",
        builderNames=["runtests"]))

スケジューラー – これは、プロジェクトのアセンブリとテストのチェーン全体を開始するトリガーとして機能する要素です。


記録されたそれらの変更 変更元、作業の過程で変換されます ビルドボット-a オブジェクトへ 変更する そして今では毎回 シェドゥラー それらに基づいて、プロジェクトのビルド プロセスを開始するためのリクエストを作成します。 ただし、これらのリクエストがいつキューに転送されるかも決定します。 オブジェクト ビルダー リクエストのキューを保存し、別のサーバーで現在のアセンブリの状態を追跡します。 ワーカー-です。 ビルダー に存在します ビルドマスター-e以降 ワーカー-e。 彼は一緒に送ります ビルドマスター-a オン ワーカー-そしてすでに具体的です ビルド - 従う必要がある一連の手順。
現在の例では、次のようなことがわかります スケジューラー 2個作成されます。 さらに、それぞれに独自のタイプがあります。

シングルブランチスケジューラ – スケジュールの中で最も人気のあるクラスの XNUMX つ。 これは XNUMX つのブランチを監視し、そのブランチ内で記録された変更によってトリガーされます。 変更を確認した場合、ビルド リクエストの送信を遅らせることができます (特別なパラメーターで指定された期間だけ遅延します)。 ツリー安定タイマー） で 名 に表示されるスケジュールの名前を設定します。 ビルドボット-ウェブインターフェイス。 で フィルター変更 フィルターが設定され、ブランチ内の変更を通過した後、スケジュールに構築リクエストの送信が要求されます。 で ビルダー名 名前が記載されている ビルダー-a、少し後で設定します。 この場合の名前はプロジェクト名と同じになります。 あなたのプロジェクト.

フォーススケジューラ とても単純なこと。 このタイプのスケジュールは、マウスのクリックによってトリガーされます ビルドボット-ウェブインターフェイス。 パラメータの本質は次のとおりです。 シングルブランチスケジューラ.

PSその3。 もしかしたら役に立つかもしれない
定期的な 特定の時間に固定された頻度で実行されるスケジュールです。 呼び出しは次のようになります

from buildbot.plugins import schedulers
nightly = schedulers.Periodic(name="daily",
                              builderNames=["full-solaris"],
                              periodicBuildTimer=24*60*60)
c['schedulers'] = [nightly]                    

5.5 ビルドファクトリー

factory = util.BuildFactory()
                        
factory.addStep(steps.Git(repourl='git://github.com/buildbot/hello-world.git', mode='incremental'))
factory.addStep(steps.ShellCommand(command=["trial", "hello"],
                                   env={"PYTHONPATH": "."}))

定期的なビルドタイマー この周期の時間を秒単位で指定します。

ビルドファクトリー 特定のを作成します ビルド、すると ビルダー に送信します ワーカー。 で ビルドファクトリー 従うべき手順を示します ワーカー-y。 メソッドを呼び出すことでステップが追加されます 追加ステップ

この例で最初に追加されたステップは次のとおりです。 git clean -d -f -f –x、その後 gitチェックアウト。 これらのアクションはパラメータに含まれます 方法、明確に記載されていませんが、デフォルト値を暗示しています。 新鮮な。 パラメータ モード='インクリメンタル' ファイルが次のディレクトリからのものであることを示します。 チェックアウト、リポジトリから欠落している間は、変更されないままになります。

XNUMX 番目に追加されたステップはスクリプトの呼び出しです。 トライアル パラメータ付き こんにちは 横に ワーカー-a ディレクトリから /home/habr/worker/yourProject/build 環境変数 PATHONPATH=... を使用すると、独自のスクリプトを作成してサイドで実行できます。 ワーカー-すべてのステップ util.ShellCommand。 これらのスクリプトはリポジトリに直接配置できます。 その後、 チェックアウト-e 彼らは陥るだろう /home/habr/worker/yourProject/build。 ただし、次の XNUMX つの「ただし」があります。

1. ワーカー キーを使用して作成する必要があります --umask 後の実行権限をブロックしないようにするため チェックアウト-そして。
2. に git pushこれらのスクリプトの -e プロパティを指定する必要があります 実行可能それで後で チェックアウト-e は、Git スクリプトを実行する権利を失いませんでした。

5.6ビルダー

c['builders'] = []
c['builders'].append(util.BuilderConfig(name="runtests",
                                        workernames=["example-worker"],
                                        factory=factory))

とは何かについて ビルダー 言われた ここで。 それでは、作成方法について詳しく説明していきます。 ビルダー構成 コンストラクターです ビルダー。 そんなデザイナーたちが、 c['ビルダー'] これはオブジェクトのシートであるため、複数指定できます ビルダー タイプ。 では、次の例を書き直してみましょう。 ビルドボット、私たちのタスクに近づけます。

c['builders'] = []
c['builders'].append(util.BuilderConfig(name="yourProject",
                                            workernames=["yourWorkerName"],
                                            factory=factory))

次にパラメータについて説明します ビルダー構成.

名 名前を指定します ビルダー-a. ここで名前を付けました あなたのプロジェクト。 これは、 ワーカー- まさにこのパスが作成されます /home/habr/worker/yourProject/build. シェドゥラー 探している ビルダー この名前だけで。

労働者名 シートが含まれています ワーカー-s。 それぞれを追加する必要があります c['労働者'].

工場 - 特定の ビルド、それに関連付けられています ビルダー。 彼は物体を送ります ビルド на ワーカー この文書に含まれるすべての手順を完了するには ビルド-そして。

6. 独自の構成の例

これは、私が実装することを提案するプロジェクト アーキテクチャの例です。 ビルドボット
.

バージョン管理システムとして使用します SVN。 リポジトリ自体は、ある種のクラウドに配置されます。 このクラウドのアドレスは次のとおりです svn.host/svn/yourProject/trunk。 下の雲の中で SVN アカウントのユーザー名があります: user、パスワード: password。 ステップを表すスクリプト ビルド-a もブランチに存在します SVN、別のフォルダーにあります buildbot/worker_linux。 これらのスクリプトは、保存されたプロパティを持つリポジトリにあります。 実行ファイル.

ビルドマスター и ワーカー 同じホスト上で実行する プロジェクト.ホスト .ビルドマスター ファイルをフォルダーに保存します /ホーム/ハブ/マスター. ワーカー 次のパスに保存されます /ホーム/ハブ/ワーカー。 プロセス通信 ビルドマスター-aと ワーカー-a はプロトコルに従ってポート 4000 経由で実行されます ビルドボット-あ、つまり 「pb」 プロトコル。

ターゲット プロジェクトはすべて Python で書かれています。 タスクは、変更を追跡し、実行可能ファイルを作成し、ドキュメントを生成し、テストを実施することです。 失敗した場合、すべての開発者は、アクションが失敗したことを示すメッセージを電子メールで送信する必要があります。

ウェブ表示 ビルドボット ポート80に接続します プロジェクト.ホスト。 Apatchをインストールする必要はありません。 図書館の一部として ねじれた すでにWebサーバーが存在しており、 ビルドボット それを使用します。

内部情報を保存するため ビルドボット будемиспользовать sqlite.

メール送信にはホストが必要です smtp.your.domain - メールから手紙を送信できるようになります [メール保護] 認証なしで。 ホスト上でも」SMTP 議事録はポスト 1025 で審理されます。

このプロセスには XNUMX 人が関与します。 管理人 и user。 管理者が管理する ビルドボット。 ユーザーはコミットする人です コミット-s。

実行可能ファイルは次のように生成されます。 pyインストーラー。 ドキュメントは次の方法で生成されます。 ドキシゲン.

このアーキテクチャについては、次のように書きました。 マスター.cfg:

マスター.cfg

import os, re
from buildbot.plugins import steps, util, schedulers, worker, changes, reporters

c= BuildmasterConfig ={}

c['workers'] = [ worker.Worker('yourWorkerName', 'password') ]
c['protocols'] = {'pb': {'port': 4000}} 


svn_poller = changes.SVNPoller(repourl="https://svn.host/svn/yourProject/trunk",
                                svnuser="user",
                                svnpasswd="password",
                                pollinterval=60,
				split_file=util.svn.split_file_alwaystrunk
                                )

c['change_source'] =  svn_poller

hourlyscheduler = schedulers.SingleBranchScheduler(
                                name="your-project-schedulers",
				change_filter=util.ChangeFilter(branch=None),
                                builderNames=["yourProject"],
				properties = {'owner': 'admin'}
                                )

c['schedulers'] = [hourlyscheduler]

checkout = steps.SVN(repourl='https://svn.host/svn/yourProject/trunk',
                        mode='full',
                        method='fresh',
                        username="user",
                        password="password",
                        haltOnFailure=True)

	
projectHost_build = util.BuildFactory()  


cleanProject = steps.ShellCommand(name="Clean",
                 command=["buildbot/worker_linux/pyinstaller_project", "clean"]
                                )
buildProject = steps.ShellCommand(name="Build",
                 command=["buildbot/worker_linux/pyinstaller_project", "build"]
                                )
doxyProject = steps.ShellCommand(name="Update Docs",
                                command=["buildbot/worker_linux/gendoc", []]
                                )
testProject = steps.ShellCommand(name="Tests",
                                command=["python","tests/utest.py"],
                                env={'PYTHONPATH': '.'}
                                )

projectHost_build.addStep(checkout)
projectHost_build.addStep(cleanProject)
projectHost_build.addStep(buildProject)
projectHost_build.addStep(doxyProject)
projectHost_build.addStep(testProject)


c['builders'] = [
        util.BuilderConfig(name="yourProject", workername='yourWorkerName', factory=projectHost_build)
]


template_html=u'''
<h4>Статус построенного релиза: {{ summary }}</h4>
<p>Используемый сервис для постраения: {{ workername }}</p>
<p>Проект: {{ projects }}</p>
<p>Для того что бы посмотреть интерфейс управления пройдите по ссылке: {{ buildbot_url }}</p>
<p>Для того что бы посмотреть результат сборки пройдите по ссылке: {{ build_url }}</p>
<p>Используя WinSCP можно подключиться к серверу c ip:xxx.xx.xxx.xx. Войдя под habr/password, забрать собранный executable файл с директории ~/worker/yourProject/build/dist.</p>
<p><b>Построение было произведено через Buildbot</b></p>
'''

sendMessageToAll = reporters.MailNotifier(fromaddr="[email protected]",
					sendToInterestedUsers=True,
					lookup="your.domain",
					relayhost="smtp.your.domain",
					smtpPort=1025,
					mode="warnings",
					extraRecipients=['[email protected]'],
              messageFormatter=reporters.MessageFormatter(
						template=template_html,
						template_type='html',
						wantProperties=True, 
                                                wantSteps=True)
					)
c['services'] = [sendMessageToAll]

c['title'] = "The process of bulding"
c['titleURL'] = "http://project.host:80/"

c['buildbotURL'] = "http://project.host"

c['www'] = dict(port=80,
                plugins=dict(waterfall_view={}, console_view={}, grid_view={}))


c['db'] = {
    'db_url' : "sqlite:///state.sqlite"
}

まず必要なのは 作成する ビルドマスター-aと ワーカー-a. 次に、このファイルを貼り付けます マスター.cfg в /ホーム/ハブ/マスター.

次のステップはサービスを開始することです ビルドマスターああ

sudo buildbot start /home/habr/master

次にサービスを開始します ワーカー-a

buildbot-worker start /home/habr/worker

準備ができて！ 今 ビルドボット 変更を追跡してトリガーします コミット-y で SVN、上記のアーキテクチャでプロジェクトを構築してテストする手順を実行します。

以下に上記の特徴をいくつか説明します master.cfg。

6.1 master.cfg に向かう途中

私のことを書きながら マスター.cfg エラーが多く発生するため、ログファイルの読み取りが必要になります。 として保存されます ビルドマスター-ec 絶対パス /home/habr/master/twistd.log、そして横に ワーカー-a 絶対パス付き /home/habr/worker/twistd.log。 エラーを読んで修正するには、サービスを再起動する必要があります。 ビルドマスター-a. その方法は次のとおりです。

sudo buildbot stop /home/habr/master
sudo buildbot upgrade-master /home/habr/master
sudo buildbot start /home/habr/master

6.2 svn の操作

svn_poller = changes.SVNPoller(repourl="https://svn.host/svn/yourProject/trunk",
                               svnuser="user",
                               svnpasswd="password",
                               pollinterval=60,
                               split_file=util.svn.split_file_alwaystrunk
                        )

c['change_source'] =  svn_poller

hourlyscheduler = schedulers.SingleBranchScheduler(
                            name="your-project-schedulers",
                            change_filter=util.ChangeFilter(branch=None),
                            builderNames=["yourProject"],
                            properties = {'owner': 'admin'}
                        )

c['schedulers'] = [hourlyscheduler]

checkout = steps.SVN(repourl='https://svn.host/svn/yourProject/trunk',
                     mode='full',
                     method='fresh',
                     username="user",
                     password="password",
                     haltOnFailure=True)

まず、見てみましょう svn_poller。 これは依然として同じインターフェイスであり、XNUMX 分に XNUMX 回定期的にリポジトリをポーリングします。 この場合 svn_poller ブランチにのみアクセスします トランク。 謎のパラメータ split_file=util.svn.split_file_alwaystrunk ルールを設定します: フォルダー構造を分割する方法 SVN 枝の上に。 彼はまた、それらに相対パスも提供します。 その順番で Split_file_alwaystrunk リポジトリに含まれるもののみを指定することでプロセスを簡略化します トランク.

В スケジューラー 表示されます フィルター変更誰が見ますか なし ブランチをそれに関連付けます トランク 特定の関連付けに従って、 Split_file_alwaystrunk。 変化への対応 トランク、発売 ビルダー 名前付き あなたのプロジェクト.

プロパティ ここでは、管理者がプロセスの所有者としてビルドおよびテスト結果のメーリング リストを受信するために必要です。

手順 ビルド-a チェックアウト ローカル バージョンのリポジトリにあるファイルを完全に削除できます ワーカー-A. そして、すべてを実行します svn update。 モードはパラメータを通じて設定されます。 モード=フル, メソッド=フレッシュ。 パラメータ 停止オンテール もし svn update エラーが発生して実行されると、それ以上のアクションは意味がないため、ビルドとテストのプロセス全体が一時停止される必要があります。

6.3 あなたへの手紙: 記者には宣言する権限がある

記者 お知らせをメールで送信するサービスです。

template_html=u'''
<h4>Статус построенного релиза: {{ summary }}</h4>
<p>Используемый сервис для постраения: {{ workername }}</p>
<p>Проект: {{ projects }}</p>
<p>Для того что бы посмотреть интерфейс управления пройдите по ссылке: {{ buildbot_url }}</p>
<p>Для того что бы посмотреть результат сборки пройдите по ссылке: {{ build_url }}</p>
<p>Используя WinSCP можно подключиться к серверу c ip:xxx.xx.xxx.xx. Войдя под habr/password, забрать собранный executable файл с директории ~/worker/yourProject/build/dist.</p>
<p><b>Построение было произведено через Buildbot</b></p>
'''
                        
sendMessageToAll = reporters.MailNotifier(fromaddr="[email protected]",
                                          sendToInterestedUsers=True,
                                          lookup="your.domain",
                                          relayhost="smtp.your.domain",
                                          smtpPort=1025,
                                          mode="warnings",
                                          extraRecipients=['[email protected]'],
                                    messageFormatter=reporters.MessageFormatter(
                                                    template=template_html,
                                                    template_type='html',
                                                    wantProperties=True, 
                                                    wantSteps=True)
                                        )
c['services'] = [sendMessageToAll]

彼はメッセージを送ることができる 違う方法.

MailNotifier 電子メールを使用して通知を送信します。

テンプレート_html ニュースレターのテキスト テンプレートを設定します。 HTML はマークアップの作成に使用されます。 エンジンによって改造される ジンジャ2 (と比較できる ジャンゴ). ビルドボット には、メッセージ テキストの生成プロセス中にその値がテンプレートに置き換えられる一連の変数があります。 これらの変数は {{ 二重中括弧 }} で囲まれています。 例えば、 要約 完了した操作のステータス、つまり成功または失敗が表示されます。 あ プロジェクト(実績作品) 出力します あなたのプロジェクト。 したがって、制御コマンドを使用すると、 ジンジャ2、変数 ビルドボット-a と Python 文字列フォーマット ツールを使用すると、非常に有益なメッセージを作成できます。

MailNotifier には次の引数が含まれます。

fromaddr – 全員がニュースレターを受け取るアドレス。

興味のあるユーザーに送信=True は、作成した所有者とユーザーにメッセージを送信します。 コミット.

検索 — ニュースレターを受信するユーザーの名前に追加する必要があるサフィックス。 それで 管理人 ユーザーがそのアドレスでニュースレターを受け取る方法 [メール保護].

リレーホスト サーバーが開かれているホスト名を指定します SMTP smptポート リッスンするポート番号を指定します SMTP サーバ。

モード = "警告" 少なくとも XNUMX つのステップがある場合にのみ郵送を行う必要があると述べています ビルド-a、ステータス失敗または警告で終了しました。 成功した場合、ニュースレターを送信する必要はありません。

追加受信者 所有者および郵便物の実行者に加えて、郵送物が送信されるべき人物のリストが含まれます。 コミット.

メッセージフォーマッタ メッセージ形式、そのテンプレート、およびから利用可能な変数のセットを指定するオブジェクトです。 ジンジャ2。 などのオプション wantProperties=True и wantSteps=True この利用可能な変数のセットを定義します。

with['services']=[sendMessageToAll] サービスのリストを提供します。そのうちの XNUMX つは、 レポーター.

やった！ おめでとう

私たちは独自の構成を作成し、それが可能な機能を確認しました。 ビルドボット。 これは、プロジェクトの作成にこのツールが必要かどうかを理解するのに十分だと思います。 彼に興味がありますか？ それは役に立ちますか？ 彼は一緒に仕事をするのが快適ですか？ そうすれば、私はこの記事を無駄に書いているわけではありません。

そしてさらに。 プロフェッショナルコミュニティに活用してもらいたい ビルドボットの範囲が広くなり、マニュアルも翻訳され、例もさらに増えました。

ご清聴ありがとうございました。 幸運を。

出所： habr.com