Use o Serverspec para o desenvolvimento orientado por testes de código de infraestrutura

Criado por Sushant Jagdale (AWS)

Resumo

Esse padrão mostra como usar o Serverspec para usar o desenvolvimento orientado a testes (TDD) ao escrever código de infraestrutura na nuvem da Amazon Web Services (AWS). O padrão também abrange a automação com a AWS CodePipeline. O TDD concentrará a atenção no que o código de infraestrutura deve fazer e definirá uma definição clara de concluído. Você pode usar o Serverspec para testar a infraestrutura criada por ferramentas como AWS CloudFormation, Terraform by HashiCorp e Ansible.

O Serverspec ajuda na refatoração do código da infraestrutura. Com o Serverspec, você pode escrever testes RSpec para verificar a instalação de vários pacotes e softwares, executar comandos, verificar processos e portas em execução, verificar as configurações de permissão de arquivos e assim por diante. O Serverspec verifica se seus servidores estão configurados corretamente. Você instala somente o Ruby em seus servidores. Você não precisa instalar nenhum software agente.

A infraestrutura orientada a testes oferece os seguintes benefícios:

Você pode usar esse padrão para executar testes de unidade do Serverspec para o software Apache e verificar as configurações de permissão do arquivo durante a criação da imagem de máquina da Amazon (AMI). Uma AMI será criada somente se todos os casos de teste forem aprovados. O Serverspec realizará os seguintes testes:

Pré-requisitos e limitações

Pré-requisitos

Versões do produto

Arquitetura

Arquitetura de destino

Ferramentas

Código

O código está anexado. O código usa a estrutura a seguir, com três diretórios e oito arquivos.

├── amazon-linux_packer-template.json (Packer template)
├── buildspec.yaml (CodeBuild .yaml file)
├── pipeline.yaml (AWS CloudFormation template to automate CodePipeline)
├── rspec_tests (RSpec required files and spec)
│   ├── Gem-file
│   ├── Rakefile
│   └── spec
│       ├── apache_spec.rb
│       └── spec_helper.rb
└── scripts
    └── rspec.sh (Installation of Ruby and initiation of RSpec)

Épicos

aws sts get-caller-identity --profile <profile>

aws codecommit create-repository --repository-name "<provide repository-name>" --repository-description "repository to unit test the infrastructure code"

git clone <repository url>
cp -R /tmp/<code folder>/  <repository_folder>/
git add .
git commit -m"initial commit"
git push

http://<your instance public ip>/hello.html

Recursos relacionados

Mais informações

Escreva testes RSpec

O teste RSpec para esse padrão está localizado em <repository folder>/rspec_tests/spec/apache_spec.rb.

require 'spec_helper'


describe service('httpd') do
  it { should be_enabled }
  it { should be_running }
end


describe port(80) do
  it { should be_listening }
end


describe file('/etc/httpd/conf/httpd.conf') do
  it { should exist }
  it { should be_owned_by 'root' }
  it { should contain 'ServerName www.example.com' }
end


describe file('/etc/httpd/conf/httpd.conf') do
  its(:content) { should match /ServerName www.example.com/ }
end


describe file('/var/www/html/hello.html') do
  it { should exist }
  it { should be_owned_by 'ec2-user' }
end


describe file('/var/log/httpd') do
  it { should be_directory }
end


describe file('/etc/sudoers') do
  it { should be_mode 440 }
end


describe group('root') do
  it { should have_gid 0 }
end

Você pode adicionar seus próprios testes ao diretório /spec.

Criar o pipeline

aws cloudformation create-stack --stack-name myteststack --template-body file://pipeline.yaml --parameters ParameterKey=RepositoryName,ParameterValue=<provide repository-name> ParameterKey=ApplicationName,ParameterValue=<provide application-name> ParameterKey=SecurityGroupId,ParameterValue=<provide SecurityGroupId> ParameterKey=VpcId,ParameterValue=<provide VpcId> ParameterKey=SubnetId,ParameterValue=<provide SubnetId> ParameterKey=Region,ParameterValue=<provide Region> ParameterKey=Keypair,ParameterValue=<provide Keypair> ParameterKey=AccountId,ParameterValue=<provide AccountId> --capabilities CAPABILITY_NAMED_IAM

Detalhes do parâmetro

repository-name— O nome do CodeCommit repositório da AWS

application-name: o nome do recurso da Amazon (ARN) está vinculado a ApplicationName; forneça qualquer nome

SecurityGroupId: qualquer ID de grupo de segurança da sua conta da AWS que tenha a porta 80 aberta

VpcId: o ID da sua VPC

SubnetId: o ID de uma sub-rede pública em sua VPC

Region: a região da AWS na qual você está executando esse padrão

Keypair: o nome da chave Secure Shell (SSH) para fazer login na instância do EC2

AccountId: o ID de sua conta da AWS

Você também pode criar um CodePipeline pipeline usando o AWS Management Console e transmitindo os mesmos parâmetros que estão na linha de comando anterior.

Anexos

Para acessar o conteúdo adicional associado a este documento, descompacte o seguinte arquivo: attachment.zip