testing your automation code (docker version)

v0.0.1

Testing YourAutomation CodeMischa Taylor (@misheska)[email protected] (C) 2014 Chef Software, Inc.

1

Wednesday, April 30, 14

v2.0.0

Why Are You Here?

2


3

You’ve used and want to

bulletproofyour so that

you are with

Spec


In this class• We’ll add tests to the apache cookbook from the

Fundamentals Course• We’ll show you how to run cookbooks in a sandbox

environment mirroring production with Test Kitchen

• We’ll show you how to detect suspicious cookbook code with Foodcritic & RuboCop

• We’ll show you how to produce runnable documentation with ChefSpec

4


Using Chef is half the battle

5

“Chef is like....tests for your infrastructure”

-Ezra Zygmuntowicz, Co-Founder Engine Yard

http://www.akitaonrails.com/2008/6/5/railsconf-2008-brazil-rails-podcast-special-edition#.U0HfiF7Ed-8


http://www.akitaonrails.com/2008/6/5/railsconf-2008-brazil-rails-podcast-special-edition#

http://www.akitaonrails.com/2008/6/5/railsconf-2008-brazil-rails-podcast-special-edition#

Chef makes things more testable• Chef automates infrastructure in a repeatable

fashion

6


What’s the other half of the battle?

7

“Have a plan”-Adam Jacob, Co-Founder Chef


There’s no more magic to testing

8http://www.flickr.com/photos/dkeats/4128747046/sizes/s/in/photostream/


http://www.flickr.com/photos/dkeats/4128747046/sizes/s/in/photostream/

http://www.flickr.com/photos/dkeats/4128747046/sizes/s/in/photostream/

You Are The Testing A-Team When...

9


Recommended plan• Build in quality and robustness up front

10

https://flic.kr/p/8W67ZC




Otherwise you could...• Verify and validate just before going to production

until time runs out. But time always runs out

11http://mrg.bz/iEr1oj


http://mrg.bz/iEr1oj

http://mrg.bz/iEr1oj

Waiting to test when it’s “done”

12

Intention:

Reality:

Build Test Deploy

Build Tes

Deploy

We’re lateno timeto test!


13


14


Bake testing in earlier

15

Shorter cycles,to start testing early as possible:

Build Test Deploy Build Test Deploy Build Test Deploy


Penny saved with testing

16

Up Front Testing Saves Money

https://www.flickr.com/people/68751915@N05/




Cost of change

17


Test arrangement• Arrange tests to get feedback fast - at the earliest

possible time

18

seconds

minutes

hours

Foodcritic/Rubocop

ChefSpec

Serverspec


Reason for multiple tools• Finding a bug in something that you can’t execute

is freaking hard!• While fixing bugs before writing code is cheap,

finding them is expensive

19


The Tools• Each tool is specialized to give feedback as early

as possible during the cookbook authoring process

20


What each tool does• In your text editor when you type in cookbook code:

• Foodcritic analyzes your Chef style• RuboCop analyzes your Ruby coding technique

• Before you deploy to a test node:• ChefSpec helps you document and organize your

code• After you deploy to a test node:

• Serverspec verifies a cookbook behaves as intended

21


v2.0.0

Legend

22


Legend: Do I run that command on my workstation?

$ whoamii-am-a-workstation

This is an example of a command to run on your workstation

user@hostname:~$ whoamii-am-a-chef-node

This is an example of a command to run on your target node via SSH.

23


$ ifconfig

Legend: Example Terminal Command and Output

lo0: flags=8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 16384! options=3<RXCSUM,TXCSUM>! inet6 fe80::1%lo0 prefixlen 64 scopeid 0x1! inet 127.0.0.1 netmask 0xff000000! inet6 ::1 prefixlen 128gif0: flags=8010<POINTOPOINT,MULTICAST> mtu 1280stf0: flags=0<> mtu 1280en0: flags=8863<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu 1500! ether 28:cf:e9:1f:79:a3! inet6 fe80::2acf:e9ff:fe1f:79a3%en0 prefixlen 64 scopeid 0x4! inet 10.100.0.84 netmask 0xffffff00 broadcast 10.100.0.255! media: autoselect! status: activep2p0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> mtu 2304! ether 0a:cf:e9:1f:79:a3! media: autoselect! status: inactive

24


OPEN IN EDITOR:

SAVE FILE!

~/hello_world

Hi!

I am a friendly file.

Legend: Example of editing a file on your workstation

25


v2.0.0

Training Environment (CloudShare)

26


CloudShare Node• Register and login to CloudShare (see invite)• Start Using This Environment

27


Two Virtual Machines

28


Two Virtual Machines

29

We’ll just use the Ubuntuw/Docker image


30

The Ubuntu w/Docker VM

will be your Chef Development

Workstationfor this class


CloudShare Development Workstation

31


CloudShare Node

32


$ ssh sysadmin@<EXTERNAL_ADDRESS>

Lab - Login

The authenticity of host 'uvo1qrwls0jdgs3blvt.vm.cld.sr (69.195.232.110)' can't be established.RSA key fingerprint is d9:95:a3:b9:02:27:e9:cd:74:e4:a2:34:23:f5:a6:8b.Are you sure you want to continue connecting (yes/no)? yesWarning: Permanently added 'uvo1qrwls0jdgs3blvt.vm.cld.sr,69.195.232.110' (RSA) to the list of known [email protected]'s password: Last login: Mon Jan 6 16:26:24 2014 from host86-145-117-53.range86-145.btcentralplus.com[chef@CentOS63 ~]$

33


mailto:[email protected]


Checkpoint • At this point you should have

• One virtual machine (VM) or server that you’ll use for the lab exercises

• The IP address or public hostname• An application for establishing an ssh connection• 'sudo' or 'root' permissions on the VM

34


v2.0.0

Workstation Setup - Linux (Docker)Getting started

35


Base OS Install• Ubuntu and Enterprise Linux support the kernel

extensions needed for Docker (64-bit only).• Ubuntu is recommended if you are using a VM. The

Enterprise Linux package uses the 3.14 kernel which has issues working with the VMware and VirtualBox guest tools.

36


Base OS Install• Recommended Packer templates for building the

base OS with Docker:• Ubuntu Server:

https://github.com/misheska/basebox-packer/blob/master/template/ubuntu/ubuntu1204-docker.json

• Vagrant Cloud: vagrant init learningchef/ubuntu1204-‐docker

37






Install Chef• Install Chef (if not already installed)

http://www.getchef.com/chef/install

38


http://www.opscode.com/chef/install

http://www.opscode.com/chef/install

Install Chef Client

39


Install on Linux

40


$ curl -L http://www.getchef.com/chef/install.sh | sudo bash

Workstation Setup - Linux

% Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed100 14398 100 14398 0 0 56535 0 --:--:-- --:--:-- --:--:-- 78250

Downloading Chef for ubuntu...Installing Chef installing with dpkg...Selecting previously unselected package chef.(Reading database ... 78644 files and directories currently installed.)Unpacking chef (from .../chef_11.12.2-1_amd64.deb) ...Setting up chef (11.12.2-1) ...Thank you for installing Chef!

41


http://www.opscode.com/chef/install.sh

http://www.opscode.com/chef/install.sh

What just happened?• Chef and all of its dependencies installed via an

operating system-specific package ("omnibus installer")• Installation includes

• The Ruby language - used by Chef• knife - Command line tool for administrators• chef-client - Client application• ohai - System profiler• ...and more

42


OPEN IN EDITOR: $HOME/.bash_profile

export PATH="/opt/chef/embedded/bin:$PATH"

Add Chef Client to PATH

43


$ source $HOME/.bash_profile

Make the profile active

44


$ which ruby

Check the PATH setting

/opt/chef/embedded/bin/ruby

45


$ chef-client --version

Verify Install

Chef: 11.12.2

46


Install Developer Tools• Install Developer Tools to build native extensions

47

http://patshaughnessy.net/2011/10/31/dont-be-terrified-of-building-native-extensions




Install Developer Tools• Use build-essential cookbook:

https://github.com/opscode-cookbooks/build-essential

48






$ mkdir /tmp/cookbooks

Temporary area for cookbook downloads

49


$ cd /tmp/cookbooks

Easiest to go to cookbooks dir

50


$ knife cookbook site download build-essential$ tar xvf build-essential-*.tar.gz

Download build-essential cookbook

51


$ cd /tmp$ sudo chef-client -z -o build-essential

Use local mode to run cookbook

52


$ gcc --version

Verify Install

gcc (Ubuntu/Linaro 4.6.3-1ubuntu5) 4.6.3

53


$ cd /tmp/cookbooks

Easiest to go to cookbooks dir

54


$ knife cookbook site download git$ knife cookbook site download dmg$ knife cookbook site download windows$ knife cookbook site download runit$ knife cookbook site download yum$ knife cookbook site download yum-epel$ knife cookbook site download chef_handler

Download git cookbook + dependencies

55


$ tar xvf git*.tar.gz$ tar xvf dmg*.tar.gz$ tar xvf windows*.tar.gz$ tar xvf runit*.tar.gz$ tar xvf yum-3*.tar.gz$ tar xvf yum-epel*.tar.gz$ tar xvf chef_handler*.tar.gz

