barking_iguana-compound 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0faf126b34f58aaef3ff3b4797468dc507884046
-  data.tar.gz: e7f0193c33253537b31c49b5a610295792043a34
+  metadata.gz: a4102d07d853b0631a982911f35b114ba5efd7cc
+  data.tar.gz: 83af11d838771d6f83056556f37d74a8ab4345f0
 SHA512:
-  metadata.gz: 88e9707c4ff7b76b9382654ee111b88bbe09d2ad2963bae7c11a423a77a7cc6e64256e85785816c71f836d60897272ea6e3fcd86a715d6e9f3a0f9804f844e8f
-  data.tar.gz: a7c28a7290f1463dd9baa20fa23f195148bbde93bc6c6019dfbc29ae2986dc5886284a157dfe65782fe9ce7e31609bcdce3307c5231d1d4b1c66c8babf745b0e
+  metadata.gz: 01055224b326b78a45d016547f9644f7f1d82b2db2b9245b1e3813372df67194bb699a9354b622f3f631c51f2d6cbcd3e754bd960b0c75b20c4d5df6e16175d3
+  data.tar.gz: 29539c1a69fa7a4006818855d357e5aa6ed568bcb93c834f5ae0cddca7adff749205ba9a1b2cbfc2f890fb271b04ca9b3f256bab77f178bf31c4a44722b78c56

data/barking_iguana-compound.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'barking_iguana-logging'
   spec.add_dependency 'barking_iguana-benchmark'
+  spec.add_dependency 'barking_iguana-fork_calls'
   spec.add_dependency 'mixlib-shellout'
   spec.add_dependency 'rspec-wait'
   spec.add_dependency 'ansible_spec'

data/docs/CHANGELOG.md

@@ -4,6 +4,9 @@ Entries are in reverse chronological order.
 
 ## *0.1.12* (Current Development)
 
+  * Initial support for testing the results of the playbook run, to check for
+    number of changes applied by `ansible-playbook`.
+
 ## *0.1.11* (2017-01-17)
 
   * Increase wait time for Ansible Playbook run to 1 hour instead of teh default

data/docs/TODO.md

@@ -1,14 +1,20 @@
 # TODO
 
 * We can add machines to different networks because even though we require
-  `10.8.*`, the networks created are `/24`'s. These should either be `/16` to
-  avoid surprises, or we should make the CIDR configurable, or we should give an
-  example showing this behaviour.
+  `10.8.*`, the networks created are `/24`'s. These should either be `/16`
+  to avoid surprises, or we should make the CIDR configurable, or we should
+  give an example showing this behaviour.
 
-* Tests. So ironic that a testing tool has no tests. For release 1.0.0 we need tests.
+* Tests. So ironic that a testing tool has no tests. For release 1.0.0 we
+  need tests.
 
-* We should support the ansible remote user attributes in the inventory, for each host.
+* We should support the ansible remote user attributes in the inventory, for
+  each host.
 
 * Rewrite the InventoryParser so it's understandable!
 
 * Make command timeouts customiseable.
+
+* Stop paying attention to `~/.ssh/known_hosts` inside the tests. If these
+  host keys exist we end up with test failures, even though we _do_ expected
+  these to change.

data/examples/simple/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: ../../
   specs:
-    barking_iguana-compound (0.1.9)
+    barking_iguana-compound (0.1.11)
       ansible_spec
       barking_iguana-benchmark
+      barking_iguana-fork_calls
       barking_iguana-logging
       colorize
       hostlist_expression
@@ -20,13 +21,14 @@ GEM
       serverspec (>= 2.0.0)
       winrm
     barking_iguana-benchmark (0.1.1)
+    barking_iguana-fork_calls (0.1.0)
     barking_iguana-logging (0.1.7)
       barking_iguana-otk
       term-ansicolor
     barking_iguana-otk (0.1.0)
     builder (3.2.3)
     colorize (0.8.1)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     erubis (2.7.0)
     ffi (1.9.17)
     gssapi (1.2.0)
@@ -73,7 +75,7 @@ GEM
       rspec-its
       specinfra (~> 2.53)
     sfl (2.3)
