cucumber-chef 1.0.3 → 2.0.0.pre

data/lib/cucumber/chef/steps/provision_steps.rb

@@ -0,0 +1,60 @@
+################################################################################
+#
+#      Author: Stephen Nelson-Smith <stephen@atalanta-systems.com>
+#      Author: Zachary Patten <zachary@jovelabs.com>
+#   Copyright: Copyright (c) 2011-2012 Atalanta Systems Ltd
+#     License: Apache License, Version 2.0
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+################################################################################
+
+Given /^I have a server called "([^\"]*)"$/ do |name|
+  @servers = (@servers || Hash.new(nil)).merge(name => Hash.new(nil))
+end
+
+And /^"([^\"]*)" is running "([^\"]*)" "([^\"]*)"$/ do |name, distro, release|
+  @servers[name].merge!( :distro => distro, :release => release )
+end
+
+And /^"([^\"]*)" has "([^\"]*)" architecture$/ do |name, arch|
+  @servers[name].merge!( :arch => arch )
+end
+
+And /^"([^\"]*)" should( not)? be persistant$/ do |name, boolean|
+  @servers[name].merge!( :persist => (!boolean ? true : false) )
+end
+
+And /^"([^\"]*)" has an IP address of "([^\"]*)"$/ do |name, ip|
+  @servers[name].merge!( :ip => ip )
+end
+
+And /^"([^\"]*)" has a MAC address of "([^\"]*)"$/ do |name, mac|
+  @servers[name].merge!( :mac => ip )
+end
+
+And /^"([^\"]*)" has been provisioned$/ do |name|
+  server_create(name, @servers[name])
+end
+
+And /^the "([^\"]*)" role has been added to the "([^\"]*)" run list$/ do |role, name|
+  chef_set_client_attributes(@servers[name], :run_list => ["role[#{role}]"])
+end
+
+And /^the "([^\"]*)" recipe has been added to the "([^\"]*)" run list$/ do |recipe, name|
+  chef_set_client_attributes(@servers[name], :run_list => ["recipe[#{recipe}]"])
+end
+
+And /^the chef-client has been run on "([^\"]*)"$/ do |name|
+  chef_run_client(name)
+end

data/lib/cucumber/chef/steps/ssh_steps.rb

@@ -0,0 +1,95 @@
+Given /^I have no public keys set$/ do
+  @auth_methods = %w(password)
+end
+
+Then /^I can ssh to "([^\"]*)" with the following credentials:$/ do |hostname, table|
+  @auth_methods ||= %w(publickey password)
+
+  credentials = table.hashes
+  credentials.each do |creds|
+    lambda {
+      Net::SSH.start(session["hostname"], creds["username"], :password => creds["password"], :auth_methods => @auth_methods)
+    }.should_not raise_error(Net::SSH::AuthenticationFailed)
+  end
+end
+
+Then /^I can ssh to the following hosts with these credentials:$/ do |table|
+  @keys ||= []
+  @auth_methods ||= %w(password)
+  session_details = table.hashes
+
+  session_details.each do |session|
+    # initialize a list of keys and auth methods for just this session, as
+    # session can have session-specific keys mixed with global keys
+    session_keys = Array.new(@keys)
+    session_auth_methods = Array.new(@auth_methods)
+
+    # you can pass in a keyfile in the session details, so we need to
+    if session["keyfile"]
+      session_keys << session["keyfile"]
+      session_auth_methods << "publickey"
+    end
+
+    lambda {
+      @connection = Net::SSH.start(session["hostname"],
+                                   session["username"],
+                                   :password => session["password"],
+                                   :auth_methods => session_auth_methods,
+                                   :keys => session_keys)
+    }.should_not raise_error
+  end
+end
+
+Given /^I have the following public keys:$/ do |table|
+  @keys = []
+  public_key_paths = table.hashes
+
+  public_key_paths.each do |key|
+    File.exist?(key["keyfile"]).should be_true
+    FileUtils.chmod(0600, key["keyfile"])
+    @keys << key["keyfile"]
+  end
+
+  @auth_methods ||= %w(password)
+  @auth_methods << "publickey"
+end
+
+When /^I ssh to "([^\"]*)" with the following credentials:$/ do |hostname, table|
+  @keys = []
+  @auth_methods ||= %w(password)
+  session = table.hashes.first
+  session_keys = Array.new(@keys)
+  session_auth_methods = Array.new(@auth_methods)
+  if session["keyfile"]
+    session_keys << session["keyfile"]
+    session_auth_methods << "publickey"
+  end
+
+  lambda {
+    @connection = Net::SSH.start(hostname,
+                                 session["username"],
+                                 :password => session["password"],
+                                 :auth_methods => session_auth_methods,
+                                 :keys => session_keys)
+  }.should_not raise_error
+end
+
+And /^I run "([^\"]*)"$/ do |command|
+  @output = @connection.exec!(command)
+end
+
+Then /^I should( not)? see "([^\"]*)" in the output$/ do |boolean, string|
+  if (!boolean)
+    @output.should =~ /#{string}/
+  else
+    @output.should_not =~ /#{string}/
+  end
+end
+
+Then /^I should( not)? see the "([^\"]*)" of "([^\"]*)" in the output$/ do |boolean, key, name|
+  if (!boolean)
+    @output.should =~ /#{$servers[name][key.downcase.to_sym]}/i
+  else
+    @output.should_not =~ /#{$servers[name][key.downcase.to_sym]}/i
+  end
+end