Extract cookbook archives

56


$ cd /tmp$ sudo chef-client -z -o git

Use local mode to run cookbook

57


$ git --version

Verify Install

git version 1.7.9.5

58


$ rm -rf /tmp/cookbooks

Keep it neat

59


v2.0.0

Our Source

60


chef-fundamentals-repo• We’re going to build on the chef-fundamentals-

repo created in the Chef Fundamentals training, adding tests:

https://github.com/learnchef/chef-fundamentals-repo/tree/master/cookbooks/apache

61






$ cd $HOME

Home directory - great place for source

62

$ cd %USERPROFILE%


$ git clone https://github.com/learnchef/chef-fundamentals-repo.git

Grab the chef-fundamentals repo from GitHub

Cloning into 'chef-fundamentals-repo'...remote: Reusing existing pack: 247, done.remote: Total 247 (delta 0), reused 0 (delta 0)Receiving objects: 100% (247/247), 149.52 KiB | 184.00 KiB/s, done.Resolving deltas: 100% (45/45), done.Checking connectivity... done.

63


https://github.com/learnchef/chef-fundamentals-repo.git

https://github.com/learnchef/chef-fundamentals-repo.git

$ cd chef-fundamentals-repo

chef-fundamentals-repo

64

!"" Berksfile!"" cookbooks/!"" data_bags/!"" environments/!"" .git/!"" README.md!"" roles/#"" Vagrantfile


v2.0.0

Reviewing Cookbooks with Test Kitchen (Docker Version)

65


Apache Clowns & Bears• We’ll be focusing on the Apache Clowns and

Bears cookbook in:

chef-‐fundamentals-‐repo/cookbooks/apache

66


Cookbook Review with Test Kitchen• Test Kitchen is a great environment in which to

develop and review cookbooks• Written by Fletcher Nichol

67


Back in my day...• Running a cookbook

involved a lot of setup:• Configure workstation• Configure Chef Server• Bootstrap node

68


No longer a chore• Test Kitchen lets you set up sandbox environments

in which to run cookbooks right on your Chef development workstation

69


Supported Environments• Test Kitchen supports:

• Virtual Machines

• Cloud Instances

• Metal - Physical Servers

• Containers (Docker, LXC, etc.)70


Sandbox Benefits• A sandbox environment:

• Is a safe place to make mistakes• Easily reset to a clean config• Can simulate production

71


Virtual Machines vs. Containers

72

Hypervisor/Host OS

Guest OS

Core OS

Guest OS Guest OS

App App App

App App App

Virtual Machines Containers


73

Test Kitchen is packaged as a

Ruby Gem


Ruby Gem• A gem is a application or supporting library

written in ruby, installable with:

74

gem install


$ sudo gem install test-kitchen --no-ri --no-rdoc

Install Test Kitchen

75

$ sudo env "PATH=$PATH" gem install test-kitchen --no-ri --no-rdoc

Run As Administrator

> gem install test-kitchen --no-ri --no-rdoc


Install Test Kitchen

76

Fetching: net-scp-1.1.2.gem (100%)Fetching: safe_yaml-1.0.2.gem (100%)Fetching: thor-0.19.1.gem (100%)Fetching: test-kitchen-1.2.1.gem (100%)Successfully installed net-scp-1.1.2Successfully installed safe_yaml-1.0.2Successfully installed thor-0.19.1Successfully installed test-kitchen-1.2.14 gems installed

Text

Output:


OPEN IN EDITOR: $HOME/.gemrc

gem: --no-ri --no-rdoc

Automatically add --no-ri & --no-rdoc

77


$ cd $HOME/chef-fundamentals-repo/cookbooks/apache

Go to Apache cookbook dir

78


79

We’re going to need a lot of gems


Gemfile• A Gemfile can be used to list all the gems you need

for cookbook testing

80


Gemfile template• Test Kitchen can generate a Gemfile template

(among other things)

81


$ kitchen init --driver=kitchen-docker --create-gemfile

create .kitchen.yml create test/integration/default create Gemfile append Gemfile append GemfileYou must run ‘bundle install’ to fetch any new gems.

Create Gemfile template

82


chef-fundamentals-repo/cookbooks/apache/Gemfile

source 'https://rubygems.org'

gem 'test-kitchen'gem 'kitchen-docker'

83


https://rubygems.org


$ kitchen init --driver=kitchen-docker --create-gemfile

create .kitchen.yml create test/integration/default create Gemfile append Gemfile append GemfileYou must run ‘bundle install’ to fetch any new gems.

Create Gemfile template

84


85


86

Gemfile is read by:

bundle install

to install gems


87

No need to install bundler• Chef install includes the bundler gem• Outside the Chef install, bundler can be installed via:•gem install bundler


$ bundle install --path vendor/bundle

Do what Test Kitchen tells you

Fetching gem metadata from https://rubygems.org/..........Fetching gem metadata from https://rubygems.org/..Installing mixlib-shellout (1.3.0)Installing net-ssh (2.8.0)Installing net-scp (1.1.2)Installing safe_yaml (1.0.2)Installing thor (0.19.1)Installing test-kitchen (1.2.1)Installing kitchen-docker (1.0.0)Using bundler (1.1.5)Your bundle is complete! It was installed into ./vendor/bundle

88






89

Vendor Everything• Gems change frequently and sometimes conflict• -‐-‐path option passed to bundle install

overrides system gems by installing Gemfile gems locally

• Bundler docs recommend using vendor/bundle


90

If you vendor gems use:

bundle exec

to read gems invendor/bunde


91

Test Kitchen commands• Let’s cover a few essential Test Kitchen commands


92

kitchen list• kitchen list prints out a list of sandbox instances

defined in .kitchen.yml


$ bundle exec kitchen list

kitchen list

Instance Driver Provisioner Last Actiondefault-ubuntu-1204 Docker ChefSolo <Not Created>default-centos-64 Docker ChefSolo <Not Created>

93


94

kitchen create• kitchen create <instance_name> spins up a

sandbox instance


$ bundle exec kitchen create default-centos-64

kitchen create

-----> Starting Kitchen (v1.2.1)-----> Creating <default-centos-64>... Step 0 : FROM centos:6.4 ---> 539c0211cd76 Step 1 : RUN yum clean all ---> Using cache ---> 9a4da62cec5e... "Links": null, "PublishAllPorts": false } }] Finished creating <default-centos-64> (0m4.55s).-----> Kitchen is finished. (0m4.66s)

95


96

kitchen login• kitchen login <instance_name> uses ssh to

login to the sandbox instance


$ bundle exec kitchen login default-centos-64

kitchen login

kitchen@localhost's password:[kitchen@fc9834984e9d ~]$ cat /etc/redhat-releaseCentOS release 6.4 (Final)[kitchen@fc9834984e9d ~]$ exitlogoutConnection to localhost closed.

97

Default password is kitchen


98

kitchen destroy• kitchen destroy <instance_name> shuts down a

sandbox instance and destroys and virtual resources allocated


$ bundle exec kitchen destroy default-centos-64

kitchen destroy

-----> Starting Kitchen (v1.2.1)-----> Destroying <default-centos-64>... 3d71e7241e317d374f42ac0fc79c0752cb77eb86b4bfd76c068beebdb151dda3 3d71e7241e317d374f42ac0fc79c0752cb77eb86b4bfd76c068beebdb151dda3 Finished destroying <default-centos-64> (0m2.90s).-----> Kitchen is finished. (0m3.07s)

99


100

kitchen converge

performs a Chef runin the sandbox instance


$ bundle exec kitchen converge default-centos-64

Perform Chef run

-----> Starting Kitchen (v1.2.1)-----> Creating <default-centos-64>... Step 0 : FROM centos:6.4 ---> 539c0211cd76 Step 1 : RUN yum clean all ---> Using cache ---> 735ba0db794e....

101



Perform Chef run

-----> Starting Kitchen (v1.2.1)-----> Creating <default-centos-64>... Step 0 : FROM centos:6.4 ---> 539c0211cd76 Step 1 : RUN yum clean all ---> Using cache ---> 735ba0db794e....[2014-04-07T02:32:50-04:00] FATAL: Chef::Exceptions::ChildConvergeError: Chef run process exited unsuccessfully (exit code 1)>>>>>> Converge failed on instance <default-centos-64>.>>>>>> Please see .kitchen/logs/default-centos-64.log for more details>>>>>> ------Exception------->>>>>> Class: Kitchen::ActionFailed>>>>>> Message: SSH exited (1) for command: [sudo -E chef-solo --config /tmp/kitchen/solo.rb --json-attributes /tmp/kitchen/dna.json --log_level info]>>>>>> ----------------------

102

FAILWednesday, April 30, 14

103

Our first bit of feedback!


104


105

Undefined attribute• When you see undefined method ‘[]’ for nil:NilClass it often means you have an undefined attribute

• Let’s see if node["motd"]["company"] is being set


cookbooks/apache/attributes/default.rb

106

default["apache"]["indexfile"] = "index1.html"

default["apache"]["sites"]["clowns"] = { "port" => 80 }

default["apache"]["sites"]["bears"] = { "port" => 81 }

NOPEWednesday, April 30, 14

