Ubuntu18.04でMoleculeとTravisCIを使用してAnsibleロールの継続的テストを実装する方法

著者は、 Write for DOnations プログラムの一環として、 MozillaFoundationを選択して寄付を受け取りました。

序章

Ansible は、YAMLテンプレートを使用して、ホストで実行されるタスクのリストを定義するエージェントレス構成管理ツールです。 Ansibleでは、 roles は、単一の複雑な機能を実行するために一緒に使用される変数、タスク、ファイル、テンプレート、およびモジュールのコレクションです。

Molecular は、Ansibleの役割の自動テストを実行するためのツールであり、一貫して適切に作成され維持されている役割の開発をサポートするように特別に設計されています。 Moleculeの単体テストを使用すると、開発者は複数の環境に対して、異なるパラメーターで同時に役割をテストできます。開発者は、頻繁に変更されるコードに対して継続的にテストを実行することが重要です。このワークフローにより、コードライブラリを更新するときに役割が引き続き機能することが保証されます。 Travis CI などの継続的インテグレーションツールを使用してMoleculeを実行すると、テストを継続的に実行できるため、コードへの貢献によって重大な変更が発生することはありません。

このチュートリアルでは、UbuntuおよびCentOSサーバーにApacheWebサーバーとファイアウォールをインストールして構成する事前に作成された基本ロールを使用します。次に、そのロールでMoleculeシナリオを初期化してテストを作成し、ターゲット環境でロールが意図したとおりに実行されることを確認します。 Moleculeを構成した後、Travis CIを使用して、新しく作成したロールを継続的にテストします。コードに変更が加えられるたびに、TravisCIはmolecule testを実行して、役割が引き続き正しく実行されることを確認します。

前提条件

このチュートリアルを開始する前に、次のものが必要です。

Ubuntu 18.04初期サーバーセットアップガイドに従ってセットアップされた1つのUbuntu18.04サーバー（sudo非rootユーザーとファイアウォールを含む）。
AnsibleとMoleculeが構成されています。これは、 Ubuntu18.04でMoleculeを使用してAnsibleの役割をテストする方法のステップ1に従って実行できます。
オープンソースに貢献する方法：Gitの使用開始に従ってインストールされたGit。
継続的インテグレーションとそのユースケースに精通していること。詳細については、継続的インテグレーション、デリバリー、およびデプロイメントの概要を確認してください。
GitHubのアカウント。
TravisCIのアカウント。

ステップ1—基本ロールリポジトリをフォークする

Apacheをインストールし、DebianベースおよびRedHatベースのディストリビューションにファイアウォールを構成するansible-apacheと呼ばれる事前に作成されたロールを使用します。この役割をフォークしてベースとして使用し、その上に分子テストを構築します。 Forkingを使用すると、リポジトリのコピーを作成できるため、元のプロジェクトを改ざんすることなくリポジトリに変更を加えることができます。

ansible-apacheロールのフォークを作成することから始めます。 ansible-apache リポジトリに移動し、フォークボタンをクリックします。

リポジトリをフォークすると、GitHubがフォークのページに移動します。これはベースリポジトリのコピーになりますが、自分のアカウントで行います。

緑色のCloneまたはDownloadボタンをクリックすると、 Clone withHTTPSのボックスが表示されます。

リポジトリに表示されているURLをコピーします。これは次のステップで使用します。 URLは次のようになります。

https://github.com/username/ansible-apache.git

usernameをGitHubユーザー名に置き換えます。

フォークを設定したら、サーバーにフォークを複製し、次のセクションで役割の準備を開始します。

ステップ2—役割の準備

前提条件のステップ1Ubuntu 18.04 でMoleculeを使用してAnsibleの役割をテストする方法を実行すると、MoleculeとAnsibleが仮想環境にインストールされます。この仮想環境を使用して、新しい役割を開発します。

まず、以下を実行して、前提条件に従って作成した仮想環境をアクティブ化します。

source my_env/bin/activate

次のコマンドを実行して、手順1でコピーしたURLを使用してリポジトリのクローンを作成します。

git clone https://github.com/username/ansible-apache.git

出力は次のようになります。

OutputCloning into 'ansible-apache'...
remote: Enumerating objects: 16, done.
remote: Total 16 (delta 0), reused 0 (delta 0), pack-reused 16
Unpacking objects: 100% (16/16), done.

新しく作成したディレクトリに移動します。

cd ansible-apache

ダウンロードした基本ロールは、次のタスクを実行します。