data/lib/cucumber/chef/steps.rb

@@ -0,0 +1,27 @@
+################################################################################
+#
+#      Author: Stephen Nelson-Smith <stephen@atalanta-systems.com>
+#      Author: Zachary Patten <zachary@jovelabs.com>
+#   Copyright: Copyright (c) 2011-2012 Atalanta Systems Ltd
+#     License: Apache License, Version 2.0
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+################################################################################
+
+require 'cucumber/chef/steps/chef_steps'
+require 'cucumber/chef/steps/minitest_steps'
+require 'cucumber/chef/steps/provision_steps'
+require 'cucumber/chef/steps/ssh_steps'
+
+################################################################################

data/lib/cucumber/chef/tcp_socket.rb

@@ -0,0 +1,83 @@
+################################################################################
+#
+#      Author: Stephen Nelson-Smith <stephen@atalanta-systems.com>
+#      Author: Zachary Patten <zachary@jovelabs.com>
+#   Copyright: Copyright (c) 2011-2012 Atalanta Systems Ltd
+#     License: Apache License, Version 2.0
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+################################################################################
+
+module Cucumber
+  module Chef
+
+    class TCPSocketError < Error; end
+
+    class TCPSocket
+
+################################################################################
+
+      def initialize(host, port, data=nil)
+        @host, @port, @data = host, port, data
+
+        if !host
+          message = "You must supply a host!"
+          $logger.fatal { message } if $logger
+          raise TCPSocketError, message
+        end
+
+        if !port
+          message = "You must supply a port!"
+          $logger.fatal { message } if $logger
+          raise TCPSocketError, message
+        end
+      end
+
+################################################################################
+
+      def ready?
+        socket = ::TCPSocket.new(@host, @port)
+
+        if @data.nil?
+          $logger.debug { "read(#{@host}:#{@port})" } if $logger
+          ((::IO.select([socket], nil, nil, 5) && socket.gets) ? true : false)
+        else
+          $logger.debug { "write(#{@host}:#{@port}, '#{@data}')" } if $logger
+          ((::IO.select(nil, [socket], nil, 5) && socket.write(@data)) ? true : false)
+        end
+
+      rescue Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
+        $logger.debug { "#{@host}:#{@port} - #{e.message}" } if $logger
+        false
+      ensure
+        (socket && socket.close)
+      end
+
+################################################################################
+
+      def wait
+        begin
+          success = ready?
+          sleep(1)
+        end until success
+      end
+
+################################################################################
+
+    end
+
+  end
+end
+
+################################################################################

data/lib/cucumber/chef/template.rb

@@ -0,0 +1,57 @@
+################################################################################
+#
+#      Author: Stephen Nelson-Smith <stephen@atalanta-systems.com>
+#      Author: Zachary Patten <zachary@jovelabs.com>
+#   Copyright: Copyright (c) 2011-2012 Atalanta Systems Ltd
+#     License: Apache License, Version 2.0
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+################################################################################
+
+module Cucumber
+  module Chef
+
+    class TemplateError < Error; end
+
+    class Template
+
+################################################################################
+
+      def self.render(template, context=nil)
+        self.render_template(self.load_template(template), context)
+      end
+
+
+################################################################################
+    private
+################################################################################
+
+      def self.load_template(template)
+        IO.read(template).chomp
+      end
+
+################################################################################
+
+      def self.render_template(template, context)
+        Erubis::Eruby.new(template).evaluate(:config => context)
+      end
+
+################################################################################
+
+    end
+
+  end
+end
+
+################################################################################