107

Undefined attribute• How is ["motd"]["company"] set in the motd

cookbook?


cookbooks/motd/attributes/default.rb

108

default["motd"]["company"] = "Chef"


Good cookbooks• Good cookbooks can be used in isolation• They set reasonable defaults for all attributes used• Test Kitchen is designed to run a cookbook in

isolation to give you feedback on attribute use

109


Test attributes• We won’t fix the motd cookbook in this class• Test Kitchen supports injection of test attributes• We’ll supply the correct attribute in

the .kitchen.yml configuration file

110


Default .kitchen.yml

111

---driver: name: docker

provisioner: name: chef_solo

platforms: - name: ubuntu-12.04 - name: centos-6.4

suites: - name: default run_list: - recipe[apache::default] attributes:


.kitchen.yml is a tab-free zone• Spacing matters in a .kitchen.yml file.• .kitchen.yml is a tab-free zone - you will get errors

if you try to use tabs. Set your editor accordingly.

112




platforms: - name: ubuntu-12.04 - name: centos-6.4

suites: - name: default run_list: - recipe[apache::default] attributes: motd: {company: Chef}

cookbooks/apache/.kitchen.yml

Set node[“motd”][“company”] (docker)

113

OPEN IN EDITOR:



Perform Chef run

-----> Starting Kitchen (v1.2.1)-----> Converging <default-centos-64>... Preparing files for transfer Preparing current project directory as a cookbook Removing non-cookbook files before transfer Transfering files to <default-centos-64>[2014-04-07T02:40:01-04:00] INFO: Forking chef instance to converge...Starting Chef Client, version 11.10.4....

114



Perform Chef run

-----> Starting Kitchen (v1.2.1)-----> Converging <default-centos-64>... Preparing files for transfer Preparing current project directory as a cookbook Removing non-cookbook files before transfer Transfering files to <default-centos-64>[2014-04-07T02:40:01-04:00] INFO: Forking chef instance to converge...Starting Chef Client, version 11.10.4....[2014-04-07T02:40:03-04:00] INFO: Report handlers completeChef Client finished, 5/10 resources updated in 2.52587913 seconds Finished converging <default-centos-64> (0m4.15s).-----> Kitchen is finished. (0m4.22s)

115

WINWednesday, April 30, 14

Where to go next• Learning Chef book excerpt

was sent to you are part of the class registration.

• Chapter 1 covers Test Kitchen and .kitchen.yml format in more detail.

• Appendix provides sample .kitchen.yml configs

116


http://shop.oreilly.com/product/0636920032397.do

http://shop.oreilly.com/product/0636920032397.do

Where to go next• Vagrant boxes for training image:

• VirtualBox 4.3.10https://s3-us-west-2.amazonaws.com/misheska/vagrant/virtualbox4.3.10/ubuntu1204-docker-chef11.12.2.box

• VMware Fusion 6/Workstation 10https://s3-us-west-2.amazonaws.com/misheska/vagrant/vmware9.6.1/ubuntu1204-docker-chef11.12.2.box

• Packer Templatehttps://github.com/misheska/basebox-packer/blob/master/template/ubuntu/ubuntu1204-docker.json

117


https://s3-us-west-2.amazonaws.com/misheska/vagrant/virtualbox4.3.10/ubuntu1204-docker-chef11.12.2.box




https://s3-us-west-2.amazonaws.com/misheska/vagrant/vmware9.6.1/ubuntu1204-docker-chef11.12.2.box






Gemfile

118


gem 'test-kitchen'gem 'kitchen-vagrant'




VirtualBox - .kitchen.yml

119

---driver: name: vagrant


platforms: - name: ubuntu1204-docker driver: box: ubuntu1204-docker box_url: https://s3-us-west-2.amazonaws.com/misheska/vagrant/vmware9.6.1/ubuntu1204-docker-chef11.12.2.box customize: memory: 1024

suites: - name: default






VMware Fusion 6 - .kitchen.yml

120



platforms: - name: ubuntu1204-docker driver: provider: vmware_fusion box: ubuntu1204-docker box_url: https://s3-us-west-2.amazonaws.com/misheska/vagrant/vmware9.6.1/ubuntu1204-docker-chef11.12.2.box customize: memory: 1024







VMware Workstation 10 - .kitchen.yml

121



platforms: - name: ubuntu1204-docker driver: provider: vmware_workstation box: ubuntu1204-docker box_url: https://s3-us-west-2.amazonaws.com/misheska/vagrant/vmware9.6.1/ubuntu1204-docker-chef11.12.2.box customize: memory: 1024







v2.0.0

Automated Verification in Test Kitchen with Serverspec (Docker Version)

122


123

Let’s verify that the Apache cookbookactually works by

configuring Test Kitchen to allowweb browser access by

the Chef Development workstation


OPEN IN EDITOR: cookbooks/apache/.kitchen.yml



platforms: - name: centos-6.4 driver_config: forward: - 80:80


Network config - clowns

124



Network reconfig requires destroy

-----> Starting Kitchen (v1.2.1)-----> Destroying <default-centos-64>... 5b88b1806d613be02bfcd14f359c8d9bb1d77f06bbce7e423c0e3100fee73177 5b88b1806d613be02bfcd14f359c8d9bb1d77f06bbce7e423c0e3100fee73177 Finished destroying <default-centos-64> (0m0.47s).-----> Kitchen is finished. (0m0.53s)

125



Perform Chef run

-----> Starting Kitchen (v1.2.1)-----> Creating <default-centos-64>... Step 0 : FROM centos:6.4 ---> 539c0211cd76 Step 1 : RUN yum clean all ---> Using cache ---> 735ba0db794e Step 2 : RUN yum install -y sudo openssh-server openssh-clients curl ---> Using cache ---> 37c081ac2580....

126


Port now forwarded

127


$ curl localhost:80

Does it blend?

<html> <body> <h1>Welcome to Chef</h1> <h2>We love clowns</h2> 172.17.0.2:80 </body></html>

128


$ curl localhost:80

Does it blend?

<html> <body> <h1>Welcome to Chef</h1> <h2>We love clowns</h2> 172.17.0.2:80 </body></html>

129


Clowns in your web browser

130

•You can access the clowns web site using the external address for your CloudShare workstation


CloudShare Node

131


CloudShare Node

132


http://<EXTERNAL_ADDRESS>

133


OPEN IN EDITOR: cookbooks/apache/.kitchen.yml---driver: name: docker


platforms: - name: centos-6.4 driver_config: forward: - 80:80 - 81:81


Network config - bears

134



Network reconfig requires destroy

-----> Starting Kitchen (v1.2.1)-----> Destroying <default-centos-64>... 5b88b1806d613be02bfcd14f359c8d9bb1d77f06bbce7e423c0e3100fee73177 5b88b1806d613be02bfcd14f359c8d9bb1d77f06bbce7e423c0e3100fee73177 Finished destroying <default-centos-64> (0m0.47s).-----> Kitchen is finished. (0m0.53s)

135



Perform Chef run

-----> Starting Kitchen (v1.2.1)-----> Creating <default-centos-64>... Step 0 : FROM centos:6.4 ---> 539c0211cd76 Step 1 : RUN yum clean all ---> Using cache ---> 735ba0db794e Step 2 : RUN yum install -y sudo openssh-server openssh-clients curl ---> Using cache ---> 37c081ac2580....[2014-04-07T03:06:36-04:00] INFO: Report handlers completeChef Client finished, 11/11 resources updated in 24.32934282 seconds Finished converging <default-centos-64> (0m38.09s).-----> Kitchen is finished. (0m38.33s)

136


Both ports forwarded

137


$ curl localhost:81

Does it blend?

<html> <body> <h1>Welcome to Chef</h1> <h2>We love bears</h2> 172.17.0.2:81 </body></html>

138


Very nice!

139


140


141


Serverspec author• Written by Gosuke Miyashita

142


OPEN IN EDITOR: cookbooks/apache/Gemfile



gem 'serverspec', '~> 1.1'

Add serverspec to Gemfile

143







gem 'serverspec', '~> 1.1'

Add serverspec to Gemfile

144

Pessimistic VersionConstraint




Version Constraint

145

• If a gem properly follows semantic versioning with its versioning scheme. You can take advantage of this to choose a version constraint to lock down the gem in your application.

http://guides.rubygems.org/patterns/#declaring_dependencies


http://semver.org/

http://semver.org/

http://semver.org/

http://semver.org/



Semantic Versioning

146

Given a version number MAJOR.MINOR.PATCH, increment the:1.MAJOR version when you make incompatible API

changes,2.MINOR version when you add functionality in a backwards-

compatible manner, and3.PATCH version when you make backwards-compatible bug

fixes.Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

http://guides.rubygems.org/patterns/#semantic_versioning




Versioning Example

147

Let’s say the following releases of a gem exist:■Version 2.1.0 — Baseline■Version 2.2.0 — Introduced some new (backward

compatible) features.■Version 2.2.1 — Removed some bugs■Version 2.2.2 — Streamlined your code■Version 2.3.0 — More new features (but still backwards

compatible).■Version 3.0.0 — Reworked the interface. Code written to

version 2.x might not work.http://guides.rubygems.org/patterns/#semantic_versioning




