how-to-implement-continuous-testing-of-ansible-roles-using-molecule-and-travis-ci-on-ubuntu-18-04

Posted on: 2019-11-08 2019-11-19
Tags: Ansible, Ubuntu 18.04

_著者はhttps://www.brightfunds.org/organizations/mozilla-foundation[Mozilla Foundation]を選択して、https：//do.co/w4do-cta [Write for DOnations]プログラムの一環として寄付を受け取りました。

前書き

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

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

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

前提条件

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

sudo non- rootユーザーとファイアウォール。
AnsibleおよびMoleculeが構成されています。これは、https：//www.digitalocean.com/community/tutorials/how-to-test-ansible-roles-with-molecule-on-ubuntu-18-04のステップ1に従って実行できます[ Ubuntu 18.04でMoleculeを使用してAnsibleロールをテストする方法]。
https://www.digitalocean.com/community/tutorials/how-to-contribute-to-open-source-getting-started-with-gitに従ってインストールしたGit 。
継続的インテグレーションとその使用事例に精通している。詳細については、https：//www.digitalocean.com/community/tutorials/an-introduction-to-continuous-integration-delivery-and-deployment [継続的な統合、配信、および展開の概要]をご覧ください。
GitHubのアカウント。
Travis CIのアカウント。

手順1-ベースロールリポジトリのフォーク

Apacheをインストールし、DebianベースおよびRed Hatベースのディストリビューションでファイアウォールを設定するhttps://github.com/do-community/ansible-apache[ansible-apache]という事前に作成されたロールを使用します。このロールを分岐してベースとして使用し、その上でMoleculeテストをビルドします。フォークを使用すると、リポジトリのコピーを作成して、元のプロジェクトを変更せずにリポジトリに変更を加えることができます。

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

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

緑色の[クローンまたはダウンロード]ボタンをクリックすると、[HTTPSでクローン] *のボックスが表示されます。

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

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

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

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

ステップ2-役割の準備

前提条件https://www.digitalocean.com/community/tutorials/how-to-test-ansible-roles-with-molecule-on-ubuntu-18-04のステップ1を実行した[分子でAnsibleロールをテストする方法Ubuntu 18.04]では、MoleculeとAnsibleを仮想環境にインストールします。この仮想環境を使用して、新しい役割を開発します。

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

source /bin/activate

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

git clone https://github.com//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は変数を使用して、異なるシステム間の格差を処理します。 Ubuntu 18.04とCentOS 7をホストとして使用しているため、このロールは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//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:









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が稼働していることを確認します。

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

特権コンテナの実行の詳細については、https：//molecule.readthedocs.io/en/latest/examples.html#systemd-container [公式の分子ドキュメント]をご覧ください。

デフォルトの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 +」プラットフォームを定義できます。このファイルの先頭に次のコードを追加します。

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

import os
import pytest

import testinfra.utils.ansible_runner

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

次に、同じファイルに、 `+ test_pkg（）+`テストを追加します。

`+ test_pkg（）+`テストを定義する次のコードをファイルに追加します。

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

...
@pytest.mark.parametrize('pkg', [
   'apache2',
   'ufw'
])
def test_pkg(host, pkg):
   package = host.package(pkg)

   assert package.is_installed

このテストは、ホストに `+ apache2 `および ` ufw +`パッケージがインストールされているかどうかを確認します。

次のテスト `+ test_svc（）`を定義するには、ファイルの ` test_pkg（）+`テストの下に次のコードを追加します。

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

...
@pytest.mark.parametrize('svc', [
   'apache2',
   'ufw'
])
def test_svc(host, svc):
   service = host.service(svc)

   assert service.is_running
   assert service.is_enabled

`+ test_svc（）`は、 ` apache2 `および ` ufw +`サービスが実行され有効になっているかどうかを確認します。

最後に、最後のテストである `+ test ufw rules（）`を ` test Debian.py`ファイルに追加します。

ファイルの `+ test_svc（）`テストの下にこのコードを追加して、 ` test_ufw_rules（）+`を定義します。

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

...
@pytest.mark.parametrize('rule', [
   '-A ufw-user-input -p tcp -m tcp --dport 80 -j ACCEPT'
])
def test_ufw_rules(host, rule):
   cmd = host.run('iptables -t filter -S')

   assert rule in cmd.stdout

`+ test_ufw_rules（）+`は、ファイアウォールの設定がApacheサービスによって使用されるポートでのトラフィックを許可することを確認します。

これらの各テストが追加されると、 `+ test_Debian.py +`ファイルは次のようになります。

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

import os
import pytest

import testinfra.utils.ansible_runner

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


@pytest.mark.parametrize('pkg', [
   'apache2',
   'ufw'
])
def test_pkg(host, pkg):
   package = host.package(pkg)

   assert package.is_installed


@pytest.mark.parametrize('svc', [
   'apache2',
   'ufw'
])
def test_svc(host, svc):
   service = host.service(svc)

   assert service.is_running
   assert service.is_enabled


@pytest.mark.parametrize('rule', [
   '-A ufw-user-input -p tcp -m tcp --dport 80 -j ACCEPT'
])
def test_ufw_rules(host, rule):
   cmd = host.run('iptables -t filter -S')

   assert rule in cmd.stdout

+ test_Debian.py +`ファイルには、3つのテストが含まれています： `+ test_pkg（）+、 + test_svc（）+、および + test_ufw_rules（）+。

保存して `+ test_Debian.py +`を終了します。

次に、 `+ test_RedHat.py +`テストファイルを作成します。このファイルには、CentOSプラットフォームをターゲットとするRed Hatディストリビューション固有のテストが含まれます。

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

nano molecule/default/tests/test_RedHat.py

Ubuntuテストファイルと同様に、3つのテストを記述して、 `+ test_RedHat.py `ファイルに含めるようにします。テストコードを追加する前に、次のコードをファイルの先頭に追加することにより、必要なライブラリをインポートし、 ` centos7 +`プラットフォームをターゲットホストとして定義できます。