如何借助Molecule测试Ansible角色

译文
开发 测试
开发人员总是在测试,需要不断的反馈来促进开发。如果获得变更方面的反馈很费时间,表明你的步骤可能太庞大,难以发现错误。小步骤和快速反馈是TDD(测试驱动型开发)的精髓。但是你如何将这个方法应用于开发特定的playbook或角色呢?

[[252388]]

【51CTO.com快译】测试技术在软件开发中扮演着重要角色,我们谈论基础设施即代码(IaC)时也一样。

开发人员总是在测试,需要不断的反馈来促进开发。如果获得变更方面的反馈很费时间,表明你的步骤可能太庞大,难以发现错误。小步骤和快速反馈是TDD(测试驱动型开发)的精髓。但是你如何将这个方法应用于开发特定的playbook或角色呢?

开发自动化时,典型的工作流程会从新的虚拟机开始。我使用Vagrant来阐述这个想法,但你可以使用libvirt、Docker、VirtualBox、VMware、私有云或公共云中的实例,或者数据中心虚拟机管理程序中配置的虚拟机(比如oVirt、Xen或VMware)。

决定使用哪个虚拟机时,应兼顾反馈速度和与你的实际目标环境的相似性。

Vagrant的最小起点是:

  1. vagrant init centos/7 # or any other box 

然后将Ansible配置添加到你的Vagrantfile:

  1. config.vm.provision "ansible" do |ansible|  
  2. ansible.playbook = "playbook.yml"  
  3. end 

***,你的工作流程将是这样:

1. vagrant up。

2. 编辑playbook。

3. vagrant provision。

4. vagrant ssh,以验证虚拟机状态。

5. 重复步骤2至4。

偶尔会销毁并再次启动虚拟机(vagrant destroy -f; vagrant up),以提高你playbook的可靠性(即为了测试你的自动化是不是端到端运行)。

虽然这是很好的工作流程,但你仍在完成连接到虚拟机,并验证一切都按预期运行的所有棘手工作。

如果测试未自动化,你没有自动化基础架构时会面临类似那样的问题。

幸好,像Testinfra和Goss这样的工具有助于自动化这些验证。