Version Constraint

148

gem 'library', '= 2.2.0'

Only use version 2.2.0


Optimistic Version Constraint

149

gem 'library', '>= 2.2.0'

Assume all changes from 2.x on will work, including 3.0.0 and higher


Pessimistic Version Constraint

150

gem 'library', '>= 2.2.0', ‘< 3.0’

Explicitly exclude any versions that might break your code


Pessimistic Version Constraint

151

gem 'library', '>= 2.2.0', ‘< 3.0’

Shorthand for:

Using the twiddle-wakka:gem 'library', '~> 2.2'


$ bundle install

Install Serverspec

152

$ CONFIGURE_ARGS="--with-ldflags=\'-Wno-error=unused-command-line-argument-hard-error-in-future'" bundle install

clang 5.1 Workaround


v2.0.0

RSpec Syntax

153


Documentation form

154

describe ‘<entity>’ do <descriptions here>end


Documentation example

155

describe ‘clowns site’ do ...end


Description form

156

describe ‘<entity>’ do it ‘<description>’ do ... endend


Description example

157

describe ‘clowns site’ do it ‘responds on port 80’ do ... endend


Expectation form

158

describe ‘<entity>’ do it ‘<description>’ do expect(thing).to eq result endend


Expectation form

159


Matcher


Expectation example

160

describe ‘clowns site’ do it ‘responds on port 80’ do expect(port 80).to be_listening ‘tcp’ endend


Expectation form

161


This is new syntax


Should vs Expect

162

describe ‘clowns site’ do it ‘responds on port 80’ do expect(port 80).to be_listening ‘tcp’ endend

Expect Form

One-Liner Should Formdescribe ‘clowns site’ do describe port(80) do it { should be_listening.with(‘tcp’) } endend


Expect vs. Should

163

Debate on whether or not to use expect vs. should is epic:http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax...and pointless. Use whatever makes the most sense to you. There are some technical limitations to the ‘should’ form, but if you stick to the “one-liner should” syntax, they are essentially interchangeable.


http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax




We Use Expect Form

164

Because all the ChefSpec examples are in the expect form


165

Let’s write some serverspectests!


166

Default location for tests• By default, Test Kitchen will look in the test/integration directory for test-related files

• For convenience, Test Kitchen creates this directory when you run kitchen init



167

.!"" attributes/!"" .bundle/!"" CHANGELOG.md!"" files/!"" Gemfile!"" Gemfile.lock!"" .kitchen/!"" .kitchen.yml!"" metadata.rb!"" README.md!"" recipes/!"" templates/!"" test/$ #"" integration/#"" vendor/


168

Suite subdirectory• Test Kitchen requires a few more directories underneath

test/integration• First directory name underneath test/integration should

match the suite name:

└── test/ └── integration/ └── <suite_name>/


OPEN IN EDITOR: cookbooks/apache/.kitchen.yml---driver: name: docker


platforms: - name: centos-6.4 driver_config: forward: - 80:80 - 81:81


Network configuration

169

Suite name


170

Suite subdirectory• Our suite name is default

└── test/ └── integration/ └── default/


171

Busser directory• The next directory level denotes the test plugin, as

Test Kitchen many different kinds of test plugins. A testplugin is called a busser. We’ll be using the busserdirectory called serverspec.

└── test/ └── integration/ └── default/ └── serverspec/


172

Hostname directory• Serverspec supports testing via SSH, so it requires yet

another directory level to denote the hostname. Wewon’t be using this capability, so it should be localhost

└── test/ └── integration/ └── default/ └── serverspec/ └── localhost/


173

Hostname directory

• NOTE: Use of the localhost directory is optional


$ cd $HOME/chef-fundamentals-repos/cookbooks/apache

Make sure you are in the apache cookbook root

174

> cd %USERPROFILE%/chef-fundamentals-repos/cookbooks/apache


$ mkdir -p test/integration/default/serverspec

Create test directory structure

175

> mkdir test\integration\default\serverspec


176

*_spec.rb files• By convention, Test Kitchen expects files with tests

to end in _spec.rb


Serverspec expectation form• Every specialized RSpec-based testing library like

serverspec has their own special twist on the basic RSpec expectation form

177


Generic Expectation Form

178



Serverspec Command

179

describe ‘<entity>’ do it ‘<description>’ do expect(command).to eq result endend

thing to expectis called a commandin serverspec


Serverspec commands & matchers• Serverspec has provides a wide variety of matchers

for each command• Serverspec commands are well-documented: http://

serverspec.org/resource_types.html

180


http://serverspec.org/resource_types.html




Serverspec resources

181


Port resource/be_listening matcher

182


183

Writing your first test• Let’s create a serverspec test checking to make sure

the clowns web site is active on port 80• Let’s use the port resource and the be_listening

matcher


Spec for clowns

184

require 'serverspec'

include Serverspec::Helper::Exec

describe 'clowns site' do it 'responds on port 80' do expect(port 80).to be_listening 'tcp' endend

OPEN IN EDITOR:apache/test/integration/default/serverspec/clown_spec.rb


185

kitchen setup• Before running tests you need to run kitchen setup

• kitchen setup loads and configures the file necessary to run test plugins on the node

• The component that manages Test Kitchen plugins is called Busser


$ bundle exec kitchen setup default-centos-64

kitchen setup

-----> Starting Kitchen (v1.2.1)-----> Setting up <default-centos-64>...Fetching: thor-0.19.0.gem (100%)Fetching: busser-0.6.2.gem (100%)Successfully installed thor-0.19.0Successfully installed busser-0.6.22 gems installed-----> Setting up Busser Creating BUSSER_ROOT in /tmp/busser Creating busser binstub Plugin serverspec installed (version 0.2.6)-----> Running postinstall for serverspec plugin Finished setting up <default-centos-64> (0m34.28s).-----> Kitchen is finished. (0m34.37s)

186


187

kitchen verify• The kitchen verify command will run the tests in

your *_spec.rb files in the test/integration tree


$ bundle exec kitchen verify default-centos-64

kitchen verify

-----> Starting Kitchen (v1.2.1)-----> Verifying <default-centos-64>... Removing /tmp/busser/suites/serverspecUploading /tmp/busser/suites/serverspec/localhost/clown_spec.rb (mode=0664)-----> Running serverspec test suite/opt/chef/embedded/bin/ruby -I/tmp/busser/suites/serverspec -S /opt/chef/embedded/bin/rspec /tmp/busser/suites/serverspec/localhost/clown_spec.rb --color --format documentation

clowns site responds on port 80

Finished in 0.00713 seconds1 example, 0 failures Finished verifying <default-centos-64> (0m0.90s).-----> Kitchen is finished. (0m0.97s)

188


189

Verifying that the tests work• Did the test actually do anything? Let’s verify this

by changing the port to a known incorrect value.


Replace port 80 with 85

190







This should fail

-----> Running serverspec test suite/opt/chef/embedded/bin/ruby -I/tmp/busser/suites/serverspec -S /opt/chef/embedded/bin/rspec /tmp/busser/suites/serverspec/localhost/clown_spec.rb --color --format documentation

clowns site responds on port 85 (FAILED - 1)

Failures:

1) clowns site responds on port 85 Failure/Error: expect(port 85).to be_listening 'tcp' netstat -tunl | grep -- :85\ expected Port "85" to be listening "tcp" # /tmp/busser/suites/serverspec/localhost/clown_spec.rb:7:in `block (2 levels) in <top (required)>'

Finished in 0.00718 seconds1 example, 1 failure...

191



This should fail

-----> Running serverspec test suite/opt/chef/embedded/bin/ruby -I/tmp/busser/suites/serverspec -S /opt/chef/embedded/bin/rspec /tmp/busser/suites/serverspec/localhost/clown_spec.rb --color --format documentation

clowns site responds on port 85 (FAILED - 1)

Failures:

1) clowns site responds on port 85 Failure/Error: expect(port 85).to be_listening 'tcp' netstat -tunl | grep -- :85\ expected Port "85" to be listening "tcp" # /tmp/busser/suites/serverspec/localhost/clown_spec.rb:7:in `block (2 levels) in <top (required)>'

Finished in 0.00718 seconds1 example, 1 failure...

192

WIN FAILWednesday, April 30, 14

193

Back to success• Remember to reset the tests back to the original port

value so they succeed again!


Reset back to port 80

194







kitchen verify

-----> Starting Kitchen (v1.2.1)-----> Verifying <default-centos-64>... Removing /tmp/busser/suites/serverspecUploading /tmp/busser/suites/serverspec/localhost/clown_spec.rb (mode=0664)-----> Running serverspec test suite/opt/chef/embedded/bin/ruby -I/tmp/busser/suites/serverspec -S /opt/chef/embedded/bin/rspec /tmp/busser/suites/serverspec/localhost/clown_spec.rb --color --format documentation


Finished in 0.00713 seconds1 example, 0 failures Finished verifying <default-centos-64> (0m0.90s).-----> Kitchen is finished. (0m0.97s)

195


196

Testing bears• Let’s add another test to do a similar check for the

bears port


Spec for bears

197



describe 'bears site' do it 'responds on port 81' do expect(port 81).to be_listening 'tcp' endend