-    specinfra (2.66.4)
+    specinfra (2.66.5)
       net-scp
       net-ssh (>= 2.7, < 5.0)
       net-telnet

data/examples/simple/test/compound/simple/000-setup/playbook.yml

@@ -1,5 +1,5 @@
 ---
-- name: Example Playbook
+- name: Example Playbook 1
   hosts: example-host
   tasks:
     - name: Create a file

data/examples/simple/test/compound/simple/001-replay/_ansible/play_spec.rb

@@ -0,0 +1,7 @@
+describe 'ansible-playbook' do
+  subject { BarkingIguana::Compound::Ansible::ResultsParser.new(ENV['ANSIBLE_RESULTS_FILE']) }
+
+  it "did not change anything" do
+    expect(subject.recap.total_changes).to eq 0
+  end
+end

data/examples/simple/test/compound/simple/001-replay/example-host/example_spec.rb

@@ -0,0 +1,5 @@
+describe file('/tmp/example-file') do
+  it "exists" do
+    expect(subject).to exist
+  end
+end

data/examples/simple/test/compound/simple/001-replay/playbook.yml

@@ -0,0 +1,10 @@
+---
+- name: Example Playbook 2
+  hosts: example-host
+  tasks:
+    - name: Ensure file ownership
+      become: yes
+      file:
+        path: /tmp/example-file
+        owner: root
+        group: root

data/lib/barking_iguana/compound/ansible/playbook.rb

@@ -48,13 +48,8 @@ module BarkingIguana
         end
 
         def run
-          options = {}
-          options[:cwd] = run_from if run_from
-          options[:live_stream] = io if io
-          options[:timeout] = 3600
-          c = Mixlib::ShellOut.new(command, options)
-          c.run_command
-          c.error!
+          command.run_command
+          command.error!
           self
         ensure
           clean_up
@@ -62,6 +57,18 @@ module BarkingIguana
 
         private
 
+        def command
+          @command ||= Mixlib::ShellOut.new(command_line, command_options)
+        end
+
+        def command_options
+          options = {}
+          options[:cwd] = run_from if run_from
+          options[:live_stream] = io if io
+          options[:timeout] = 3600
+          options
+        end
+
         def clean_up
           return unless run_from
           FileUtils.remove_file wrapper_playbook, true
@@ -86,7 +93,7 @@ module BarkingIguana
           end
         end
 
-        def command
+        def command_line
           c = ["env ANSIBLE_RETRY_FILES_ENABLED=no ansible-playbook #{playbook_paths}"]
           inventory_paths.each do |i|
             c << "-i #{i}"

data/lib/barking_iguana/compound/ansible/results_parser.rb

@@ -0,0 +1,26 @@
+module BarkingIguana
+  module Compound
+    module Ansible
+      class ResultsParser
+        attr_accessor :file
+        private :file=, :file
+
+        def initialize file
+          self.file = file
+        end
+
+        def recap
+          OpenStruct.new total_changes: total_changes
+        end
+
+        private
+
+        def total_changes
+          recap_text = File.read(file).split(/^PLAY RECAP \**$/)[-1].strip
+          matches = recap_text.scan(/ changed=(\d+) /)
+          matches[0].map(&:to_i).inject(&:+)
+        end
+      end
+    end
+  end
+end

data/lib/barking_iguana/compound/ansible_spec.rb

