如何在Ubuntu18.04上使用Molecule测试Ansible角色

作为 Write for DOnations 计划的一部分，作者选择了 Mozilla 基金会来接受捐赠。

介绍

Ansible 中的单元测试是确保角色按预期运行的关键。 Molecule 允许您指定针对不同环境测试角色的场景，从而简化了此过程。在后台使用 Ansible，Molecule 将角色卸载到配置程序中，该配置程序在配置的环境中部署角色并调用验证程序（例如 Testinfra）来检查配置漂移。这可确保您的角色在该特定场景中对环境进行了所有预期的更改。

在本指南中，您将构建一个 Ansible 角色，将 Apache 部署到主机并在 CentOS 7 上配置 firewalld。要测试此角色是否按预期工作，您将使用 Docker 作为驱动程序和 Testinfra（用于测试服务器状态的 Python 库）在 Molecule 中创建一个测试。 Molecule 将提供 Docker 容器来测试角色，Testinfra 将验证服务器是否已按预期配置。完成后，您将能够为跨环境的构建创建多个测试用例，并使用 Molecule 运行这些测试。

先决条件

在开始本指南之前，您需要以下内容：

一台 Ubuntu 18.04 服务器。按照 Initial Server Setup with Ubuntu 18.04 指南中的步骤创建非 root sudo 用户，并确保无需密码即可连接到服务器。
Docker 安装在您的服务器上。按照如何在 Ubuntu 18.04 上安装和使用 Docker 中的步骤 1 和 2，包括将您的非 root 用户添加到 docker 组。
在您的服务器上安装并配置了 Python 3 和 venv。遵循如何在 Ubuntu 18.04 服务器上安装 Python 3 和设置编程环境以获取指导。
熟悉 Ansible 剧本。如需查看，请参阅配置管理 101：编写 Ansible Playbooks。

第 1 步 — 准备环境

如果您已满足先决条件，则应安装并正确配置 Python 3、venv 和 Docker。让我们首先创建一个虚拟环境来使用 Molecule 测试 Ansible。

首先以非 root 用户身份登录并创建一个新的虚拟环境：

python3 -m venv my_env

激活它以确保您的操作仅限于该环境：

source my_env/bin/activate

接下来，在您激活的环境中，安装 wheel 包，它提供了 bdist_wheel setuptools 扩展，pip 用于安装 Ansible：

python3 -m pip install wheel

您现在可以使用 pip 安装 molecule 和 docker。 Ansible 将作为 Molecule 的依赖项自动安装：

python3 -m pip install molecule docker

以下是每个软件包的作用：

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

您将看到列出每个默认测试操作的输出。在开始测试之前，Molecule 会验证配置文件 molecule.yml 以确保一切正常。它还打印这个测试矩阵，它指定了测试操作的顺序：

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
...

创建角色并自定义测试后，我们将详细讨论每个测试操作。现在，请注意每个测试的 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 索引页面。

仍然在 ansible-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 个任务：

"Ensure required packages are present"：此任务将安装 pkg_list 下的变量文件中列出的包。变量文件将位于 ~/ansible-apache/vars/main.yml，您将在此步骤结束时创建它。
"Ensure latest index.html is present"：此任务将复制模板页面 index.html.j2，并将其粘贴到由 Apache 生成的默认索引文件 /var/www/html/index.html 上。您还将在此步骤中创建新模板。
"Ensure httpd service is started and enabled"：此任务将启动并启用变量文件中 svc_list 中列出的服务。
"Whitelist http in firewalld"：此任务会将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。

注意： 确保您的变量文件没有任何空行，否则您的测试将在 linting 期间失败。

现在您已经完成了角色的创建，让我们配置 Molecule 以测试它是否按预期工作。

第 4 步 — 修改运行测试的角色

在我们的例子中，配置 Molecule 涉及修改 Molecule 配置文件 molecule.yml 以添加平台规范。因为您正在测试配置和启动 httpd systemd 服务的角色，所以您需要使用配置了 systemd 并启用特权模式的映像。在本教程中，您将使用 Docker Hub 上可用的 milcom/centos7-systemd 映像。特权模式允许容器使用其主机的几乎所有功能运行。

让我们编辑 molecule.yml 以反映这些变化：

nano molecule/default/molecule.yml

添加突出显示的平台信息：

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

---
dependency:
  name: galaxy
driver:
  name: docker
lint:
  name: yamllint
platforms:
  - name: centos7
    image: milcom/centos7-systemd
    privileged: true
provisioner:
  name: ansible
  lint:
    name: ansible-lint
scenario:
  name: default
verifier:
  name: testinfra
  lint:
    name: flake8

完成后保存并关闭文件。

现在您已经成功配置了测试环境，让我们继续编写 Molecule 在执行角色后将对您的容器运行的测试用例。

第五步——编写测试用例

在对该角色的测试中，您将检查以下条件：

已安装 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 模块：