OPEN IN EDITOR:apache/test/integration/default/serverspec/bear_spec.rb


198

No need to run kitchen setup• You only need to run kitchen setup once per

node. (Though it doesn’t hurt to run it more than once).



Verifying clowns & bears

...----> Running serverspec test suite /opt/chef/embedded/bin/ruby -I/tmp/busser/suites/serverspec -S /opt/chef/embedded/bin/rspec /tmp/busser/suites/serverspec/localhost/bear_spec.rb /tmp/busser/suites/serverspec/localhost/clown_spec.rb --color --format documentation

bears site responds on port 81


Finished in 0.00889 seconds 2 examples, 0 failures...

199


200

Code cleanup• Common code can be moved to a file called spec_helper.rb in test/integration/default/serverspec

• Test Kitchen automatically looks for spec_helper.rb in test/integration/default/serverspec


201

Code cleanup• Let’s move common code between clowns & bears

to spec_helper.rb


spec_helper.rb

202



OPEN IN EDITOR:apache/test/integration/default/serverspec/spec_helper.rb


require spec_helper clowns

203

require 'spec_helper'




require spec_helper bears

204


describe 'bears site' do it 'responds on port 81' do expect(port 81).to be_listening 'tcp' endend




Testing clowns and bears w/spec_helper.rb


bears site response on port 81



205



Testing clowns and bears w/spec_helper.rb


bears site response on port 81



206


207

Are the web sites really working?• While we’ve added checks to verify that the test

node is listening on ports 80 and 81, we haven’t verified that users see the right content when they visit these sites.

• Let’s use the command resource with the return_stdout matcher to do a simple check with curl to verify that port 80 is clowns and port 81 is bears.


command resource/return_stdout matcher

208


Check clown content

209


describe 'clowns site' do it 'responds on port 80' do expect(port 80).to be_listening 'tcp' end

it 'returns clowns in the HTML body' do expect(command 'curl localhost:80').to \ return_stdout(/clowns/) endend



210


Check bear content

211


describe 'bears site' do it 'responds on port 81' do expect(port 81).to be_listening 'tcp' end

it 'returns bears in the HTML body' do expect(command 'curl localhost:81').to \ return_stdout(/bears/) endend




Testing for content

...-----> Running serverspec test suite/opt/chef/embedded/bin/ruby -I/tmp/busser/suites/serverspec -S /opt/chef/embedded/bin/rspec /tmp/busser/suites/serverspec/localhost/bear_spec.rb /tmp/busser/suites/serverspec/localhost/clown_spec.rb --color --format documentation

bears site responds on port 81 returns bears in the HTML body

clowns site responds on port 80 returns clowns in the HTML body

Finished in 0.0293 seconds4 examples, 0 failures Finished verifying <default-centos-64> (0m1.73s).-----> Kitchen is finished. (0m1.79s)...

212


213

Detecting the target OS• Many of the resources require that Serverspec

detect the OS so it can run the correct command for your platform expect(package 'httpd').to be_installed

• You’ll need to add an extra Helper to spec_helper.rb


spec_helper.rb

214


include Serverspec::Helper::Execinclude Serverspec::Helper::DetectOS

OPEN IN EDITOR:apache/test/integration/default/serverspec/spec_helper.rb


Check httpd package

215


describe 'server' do it 'has apache installed' do expect(package 'httpd').to be_installed endend

OPEN IN EDITOR:apache/test/integration/default/serverspec/default_spec.rb



Testing for httpd

...-----> Running serverspec test suite/opt/chef/embedded/bin/ruby -I/tmp/busser/suites/serverspec -S /opt/chef/embedded/bin/rspec /tmp/busser/suites/serverspec/localhost/bear_spec.rb /tmp/busser/suites/serverspec/localhost/clown_spec.rb --color --format documentation

bears site responds on port 81 returns bears in the HTML body

clowns site responds on port 80 returns clowns in the HTML body

Finished in 0.0293 seconds4 examples, 0 failures Finished verifying <default-centos-64> (0m1.73s).-----> Kitchen is finished. (0m1.79s)...

216


217

kitchen test• The kitchen test command will automate all the

previous actions you’ve learned so far into one command. It runs the following commands in sequence:• kitchen destroy (if necessary)•kitchen create•kitchen converge•kitchen setup•kitchen verify•kitchen destroy


218

kitchen test• The kitchen test command is intended to be used

as a final check on a fresh image before committing changes to source control and/or to be used in a Continuous Integration environment like Jenkins.


$ bundle exec kitchen test default-centos-64

kitchen test

-----> Starting Kitchen (v1.2.1)-----> Cleaning up any prior instances of <default-centos-64>-----> Destroying <default-centos-64>... 2c46b1a4609dc6a2beaf44e1134638b0a8ac47c9c5a02baee0bdb3df64e7bcdf 2c46b1a4609dc6a2beaf44e1134638b0a8ac47c9c5a02baee0bdb3df64e7bcdf Finished destroying <default-centos-64> (0m0.60s).-----> Testing <default-centos-64>-----> Creating <default-centos-64>......Finished in 0.0311 seconds4 examples, 0 failures Finished verifying <default-centos-64> (0m1.71s).-----> Destroying <default-centos-64>... d22a8c4db8505f89f7f7e65bca26492f58d5637f9a88763d5eb919d860dade4e d22a8c4db8505f89f7f7e65bca26492f58d5637f9a88763d5eb919d860dade4e Finished destroying <default-centos-64> (0m0.47s). Finished testing <default-centos-64> (0m39.78s).-----> Kitchen is finished. (0m39.84s)

219


Where to go next• Jenkins cookbook is chock full of advanced

Serverspec techniques:

https://github.com/opscode-cookbooks/jenkins

220




Where to go next• jenkins/test/shared/support contains

examples for implementing custom Serverspec matchers used in jenkins/test/integration:•describe jenkins_job('my-‐project') do it { should be_a_jenkins_job }end

221


Where to go next• test/fixtures contains mini-cookbooks to

exercise resource providers• Aliased in Berksfile:•cookbook 'smoke', path: 'test/fixtures/cookbooks/smoke'

• Run via Rakefile

222


Where to go next• Uses data/path directive in .kitchen.yml to share

test data between serverspec suites• Directory specified in data/path is copied to /tmp/kitchen/data on guest

• Reason for weird require_relative directive in tests that use custom Serverspec matchers:require_relative '../../../kitchen/data/spec_helper'

223


RECAP: Why Test?• It’s important to find bugs fast

224


Better, Faster, Stronger• Test Kitchen is an invaluable tool for managing

sandbox environments and truly verifying that a cookbook produces the intended results

• But it does require spinning up an instance and performing a full Chef converge, which can take a long time

• Use Test Kitchen judiciously. The other tools can provide more limited forms of feedback faster.

225


v2.0.0

Detect Suspicious Cookbook Code with Foodcritic

226


Feedback on Chef Coding Style• Foodcritic provides feedback on your Chef coding

style• It is designed to be used as you are writing Chef

code - how’s that for freaking fast!• Written by Andrew Crump

http://acrmp.github.com/footcritic

227




Feedback on Chef Coding Style• Let’s install Foodcritic on your development

workstation so you can give it a spin• Add Foodcritic to your Gemfile• Install the app with bundle install

228





gem 'serverspec', '~> 1.1'gem 'foodcritic', '~> 3.0'

Add foodcritic to Gemfile

229




$ sudo yum install -y libxslt-devel libxml2-devel

Install Prerequisites

230

$ sudo apt-get install -y libxslt-dev libxml2-dev


$ bundle install

Install Foodcritic

231




$ bundle exec foodcritic --version

Verify install

foodcritic 3.0.3

232


$ bundle exec foodcritic .

Run Foodcritic on your cookbook

233

FC003: Check whether you are running with chef server before using server-specific features: cookbooks/apache/recipes/ip-logger.rb:1FC008: Generated cookbook metadata needs updating: cookbooks/apache/metadata.rb:2FC008: Generated cookbook metadata needs updating: cookbooks/apache/metadata.rb:3


234

More feedback!


235

Fast feedback!


Feedback on Chef Coding Style• Foodcritic comes with a set of checks called rules• Foodcritic rules are documented at http://

acrmp.github.io/foodcritic/• The default rules are a good start, and you can add

new rules of your own easily

236


http://acrmp.github.io/foodcritic/




Default Rules

237


238

What about theFC003 & FC008 issues

in the apache cookbook?


FC008 - Generated cookbook metadata needs updating

239


240

Let’s fix!


cookbooks/apache/metadata.rb

241

name 'apache'maintainer 'YOUR_COMPANY_NAME'maintainer_email 'YOUR_EMAIL'license 'All rights reserved'description 'Installs/Configures apache'long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))version '0.2.0'


OPEN IN EDITOR: cookbooks/apache/metadata.rb

name 'apache'maintainer 'Mischa Taylor'maintainer_email '[email protected]'license 'All rights reserved'description 'Installs/Configures apache'long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))version '0.2.0'

242

Addressing FC008




$ bundle exec foodcritic .

Rerun foodcritic

243

FC003: Check whether you are running with chef server before using server-specific features: ./recipes/ip-logger.rb:1


