Serverspec: Quick Start - Run Sample Test to EC2 server

In this post, I am going to install Serverspec and run a sample test on a EC2 instance.


what is Serverspec?

Serverspec is a server-testing framework in Ruby.

A similar technology may include Goss (https://web-quickstart.blogspot.com/2021/04/goss-quick-start-on-awsec2.html).


install

% gem install serverspec
% gem list serverspec
serverspec (2.41.5)

If you get "FilePermissionError" see https://web-quickstart.blogspot.com/2021/04/troubleshoot-gem-install.html


test server

I have created an EC2 instance as:

ssh -i test ec2-user@34.203.28.211

reference: https://web-quickstart.blogspot.com/2021/04/terraform-ec2-instance-with-ssh-setup.html


init project

% serverspec-init
Select OS type:
  1) UN*X
  2) Windows

Select number: 1

Select a backend type:
  1) SSH
  2) Exec (local)

Select number: 1

Vagrant instance y/n: n

Input target host name: 34.203.28.211
 + spec/
 + spec/34.203.28.211/
 + spec/34.203.28.211/sample_spec.rb
 + spec/spec_helper.rb
 + Rakefile
% tree -a -I .git 
.
├── .rspec
├── .terraform
│   └── ...
├── .terraform.lock.hcl
├── Rakefile
├── main.tf
├── spec
│   ├── 34.203.28.211
│   │   └── sample_spec.rb
│   └── spec_helper.rb
├── terraform.tfstate
├── terraform.tfstate.backup
├── test
└── test.pub


ssh config

For Serverspec to be able to ssh -i test ec2-user@34.203.28.211, you can modify ~/.ssh/config .

Alternatively, you can specify the user and private key in spec/spec_helper.rb as:

options[:user] ||= 'ec2-user'
options[:keys] ||= 'test'


test (fail)

Replace the spec/34.203.28.211/sample_spec.rb with the following code:

require 'spec_helper'

describe package('httpd') do
  it { should be_installed }
end

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

You should get two failures if you have not configured the server yet.

% rake spec                            
Package "httpd"
  is expected to be installed (FAILED - 1)

Port "80"
  is expected to be listening (FAILED - 2)


fix and test again (succeed)

Install and start apache on the target server:

$ sudo yum install httpd
$ sudo service httpd start

The test should be successful now.

% rake spec 
Package "httpd"
  is expected to be installed

Port "80"
  is expected to be listening

Finished in 9.64 seconds (files took 0.27145 seconds to load)
2 examples, 0 failures


Troubleshoot

FilePermissionError

see https://web-quickstart.blogspot.com/2021/04/troubleshoot-gem-install.html


NotImplementedError

install the missing modules

% rake spec
NotImplementedError:
  OpenSSH keys only supported if ED25519 is available
  net-ssh requires the following gems for ed25519 support:
   * ed25519 (>= 1.2, < 2.0)
   * bcrypt_pbkdf (>= 1.0, < 2.0)

% gem install ed25519
% gem install bcrypt_pbkdf


set :request_pty, true

add the line

% rake spec 
Please write "set :request_pty, true" in your spec_helper.rb or other appropriate file.
% vim spec/spec_helper.rb
+ set :request_pty, true


Wrong sudo password

set SUDO_PASSWORD

% rake spec 
Wrong sudo password! Please confirm your password on 10.157.87.100.
% export SUDO_PASSWORD=YOUR_PASSWORD


Comments

Post a Comment

Popular posts from this blog

Minikube Installation for M1 Mac

Image
In this post, I am going to try Minikube on Mac with M1 Chip. what is minikube Minikube is k8s tool running on a local machine. See also kind  for multi cluster implementation for local k8s. install % curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-arm64 % install minikube-darwin-arm64 /usr/local/bin/minikube % minikube version  minikube version: v1.20.0  Note: Installing with brew fails due to a different binary as of 2021-05-24. % brew install minikube % minikube version ❌  Exiting due to MK_WRONG_BINARY_M1: You are trying to run amd64 binary on M1 system. Please use darwin/arm64 binary instead (Download at https://github.com/kubernetes/minikube/releases/download/v1.20.0/minikube-darwin-amd64.) % brew uninstall minikube start The default driver 'virtualbox' is not supported on M1, but you can use 'docker' driver:  https://minikube.sigs.k8s.io/docs/drivers/docker/  . Make sure docker is running, and then specify the driver ...
Read more

Selenide: Quick Start

Selenide is a Selenium wrapper in Java for testing.   This post describes how you can start using Selenide (using Gradle). 1. Setup Java Application # keep pressing enters to choose default values gradle init --type java-application # confirm that test succeeds gradle test 2. Add Selenide Dependency open build.gradle and edit as: dependencies {   ...   testImplementation 'com.codeborne:selenide:5.13.0' } 3. Write Test (replace the existing test with selenide code) src/test/java/selenide/AppTest.java package selenide; import static com.codeborne.selenide.Condition.text; import static com.codeborne.selenide.Selenide.$; import static com.codeborne.selenide.Selenide.open; import org.junit.Test;   public class AppTest { @Test public void test() { open("https://www.google.ca/"); $("input[type=text]").val("test").pressEnter(); $("body").shouldHave(text("test")); } } 4. Run Selenide gradle test This will open a browser t...
Read more

Ansistrano (Ansible + Capistrano): Quick Start

In this post, I am going to try Ansistrano to deploy a file on a web server. (See this post  this post  for detail about Ansible) what is Ansistrano? " ansistrano.deploy and ansistrano.rollback are Ansible roles to easily manage the deployment process for scripting applications such as PHP, Python and Ruby. It's an Ansible port for Capistrano." ( https://github.com/ansistrano/deploy ) install %  ansible-galaxy install ansistrano.deploy ansistrano.rollback create test file % mkdir -p public_html  % echo 'hello' > public_html/index.html  deploy % vim playbook.yml --- - name: deploy code hosts: webservers become: true vars: ansistrano_deploy_from: "{{ playbook_dir }}/public_html/" ansistrano_deploy_to: "/var/www/my-app" ansistrano_keep_releases: 3 ansistrano_deploy_via: "rsync" roles: - ansistrano.deploy See  https://github.com/ansistrano/deploy for the vars to customize as needed. Run the playbook. ...
Read more