如何在Ubuntu 18.04上测试与分子的可靠角色-系统运维-优客志

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

介绍

Ansible中的单元测试是确保角色按预期运行的关键。通过允许您指定针对不同环境测试角色的方案， Molecule使此过程更容易。使用Ansible，Molecule将角色卸载到配置器，该配置器在配置的环境中部署角色并调用验证器（例如Testinfra ）来检查配置偏差。这可确保您的角色在该特定方案中对环境进行了所有预期的更改。

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

先决条件

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

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

第1步 - 准备环境

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

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

python3 -m venv my_env

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

source my_env/bin/activate

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

python3 -m pip install wheel

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

python3 -m pip install molecule docker

以下是每个包的功能：

molecule ：这是您将用于测试角色的主要Molecule包。安装molecule自动安装Ansible以及其他依赖项，并允许使用Ansible playbooks来执行角色和测试。
docker ：Molecule使用此Python库与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 /任务/ 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 /模板/ index.html.j2

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

保存并关闭文件。

完成角色的最后一步是编写变量文件，该文件为我们的主角色playbook提供包和服务的名称：

nano vars/main.yml

使用以下代码粘贴默认内容，该代码指定pkg_list和svc_list ：

〜/ ansible-Apache/瓦尔/ 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.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将针对您的容器运行的测试用例。

第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模块：