変数を含める：役割は、ホストの分布に従って、必要なすべての変数を含めることから始まります。 Ansibleは変数を使用して、異なるシステム間の不一致を処理します。 Ubuntu18.04とCentOS7をホストとして使用しているため、ロールはOSファミリがそれぞれDebianとRed Hatであることを認識し、vars/Debian.ymlとvars/RedHat.ymlの変数を含みます。
配布関連のタスクが含まれます：これらのタスクには、tasks/install-Debian.ymlおよびtasks/install-RedHat.ymlが含まれます。指定されたディストリビューションに応じて、関連するパッケージをインストールします。 Ubuntuの場合、これらのパッケージはapache2およびufwです。 CentOSの場合、これらのパッケージはhttpdおよびfirewalldです。
最新のindex.htmlが存在することを確認します：このタスクは、ApacheがWebサーバーのホームページとして使用するテンプレートtemplates/index.html.j2をコピーします。
関連するサービスを開始し、起動時にそれらを有効にします：最初のタスクの一部としてインストールされた必要なサービスを開始して有効にします。 CentOSの場合、これらのサービスはhttpdとfirewalldであり、Ubuntuの場合はapache2とufwです。
トラフィックを許可するようにファイアウォールを構成します：これには、tasks/configure-Debian-firewall.ymlまたはtasks/configure-RedHat-firewall.ymlのいずれかが含まれます。 Ansibleは、FirewalldまたはUFWのいずれかをファイアウォールとして構成し、httpサービスをホワイトリストに登録します。

この役割がどのように機能するかを理解したので、それをテストするようにMoleculeを構成します。これらのタスクのテストケースを作成して、それらが行う変更をカバーします。

ステップ3—テストを書く

基本ロールが意図したとおりにタスクを実行することを確認するには、Moleculeシナリオを開始し、ターゲット環境を指定して、3つのカスタムテストファイルを作成します。

次のコマンドを使用して、この役割の分子シナリオを初期化することから始めます。

molecule init scenario -r ansible-apache

次の出力が表示されます。

Output--> Initializing new scenario default...
Initialized scenario in /home/sammy/ansible-apache/molecule/default successfully.

CentOSとUbuntuをプラットフォームとしてMolecule構成ファイルに含めることにより、ターゲット環境として追加します。これを行うには、テキストエディタを使用してmolecule.ymlファイルを編集します。

nano molecule/default/molecule.yml

次の強調表示されたコンテンツをMolecule構成に追加します。

〜/ ansible-apache /molecule / default /molecule.yml

---
dependency:
  name: galaxy
driver:
  name: docker
lint:
  name: yamllint
platforms:
  - name: centos7
    image: milcom/centos7-systemd
    privileged: true
  - name: ubuntu18
    image: solita/ubuntu-systemd
    command: /sbin/init
    privileged: true
    volumes:
      - /lib/modules:/lib/modules:ro
provisioner:
  name: ansible
  lint:
    name: ansible-lint
scenario:
  name: default
verifier:
  name: testinfra
  lint:
    name: flake8

ここでは、systemdサービスを使用しているため、特権モードで起動される2つのターゲットプラットフォームを指定しています。

centos7は最初のプラットフォームであり、milcom/centos7-systemdイメージを使用します。
ubuntu18は2番目のプラットフォームであり、solita/ubuntu-systemdイメージを使用します。特権モードを使用して必要なカーネルモジュールをマウントすることに加えて、起動時に/sbin/initを実行して、iptablesが稼働していることを確認します。

ファイルを保存して終了します。

特権コンテナの実行の詳細については、公式のMoleculeドキュメントを参照してください。

デフォルトのMoleculeテストファイルを使用する代わりに、3つのカスタムテストファイルを作成します。1つはターゲットプラットフォームごとに1つ、もう1つはすべてのプラットフォームに共通のテストを作成するためのファイルです。次のコマンドを使用して、シナリオのデフォルトのテストファイルtest_default.pyを削除することから始めます。

rm molecule/default/tests/test_default.py

これで、ターゲットプラットフォームごとに、test_common.py、test_Debian.py、およびtest_RedHat.pyの3つのカスタムテストファイルの作成に進むことができます。

最初のテストファイルtest_common.pyには、各ホストが実行する共通のテストが含まれています。共通テストファイルtest_common.pyを作成および編集します。

nano molecule/default/tests/test_common.py

次のコードをファイルに追加します。

〜/ ansible-apache /molecule / default / tests / test_common.py

import os
import pytest

import testinfra.utils.ansible_runner

testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
    os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')


@pytest.mark.parametrize('file, content', [
  ("/var/www/html/index.html", "Managed by Ansible")
])
def test_files(host, file, content):
    file = host.file(file)

    assert file.exists
    assert file.contains(content)

test_common.pyファイルに、必要なライブラリをインポートしました。また、test_files()と呼ばれるテストを作成しました。このテストは、役割が実行するディストリビューション間の唯一の共通タスク、つまりテンプレートをWebサーバーのホームページとしてコピーすることを保持します。

次のテストファイルtest_Debian.pyには、Debianディストリビューションに固有のテストが含まれています。このテストファイルは、特にUbuntuプラットフォームを対象としています。

次のコマンドを実行して、Ubuntuテストファイルを作成および編集します。

nano molecule/default/tests/test_Debian.py

これで、必要なライブラリをインポートして、ubuntu18プラットフォームをターゲットホストとして定義できます。このファイルの先頭に次のコードを追加します。