@@ -0,0 +1,56 @@
+module BarkingIguana
+  module Compound
+    class AnsibleSpec
+      extend Forwardable
+      attr_accessor :stage
+
+      def initialize stage
+        self.stage = stage
+      end
+
+      include BarkingIguana::Logging::Helper
+      include BarkingIguana::Benchmark
+
+      def run
+        unless File.exists? ansible_test_directory
+          logger.debug { "#{ansible_test_directory} doesn't exist, assuming no ansible tests for this stage" }
+          return
+        end
+
+        command = "bundle exec ruby -S rspec -r #{spec_helper} #{test_files.join(' ')}"
+        c = Mixlib::ShellOut.new command, live_stream: logger, cwd: control_repo_dir, env: env
+        benchmark command do
+          c.run_command
+        end
+        logger.info { "ansible tests exited with status #{c.exitstatus}" }
+        c.error!
+      end
+
+      private
+
+      def test_files
+        Dir.glob File.expand_path '**/*_spec.rb', ansible_test_directory
+      end
+
+      def env
+        {
+          ANSIBLE_RESULTS_FILE: ansible_results_file
+        }
+      end
+
+      def spec_helper
+        File.expand_path '../../../../resources/ansible_spec_helper.rb', __FILE__
+      end
+
+      def ansible_test_directory
+        File.expand_path '_ansible', root_dir
+      end
+
+      def_delegator :stage, :test
+      def_delegator :stage, :stage_directory, :root_dir
+      def_delegator :stage, :results_file, :ansible_results_file
+      def_delegator :test, :suite
+      def_delegator :suite, :control_directory, :control_repo_dir
+    end
+  end
+end

data/lib/barking_iguana/compound/server_spec.rb

@@ -35,7 +35,7 @@ module BarkingIguana
       def host_tests
         hosts.inject({}) do |a,e|
           name = e.name
-          glob = "#{root_dir}/{#{name}/**/*_,}spec.rb"
+          glob = "#{root_dir}/#{name}/**/*_spec.rb"
           logger.debug { "Host glob for #{name.inspect} = #{glob.inspect}" }
           tests = Dir.glob glob
           logger.debug { "Host tests for #{name.inspect} = #{tests.inspect}" }
@@ -50,7 +50,7 @@ module BarkingIguana
       end
 
       def spec_helper
-        File.expand_path '../../../../resources/spec_helper.rb', __FILE__
+        File.expand_path '../../../../resources/server_spec_helper.rb', __FILE__
       end
 
       def_delegator :stage, :test

data/lib/barking_iguana/compound/test_stage.rb

@@ -68,9 +68,17 @@ module BarkingIguana
         @generated_inventory ||= generate_inventory
       end
 
+      def tmp_dir *sub_path
+        @tmp_dir ||= Dir.mktmpdir
+        return @tmp_dir if sub_path.empty?
+        full_path = File.expand_path File.join(sub_path), @tmp_dir
+        FileUtils.mkdir_p full_path
+        full_path
+      end
+
       def generate_inventory
         benchmark "#{name}: generating inventory for test stage" do
-          Dir.mktmpdir('inventory').tap do |d|
+          tmp_dir('inventory').tap do |d|
             logger.debug { "#{name}: inventory directory is #{d.inspect}" }
             connection_file = File.expand_path 'connection', d
             Ansible::InventoryWriter.new(connection_file).tap do |i|
@@ -96,7 +104,11 @@ module BarkingIguana
       end
 
       def playbook
-        Ansible.playbook(playbook_path, run_from: control_directory).inventory(generated_inventory).stream_to(logger).verbosity(ansible_verbosity).diff
+        Ansible.playbook(playbook_path, run_from: control_directory).inventory(generated_inventory).stream_to(playbook_logger).verbosity(ansible_verbosity).diff
+      end
+
+      def playbook_logger
+        @playbook_logger ||= BarkingIguana::ForkCalls.fork_to(logger, results_logger)
       end
 
       def setup
@@ -123,15 +135,41 @@ module BarkingIguana
         FileUtils.rm_r generated_inventory
       end
 
-      def server_spec
-        @server_spec ||= ServerSpec.new(self)
+      def clean_up
+        logger.debug { "Removing temporary directory for stage #{name} from #{tmp_dir}" }
+        FileUtils.rm_r tmp_dir
       end
 
       def_delegator :original_inventory, :hosts
       def_delegator :test, :suite
       def_delegator :test, :host_manager
       def_delegator :suite, :control_directory