244

Two down,one to go!


FC003 - Check for chef server before using server-specific features

245


246

Ignoring FC003• Let’s say, for now, we don’t want to fix ip-‐logger.rb, and we’d like to squelch the FC003 check


247

--tags parameter• The -‐-‐tags <TAGS> parameter can be used to

specify a list of rules for foodcritic to use•foodcritic -‐-‐tags FC001,FC002,FC008

• The tilde (~) modifier can be used to ignore specific rules•foodcritic -‐-‐tags ~FC003


$ bundle exec foodcritic --tags ~FC003 .

Ignore FC003

248


$ bundle exec foodcritic --tags ~FC003 .

Ignore FC003

249


250

Custom rules• Etsy created some custom Foodcritic rules to check

for issues that caused production outages/performance degradation.

• Good example for how to create your own custom rules

• Documented here:https://github.com/etsy/foodcritic-rules


https://github.com/etsy/foodcritic-rules


Etsy Foodcritic Rules• ETSY001 - Package or yum_package resource used

with :upgrade action• ETSY002 - Execute resource used to run git commands• ETSY003 - Execute resource used to run curl or wget commands• ETSY004 - Execute resource defined without conditional or

action :nothing• ETSY005 - Action :restart sent to a core service• ETSY006 - Execute resource used to run chef-provided command• ETSY007 - Package or yum_package resource used to install

core package without specific version number

251


$ git clone https://github.com/etsy/foodcritic-rules ../../foodcritic/etsy$ rm -rf ../../foodcritic/etsy/.git

Installing new rules

252






253

--include parameter• The -‐-‐include <PATH> parameter species

additional paths to load rules (shortened with -I)


$ bundle exec foodcritic -t ~FC003 -I ../../foodcritic .

Including Custom Rules

ETSY005: Action :restart sent to a core service: ./recipes/default.rb:19ETSY005: Action :restart sent to a core service: ./recipes/default.rb:32ETSY007: Package or yum_package resource used to install core package without specific version number: ./recipes/default.rb:10

254


255

Editor support• Many popular editors can be configured to run

Foodcritic inside the editor (including Vim, GNU Emacs and Sublime Text). So you can get feedback even faster.


v2.0.0

Detect Suspicious Ruby Code with RuboCop

256


RuboCop - Feedback on Ruby Style• Many people new to Ruby would like some guidance

on how to write idiomatic Ruby• Get the same kind of feedback for Ruby using

RuboCop that you get for Chef Code using Foodcritic (Chef code is Ruby)

257


RuboCop Author• Written by Bozhidar Batsov:

https://github.com/bbatsov/rubocop

258




RuboCop - Feedback on Ruby Style• Follows community-driven style guide:

https://github.com/bbatsov/ruby-style-guide

• Looks at cookbooks for Ruby best practices, not the Chef DSL - that’s Foodcritic

259




RuboCop - Feedback on Ruby Style• Let’s install RuboCop on your development

workstation so you can give it a spin• Add RuboCop to your Gemfile• Install the app with bundle install

260





gem 'serverspec', '~> 1.1'gem 'foodcritic', '~> 3.0'gem 'rubocop', '~> 0.20'

Add rubocop to Gemfile

261




$ bundle install

Install RuboCop

262




$ bundle exec rubocop --version

Verify Install

0.20.1

263


Running RuboCop• Just run the rubocop command - it recursively

checks all the *.rb files in all subdirectories underneath the current directory (excluding vendor/)

264


$ bundle exec rubocop

Run RuboCop on your cookbook

attributes/default.rb:3:19: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.default["apache"]["sites"]["bears"] = { "port" => 81 } ^^^^^^^attributes/default.rb:3:28: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.default["apache"]["sites"]["bears"] = { "port" => 81 } ^^^^^^^attributes/default.rb:3:41: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.default["apache"]["sites"]["bears"] = { "port" => 81 } ^^^^^^

7 files inspected, 52 offenses detected

265


rubocop-todo.yml via --auto-gen-config• rubocop-todo.yml will help generate TODOs for each

item on the offense list• It also shows you what config setting can be used to

mask each offense, which we’ll need to do for some of these, because Chef code conventions vary slightly from the Rubocop community standards

266


$ bundle exec rubocop --auto-gen-config

Generate rubocop-todo.yml

attributes/default.rb:3:28: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.default["apache"]["sites"]["bears"] = { "port" => 81 } ^^^^^^^attributes/default.rb:3:41: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.default["apache"]["sites"]["bears"] = { "port" => 81 } ^^^^^^

7 files inspected, 52 offenses detectedCreated rubocop-todo.yml.Run `rubocop --config rubocop-todo.yml`, oradd inherit_from: rubocop-todo.yml in a .rubocop.yml file.

267


.rubocop.yml Configures RuboCop• .rubocop.yml can be used to configure RuboCop

(similar to .kitchen.yml in Test Kitchen)• We’ll add a settings to ignore things, similar to what

we did for Foodcritic, that don’t make as much sense for Chef.

• Settings are documented in the RuboCop README: https://github.com/bbatsov/rubocop/blob/master/README.md

• Cop is the RuboCop equivalent of a rule268


https://github.com/bbatsov/rubocop/blob/master/README.md




OPEN IN EDITOR: cookbooks/apache/.rubocop.yml

inherit_from: rubocop-‐todo.yml

Include rubocop-todo.yml

269


$ bundle exec rubocop

Run RuboCop on your cookbook

Inspecting 7 files.......

7 files inspected, no offenses detected

270


Easy peasy• Wow, now more offenses...not really

271


Match Chef community standards• First, we’ll move some of the Cops from rubocop-

todo.yml to .rubocop.yml for things that match Chef community standards (as opposed to the Ruby community standards)

272


Missing utf-8 encoding comment

273




Encoding: Enabled: false

Chef does not (yet) support encoding comment

274


Line is too long

275





LineLength: Max: 200

Relax line limit

276


Use the new Ruby 1.9 hash syntax

277






HashSyntax: EnforcedStyle: hash_rockets

Some cookbooks try to be Ruby 1.8 compatible

278


Prefer single-quoted strings

279






HashSyntax: EnforcedStyle: hash_rockets

StringLiterals: Enabled: false

Conflicts w/decision to relax FC002

280


$ bundle exec rubocop --auto-gen-config

Regenerate rubocop-todo.yml

metadata.rb:2:11: C: Put one space between the method name and the first argument.maintainer 'Mischa Taylor' ^^^^^^^metadata.rb:4:8: C: Put one space between the method name and the first argument.license 'All rights reserved' ^^^^^^^^^^metadata.rb:5:12: C: Put one space between the method name and the first argument.description 'Installs/Configures apache' ^^^^^^metadata.rb:7:8: C: Put one space between the method name and the first argument.version '0.2.0' ^^^^^^^^^^

7 files inspected, 11 offenses detected

281


Rubocop Workflow• Uncomment lines in rubocop-todo.yml• Fix offenses• git commit• Repeat

282


Only really critical issue

283


Trailing whitespace & Git• Whitespace differences make diffs longer and

diverts focus from more important changes• Even with Git, trailing whitespace can make merge

conflicts more difficult to resolve

284


285

Editor support• Many popular editors can be configured to run

RuboCop inside the editor (including Vim, GNU Emacs and Sublime Text). So you can get feedback even faster.

• RuboCop includes great docs on editor configuration (which work for Foodcritic as well): https://github.com/bbatsov/rubocop#editor-integration


https://github.com/bbatsov/rubocop#

https://github.com/bbatsov/rubocop#

v2.0.0

Runnable documentation with ChefSpec

286


RECAP: Why Not Begin With Testing?• Finding a bug in something that you can’t execute

is freaking hard!• While fixing bugs before writing code is cheap,

finding them is expensive

287


What is ChefSpec?• ChefSpec helps produce runnable documentation.

Its primary purpose is to help document and organize your code.• As a side effect, you’ll end up with a set of tests

which can also be used to uncover bugs when changes are made.

• Plus, your cookbook code will be improved when it is guided by tests.

288


ChefSpec Authors• Written by Andrew Crump and Seth Vargo

289


ChefSpec - Runnable Documentation• Let’s install ChefSpec on your development

workstation so you can give it a spin• Add ChefSpec to your Gemfile• Install the app with bundle install

290


OPEN IN EDITOR: chef-fundamentals-repo/Gemfile



gem 'serverspec', '~> 1.1'gem 'foodcritic', '~> 3.0'gem 'rubocop', '~> 0.20'gem 'chefspec', '~> 3.4'

Gemfile

291




$ bundle install

Install ChefSpec

292




ChefSpec builds on RSpec• ChefSpec uses the RSpec description form to create

runnable documentation (in a similar vein to serverspec)

293


Documentation form

294

describe ‘<recipe_name>’ do <perform in-‐memory Chef run> <descriptions here>end


Documentation example

295

describe ‘apache::default’ do ...end


In-Memory Chef Run Form

296

require ‘chefspec’

describe ‘<recipe_name>’ do chef_run = ChefSpec::Runner.new.converge(<recipe_name>) <descriptions here>end


In-Memory Chef Run Example

297


