使用 Testinfra 和 Ansible 驗證伺服器狀態

根據設計，Ansible 傳遞機器的期望狀態，以確保 Ansible 劇本或角色的內容部署到目標機器上。但是，如果你需要確保所有基礎架構更改都在 Ansible 中，該怎麼辦？或者想隨時驗證伺服器的狀態？

Testinfra 是一個基礎架構測試框架，它可以輕鬆編寫單元測試來驗證伺服器的狀態。它是一個 Python 庫，使用強大的 pytest 測試引擎。

開始使用 Testinfra

可以使用 Python 包管理器（pip）和 Python 虛擬環境輕鬆安裝 Testinfra。

$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip install testinfra

Testinfra 也可以通過 Fedora 和 CentOS 的 EPEL 倉庫中使用。例如，在 CentOS 7 上，你可以使用以下命令安裝它：

$ yum install -y epel-release
$ yum install -y python-testinfra

一個簡單的測試腳本

在 Testinfra 中編寫測試很容易。使用你選擇的代碼編輯器，將以下內容添加到名為 test_simple.py 的文件中：

import testinfra

def test_os_release(host):
    assert host.file("/etc/os-release").contains("Fedora")

def test_sshd_inactive(host):
    assert host.service("sshd").is_running is False

默認情況下，Testinfra 為測試用例提供了一個 host 對象，該對象能訪問不同的輔助模塊。例如，第一個測試使用 file 模塊來驗證主機上文件的內容，第二個測試用例使用 service 模塊來檢查 systemd 服務的狀態。

要在本機運行這些測試，請執行以下命令：

(venv)$ pytest test_simple.py
================================ test session starts ================================
platform linux -- Python 3.7.3, pytest-4.4.1, py-1.8.0, pluggy-0.9.0
rootdir: /home/cverna/Documents/Python/testinfra
plugins: testinfra-3.0.0
collected 2 items
test_simple.py ..

================================ 2 passed in 0.05 seconds ================================

有關 Testinfra API 的完整列表，你可以參考文檔。

Testinfra 和 Ansible

Testinfra 支持的後端之一是 Ansible，這意味著 Testinfra 可以直接使用 Ansible 的清單文件和清單中定義的一組機器來對它們進行測試。

我們使用以下清單文件作為示例：

[web]
app-frontend01
app-frontend02

[database]
db-backend01

我們希望確保我們的 Apache Web 伺服器在 app-frontend01 和 app-frontend02 上運行。讓我們在名為 test_web.py 的文件中編寫測試：

def check_httpd_service(host):
    """Check that the httpd service is running on the host"""
    assert host.service("httpd").is_running

要使用 Testinfra 和 Ansible 運行此測試，請使用以下命令：

(venv) $ pip install ansible
(venv) $ py.test --hosts=web --ansible-inventory=inventory --connection=ansible test_web.py

在調用測試時，我們使用 Ansible 清單文件的 [web] 組作為目標計算機，並指定我們要使用 Ansible 作為連接後端。

使用 Ansible 模塊

Testinfra 還為 Ansible 提供了一個很好的可用於測試的 API。該 Ansible 模塊能夠在測試中運行 Ansible 動作，並且能夠輕鬆檢查動作的狀態。

def check_ansible_play(host):
    """ 
    Verify that a package is installed using Ansible
    package module
    """
    assert not host.ansible("package", "name=httpd state=present")["changed"]

默認情況下，Ansible 的檢查模式已啟用，這意味著 Ansible 將報告在遠程主機上執行動作時會發生的變化。

Testinfra 和 Nagios

現在我們可以輕鬆地運行測試來驗證機器的狀態，我們可以使用這些測試來觸發監控系統上的警報。這是捕獲意外的更改的好方法。

Testinfra 提供了與 Nagios 的集成，它是一種流行的監控解決方案。默認情況下，Nagios 使用 NRPE 插件對遠程主機進行檢查，但使用 Testinfra 可以直接從 Nagios 主控節點上運行測試。

要使 Testinfra 輸出與 Nagios 兼容，我們必須在觸發測試時使用 --nagios 標誌。我們還使用 -qq 這個 pytest 標誌來啟用 pytest 的靜默模式，這樣就不會顯示所有測試細節。

(venv) $ py.test --hosts=web --ansible-inventory=inventory --connection=ansible --nagios -qq line test.py
TESTINFRA OK - 1 passed, 0 failed, 0 skipped in 2.55 seconds

Testinfra 是一個功能強大的庫，可用於編寫測試以驗證基礎架構的狀態。 另外與 Ansible 和 Nagios 相結合，提供了一個用於架構即代碼 (IaC) 的簡單解決方案。 它也是使用 Molecule 開發 Ansible 角色過程中添加測試的關鍵組件。

via: https://opensource.com/article/19/5/using-testinfra-ansible-verify-server-state

作者：Clement Verna 選題：lujun9972 譯者：geekpi 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive