barking_iguana-compound 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 424d8a8ee3ddc8e5aae5daf84f27788f6f2fd77e
-  data.tar.gz: fb4124b4fa642abb33d64cb69532d2f991482ec6
+  metadata.gz: 660f437659c9d71510010c474a79652d23ae8f72
+  data.tar.gz: 6d9144927d86139196261607bffe1087ec1a60b9
 SHA512:
-  metadata.gz: 39f6d055963b1e84e99362f32c9d0093cb92cd001867e26acb33b2734b97cf7935821ae4087d70441634a62298e49a144b4f2565dfb5ac48cdeae93f9d07e567
-  data.tar.gz: e40b47bd3410c0b27a073fc7e42feb67e5d455b4171a28acb240fdcd5888eab8d02498282acaf4881130072a299e38b7c5501d25d637b752cd010d0e9ce76356
+  metadata.gz: 22aac3dbdb690d0b08230002e1a6391c8dbbc5b6c729064f1860027f552f81a7ad26b8906e4f8c223f2c6a3d0c54547d68cd2610f22d9073e4e02030dfcd5c5c
+  data.tar.gz: d2e833cc167db10884952f020accb87780b9341e0cac9264571d6548d1ae7c7d73bcd60bfdf78005fa78a76f03744619c278ffb24b1832cc54726000000f5c76

data/README.md

@@ -1,179 +1,5 @@
-# BarkingIguana::Compound
+# Compound
 
-Compound testing for Ansible atoms.
-
-When you need to test several roles and/or playbooks together over their lifetime e.g. testing database failover and recovery.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'barking_iguana-compound'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install barking_iguana-compound
-
-## Usage
-
-Install it, as per above.
-
-Normally you'll use Compond as part of a Rake task, so include it in your
-`Rakefile`. Tell it to define Rake tasks for your compound tests - we assume
-these live in `test/compound` - and where your playbooks live, your control
-repository:
-
-```ruby
-require 'barking_iguana/compound'
-ansible_control_repo = File.dirname __FILE__
-BarkingIguana::Compound.new('test/compound', ansible_control_repo).define_rake_tasks
-```
-
-Now let's define a test managing hosts files. It's a trivial test, but it
-suffices to demonstrate the capacilities of Compound.
-
-### Writing a compound test
-
-Create a directory for the test:
-
-    $ mkdir -p test/compound/hosts_file_management
-
-Each test will have several _stages_, which represent parts of the expected
-lifecycle of your servers. For example, you set up your servers using Ansible,
-to you probably have a setup stage. You may be setting up a HA cluster, so
-perhaps you have a stage where the master in the cluster fails.
-
-Each stage involves several actions. We'll cover them in detail below, but in
-summary:
-
-The `setup` action runs first. For each stage this action decides which virtual
-machines should be powered on or off during the rest of the stage.
-
-Next, the `converge` action runs the playbook for that stage, if one is provided
-by you, to allow things to happen. The playbook may apply roles or kill
-processes, whatever you need to simulate what's happening to your servers at
-that part of the lifecycle.
-
-Finally, the `verify` stage runs some serverspec tests which you will define
-against the results of the `converge` action. This allows you to check what
-happens after the tasks in the playbook have been run e.g. you may verify that a
-standby server has become the master.
-
-Each stage lives in a directory inside the test. They're executed in
-alphabetical order, and you are encouraged to prefix each stage with numbers to
-make it very clear which one should execute in which order.
-
-We'll cover each of those actions in greater detail now, for the setup stage of
-our hosts file example.
-
-#### Test Stages
-
-Start by creating the directory for that stage:
-
-    $ mkdir -p test/compound/hosts_file_management/000-setup
-
-##### The Setup Action
-
-This action controls which virtual machines are available for you to work with,
-by looking at an Ansible inventory file in the stage directory and starting all
-the hosts it finds.
-
-Let's create a simple inventory file with 2 hosts and 1 group.
-
-The inventory file for each stage lives in the stage directory in a file called
-`inventory`, so in our example so for that's `test/compound/hosts_file_management/000-setup/inventory`.
-
-They're just normal Ansible inventory files, with only one restriction: the
-`ansible_host` _must_ start with `10.8.`.
-
-```
-[linux]
-host001 ansible_host=10.8.100.11
-host002 ansible_host=10.8.100.12
-```
-
-When the setup action for a stage with this inventory is run, Compound will
-launch two virtual machines for you to test with, `host001` and `host002` with
-the respective IP addresses.
-
-##### The Converge Action
-
-Now that virtual machines are available to use, the converge action can run
-the playbook for your stage against them.
-
-Playbooks live in the stage directory, in a file called `playbook.yml`. I'm
-inventive like that. For our example stage that's `test/compound/hosts_file_management/000-setup/playbook.yml`.
-
-For our setup action we'll apply the `hosts` role to all hosts.
-
-```
----
-- hosts: all
-  roles:
-    - hosts
-```
-
-After a converge, Compound will attempt to verify whatever you ask it to.
-Onwards, to the verify action.
-
-##### The Verify Action
-
-Now we run automated tests to assert that our virtual machines behave like we
-think they should, after the stage playbook has been applied in the converge
-action.
-
-The verify action is based around serverspec tests, arranged around the name of
-the host which they test.
-
-For example, to test `host001` we'd create tests under a `test/compound/hosts_file_management/host001/`
-directory. Each test file must be suffixed with `_spec.rb`. A simple example
-would be checking that the other host of the pair is resolvable now that the
-hosts role has been applied to the hosts:
-
-```ruby
-# test/compound/hosts_file_management/host001/resolving_spec.rb
-describe host('host002') do
-  it "is resolvable" do
-    expect(subject).to be_resolvable
-  end
-end
-```
-
-```ruby
-# test/compound/hosts_file_management/host002/resolving_spec.rb
-describe host('host001') do
-  it "is resolvable" do
-    expect(subject).to be_resolvable
-  end
-end
-```
-
-Compound will take the appropriate actions to make sure your tests are run on
-the correct hosts, you don't need to worry about SSH keys, passwords or ports.
-
-### Running the tests
-
-Since we've asked Compound to define rake tasks above, we can run those. The tasks generated are based on the directory names we use in the tests. The above test can be run like this:
-
-    $ bundle exec rake compound:hosts_file_management
-
-You can see a list of all tests by asking Rake to list them:
-
-    $ bundle exec rake -T
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/barking_iguana-compound.
+For docs see [`docs/index.md`][0].
 
+[0]: https://barkingiguana.github.io/compound/

data/docs/CHANGELOG.md

@@ -0,0 +1,49 @@
+# CHANGELOG
+
+Entries are in reverse chronological order.
+
+## *0.1.5* (Current Development)
+
+  Add release notes here, as things are added to the project.
+
+## *0.1.4* (2016-12-27)
+
+  * Bug fix: allow connecting to VMs when we generate their IP address on
+    the fly.
+
+  * Bug fix: correctly expand the staging directory when searching for
+    the stages `playbook.yml` or `inventory` file.
+
+## *0.1.3* (2016-12-27)
+
+  * Various bug fixes - mostly typos that would stop the full test run
+    happening.
+
+  * Add a command line tool, so we don't need the `Rakefile`. Currently this
+    only handles running the entire test suite.
+
+  * Stop requiring that the inventory files specify an IP address. If no
+    IP address is provided for a VM it will be assigned an unallocated one.
+
+  * Simplify asking Compound to define Rake tasks by allowing it to guess
+    the directories involved. These can still be overridden, but they
+    shouldn't normally need to be.
+
+  * Stop supporting the concept of 'simple' tests - tests which have only
+    one implicit stage. Compound feels most useful when focussing on
+    lifecycle style tests which have several stages.
+
+## *0.1.2* (2016-12-16)
+
+  Allow a default inventory and playbook for each test, living in the test
+  directory instead of in each stage. This is less likely to be useful for
+  the playbook, but a default inventory will reduce duplication.
+
+## *0.1.1* (2016-12-16)
+
+  Symlink wrapper playbooks instead of writing temporary playbooks with
+  includes.
+
+## *0.1.0* (2016-12-11)
+
+  Initial release.

data/docs/TODO.md

