Ubuntu 16.04でMoleculeを使用してAnsibleロールをテストする方法

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

前書き

Ansibleのユニットテストは、ロールが意図したとおりに機能することを確認するための鍵です。 Moleculeでは、さまざまな環境に対して役割をテストするシナリオを指定できるため、このプロセスが簡単になります。フードの下でAnsibleを使用して、Moleculeはロールをプロビジョニングされた環境に展開するプロビジョニング担当者にオフロードし、ベリファイア（https://github.com/philpep/testinfra[Testinfra]など）を呼び出して構成のドリフトを確認します。これにより、ロールがその特定のシナリオで環境に対して予想されるすべての変更を行ったことを確認できます。

このガイドでは、https：//httpd.apache.org/ [Apache]をホストにデプロイし、CentOS 7でhttps://firewalld.org/[Firewalld]を構成するAnsibleロールを構築します。この役割が意図したとおりに機能することをテストするには、https：//www.docker.com/ [Docker]をドライバーとして使用し、Testinfra（サーバーの状態をテストするためのPythonライブラリー）を使用してMoleculeでテストを作成します。 MoleculeはDockerコンテナーをプロビジョニングしてロールをテストし、Testinfraはサーバーが意図したとおりに構成されていることを確認します。終了したら、環境全体のビルド用に複数のテストケースを作成し、Moleculeを使用してこれらのテストを実行できます。

前提条件

このガイドを始める前に、次のものが必要です。

Ubuntu 16.04サーバー1台。 Ubuntu 16.04での初期サーバーセットアップガイドの手順に従って、非ルートsudoユーザーを作成します。パスワードなしでサーバーに接続できることを確認してください。
サーバーにインストールされたDocker。 https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04 [Ubuntu 16.04にDockerをインストールして使用する方法]の手順1と2を実行します。、そして必ず非rootユーザーを `+ docker +`グループに追加してください。
Ansibleプレイブックに精通している。確認するには、https：//www.digitalocean.com/community/tutorials/configuration-management-101-writing-ansible-playbooks [Configuration Management 101：Ansible Playbookの作成]を参照してください。

ステップ1-環境の準備

ロールとテストを作成するには、まず仮想環境を作成してMoleculeをインストールしましょう。 Moleculeをインストールすると、Ansibleもインストールされ、プレイブックを使用してロールを作成し、テストを実行できるようになります。

非rootユーザーとしてログインし、リポジトリが最新であることを確認することから始めます。

sudo apt-get update

これにより、パッケージリポジトリに最新バージョンの `+ python-pip `パッケージが含まれることになり、 ` pip `とPython 2.7がインストールされます。 ` pip `を使用して仮想環境を作成し、追加のパッケージをインストールします。 ` pip +`をインストールするには、次を実行：

sudo apt-get install -y python-pip

+ pip +`を使用して `+ virtualenv + Pythonモジュールをインストールします。

python -m pip install virtualenv

次に、仮想環境を作成してアクティブ化します。

python -m virtualenv

それをアクティブにして、アクションがその環境に制限されるようにします。

source my_env/bin/activate

+ pip`を使用して + molecule`と `+ docker`をインストールします。

python -m pip install molecule docker

これらの各パッケージの機能は次のとおりです。

+ molecule +：これは、ロールをテストするために使用するメインのMoleculeパッケージです。 `+ molecule +`をインストールすると、他の依存関係とともにAnsibleが自動的にインストールされ、Ansibleプレイブックを使用してロールとテストを実行できるようになります。
+ docker +：このPythonライブラリは、MoleculeがDockerとのインターフェースに使用します。 Dockerをドライバーとして使用しているため、これが必要になります。

次に、Moleculeでロールを作成しましょう。

ステップ2-分子内での役割の作成

環境を設定したら、Moleculeを使用して基本的な役割を作成し、Apacheのインストールをテストできます。このロールは、ディレクトリ構造といくつかの初期テストを作成し、ドライバーとしてDockerを指定して、Moleculeがテストを実行するためにDockerを使用するようにします。

`+ ansible-apache`という新しいロールを作成します：

molecule init role -r ansible-apache -d docker

`+ -r `フラグはロールの名前を指定し、 ` -d +`はMoleculeがテストで使用するホストをプロビジョニングするドライバーを指定します。

新しく作成されたロールのディレクトリに移動します。

cd ansible-apache

デフォルトのロールをテストして、Moleculeが適切にセットアップされているかどうかを確認します。

molecule test

デフォルトの各テストアクションをリストする出力が表示されます。

Output--> Validating schema /home/sammy/ansible-apache/molecule/default/molecule.yml.
Validation completed successfully.
--> Test matrix

└── default
   ├── lint
   ├── destroy
   ├── dependency
   ├── syntax
   ├── create
   ├── prepare
   ├── converge
   ├── idempotence
   ├── side_effect
   ├── verify
   └── destroy
...

テストを開始する前に、Moleculeは設定ファイル `+ molecule.yml +`を検証して、すべてが正常であることを確認します。また、テストアクションの順序を指定するこのテストマトリックスを出力します。

ロールを作成してテストをカスタマイズしたら、各テストアクションについて詳しく説明します。とりあえず、各テストの `+ PLAY_RECAP `に注意し、デフォルトアクションのいずれも ` failed `ステータスを返さないことを確認してください。たとえば、デフォルトの ` 'create' `アクションの ` PLAY_RECAP +`は次のようになります。

Output...
PLAY RECAP *********************************************************************
localhost                  : ok=5    changed=4    unreachable=0    failed=0

次に、ロールを変更してApacheとFirewalldを構成します。