describe 'apache::default' do chef_run = ChefSpec::Runner.new.converge('apache::default')

<descriptions here>end


Expectation form

298

describe ‘<recipe_name>’ do <perform in-‐memory Chef run> it ‘<description>’ do expect(<chef_run>).to eq result endend


Expectation form

299

describe ‘<recipe_name>’ do <perform in-‐memory Chef run> it ‘<description>’ do expect(<chef_run>).to eq result endend

MatcherWednesday, April 30, 14

Expectation Example

300



it ‘installs apache2’ do expect(chef_run).to install_package(‘httpd’) endend


Runnable Documentation• expect statement does not actually perform the

httpd package installation• It just verifies the cookbook syntax that it instructs

Chef to install the package• Good enough for well-tested primitives like the package resource

301


302

Let’s write some ChefSpectests!


303

Default location for tests• By default, ChefSpec will look in the spec/directory

for ChefSpec test-related files



304

.!"" .bundle/!"" .kitchen/!"" .kitchen.yml!"" CHANGELOG.md!"" Gemfile!"" Gemfile.lock!"" README.md!"" attributes/!"" files/!"" metadata.rb!"" recipes/!"" spec/!"" templates/!"" test/$ #"" integration/#"" vendor/ #"" bundle/


$ mkdir spec

Create spec directory in cookbooks/apache

305

> mkdir spec


306

*_spec.rb files• By convention, ChefSpec expects files with tests to

end in _spec.rb


ChefSpec Matcher Documentation

307

http://rubydoc.info/github/acrmp/chefspec/frames




ChefSpec > API

308


Each API has an example

309


Let’s use the install_package matcher

310


install_package Example

311


OPEN IN EDITOR: spec/default_spec.rb

require 'chefspec'


it 'installs apache2' do expect(chef_run).to install_package('httpd') endend

Test apache::default recipe

312


313

Rspec runs ChefSpec• There’s no separate chefspec command.• Just run rspec to run ChefSpec tests.


$ bundle exec rspec --color

Run ChefSpec on your cookbok

.

Finished in 0.0006 seconds1 example, 0 failures

314



require 'chefspec'


it 'installs apache2' do expect(chef_run).to install_package('badhttpd') endend

Did it really check anything?

315


$ bundle exec rspec


F

Failures:

1) apache::default installs apache2 Failure/Error: expect(chef_run).to install_package('badhttpd') expected "package[badhttpd]" with action :install to be in Chef run. Other package resources:

package[httpd]

# ./spec/default_spec.rb:7:in `block (2 levels) in <top (required)>'

Finished in 0.00044 seconds1 example, 1 failure

316



require 'chefspec'



Restore back to working

317




.


318


Lazy evaluation with let

319

require 'chefspec'

describe 'apache::default' do let(:chef_run) \ { ChefSpec::Runner.new.converge(described_recipe) }


Lazy evaluation


320

described_recipe• let blocks aren’t evaluated until the first time they

are called• Also allows ChefSpec to run the described_recipe

macro to evaluate the recipe name



require 'chefspec'

describe 'apache::default' do let(:chef_run) \ { ChefSpec::Runner.new.converge(described_recipe) }


Lazy evaluation

321




.


322


323

ChefSpec Resource Report• ChefSpec Resource Report can help guide writing

your tests



require 'chefspec'

at_exit { ChefSpec::Coverage.report! }

describe 'apache::default' do let (:chef_run) \ { ChefSpec::Runner.new.converge(described_recipe) }


Adding resource report

324




.


ChefSpec Coverage report generated...

Total Resources: 9 Touched Resources: 1 Touch Coverage: 11.11%

Untouched Resources:

service[httpd] /recipes/default.rb:14 execute[mv /etc/httpd/conf.d/welcome.conf /etc/httpd/conf.d/welcome.conf.disabled] /recipes/default.rb:19 template[/etc/httpd/conf.d/clowns.conf] /recipes/default.rb:32 directory[/srv/apache/clowns] /recipes/default.rb:43 template[/srv/apache/clowns/index.html] /recipes/default.rb:49 template[/etc/httpd/conf.d/bears.conf] /recipes/default.rb:32 directory[/srv/apache/bears] /recipes/default.rb:43 template[/srv/apache/bears/index.html] /recipes/default.rb:49

325


326

create_file matcher• Let’s verify that the clowns.conf file gets created

with the create_file matcher


327

create_file matcher



require 'chefspec'


describe 'apache::default' do let(:chef_run) \ { ChefSpec::Runner.new.converge(described_recipe) } ...

it 'creates clowns.conf' do expect(chef_run).to \ create_file('/etc/httpd/conf.d/clowns.conf') endend

Checking clowns.conf files

328




F

Failures:

1) apache::default creates clowns.conf Failure/Error: expect(chef_run).to create_file('/srv/apache/clowns') expected "file[/srv/apache/clowns]" with action :create to be in Chef run. Other file resources:


Finished in 0.01903 seconds2 examples, 1 failure

Failed examples:

rspec ./spec/default_spec.rb:12 # apache::default creates clowns.conf

329




F

Failures:

1) apache::default creates clowns.conf Failure/Error: expect(chef_run).to create_file('/srv/apache/clowns') expected "file[/srv/apache/clowns]" with action :create to be in Chef run. Other file resources:


Finished in 0.01903 seconds2 examples, 1 failure

Failed examples:

rspec ./spec/default_spec.rb:12 # apache::default creates clowns.conf

330

FAILWednesday, April 30, 14

331

ChefSpec == Runnable Documentation• Remember: ChefSpec is just runnable

documentation• It isn’t actually performing a Chef run to verify that

clowns.conf was created• Instead it is just verifying that you told Chef to

create the clowns.conf via the file resource, which you never did - you used the template resource


332

template matcher



require 'chefspec'


describe 'apache::default' do let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) } ...

it 'creates clowns.conf' do expect(chef_run).to \ create_template('/etc/httpd/conf.d/clowns.conf') endend

Checking clowns.conf file

333




.

Finished in 0.01955 seconds2 examples, 0 failures

334




.


335


336

spec_helper.rb• Similar to Serverspec, common code can be moved

to a file called spec_helper.rb with ChefSpec


OPEN IN EDITOR: spec/spec_helper.rb

require 'chefspec'



337


338