我将着重介绍Testinfra,因为它是用Python编写的,是Molecule的默认验证器。想法很简单:使用Python自动化你的验证。

  1. def test_nginx_is_installed(host):  
  2. nginx = host.package("nginx" 
  3. assert nginx.is_installed  
  4. assert nginx.version.startswith("1.2" 
  5. def test_nginx_running_and_enabled(host):  
  6. nginx = host.service("nginx" 
  7. assert nginx.is_running  
  8. assert nginx.is_enabled 

在开发环境中,该脚本将使用SSH(就像Ansible)连接到目标主机以执行上述验证(包存在/版本和服务状态):

  1. py.test --connection=ssh --hosts=server 

简而言之,在基础架构自动化开发过程中,面临的挑战是配置新的基础架构,针对它们执行playbook,验证你的变更体现了你在playbooks中声明的状态。

  • Testinfra能验证什么?
    • 从用户的角度来看,基础架构已安装并运行起来(比如,HTTPD或Nginx在回应请求,MariaDB或PostgreSQL在处理SQL查询)。
    • OS服务已运行并启用
    • 进程在侦听特定的端口
    • 进程在回应请求
    • 配置文件用模板正确复制或生成
    • 你几乎执行的任何操作,确保服务器状态正确无误
  • 这些自动化测试提供了哪些安全措施?
    • 执行复杂的变更或引入新功能而不破坏现有行为(比如,添加对基于Debian的系统的支持后,仍可以在基于RHEL的发行版中运行)。
    • 发布Ansible的新版本并引入新的***实践时,重构/改进代码库。

到目前为止,我们对Vagrant、Ansible和Testinfra所做的工作很容易与四阶段测试模式中描述的步骤对应起来――这种测试结构方法使测试目标清晰。它包括下列阶段:安装、演练、验证和拆除:

  • 安装:为测试执行准备环境(比如启用新的虚拟机):
  1. vagrant up 
  • 演练:针对测试的系统有效地执行代码(即Ansible playbook):
  1. vagrant provision 
  • 验证:验证上一步的输出:
  1. py.test(针对Testinfra) 
  • 拆除:回到安装前的状态:
  1. vagrant destroy 

我们用于特定playbook的同一个想法可以运用于角色开发和测试,但每当开发新产品时是否需要执行所有这些步骤?如果你想使用容器或OpenStack而不是Vagrant,该怎么办?如果你宁愿使用Goss而不是Testinfra,该怎么办?如何针对你代码中的每次变更持续运行此操作?有没有一种更简单快速的方法来使用自动化测试开发playbook和角色?

Molecule

Molecule使用测试帮助开发角色。该工具甚至可以用测试用例初始化新角色:molecule init role –role-name foo。

Molecule很灵活,足以让你可以将不同的驱动程序用于基础架构配置,包括Docker、Vagrant、OpenStack、GCE、EC2和Azure。它还允许使用不同的服务器验证工具,包括Testinfra和Goss。

它的命令简化了开发工作流程中常用任务的执行:

  • lint-执行yaml-lint、ansible-lint和flake8,如果有问题报告故障
  • syntax-验证角色的语法错误
  • create-创建驱动程序已配置的实例
  • prepare-使用准备playbook来配置实例
  • converge-执行针对主机的playbook
  • idempotence-执行两次playbook;万一第二次运行出现变更,就失效(非幂等)
  • verify-执行服务器状态验证工具(testinfra或goss)
  • destroy-销毁实例
  • test-执行前面的所有步骤

login命令可用于连接到已配置的服务器用于故障排查。

逐步操作

你如何从根本没有测试到针对每次变更/提交执行一个体面的代码库?

1. virtualenv(可选)

virtualenv工具创建孤立的环境,而virtualenvwrapper是便于使用virtualenv的扩展件的集合。

这些工具可防止Molecule与计算机中其他Python包之间的依赖项和冲突。

  1. sudo pip install virtualenvwrapper  
  2. export WORKON_HOME=~/envs  
  3. source /usr/local/bin/virtualenvwrapper.sh  
  4. mkvirtualenv mocule 

2. Molecule

安装带Docker驱动程序的Molecule:

  1. pip install molecule ansible docker-py 

生成带测试场景的新角色:

  1. molecule init role -r role_name 

或者针对现有角色:

  1. molecule init scenario -r my-role 

所有必要的配置都是使用你的角色生成,你只要使用Testinfra编写测试用例:

  1. import os  
  2. import testinfra.utils.ansible_runner  
  3. testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(  
  4. os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all' 
  5. def test_jboss_running_and_enabled(host):  
  6. jboss = host.service('wildfly' 
  7. assert jboss.is_enabled  
  8. def test_jboss_listening_http(host):  
  9. socket = host.socket('tcp://0.0.0.0:8080' 
  10. assert socket.is_listening  
  11. def test_mgmt_user_authentication(host):  
  12. command = """curl --digest -L -D - http://localhost:9990/management \  
  13. -u ansible:ansible"" 
  14. cmd = host.run(command)  
  15. assert 'HTTP/1.1 200 OK' in cmd.stdout 

Wildfly角色的该示例测试用例验证OS服务已启用,进程在侦听端口8080,身份验证已正确配置。

为这些测试编写代码很简单,你基本上需要考虑一种自动验证方法。

你登录到playbook针对的机器或者为监视/警报系统构建验证时,你已经在编写测试。 这有助于使用Testinfra API或使用系统命令来构建内容。

CI

持续执行Molecule测试很简单。上述示例适用于带Docker驱动程序的TravisCI,但它可能很容易改动,适合Molecule支持的任何CI服务器和任何基础架构驱动程序。

  1. ---  
  2. sudo: required  
  3. language: python  
  4. services:  
  5. - docker  
  6. before_install:  
  7. - sudo apt-get -qq update  
  8. - pip install molecule  
  9. - pip install docker-py  
  10. script:  
  11. - molecule test 

访问Travis CI以获取示例输出。

原文标题:Testing Ansible roles with Molecule,作者:Jairo da Silva Junior

【51CTO译稿,合作站点转载请注明原文译者和出处为51CTO.com】

责任编辑:庞桂玉 来源: 51CTO
相关推荐

2012-07-26 10:30:42

测试测试人员

2012-05-14 11:52:45

服务器角色

2011-07-26 10:27:07

分析器操作系统服务器

2013-12-23 10:36:57

Nagios监控监测

2014-02-17 10:48:57

NagiosBGP会话

2016-12-07 09:26:27

GlusterFS存储池

2011-11-30 09:29:18

BYODWindows服务器

2013-07-26 17:07:33

Foglight容量

2010-11-16 10:32:06

职场

2015-09-15 09:50:02

CIO ITaaSIT即服务

2020-10-10 20:30:05

Ansible自动化工具系统运维

2020-01-02 10:44:22

运维架构技术

2023-02-21 14:16:42

2015-08-19 09:38:29

云集群高性能计算云计算

2021-09-15 10:27:25

物联网人工智能IoT

2016-11-08 13:50:57

2023-03-06 07:44:51

项目管理测试角色项目

2013-03-19 10:37:55

psacctacct监视

2013-11-18 11:41:37

2024-03-07 11:39:24

HadolintDockerfile工具
点赞
收藏

51CTO技术栈公众号