data/lib/cucumber/chef/templates/bootstrap/ubuntu-precise-test-lab.erb

@@ -0,0 +1,99 @@
+bash -c '
+CUCUMBER_CHEF_BOOTSTRAP_DONE="/.cucumber-chef-bootstrap-finished"
+[ -f ${CUCUMBER_CHEF_BOOTSTRAP_DONE} ] && echo "Already bootstrapped!" && exit
+
+export DEBIAN_FRONTEND=noninteractive
+
+sed -i "s/127.0.0.1 localhost/127.0.0.1 <%= @config[:hostname] %> <%= @config[:hostname].split(".")[0] %> localhost/" /etc/hosts
+echo "<%= @config[:hostname] %>" | tee /etc/hostname
+hostname <%= @config[:hostname] %>
+
+echo "deb http://apt.opscode.com/ `lsb_release -cs`-0.10 main" | tee /etc/apt/sources.list.d/opscode.list
+mkdir -p /etc/apt/trusted.gpg.d
+gpg --fetch-key http://apt.opscode.com/packages@opscode.com.gpg.key
+gpg --export packages@opscode.com | tee /etc/apt/trusted.gpg.d/opscode-keyring.gpg > /dev/null
+apt-get -q -y --force-yes update
+apt-get -q -y --force-yes -o Dpkg::Options::="--force-confnew" install opscode-keyring
+chown -R ${SUDO_USER}:${SUDO_USER} ${HOME}/.gnupg
+apt-get -q -y upgrade
+
+cat <<EOF | debconf-set-selections
+chef chef/chef_server_url string http://<%= @config[:chef_server] %>:4000
+chef-solr chef-solr/amqp_password password <%= @config[:amqp_password] %>
+chef-server-webui chef-server-webui/admin_password password <%= @config[:admin_password] %>
+EOF
+
+apt-get -q -y install chef chef-server
+
+echo -n "Waiting on validation.pem and webui.pem to appear..."
+until [ -f /etc/chef/validation.pem ] && [ -f /etc/chef/webui.pem ]; do
+  echo -n "."
+  sleep 1
+done
+echo "done."
+
+mkdir -p ~/.chef
+cp /etc/chef/validation.pem /etc/chef/webui.pem ~/.chef
+
+apt-get -q -y install expect
+KNIFE_CONFIG_EXP_FILE="/tmp/knife-config.exp"
+cat <<EOF > ${KNIFE_CONFIG_EXP_FILE}
+#!/usr/bin/expect -f
+set timeout 10
+spawn knife configure -i
+expect "Overwrite ${HOME}/.chef/knife.rb" { send "Y\n" }
+expect "Where should I put the config file?" { send "\n" }
+expect "Please enter the chef server URL" { send "\n" }
+expect "Please enter a clientname for the new client" { send "${SUDO_USER}\n" }
+expect "Please enter the existing admin clientname" { send "\n" }
+expect "Please enter the location of the existing admin client" { send "${HOME}/.chef/webui.pem\n" }
+expect "Please enter the validation clientname" { send "\n" }
+expect "Please enter the location of the validation key" { send "${HOME}/.chef/validation.pem\n" }
+expect "Please enter the path to a chef repository" { send "${HOME}/chef_repo\n" }
+interact
+EOF
+chmod +x ${KNIFE_CONFIG_EXP_FILE}
+${KNIFE_CONFIG_EXP_FILE}
+
+knife client create <%= @config[:user] %> -d -a -f ${HOME}/.chef/<%= @config[:user] %>.pem
+
+chown -R ${SUDO_USER}:${SUDO_USER} ${HOME}
+
+nc -w 1 127.0.0.1 4040
+if [ $? -ne 0 ]; then
+  /etc/init.d/chef-server-webui stop && sleep 3
+  /usr/sbin/chef-server-webui -e production &
+  while true; do
+    nc -w 1 127.0.0.1 4040
+    if [ $? -eq 0 ]; then
+      break
+    fi
+    sleep 1
+  done
+  kill `jobs -p` && sleep 3
+  /etc/init.d/chef-server-webui start && sleep 3
+fi
+
+if [ ! -f /etc/chef/client.pem ]; then
+  /etc/init.d/chef-client restart
+  echo -n "Waiting on client.pem to appear..."
+  i="0"
+  until [ -f /etc/chef/client.pem ]; do
+    i=$[$i+1]
+    sleep 1
+    echo -n "."
+    if [ $i -gt 60 ]; then
+      echo -n "restart-chef-client"
+      /etc/init.d/chef-client restart
+      i="0"
+    fi
+  done
+  echo "done."
+fi
+
+cat <<EOF > /etc/chef/first-boot.json
+<%= @config[:attributes].to_json %>
+EOF
+
+touch ${CUCUMBER_CHEF_BOOTSTRAP_DONE}
+'

