Ubuntu 18.04でMoleculeおよびTravis CIを使用してAnsibleロールの継続的なテストを実装する方法

著者は、Write for DOnationsプログラムの一部として寄付を受け取るためにMozilla Foundationを選択しました。

前書き

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

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

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

前提条件

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

sudo非rootユーザーとファイアウォールを含むUbuntu 18.04 Initial Server Setupガイドに従ってセットアップされた1つのUbuntu18.04サーバー。
AnsibleとMoleculeが構成されています。これは、How To Test Ansible Roles with Molecule on Ubuntu 18.04のステップ1に従って実行できます。
How To Contribute to Open Source: Getting Started with Gitに従ってインストールされたGit。
継続的インテグレーションとその使用事例に精通している。詳細については、An Introduction to Continuous Integration, Delivery, and Deploymentを確認してください。
GitHubのアカウント。
Travis CIのアカウント。

[[step-1 -—- forking-the-base-role-repository]] ==ステップ1—基本ロールリポジトリをフォークする

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

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

リポジトリをフォークすると、GitHubからフォークのページに移動します。これは基本リポジトリのコピーですが、自分のアカウントにあります。

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

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

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

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

フォークをセットアップしたら、サーバー上でフォークを複製し、次のセクションでロールの準備を開始します。

[[step-2 -—- preparing-your-role]] ==ステップ2—役割の準備

前提条件のHow To Test Ansible Roles with Molecule on Ubuntu 18.04のステップ1に従うと、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

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

Includes variables：役割は、ホストの分布に従って、必要なすべてのvariablesを含めることから始まります。 Ansibleは変数を使用して、異なるシステム間の格差を処理します。 Ubuntu18.04とCentOS7をホストとして使用しているため、ロールはOSファミリがそれぞれDebianとRed Hatであり、vars/Debian.ymlとvars/RedHat.ymlの変数を含むことを認識します。
Includes distribution-relevant tasks：これらのタスクにはtasks/install-Debian.ymlとtasks/install-RedHat.ymlが含まれます。指定されたディストリビューションに応じて、関連するパッケージがインストールされます。 Ubuntuの場合、これらのパッケージはapache2とufwです。 CentOSの場合、これらのパッケージはhttpdとfirewalldです。
Ensures latest index.html is present：このタスクは、ApacheがWebサーバーのホームページとして使用するテンプレートtemplates/index.html.j2をコピーします。
Starts relevant services and enables them on boot：最初のタスクの一部としてインストールされた必要なサービスを開始して有効にします。 CentOSの場合、これらのサービスはhttpdとfirewalldであり、Ubuntuの場合、これらはapache2とufwです。
Configures firewall to allow traffic：これにはtasks/configure-Debian-firewall.ymlまたはtasks/configure-RedHat-firewall.ymlのいずれかが含まれます。 Ansibleは、FirewalldまたはUFWのいずれかをファイアウォールとして構成し、httpサービスをホワイトリストに登録します。

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

[[step-3 -—- writing-your-tests]] ==ステップ3—テストを書く

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

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

molecule init scenario -r ansible-apache

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

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

Molecule構成ファイルにプラットフォームとして含めることにより、CentOSとUbuntuをターゲット環境として追加します。これを行うには、テキストエディタを使用して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が稼働していることを確認します。

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

特権コンテナーの実行の詳細については、official Molecule documentationにアクセスしてください。

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

rm molecule/default/tests/test_default.py

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

最初のテストファイル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プラットフォームをターゲットホストとして定義できます。このファイルの先頭に次のコードを追加します。