-      def_delegator :server_spec, :run, :verify
+
+      def verify
+        server_spec.run
+        ansible_spec.run
+      end
+
+      def results_file
+        @results_file ||= File.expand_path('playbook.out', tmp_dir('results', 'ansible'))
+      end
+
+      private
+
+      def server_spec
+        @server_spec ||= ServerSpec.new(self)
+      end
+
+      def ansible_spec
+        @ansible_spec ||= AnsibleSpec.new(self)
+      end
+
+      def results_logger
+        @results_logger ||= ::Logger.new(results_file).tap do |l|
+          l.level = ::Logger::DEBUG
+          l.formatter = lambda { |_, _, _, message| message }
+        end
+      end
     end
   end
 end

data/lib/barking_iguana/compound/version.rb

@@ -1,5 +1,5 @@
 module BarkingIguana
   module Compound
-    VERSION = "0.1.11"
+    VERSION = "0.1.12"
   end
 end

data/lib/barking_iguana/compound.rb

@@ -1,5 +1,6 @@
 require 'barking_iguana/logging'
 require 'barking_iguana/benchmark'
+require 'barking_iguana/fork_calls'
 
 require 'erb'
 require 'forwardable'
@@ -13,11 +14,13 @@ require 'barking_iguana/compound/ansible'
 require 'barking_iguana/compound/ansible/inventory'
 require 'barking_iguana/compound/ansible/inventory_parser'
 require 'barking_iguana/compound/ansible/inventory_writer'
+require 'barking_iguana/compound/ansible/results_parser'
 require 'barking_iguana/compound/ansible/playbook'
 require 'barking_iguana/compound/command_line_client'
 require 'barking_iguana/compound/environment'
 require 'barking_iguana/compound/host_manager'
 require 'barking_iguana/compound/host'
+require 'barking_iguana/compound/ansible_spec'
 require 'barking_iguana/compound/server_spec'
 require 'barking_iguana/compound/test_stage'
 require 'barking_iguana/compound/test'

data/resources/ansible_spec_helper.rb

@@ -0,0 +1 @@
+require 'barking_iguana/compound'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barking_iguana-compound
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Craig R Webster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: barking_iguana-fork_calls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +203,9 @@ files:
 - examples/simple/Rakefile
 - examples/simple/test/compound/simple/000-setup/example-host/example_spec.rb
 - examples/simple/test/compound/simple/000-setup/playbook.yml
+- examples/simple/test/compound/simple/001-replay/_ansible/play_spec.rb
+- examples/simple/test/compound/simple/001-replay/example-host/example_spec.rb
+- examples/simple/test/compound/simple/001-replay/playbook.yml
 - examples/simple/test/compound/simple/Vagrantfile
 - examples/simple/test/compound/simple/inventory
 - exe/compound
@@ -198,19 +215,21 @@ files:
 - lib/barking_iguana/compound/ansible/inventory_parser.rb
 - lib/barking_iguana/compound/ansible/inventory_writer.rb
 - lib/barking_iguana/compound/ansible/playbook.rb
+- lib/barking_iguana/compound/ansible/results_parser.rb
+- lib/barking_iguana/compound/ansible_spec.rb
 - lib/barking_iguana/compound/command_line_client.rb
 - lib/barking_iguana/compound/environment.rb
 - lib/barking_iguana/compound/host.rb
 - lib/barking_iguana/compound/host_manager.rb
 - lib/barking_iguana/compound/server_spec.rb
-- lib/barking_iguana/compound/spec_helper.rb
 - lib/barking_iguana/compound/test.rb
 - lib/barking_iguana/compound/test_stage.rb
 - lib/barking_iguana/compound/test_suite.rb
 - lib/barking_iguana/compound/vagrant.rb
 - lib/barking_iguana/compound/version.rb
 - resources/Vagrantfile.erb
-- resources/spec_helper.rb
+- resources/ansible_spec_helper.rb
+- resources/server_spec_helper.rb
 homepage: https://github.com/barkingiguana/compound
 licenses: []
 metadata:

data/resources/spec_helper.rb

@@ -1,6 +0,0 @@
-require 'serverspec'
-require 'rspec/wait'
-
-set :backend, :ssh
-set :host, ENV['TARGET_HOST']
-set :ssh_options, user: ENV['TARGET_SSH_USER'], keys: [ENV['TARGET_SSH_KEY']]