data/lib/cucumber/chef/templates/cucumber/env.rb

@@ -0,0 +1,56 @@
+require 'rspec/expectations'
+require 'cucumber/chef'
+require 'cucumber/chef/helpers'
+require 'cucumber/chef/steps'
+require 'cucumber/chef/version'
+
+class CustomWorld
+  include Cucumber::Chef
+  include Cucumber::Chef::Helpers
+end
+
+World do
+  CustomWorld.new
+end
+
+$servers = Hash.new(nil)
+
+Before do
+  knife_rb = Cucumber::Chef.locate(:file, ".chef", "knife.rb")
+  Chef::Config.from_file(knife_rb)
+
+  $servers_bin ||= (Cucumber::Chef.locate(:file, ENV['HOME'], "servers.bin") rescue File.expand_path(File.join(ENV['HOME'], "servers.bin")))
+
+  # cleanup previous lxc containers if asked
+  if (ENV['DESTROY'] == "1")
+    log("servers", "are being destroyed")
+    servers.each do |name|
+      server_destroy(name)
+    end
+    File.exists?($servers_bin) && File.delete($servers_bin)
+  else
+    log("servers", "are being preserved")
+  end
+
+  if File.exists?($servers_bin)
+    $servers = Marshal.load(IO.read($servers_bin))
+  end
+
+  chef_set_client_config(:chef_server_url => "http://192.168.255.254:4000",
+                         :validation_client_name => "chef-validator")
+end
+
+After do |scenario|
+  @connection.close if @connection
+
+  File.open($servers_bin, 'w') do |f|
+    f.puts(Marshal.dump($servers))
+  end
+
+  Kernel.exit if scenario.failed?
+
+  # cleanup non-persistent lxc containers on exit
+  $servers.select{ |name, attributes| !attributes[:persist] }.each do |name, attributes|
+    server_destroy(name)
+  end
+end

data/lib/cucumber/chef/templates/cucumber/example_feature.erb

@@ -0,0 +1,49 @@
+@<%= @project %>
+Feature: Perform test driven infrastructure with Cucumber-Chef
+  In order to learn how to develop test driven infrastructure
+  As an infrastructure developer
+  I want to better understand how to use Cucumber-Chef
+
+  Background:
+    * I have a server called "<%= @project %>"
+    * "<%= @project %>" is running "ubuntu" "lucid"
+    * "<%= @project %>" has been provisioned
+    * the "chef-client::service" recipe has been added to the "<%= @project %>" run list
+    * the chef-client has been run on "<%= @project %>"
+    * I ssh to "<%= @project %>" with the following credentials:
+      | username | keyfile |
+      | root | ../.ssh/id_rsa |
+
+  Scenario: Can connect to the provisioned server via SSH authentication
+    When I run "hostname"
+    Then I should see "<%= @project %>" in the output
+
+  Scenario: Default root shell is bash
+    When I run "echo $SHELL"
+    Then I should see "bash" in the output
+
+  Scenario: Default gateway and resolver are using Cucumber-Chef Test Lab
+    When I run "route -n | grep 'UG'"
+      Then I should see "192.168.255.254" in the output
+    When I run "cat /etc/resolv.conf"
+      Then I should see "192.168.255.254" in the output
+      And I should see "8.8.8.8" in the output
+      And I should see "8.8.4.4" in the output
+
+  Scenario: Primary interface is configured with my IP address and MAC address
+    When I run "ifconfig eth0"
+      Then I should see the "IP" of "<%= @project %>" in the output
+      And I should see the "MAC" of "<%= @project %>" in the output
+
+  Scenario: Local interface is not configured with my IP address or MAC address
+    When I run "ifconfig lo"
+      Then I should see "127.0.0.1" in the output
+      And I should not see the "IP" of "<%= @project %>" in the output
+      And I should not see the "MAC" of "<%= @project %>" in the output
+
+  Scenario: Chef-Client is running as a daemon
+    When I run "ps aux | grep [c]hef-client"
+      Then I should see "chef-client" in the output
+      And I should see "-d" in the output
+      And I should see "-i 1800" in the output
+      And I should see "-s 20" in the output