RSpec recurses through spec/*• RSpec recurses through the spec/ subtree, looking

for tests, so you can create any directory structure you like underneath

• We’ll move default_spec.rb to spec/recipes


$ mkdir spec/recipes$ mv spec/default_spec.rb spec/recipes

Move default_spec.rb

339


OPEN IN EDITOR: spec/recipes/default_spec.rb


describe 'apache::default' do let (:chef_run) \ { ChefSpec::Runner.new.converge(described_recipe) }

it 'installs apache2' do expect(chef_run).to install_package('httpd') end

it 'creates clowns.conf' do expect(chef_run).to \ create_template('/etc/httpd/conf.d/clowns.conf') endend


340




.


341




.


342


343

Where to go next• There’s a lot of ChefSpec written for the community

cookbooks. Check out the spec/ directory your favorites.


v2.0.0

Continuous Validation with Guard

344


What is Guard?• A tool that monitors for filesystem changes and

performs actions (like launching rake tasks)• Written by Thibaud Guillaume-Gentil

345


Guard install• Let’s install Guard on your development

workstation so you can give it a spin• Add guard to your Gemfile• Install the app with bundle install

346





gem 'serverspec', '~> 1.1'gem 'foodcritic', '~> 3.0'gem 'rubocop', '~> 0.20'gem 'chefspec', '~> 3.4'gem 'guard', '~> 2.6'

Gemfile

347




$ bundle install

Install Guard

348







gem 'serverspec', '~> 1.1'gem 'foodcritic', '~> 3.0'gem 'rubocop', '~> 0.20'gem 'chefspec', '~> 3.4'gem 'guard', '~> 2.6'gem 'guard-rubocop', '~> 1.1'

Gemfile

349




$ bundle install

Install guard-rubocop

350




$ bundle exec guard init

Create Guardfile

02:39:58 - INFO - Writing new Guardfile to /home/vagrant/chef-fundamentals-repo/cookbooks/apache/Guardfile02:45:32 - INFO - rubocop guard added to Guardfile, feel free to edit it

351


cookbooks/apache/Guardfile

352

# A sample Guardfile

# More info at https://github.com/guard/guard#readme

guard :rubocop do

watch(%r{.+\.rb$})

watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }

end


https://github.com/guard/guard#readme

https://github.com/guard/guard#readme

$ bundle exec guard

Run Guard

02:48:54 - INFO - Guard is now watching at '/home/vagrant/chef-fundamentals-repo/cookbooks/apache'[1] guard(main)>

353


CloudShare Node

354


CloudShare Node

355


$ cd $HOME/chef-fundamentals-repo/cookbooks/apache

In another session

356

And edit some .rb file - upon save, rubocop is launched!


Stopping guard[1] guard(main)> quit

19:23:42 - INFO - Bye bye...

357


358

Where to go nextMichael Goetz blog posts:

https://micgo.net/check-yo-self-before-you-wreck-yo-self-with-foodcritic-chefspec/

Foodcritic and Guard:

Serverspec and Guard:https://micgo.net/serverspec-guard-and-test-kitchen-testing-

servers-like-a-boss/






https://micgo.net/serverspec-guard-and-test-kitchen-testing-servers-like-a-boss/




359

Where to go nextMichael Goetz blog posts:

ChefSpec and Guard:https://micgo.net/continuous-chefspec-validation-with-guard/


https://micgo.net/continuous-chefspec-validation-with-guard/

https://micgo.net/continuous-chefspec-validation-with-guard/

v2.0.0

Repeating Test Steps with Rake

360


What is Rake?• Rake includes a language for expressing the

command line steps needed to create an app• Perfect for capturing all the commands you’ve

learned in this class so others can run them easily, or in your continuous integration system (Jenkins, Bamboo, TeamCity, etc.)

361


Rake Author• Written by Jim Weirich:

http://rake.rubyforge.org/

362




Rake - Repeatable Test Commands• Let’s install Rake on your development workstation

so you can give it a spin• Add rake to your Gemfile• Install the app with bundle install

363


OPEN IN EDITOR: chef-fundamentals-repo/Gemfile



gem 'rake'gem 'serverspec', '~> 1.1'gem 'foodcritic', '~> 3.0'gem 'rubocop', '~> 0.20'gem 'chefspec', '~> 3.4'gem 'guard', '~> 2.6'gem 'guard-rubocop', '~> 1.1'

Gemfile

364




$ bundle install

Install Rake

365




Rake - Repeatable Tasks• Task - expresses command line actions to perform

366


Rake Task Form

367

task :<task_name> do <action> <action>end


Rake - Repeatable Tasks• Configuration file for rake is a Rakefile

368


Rake - Actions• Actions are expressed in Ruby syntax• sh “<command>” runs a shell command:

sh “bundle exec rspec”

369


OPEN IN EDITOR: cookbooks/apache/Rakefile

task :rubocop do sh 'bundle exec rubocop'end

Rubocop Task

370


$ bundle exec rake rubocop

Execute Rake Task

Inspecting 9 files.......


371


Task Description• Every task should have a description which

documents what the task does• rake -‐-‐tasks prints out tasks with descriptions

372



desc 'Run Ruby style checks with Rubocop'task :rubocop do sh 'bundle exec rubocop'end

Rubocop Task

373


$ bundle exec rake --tasks

Execute Rake Task

rake rubocop # Run Ruby style checks with Rubocop

374


Adding Foodcritic• Let’s add a task for Foocritic next

375




desc 'Run Chef style checks with Foodcritic'task :foodcritic do sh 'bundle exec foodcritic -t ~FC003 .'end

Foodcritic Task

376


$ bundle exec rake foodcritic

Execute Rake Task

bundle exec foodcritic -t ~FC003 .FC011: Missing README in markdown format: spec/README.md:1FC031: Cookbook without metadata file: spec/metadata.rb:1FC045: Consider setting cookbook name in metadata: spec/metadata.rb:1

377


$ bundle exec rake foodcritic

Execute Rake Task

bundle exec foodcritic -t ~FC003 .FC011: Missing README in markdown format: spec/README.md:1FC031: Cookbook without metadata file: spec/metadata.rb:1FC045: Consider setting cookbook name in metadata: spec/metadata.rb:1

378

WAT?Wednesday, April 30, 14

Foodcritic 3.0.3 issue• Foodcritic is checking spec/ subtree when it

shouldn’t• Does not expose command line option to exclude

directories:https://github.com/acrmp/foodcritic/issues/148

• When fixed, this should work:bundle exec foodcritic -‐X spec -‐t ~FC003 .

379


https://github.com/acrmp/foodcritic/issues/148

https://github.com/acrmp/foodcritic/issues/148



require 'foodcritic'desc 'Run Chef style checks with Foodcritic'FoodCritic::Rake::LintTask.new(:foodcritic) do |t| t.options = { tags: ['~FC003'], excludes: ['test', 'spec', 'features'] }end

Workaround - Use Ruby

380


Default task• Rake supports a special task name called default• default runs when no parameters are supplied to

rake• default (as well as any other task) can point to a

list of other task names to execute task :default => [:foodcritic]

381



task :default => [:rubocop, :foodcritic]


require 'foodcritic'desc 'Run Chef style checks with Foodcritic'FoodCritic::Rake::LintTask.new(:foodcritic) do |t| t.options = { tags: ['~FC003'], excludes: ['test', 'spec', 'features' ] }end

Foodcritic Task

382


$ bundle exec rake

Execute Rake Task

bundle exec rubocopInspecting 9 files.......


383


384

Where to go next

Rake Boot Camp

http://cloud.github.com/downloads/jimweirich/RakePresentations/PowerRake.key.pdf

http://www.confreaks.com/videos/899-railsconf2012-basic-rake

Go to http://confreaks.comSearch for “Basic Rake”






http://confreaks.com

http://confreaks.com

385

Where to go next

Rake Tasks can have testshttp://blog.jayfields.com/2006/11/ruby-testing-rake-tasks.html


http://blog.jayfields.com/2006/11/ruby-testing-rake-tasks.html

http://blog.jayfields.com/2006/11/ruby-testing-rake-tasks.html

v2.0.0

Jenkins

386


What is Jenkins?• Jenkins is a commonly used, open source

continuous integration system used to build early and often

• Written by Kohsuke Kawaguchi

387


$ sudo yum install -y libxslt-devel libxml2-devel

Install Prerequisites

388

$ sudo apt-get install -y libxslt-dev libxml2-dev


$ cd $HOME

Home directory - great place for source

389

$ cd %USERPROFILE%


Jenkins cookbook• Jenkins cookbook - https://github.com/opscode-

cookbooks/jenkins• Jenkins cookbook is library cookbook

390






Library cookbook• Popularized by Bryan Berry’s blog post How to Write

Resuable Chef Cookbooks, Gangnam Style

391


http://devopsanywhere.blogspot.com/2012/11/how-to-write-reusable-chef-cookbooks.html




Jenkins wrapper cookbook• Start of our wrapper cookbook:https://github.com/misheska/test-class-jenkins

392


https://github.com/misheska/test-class-jenkins


$ git clone https://github.com/misheska/test-class-jenkins

Grab test-class-jenkins from Github

Cloning into 'test-class-jenkins'...remote: Counting objects: 19, done.remote: Compressing objects: 100% (16/16), done.remote: Total 19 (delta 0), reused 19 (delta 0)Unpacking objects: 100% (19/19), done.

393




$ cd test-class-jenkins

test-class-jenkins

394


$ bundle install --path vendor/bundle

Install gems vendored

Fetching gem metadata from https://rubygems.org/.......Fetching additional metadata from https://rubygems.org/..Resolving dependencies...Installing rake (10.2.2)Installing addressable (2.3.6)Installing ast (1.1.0)...Installing powerpack (0.0.9)Installing rainbow (2.0.0)Installing ruby-progressbar (1.4.2)Installing rubocop (0.20.1)Using bundler (1.5.3)Your bundle is complete!It was installed into ./vendor/bundle

395






Jenkins PSA

396


397


test-class-jenkins/recipes/default.rb

398

include_recipe 'jenkins::java'include_recipe 'jenkins::master'


test-class-jenkins/attributes/default.rb

399

include_attribute 'jenkins::master'


test-class-jenkins/Gemfile

400


gem 'test-kitchen'gem 'kitchen-docker'

gem 'rake'gem 'berkshelf', '~> 3.0.0.rc'gem 'rubocop', '~> 0.20'gem 'foodcritic', '~> 3.0'




test-class-jenkins/.kitchen.yml

401



platforms: - name: centos-6.4 driver_config: forward: - 8080:8080

suites: - name: default run_list: - recipe[test-class-jenkins::default]


$ bundle exec kitchen converge

Perform Chef run of Jenkins wrapper

-----> Starting Kitchen (v1.2.1)-----> Creating <default-centos-64>... Step 0 : FROM centos:6.4...----> Converging <default-centos-64>... Preparing files for transfer Resolving cookbook dependencies with Berkshelf 3.0.0.rc1......

402


http://<EXTERNAL_ADDRESS>:8080

403


Check plugins

404


Just defaults

405


jenkins_plugin resource

406


OPEN IN EDITOR: test-class-jenkins/recipes/default.rb

include_recipe 'jenkins::java'include_recipe 'jenkins::master'

# Install version 1.13 of the greenballs pluginjenkins_plugin 'greenballs' do version '1.13'end

Install greenballs plugin

407





408


Greenballs installed

409


jenkins_script resource

410


OPEN IN EDITOR: test-class-jenkins/recipes/default.rb

...

jenkins_script 'configure-‐mailer' do command <<-‐GROOVY.gsub(/^ {4}/, '') jenkins = jenkins.model.Jenkins.getInstance() mailer = jenkins.getDescriptorByType(hudson.tasks.Mailer.DescriptorImpl) mailer.setSmtpHost("smtp.gmail.com") mailer.setUseSsl(true) mailer.setSmtpAuth("smtp", "password") mailer.setReplyToAddress("[email protected]") mailer.save() GROOVYend

Configure E-mail Notification

411




412





413


414


jenkins_job resource

415


testing your automation code (docker version)

Technology