Ansible のテスト

組織

プル要求 (PR: Pull Requests) が作成されると、継続的統合 (CI) ツールである Azure Pipeline を使用してテストが行われます。結果はすべての PR の最後に表示されます。

Azure Pipeline がエラーを検出し、それが PR で変更されたファイルにリンクされると、関連する行が GitHub のコメントとして追加されます。たとえば、以下のようになります。

The test `ansible-test sanity --test pep8` failed with the following errors:

lib/ansible/modules/network/foo/bar.py:509:17: E265 block comment should start with '# '

The test `ansible-test sanity --test validate-modules` failed with the following error:
lib/ansible/modules/network/foo/bar.py:0:0: E307 version_added should be 2.4. Currently 2.3

上記の例から、--test pep8 および --test validate-modules が問題を特定したことが分かります。指定されたコマンドを使用すると、同じテストをローカルで実行して、変更を GitHub にプッシュして Azure Pipeline を待つことなく、すべての問題を修正したことを確認できます。次に例を示します。

Ansible がまだ利用できるようになっていない場合は、ローカルでチェックアウトを実行してください。

source hacking/env-setup

次に、GitHub コメントで説明するテストを実行します。

ansible-test sanity --test pep8
ansible-test sanity --test validate-modules

GitHub のコメントに何が失敗したかが書かれていない場合は、PR の末尾にある「checks have failed」というメッセージの下にある「Details」ボタンをクリックして結果を確認することができます。

失敗した CI ジョブの再実行

時折、変更とは関係のない理由で PR が失敗することがあります。これには、以下のような理由が考えられます。

• yum や git リポジトリーなどの外部リソースにアクセスする際に一時的に問題が発生した場合。

• テストを実行するための仮想マシンを作成するタイムアウト。

これらの問題のいずれかがケースとして表示される場合は、以下を実行して Azure Pipelines テストを再実行できます。

• /rebuild (完全な再構築) または /rebuild_failed (構築に失敗した CI ノードのみの再構築) でのコメントを追加する

• PR を閉じて再度開く (完全な再構築)

• PR に何らかの変更を加えて GitHub にプッシュする

それでも問題が解決しない場合は、#ansible-devel チャットチャンネルでお問い合わせください（ansible.imでMatrixを使用、または`irc.libera.chat <https://libera.chat/>`_でIRCを使用）。

設定: プル要求のチェックアウト

これは、以下の方法で実行できます。

• Ansible のチェックアウト

• 提案された変更をテストブランチに取得

• テスト

• GitHub に特定の問題についてのコメント

以下に、実行する方法を説明します。

作業用に新しい領域を作成します。

git clone https://github.com/ansible/ansible.git ansible-pr-testing
cd ansible-pr-testing

次に、テストするプル要求を見つけて、その番号を書き留めます。次のようになります。

Use os.path.sep instead of hardcoding / #65381

提案された変更を取得し、テスト用にブランチを作成するときにプル要求番号を使用します。

git fetch origin refs/pull/XXXX/head:testing_PRXXXX
git checkout testing_PRXXXX

1 つ目のコマンドはプル要求から提案された変更を取得し、testing_PRXXXX という名前の新規ブランチを作成します。XXXX はプル要求に関連する実際の番号 (例: 65381) です。2 つ目のコマンドは、新たに作成されたブランチをチェックアウトします。

Ansible のソースには、Ansible の開発者が頻繁に使用するフルインストールを必要とせず、ソースから直接 Ansible を使用するようにするスクリプトが含まれています。

ソースを作成するだけ (Linux/Unix の用語を使用するために) で、すぐに使い始めることができます。

source ./hacking/env-setup

このスクリプトは、PYTHONPATH 環境変数を変更します (他にもいくつかあります)。これは、シェルセッションが開いている間は一時的に設定されます。

プル要求のテスト

この時点でテストを開始する準備が整いました。

何をテストするかのアイデアをいくつか挙げてみましょう。

• 例題を含むテスト Playbook を作成し、それらが正しく機能するかどうかを確認します。

• Python のバックトレースが返されているかどうかをテストします (これはバグです)。

• 異なるオペレーティングシステムで、または異なるバージョンのライブラリーに対してテストを行います。

ansible-test sanity

ansible-test units

ansible-test integration -v ping

Works for me! Tested on `Ansible 2.3.0`.  I verified this on CentOS 6.5 and also Ubuntu 14.04.