ステップ3-ApacheとFirewalldの構成

ApacheとFirewalldを構成するには、ロールのタスクファイルを作成し、インストールするパッケージと有効にするサービスを指定します。これらの詳細は、デフォルトのApacheインデックスページを置き換えるために使用する変数ファイルとテンプレートから抽出されます。

`+ nano +`またはお好みのテキストエディターを使用して、ロールのタスクファイルを作成します。

nano tasks/main.yml

ファイルが既に存在することがわかります。そこにあるものを削除し、次のコードを貼り付けて必要なパッケージをインストールし、正しいサービス、HTMLデフォルト、ファイアウォール設定を有効にします。

〜/ ansible-apache / tasks / main.yml

---
- name: "Ensure required packages are present"
 yum:
   name: "{{ pkg_list }}"
   state: present

- name: "Ensure latest index.html is present"
 template:
   src: index.html.j2
   dest: /var/www/html/index.html

- name: "Ensure httpd service is started and enabled"
 service:
   name: "{{ item }}"
   state: started
   enabled: true
 with_items: "{{ svc_list }}"

- name: "Whitelist http in firewalld"
 firewalld:
   service: http
   state: enabled
   permanent: true
   immediate: true

このプレイブックには4つのタスクが含まれています。

"必要なパッケージが存在することを確認する "：このタスクは、変数ファイルの `+ pkg_list `の下にリストされているパッケージをインストールします。変数ファイルは `〜/ ansible-apache / vars / main.yml +`にあり、このステップの最後に作成します。
"最新のindex.htmlが存在することを確認する "：このタスクは、テンプレートページ `+ index.html.j2 `をコピーし、デフォルトのインデックスファイル ` / var / www / html / index.html +に貼り付けます。 `、Apacheによって生成されます。このステップでは、テンプレートも作成します。
" httpdサービスが開始され有効になっていることを確認する "：このタスクは、変数ファイルの `+ svc_list +`にリストされているサービスを開始して有効にします。
" firewalldのhttpをホワイトリストに入れる "：このタスクは、 `+ firewalld `の ` http `サービスをホワイトリストに登録します。 Firewalldは、CentOSサーバーにデフォルトで存在する完全なファイアウォールソリューションです。 ` http `サービスが機能するには、必要なポートを公開する必要があります。サービスをホワイトリストに登録するように「 firewalld +」に指示すると、サービスが必要とするすべてのポートがホワイトリストに登録されます。

完了したら、ファイルを保存して閉じます。

次に、 `+ index.html.j2 `テンプレートページ用の ` templates +`ディレクトリを作成します。

mkdir templates

ページ自体を作成します。

nano templates/index.html.j2

次の定型コードを貼り付けます。

〜/ ansible-apache / templates / index.html.j2

<div style="text-align: center">
   <h2>Managed by Ansible</h2>
</div>

ファイルを保存して閉じます。

ロールを完了するための最後のステップは、変数ファイルを作成することです。このファイルは、パッケージとサービスの名前をメインのロールプレイブックに提供します。

nano vars/main.yml

`+ pkg_list `と ` svc_list +`を指定する次のコードでデフォルトのコンテンツに貼り付けます：

〜/ ansible-apache / vars / main.yml

---
pkg_list:
 - httpd
 - firewalld
svc_list:
 - httpd
 - firewalld

これらのリストには、次の情報が含まれています。

+ pkg_list +：これには、ロールがインストールするパッケージの名前が含まれます： + httpd +`と `+ firewalld +。
+ svc_list +：これには、ロールが開始して有効にするサービスの名前が含まれます： + httpd +`と `+ firewalld +。

ロールの作成が完了したので、Moleculeが意図したとおりに機能するかどうかをテストするように構成します。

ステップ4-テストを実行するためのロールの変更

私たちの場合、Moleculeの構成には、Molecule構成ファイル + molecule.yml +`を変更してプラットフォーム仕様を追加することが含まれます。 `+ httpd + systemdサービスを設定および開始するロールをテストしているため、systemdが設定され、特権モードが有効になっているイメージを使用する必要があります。このチュートリアルでは、 `+ milcom / centos7-systemd +`イメージhttps://hub.docker.com/r/milcom/centos7-systemd/[Docker Hubで利用可能]を使用します。特権モードでは、コンテナをホストマシンのほぼすべての機能で実行できます。

これらの変更を反映するために `+ molecule.yml +`を編集しましょう：

nano molecule/default/molecule.yml

強調表示されたプラットフォーム情報を追加します。

〜/ 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

完了したら、ファイルを保存して閉じます。

テスト環境の構成が正常に完了したので、ロールの実行後にMoleculeがコンテナーに対して実行するテストケースの作成に移ります。

ステップ5-テストケースの作成

この役割のテストでは、次の条件を確認します。

`+ httpd `および ` firewalld +`パッケージがインストールされていること。
`+ httpd `および ` firewalld +`サービスが実行され、有効になっていること。
ファイアウォール設定で「+ http +」サービスが有効になっていること。
`+ index.html +`には、テンプレートファイルで指定されたものと同じデータが含まれています。

これらすべてのテストに合格すると、ロールは意図したとおりに機能します。

これらの条件のテストケースを作成するには、 `+〜/ ansible-apache / molecule / default / tests / test_default.py +`でデフォルトのテストを編集しましょう。 Testinfraを使用して、Moleculeクラスを使用するPython関数としてテストケースを記述します。

`+ test_default.py +`を開きます：

nano molecule/default/tests/test_default.py

ファイルの内容を削除して、テストを最初から作成できるようにします。

必要なPythonモジュールをインポートすることから始めます。