@@ -0,0 +1,12 @@
+# 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.
+
+* Tests. So ironic that a testing tool has no tests. For release 1.0.0 we need tests.
+
+* A host doesn't have a `uri`, it's got an IP address.
+
+* We should support the ansible remote user attributes in the inventory, for each host.

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/docs/index.md

@@ -0,0 +1,232 @@
+# BarkingIguana::Compound
+
+Compound testing for Ansible atoms.
+
+Sometimes we need to test the interaction of several roles and/or playbooks,
+especially over the expected lifetime of our tech stack.
+
+Say we have a typical three tier web app; web, app and database tiers.
+
+When an app server is put into maintenance mode, does the reverse proxy on the
+web tier pick that up? Does it reconfigure the pool so that requests no longer
+hit that app server? Does it do so in a reasonable time?
+
+Previously we could test that the configuration of the reverse proxy was what we
+expected to see on disk, but testing that it behaved in the way that we thought
+it would was a case of deploying to a test servers and poking at the result
+manually. Error prone, slow, not terribly maintainable, and it can in many cases
+block uses of a server that it typically a shared resource. Very not fun.
+
+With Compound, we can write Ansible inventories to represent real world
+situations, run playbooks against them to install and configure the software we
+want to test or simulate real world behaviour such as turning on maintenance
+mode, and then assert the behaviour we expect using serverspec style tests.
+
+## Installation
+
+I assume you have Ruby and `bundler` already installed, because I'm a Ruby
+developer and this is a Ruby project. If you don't, you'll need to install
+them now.
+
+If you don't already have one, create a file called `Gemfile` in the root of
+your Ansible control repository.
+
+Add this line to your `Gemfile`:
+
+```ruby
+gem 'barking_iguana-compound'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself by running:
+
+    $ gem install barking_iguana-compound
+
+You'll also need Vagrant, and VirtualBox, installed where you'd like to run
+your tests.
+
+## Usage
+
+Install it, as per above.
+
+Normally you'll use Compond as part of a Rake task, so include it in a
+`Rakefile` in the root of your project.
+
+Tell Compound to define Rake tasks for your compound tests:
+
+```ruby
+require 'barking_iguana/compound'
+BarkingIguana::Compound::TestSuite.define_rake_tasks
+```
+
+Now let's define a test managing hosts files. It's a trivial test, but it
+suffices to demonstrate the capacilities of Compound.
+
+### Writing a compound test
+
+Create a directory for the test:
+
+    $ mkdir -p test/compound/hosts_file_management
+
+Each test will have several _stages_, which represent parts of the expected
+lifecycle of your servers. For example, you set up your servers using Ansible,
+to you probably have a setup stage. You may be setting up a HA cluster, so
+perhaps you have a stage where the master in the cluster fails.
+
+Each stage involves several actions. We'll cover them in detail below, but in
+summary:
+
+The `setup` action runs first. For each stage this action decides which virtual
+machines should be powered on or off during the rest of the stage.
+
+Next, the `converge` action runs the playbook for that stage, if one is provided
+by you, to allow things to happen. The playbook may apply roles or kill
+processes, whatever you need to simulate what's happening to your servers at
+that part of the lifecycle.
+
+Finally, the `verify` stage runs some serverspec tests which you will define
+against the results of the `converge` action. This allows you to check what
+happens after the tasks in the playbook have been run e.g. you may verify that a
+standby server has become the master.
+
+Each stage lives in a directory inside the test. They're executed in
+alphabetical order, and you are encouraged to prefix each stage with numbers to
+make it very clear which one should execute in which order.
+
+We'll cover each of those actions in greater detail now, for the setup stage of
+our hosts file example.
+
+#### Test Stages
+
+Start by creating the directory for that stage:
+
+    $ mkdir -p test/compound/hosts_file_management/000-setup
+
+##### The Setup Action
+
+This action controls which virtual machines are available for you to work with,
+by looking at an Ansible inventory file in the stage directory and starting all
+the hosts it finds.
+
+Let's create a simple inventory file with 2 hosts and 1 group.
+
+The inventory file for each stage lives in the stage directory in a file called
+`inventory`, so in our example so for that's `test/compound/hosts_file_management/000-setup/inventory`.
+
+These are normal Ansible inventory files:
+
+```
+[all:children]
+web
+application
+database
+
+[web]
+host001
+
+[application]
+host002
+
+[database]
+host003
+```
+
+When the setup action for a stage with this inventory is run, Compound will
+launch three virtual machines for you to test with, `host001`, `host002`, and
+`host003`. It will assign them IP addresses in the `10.8.42/24` range.
+
+##### The Converge Action
+
+Now that virtual machines are available to use, the converge action can run
+the playbook for your stage against them.
+
+Playbooks live in the stage directory, in a file called `playbook.yml`. I'm
+inventive like that. For our example stage that's `test/compound/hosts_file_management/000-setup/playbook.yml`.
+
+For our setup action we'll apply the `hosts` role to all hosts.
+
+```
+---
+- hosts: all
+  roles:
+    - hosts
+```
+
+After a converge, Compound will attempt to verify whatever you ask it to.
+Onwards, to the verify action.
+
+##### The Verify Action
+
+Now we run automated tests to assert that our virtual machines behave like we
+think they should, after the stage playbook has been applied in the converge
+action.
+
+The verify action is based around serverspec tests, arranged around the name of
+the host which they test.
+
+For example, to test `host001` we'd create tests under a `test/compound/hosts_file_management/host001/`
+directory. Each test file must be suffixed with `_spec.rb`. A simple example
+would be checking that the other host of the pair is resolvable now that the
+hosts role has been applied to the hosts:
+
+```ruby
+# test/compound/hosts_file_management/host001/resolving_spec.rb
+describe host('host002') do
+  it "is resolvable" do
+    expect(subject).to be_resolvable
+  end
+end
+```
+
+```ruby
+# test/compound/hosts_file_management/host002/resolving_spec.rb
+describe host('host001') do
+  it "is resolvable" do
+    expect(subject).to be_resolvable
+  end
+end
+```
+
+Compound will take the appropriate actions to make sure your tests are run on
+the correct hosts, you don't need to worry about SSH keys, passwords or ports.
+
+### Running the tests
+
+Since we've asked Compound to define rake tasks above, we can run those. The
+tasks generated are based on the directory names we use in the tests. The above
+test can be run like this:
+
+    $ bundle exec rake compound:hosts_file_management
+
+You can see a list of all tests by asking Rake to list them:
+
+    $ bundle exec rake -T
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to [rubygems.org][0].
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/barkingiguana/compound.
+
+If you'd like to contribute features, please do discuss them by opening an issue on GitHub.
+
+Some things I'd like to tackle are listed in [docs/TODO.md][1].
+
+Please keep [docs/CHANGELOG.md][2] updated as you add/remove/change things.
+
+
+[0]: https://rubygems.org
+[1]: http://barkingiguana.com/compound/TODO
+[2]: http://barkingiguana.com/compound/CHANGELOG

data/exe/compound

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'barking_iguana/compound'
+
+BarkingIguana::Compound::CommandLineClient.new(ARGV).run

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

@@ -19,7 +19,7 @@ module BarkingIguana
           hosts = h.values.flatten.uniq { |h| h['uri'] }
           hosts.map do |data|
             name = data['name'].gsub(/ .*/, '')
-            Host.new name: name, uri: data['uri']
+            Host.new name: name, ip_address: data['uri']
           end
         end
       end

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

@@ -0,0 +1,40 @@
+module BarkingIguana
+  module Compound
+    module Ansible
+      class InventoryWriter
+        attr_accessor :path
+        private :path=
+
+        attr_accessor :hosts
+        private :hosts=, :hosts
+
+        def initialize path = nil
+          self.path = path || generate_random_filename
+          self.hosts = []
+        end
+
+        def add_host host
+          hosts << host
+          hosts.uniq! &:ip_address
+        end
+
+        def generate_random_filename
+          name = [
+            'inventory',
+            Process.pid,
+            Time.now.to_i,
+            rand(9_999_999_999).to_s.rjust(10, '0')
+          ].join('-')
+        end
+
+        def write_file
+          File.open path, 'w' do |inventory|
+            hosts.sort_by(&:name).each do |h|
+              inventory.puts "#{h.inventory_name} ansible_host=#{h.ip_address} ansible_user=#{h.ssh_username} ansible_ssh_private_key_path=#{h.ssh_key} ansible_ssh_extra_args=\"#{h.ssh_extra_args}\""
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,13 +2,14 @@ module BarkingIguana
   module Compound
     module Ansible
       class Playbook
-        attr_accessor :file, :inventory_path, :limit_pattern, :run_from, :user_name, :private_key_file, :io, :output_verbosity, :show_diff
+        attr_accessor :file, :inventory_paths, :limit_pattern, :run_from, :user_name, :private_key_file, :io, :output_verbosity, :show_diff
 
         def initialize file, run_from: nil
           self.file = file
           self.run_from = run_from
           self.output_verbosity = 0
           self.show_diff = false
+          self.inventory_paths = []
         end
 
         def verbosity n
@@ -27,7 +28,7 @@ module BarkingIguana
         end
 
         def inventory name
-          self.inventory_path = name
+          self.inventory_paths << name
           self
         end
 
@@ -67,17 +68,13 @@ module BarkingIguana
 
         # TODO: Symlink the playbook to wrapper_playbook.path
         # so we can use the group_vars, host_vars, etc.
-        def playbook_path
+        def playbook_paths
           return file unless run_from
           tempfile = wrapper_playbook
           FileUtils.symlink file, tempfile
           tempfile
         end
 
-        def wrapper_playbook_content
-          "---\n- include: #{file}"
-        end
-
         def wrapper_playbook
           @wrapper_playbook ||= begin
             name = [
@@ -91,13 +88,16 @@ module BarkingIguana
         end
 
         def command
-          c = "env ANSIBLE_RETRY_FILES_ENABLED=no ansible-playbook #{playbook_path} -i #{inventory_path}"
-          c << " -l #{limit_pattern}," unless limit_pattern.nil?
-          c << " -u #{user_name}" unless user_name.nil?
-          c << " -#{'v' * output_verbosity}" if output_verbosity > 0
-          c << " --diff" if show_diff
-          c << " --private-key=#{private_key_file}" unless private_key_file.nil?
-          c
+          c = ["env ANSIBLE_RETRY_FILES_ENABLED=no ansible-playbook #{playbook_paths}"]
+          inventory_paths.each do |i|
+            c << "-i #{i}"
+          end
+          c << "-l #{limit_pattern}," unless limit_pattern.nil?
+          c << "-u #{user_name}" unless user_name.nil?
+          c << "-#{'v' * output_verbosity}" if output_verbosity > 0
+          c << "--diff" if show_diff
+          c << "--private-key=#{private_key_file}" unless private_key_file.nil?
+          c.join ' '
         end
       end
     end

data/lib/barking_iguana/compound/command_line_client.rb

@@ -0,0 +1,25 @@
+module BarkingIguana
+  module Compound
+    class CommandLineClient
+      attr_accessor :argv
+      private :argv=, :argv
+
+      def initialize argv
+        self.argv = argv
+      end
+
+      def run
+        # TODO: Make it possible to select the test to run if desired
+        test_suite.run
+      end
+
+      def test_suite
+        @test_suite ||= TestSuite.new('test/compound', control_directory: working_directory)
+      end
+
+      def working_directory
+        Dir.pwd
+      end
+    end
+  end
+end

data/lib/barking_iguana/compound/host.rb

@@ -1,14 +1,27 @@
 module BarkingIguana
   module Compound
     class Host
-      attr_accessor :name, :uri, :state
+      attr_accessor :inventory_name, :ip_address, :state
 
-      def initialize(name:, uri:)
-        self.name = name
-        self.uri = uri
+      def initialize(name:, ip_address:)
+        self.inventory_name = name
+        self.ip_address = ip_address
         self.state = 'unknown'
       end
 
+      def name
+        @name ||= inventory_name.gsub(/[^a-z0-9\-]/, '-')
+      end
+
+      def <=> other
+        name <=> other.name
+      end
+      include Comparable
+
+      def assign_ip_address new_ip_address
+        self.ip_address = new_ip_address
+      end
+
       def ssh_key
         "#{ENV['HOME']}/.vagrant.d/insecure_private_key"
       end
@@ -16,6 +29,10 @@ module BarkingIguana
       def ssh_username
         'vagrant'
       end
+
+      def ssh_extra_args
+        '-o StrictHostKeyChecking=no'
+      end
     end
   end
 end

data/lib/barking_iguana/compound/host_manager.rb

@@ -12,9 +12,6 @@ module BarkingIguana
 
       def initialize hosts = [], implementation_options = {}
         self.hosts = hosts
-        if hosts.any? { |h| h.uri !~ /^10\.8\./ }
-          raise "Your hosts must be in the 10.8/16 CIDR to be managed by me"
-        end
         self.implementation = Vagrant.new self, implementation_options
         implementation.prepare
       end

data/lib/barking_iguana/compound/server_spec.rb

@@ -40,7 +40,7 @@ class ServerSpec
   end
 
   def root_dir
-    stage.stage_file_root
+    stage.directory
   end
 
   def hosts

data/lib/barking_iguana/compound/test.rb

@@ -20,17 +20,13 @@ module BarkingIguana
       end
 
       def stages
-        return [ TestStage.new(self, directory) ] if simple_test?
         Dir[directory + '/*'].select { |d| File.directory? d }.map { |s| TestStage.new self, File.basename(s) }
       end
 
-      def simple_test?
-        File.exists? "#{directory}/playbook.yml"
-      end
-
       def run
         benchmark "test #{name}" do
           begin
+            logger.debug { "#{name}: found #{stages.size} stages: #{stages.map(&:name).map(&:inspect).join(', ')}" }
             stages.each &:run
           ensure
             teardown
@@ -60,7 +56,11 @@ module BarkingIguana
       end
 
       def host_manager
-        @host_manger ||= HostManager.new(hosts, driver_options)
+        @host_manger ||= begin
+          # FIXME: Implement uniqueness operators on Host
+          hosts = stages.map(&:hosts).flatten.uniq(&:ip_address).sort
+          HostManager.new(hosts, driver_options)
+        end
       end
 
       def driver_options
@@ -76,8 +76,7 @@ module BarkingIguana
       end
 
       def hosts
-        # FIXME: Implement uniqueness operators on Host
-        stages.map(&:hosts).flatten.uniq { |h| h.uri }
+        host_manager.all
       end
     end
   end

data/lib/barking_iguana/compound/test_stage.rb

@@ -1,11 +1,11 @@
 module BarkingIguana
   module Compound
     class TestStage
-      attr_accessor :test, :stage_directory
+      attr_accessor :test, :directory
 
-      def initialize test, stage_directory
+      def initialize test, directory
         self.test = test
-        self.stage_directory = stage_directory
+        self.directory = directory
       end
 
       def actions
@@ -26,34 +26,68 @@ module BarkingIguana
       end
 
       def name
-        return if test.simple_test?
-        stage_directory
+        directory
       end
 
       def display_name
-        return test.name if test.simple_test?
-        test.name + ' stage ' + stage_directory
+        test.name + ' stage ' + directory
       end
 
       def inventory_path
-        File.join stage_file_root, 'inventory'
+        @inventory_path ||= stage_file_with_fallback('inventory')
       end
 
-      def stage_file_root
-        return test.directory if test.simple_test?
-        File.expand_path stage_directory, test.directory
+      def stage_directory
+        File.expand_path directory, test.directory
+      end
+
+      def stage_file_with_fallback file_name
+        logger.debug { "Searching for #{file_name.inspect}" }
+        stage_file = File.expand_path file_name, stage_directory
+        logger.debug { "Checking #{stage_file.inspect}" }
+        if File.exists? stage_file
+          logger.debug { "Found #{file_name.inspect} at #{stage_file.inspect}" }
+          return stage_file
+        end
+        test_file = File.expand_path file_name, test.directory
+        logger.debug { "Assuming it'll be at #{test_file.inspect}" }
+        test_file
       end
 
       def playbook_path
-        "#{stage_file_root}/playbook.yml"
+        @playbook_path ||= stage_file_with_fallback('playbook.yml')
       end
 
-      def inventory
+      def original_inventory
         Ansible.inventory inventory_path
       end
 
+      def generated_inventory
+        @generated_inventory ||= generate_inventory
+      end
+
+      def generate_inventory
+        benchmark "#{name}: generating inventory for test stage" do
+          Dir.mktmpdir('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|
+              benchmark "#{name}: generating connection inventory at #{connection_file}" do
+                test.hosts.each do |h|
+                  i.add_host h
+                end
+                i.write_file
+              end
+            end
+            original_file = File.expand_path 'original', d
+            logger.debug { "#{name}: copying original inventory to #{original_file} from #{inventory_path}" }
+            FileUtils.copy inventory_path, original_file
+          end
+        end
+      end
+
       def hosts
-        inventory.hosts
+        original_inventory.hosts
       end
 
       def control_directory
@@ -61,7 +95,7 @@ module BarkingIguana
       end
 
       def playbook
-        Ansible.playbook(playbook_path, run_from: control_directory).inventory(inventory.path).private_key("#{ENV['HOME']}/.vagrant.d/insecure_private_key").user('vagrant').stream_to(logger).verbosity(2).diff
+        Ansible.playbook(playbook_path, run_from: control_directory).inventory(generated_inventory).stream_to(logger).verbosity(2).diff
       end
 
       def suite
@@ -69,9 +103,9 @@ module BarkingIguana
       end
 
       def setup
-        desired_hosts = inventory.hosts.map { |h| h.name  }.sort
+        desired_hosts = original_inventory.hosts.sort.map(&:name)
         logger.debug { "Desired hosts for #{display_name}: #{desired_hosts.join(', ')}" }
-        active_hosts = host_manager.active.map { |h| h.name }.sort
+        active_hosts = host_manager.active.sort.map(&:name)
         logger.debug { "Active hosts for #{display_name}: #{active_hosts.join(', ')}" }
         hosts_to_launch = desired_hosts - active_hosts
         logger.debug { "Launch hosts for #{display_name}: #{hosts_to_launch.join(', ')}" }
@@ -86,8 +120,14 @@ module BarkingIguana
       end
 
       def converge
-        return unless File.exists? playbook_path
+        unless File.exists? playbook_path
+          logger.debug { "Not running anything because #{playbook_path.inspect} does not exist" }
+          return
+        end
         playbook.run
+      ensure
+        logger.debug { "Removing generated inventory from #{generated_inventory}" }
+        # FileUtils.rm_r generated_inventory
       end
 
       def verify

data/lib/barking_iguana/compound/test_suite.rb

@@ -1,6 +1,10 @@
 module BarkingIguana
   module Compound
     class TestSuite
+      def self.define_rake_tasks
+        new.define_rake_tasks
+      end
+
       def define_rake_tasks
         Rake::Task.define_task name do
           run
@@ -11,29 +15,20 @@ module BarkingIguana
             test.run
           end.add_description "Run #{test.name} test from #{name} suite"
 
-          Rake::Task.define_task "#{name}:#{test.name}:destroy" do
-            test.teardown
-          end.add_description "Tear down #{test.name} test from #{name} suite"
-
-          test.stages.each do |stage|
-            stage.actions.each do |action|
-              Rake::Task.define_task "#{name}:#{test.name}:#{action}" do
-                stage.public_send action
-              end.add_description "Run action #{action} of the #{test.name} test from #{name} suite"
-            end
-          end if test.simple_test?
-
           test.stages.each do |stage|
             Rake::Task.define_task "#{name}:#{test.name}:#{stage.name}" do
               stage.run
-            end.add_description "Run stage #{stage.name} of the #{test.name} test from #{name} suite"
-
+            end.add_description "Run #{stage.name} stage of the #{test.name} test from #{name} suite"
             stage.actions.each do |action|
               Rake::Task.define_task "#{name}:#{test.name}:#{stage.name}:#{action}" do
                 stage.public_send action
-              end.add_description "Run action #{action} of stage #{stage.name} of the #{test.name} test from #{name} suite"
+              end.add_description "Run action #{action} for #{stage.name} stage of the #{test.name} test from #{name} suite"
             end
-          end unless test.simple_test?
+          end
+
+          Rake::Task.define_task "#{name}:#{test.name}:destroy" do
+            test.teardown
+          end.add_description "Tear down #{test.name} test from #{name} suite"
         end
       end
 
@@ -43,9 +38,17 @@ module BarkingIguana
       attr_accessor :directory
       private :directory=
 
-      def initialize directory, control_directory
-        self.directory = directory
-        self.control_directory = control_directory
+      def initialize(directory = nil, control_directory: nil)
+        self.control_directory = control_directory || guess_directory
+        self.directory = directory || File.expand_path("test/compound", control_directory)
+      end
+
+      def guess_directory
+        caller.detect do |trace|
+          path = trace.split(/:/, 2)[0]
+          file = File.basename path
+          break File.dirname path if file == 'Rakefile'
+        end
       end
 
       def tests

data/lib/barking_iguana/compound/vagrant.rb

@@ -42,13 +42,26 @@ class Vagrant
     end
   end
 
-  def write_file
+  def write_vagrant_file
     logger.debug { "Writing Vagrantfile to #{vagrant_file_path}" }
     File.open vagrant_file_path, 'w' do |f|
       f.puts vagrant_file_content
     end
   end
-  alias_method :prepare, :write_file
+
+  def assign_ip_addresses
+    hosts.each do |h|
+      next if valid_ip_address? h.ip_address
+      ip_address = next_available_ip_address
+      logger.debug { "Assigning #{h.name} an IP address: #{ip_address}" }
+      h.assign_ip_address ip_address
+    end
+  end
+
+  def prepare
+    assign_ip_addresses
+    write_vagrant_file
+  end
 
   def vagrant_file_content
     ERB.new(vagrant_file_template).result binding
@@ -73,7 +86,25 @@ class Vagrant
     end
   end
 
+  private
+
   def hosts
     manager.hosts
   end
+
+  def next_available_ip_address
+    unassigned_ip_addresses.shift
+  end
+
+  def valid_ip_address? ip_address
+    ip_address =~ /^10\.8\./
+  end
+
+  def unassigned_ip_addresses
+    @unassigned_ip_addresses ||= begin
+      assignable_ip_addresses = (10..200).to_a.map { |dd| "10.8.42.#{dd}" }
+      assigned_ip_addresses = hosts.map(&:ip_address)
+      assignable_ip_addresses - assigned_ip_addresses
+                                 end
+  end
 end

data/lib/barking_iguana/compound/version.rb

@@ -1,5 +1,5 @@
 module BarkingIguana
   module Compound
-    VERSION = "0.1.1"
+    VERSION = "0.1.4"
   end
 end

data/lib/barking_iguana/compound.rb

@@ -11,12 +11,15 @@ require 'barking_iguana/compound/version'
 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/playbook'
+require 'barking_iguana/compound/command_line_client'
+require 'barking_iguana/compound/host_manager'
+require 'barking_iguana/compound/host'
+require 'barking_iguana/compound/server_spec'
 require 'barking_iguana/compound/test_stage'
 require 'barking_iguana/compound/test'
 require 'barking_iguana/compound/test_suite'
-require 'barking_iguana/compound/host_manager'
-require 'barking_iguana/compound/host'
 require 'barking_iguana/compound/vagrant'
 
 module BarkingIguana

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barking_iguana-compound
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Craig R Webster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,7 +167,8 @@ dependencies:
 description: Compound testing of Ansible playbooks
 email:
 - craig@barkingiguana.com
-executables: []
+executables:
+- compound
 extensions: []
 extra_rdoc_files: []
 files:
@@ -179,11 +180,18 @@ files:
 - barking_iguana-compound.gemspec
 - bin/console
 - bin/setup
+- docs/CHANGELOG.md
+- docs/TODO.md
+- docs/_config.yml
+- docs/index.md
+- exe/compound
 - lib/barking_iguana/compound.rb
 - lib/barking_iguana/compound/ansible.rb
 - lib/barking_iguana/compound/ansible/inventory.rb
 - 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/command_line_client.rb
 - lib/barking_iguana/compound/host.rb
 - lib/barking_iguana/compound/host_manager.rb
 - lib/barking_iguana/compound/server_spec.rb