data/lib/cucumber/chef/templates/cucumber/example_steps.erb

@@ -0,0 +1,11 @@
+Given /^some initial state$/ do
+  pending # express the regexp above with the code you wish you had
+end
+
+When /^tickle$/ do
+  pending # express the regexp above with the code you wish you had
+end
+
+Then /^resulting state$/ do
+  pending # express the regexp above with the code you wish you had
+end

data/lib/cucumber/chef/templates/cucumber/readme-data_bags.erb

@@ -0,0 +1 @@
+Create supporting data bags here.  Each data bag should get it's own subdirectory just like normal.

data/lib/cucumber/chef/templates/cucumber/readme-keys.erb

@@ -0,0 +1 @@
+Place supporting public key pairs here.

data/lib/cucumber/chef/templates/cucumber/readme-roles.erb

@@ -0,0 +1 @@
+Create supporting roles here.

data/lib/cucumber/chef/templates/cucumber/readme.erb

@@ -0,0 +1,18 @@
+Welcome to the suite of cucumber-chef tests
+
+Your general workflow will be to write cucumber features that describe the intended behaviour.  You will then write failing tests by writing steps to test the behaviour, expressing them as cucumer scenarios.
+
+You will then want to create a cookbook, and write recipes that make your tests pass.  Upload your cookbook to your Hosted Chef-Server using 'knife' or the Cucumber-Chef Test Lab OS Chef-Server using the 'cc-knife' tool, and then run the tests with:
+
+cucumber-chef test [cucumber options]
+
+For an example feature, take a look at <chef-repo>/features/<%= @project %>/<%= @project %>.feature
+
+For an example step definition, look at <chef-repo>/features/<%= @project %>/step_definitions/<%= @project %>_steps.rb
+
+Cucumber-Chef Test Lab Network
+==============================
+CIDR: 192.168.0.0/16
+Network: 192.168.0.0
+Broadcast: 192.168.255.255
+Test Lab/Gateway: 192.168.255.254

data/lib/cucumber/chef/templates/cucumber-chef/config-rb.erb

@@ -0,0 +1,33 @@
+################################################################################
+# Cucumber-Chef
+################################################################################
+
+provider                        :aws
+librarian_chef                  <%= @librarian_chef %>
+
+
+################################################################################
+# Provider: AWS
+################################################################################
+
+aws[:aws_access_key_id]         = "<%= @aws_access_key %>"
+aws[:aws_secret_access_key]     = "<%= @aws_secret_access_key %>"
+
+aws[:aws_ssh_key_id]            = "<%= @aws_ssh_id %>"
+aws[:identity_file]             = "<%= File.join(@aws_ssh_key_dir, @aws_ssh_key) %>"
+
+aws[:region]                    = "<%= @region %>-1"
+aws[:availability_zone]         = "<%= @region %>-1a"
+
+#aws[:aws_instance_arch]         = "i386"
+#aws[:aws_instance_disk_store]   = "instance-store"
+#aws[:aws_instance_type]         = "m1.small"
+
+#aws[:aws_security_group]        = "cucumber-chef"
+
+
+################################################################################
+# Provider: Vagrant
+################################################################################
+
+# TODO

data/lib/cucumber/chef/templates/cucumber-chef/cucumber-yml.erb

@@ -0,0 +1,2 @@
+---
+default: -c -v

data/lib/cucumber/chef/templates/cucumber-chef/knife-rb.erb

@@ -0,0 +1,18 @@
+current_dir = File.dirname(__FILE__)
+
+log_level               :debug
+log_location            STDOUT
+node_name               "<%= @config[:user] %>"
+client_key              "#{current_dir}/<%= @config[:user] %>.pem"
+validation_client_name  "chef-validator"
+validation_key          "#{current_dir}/validation.pem"
+chef_server_url         "http://<%= @config[:chef_server] %>:4000"
+cache_type              "BasicFile"
+cookbook_path           ['#{current_dir}/../cookbooks']
+
+cache_options(:path => "#{current_dir}/checksums")
+<% if @config[:librarian_chef] -%>
+
+require 'librarian/chef/integration/knife'
+cookbook_path Librarian::Chef.install_path, "#{current_dir}/../site-cookbooks"
+<% end -%>