如何在Ubuntu18.04上使用Molecule和TravisCI实现Ansible角色的持续测试

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

介绍

Ansible 是一个无代理配置管理工具，它使用 YAML 模板定义要在主机上执行的任务列表。在 Ansible 中，roles 是变量、任务、文件、模板和模块的集合，它们一起用于执行单一、复杂的功能。

Molecule 是一种用于对 Ansible 角色进行自动化测试的工具，专门设计用于支持开发始终如一地编写和维护良好的角色。 Molecule 的单元测试允许开发人员同时针对多个环境和不同参数测试角色。开发人员不断地针对经常更改的代码运行测试，这一点很重要。此工作流程可确保角色在您更新代码库时继续工作。使用持续集成工具运行 Molecule，例如 Travis CI，允许测试持续运行，确保对代码的贡献不会引入重大更改。

在本教程中，您将使用预制的基本角色在 Ubuntu 和 CentOS 服务器上安装和配置 Apache Web 服务器和防火墙。然后，您将在该角色中初始化一个 Molecule 场景以创建测试并确保该角色在您的目标环境中按预期执行。配置 Molecule 后，您将使用 Travis CI 不断测试您新创建的角色。每次对代码进行更改时，Travis CI 都会运行 molecule test 以确保角色仍然正确执行。

先决条件

在开始本教程之前，您需要：

按照 Ubuntu 18.04 Initial Server Setup 指南设置一台 Ubuntu 18.04 服务器，包括 sudo 非 root 用户和防火墙。
Ansible 和 Molecule 已配置，您可以按照如何在 Ubuntu 18.04 上使用 Molecule 测试 Ansible 角色的第 1 步来完成。
按照如何为开源做贡献：Git入门安装Git。
熟悉持续集成及其用例。要了解更多信息，请查看持续集成、交付和部署简介。
GitHub 上的帐户。
Travis CI 上的帐户。

第 1 步 - 分叉基本角色存储库

您将使用一个名为 ansible-apache 的预制角色，该角色安装 Apache 并在基于 Debian 和 Red Hat 的发行版上配置防火墙。您将分叉并使用此角色作为基础，然后在其之上构建 Molecule 测试。 Forking 允许您创建存储库的副本，以便您可以对其进行更改而不会篡改原始项目。

首先创建一个 ansible-apache 角色的分支。转到 ansible-apache 存储库并单击 Fork 按钮。

分叉存储库后，GitHub 将引导您进入分叉页面。这将是基本存储库的副本，但在您自己的帐户上。

单击绿色的 Clone 或下载 按钮，您将看到一个带有 Clone with HTTPS 的框。

复制为您的存储库显示的 URL。您将在下一步中使用它。 URL 将与此类似：

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

您将 username 替换为您的 GitHub 用户名。

设置好 fork 后，您将在服务器上克隆它并开始准备下一部分中的角色。

第 2 步——准备你的角色

按照先决条件如何在 Ubuntu 18.04 上使用 Molecule 测试 Ansible 角色的步骤 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

您下载的基本角色执行以下任务：

包含变量：角色首先根据主机的分布包含所有需要的变量。 Ansible 使用变量来处理不同系统之间的差异。由于您使用 Ubuntu 18.04 和 CentOS 7 作为主机，因此该角色将识别出操作系统系列分别是 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 场景，指定您的目标环境，并创建三个自定义测试文件。

首先使用以下命令为此角色初始化 Molecule 场景：

molecule init scenario -r ansible-apache

您将看到以下输出：

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

通过将 CentOS 和 Ubuntu 作为平台包含在 Molecule 配置文件中，您将添加 CentOS 和 Ubuntu 作为目标环境。为此，请使用文本编辑器编辑 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
  - 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 服务：

centos7是第一个平台，使用milcom/centos7-systemd镜像。
ubuntu18 是第二个平台，使用 solita/ubuntu-systemd 图像。除了使用特权模式和挂载所需的内核模块之外，您还在启动时运行 /sbin/init 以确保 iptables 已启动并运行。

保存并退出文件。

有关运行特权容器的更多信息，请访问官方分子文档。

您将不使用默认的 Molecule 测试文件，而是创建三个自定义测试文件，一个用于每个目标平台，一个用于编写所有平台之间通用的测试。首先使用以下命令删除场景的默认测试文件 test_default.py：

rm molecule/default/tests/test_default.py

您现在可以继续为每个目标平台创建三个自定义测试文件 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 平台定义为目标主机。将以下代码添加到此文件的开头：