controlrepo 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 074cfbffbc367cb76428c30a900b1bc1b2dc7525
-  data.tar.gz: f2901badd0097e028d2cc835ae0fe5c5eae7bc8a
+  metadata.gz: 1a2459c4880e5865531609c8b94a3d7a1c492133
+  data.tar.gz: 32094fc438825fb19b1d40cfde19b56837e24566
 SHA512:
-  metadata.gz: ceb858045e2bbc73fab0873d65a617338b980c1d2ecfd06aa37dcb60be0c821ec91f1671fb19a1155438735cce20cace0bf2a9206097f63f799879487e93b995
-  data.tar.gz: 281451f8f1c470f8ff9a31c8c57f1f2a4f51566b26bf72833a7ce731fac1647575a0cb608daab0671fe2f2d00f6c47c61fd3fdd80dee0a9acf82f51d1dac08ae
+  metadata.gz: ccc385b3ce617f8f28146fe78cf10ef4c39a21e317ad572cd358bcf1668a818375e33c1c94451cca9bfdc0351b994819183970b187b95f4d4e8a8550db6d0c77
+  data.tar.gz: 8fc06a94e542a89c3cd5a19907fdedb47c249fc7faf00e4ac967974ddc8b36c0dbeb4419a567bfc82970ad58bdc34493838cbf8f89f8def9a702fd1d9fd4616c

data/.gitignore

@@ -1 +1,2 @@
-.DS_Store
+.DS_Store
+*.gem

data/README.md

@@ -6,7 +6,7 @@ This gem gives you a bunch of tools to use for testing and generally managing Pu
 
 This toolset has two distinct ways of being used, easy mode and hard mode.
 
-### Easy Mode
+## Easy Mode
 
 The object of *easy mode* is to allow people to run simple `it { should compile }` acceptance tests without needing to set up any of the extra stuff required by the rspec-puppet testing framework.
 
@@ -14,7 +14,7 @@ The object of *easy mode* is to allow people to run simple `it { should compile
 
 A stretch goal is to also include acceptance testing, allowing people to spin up boxes for each role they have and test them before merging code into development environments or production. At the moment we can't do this, hold tight.
 
-#### Easy mode config
+### Easy mode config
 
 The whole idea of easy mode is that we should just be able to write down which classes we want to test on which machines and this tool should be able to do the rest. This all has to be set up somewhere, this is **spec/controlrepo.yaml** which looks something like this:
 
@@ -50,15 +50,15 @@ test_matrix:
 
 It consists of the following sections:
 
-##### Classes:
+#### Classes:
 
 This is where we list all of the classes that we want to test, normally this will just be a list of roles. Note that these classes must *actually exist* for reasons that should be obvious.
 
-##### Nodes:
+#### Nodes:
 
 Each node in the list refers one of two things depending on weather we are running **spec** or **acceptance** tests. If we are running **spec** tests each node refers to the name of a [fact set](#fact-sets) because this will be the set of facts that the `it { should compile }` test will be run against. If we are are running **acceptance** tests then each node will refer to a *nodeset* file which we can generate (or at least try to) using the `generate_nodesets` rake task. For acceptance testing the nodeset file will tell us how to spin up the VMs for each machine.
 
-##### Groups:
+#### Groups:
 
 Groups are used to save us a bit of time and code (if you can call yaml that). Unsurprisingly a group is a way to bundle either classes or nodes into a group that we can refer to but it's name instead of repeating ourselves a whole bunch. There are 2 **default groups:**
 
@@ -69,7 +69,7 @@ You can guess what they are for I hope.
 
 *Note that groups CANNOT contain a mix of classes and nodes, only one or the other.*
 
-##### Test Matrix:
+#### Test Matrix:
 
 This is the section of th config file that makes the magic happen. In the test matrix we choose on which nodes we will tests which classes. You can use groups anywhere here as you can see in the example above. We also have the option of using *include* and *exclude* which will be useful if you have a lot of groups.
 
@@ -86,12 +86,92 @@ This is assuming that you have all of your linux nodes in the `linux_nodes` grou
 
 When setting up your tests matrix don't worry too much about using groups that will cause duplicate combinations of `node -> class` pairs. The rake tasks run deduplication before running any of the tests to make sure that we are not wasting time. This happens at runtime and does not affect the file or anything.
 
-#### Lets go!
+## Hiera Data
 
-Now to run the spec tests just do a `bundler exec rake controlrepo_spec`
+If you have hiera data inside your controlrepo (or somewhere else) the Controlrepo gem can be configured to use it. Just dump your `hiera.yaml` file from the puppet master into the `spec/` directory and you are good to go. **NOTE:** This assumes that the path to your hiera data (datadir) is relative to the root of the controlrepo, if not it will fall over
 
+## R10k.yaml
 
-### Hard mode
+For the Controlrepo gem to be able to clone the controlrepo (itself) from git (into a temp dir) it needs an `r10k.yaml` file under the `spec/` directory. Don't worry about any of the paths here, we dynamically generate and override them. I realise that this is kind of redundant and will be looking into changing it in the future.
+
+TODO: Look into this ^
+
+## pre_conditions
+
+If your spec tests are failing because if dependencies on the (closed source) PE modules, don't stress, there is a way around this! Let's start with an example: Somewhere in my puppet code I am managing something that needs to restart the Puppet Server i.e.
+
+```puppet
+file { '/etc/puppetlabs/puppet/puppet.conf':
+  ensure  => file,
+  content => '#nothing',
+  notify  => Service['pe-puppetserver'], # This will fail without the PE module!
+  }
+```
+
+If we try to compile a catalog against this code it will fail because we are not including the PE class that manages `Service['pe-puppetserver']`, therefore it is not in the catalog and we cannot establist dependencies upon it. 
+
+If we run into a situations like this we can use the `spec/pre_conditions` folder to get around them e.g. Putting this in the `spec/pre_conditions` folder will solve our issues:
+
+```puppet
+service { 'pe-puppetserver':
+  ensure => 'running',
+}
+```
+
+This is because anything in this folder will get add to the catalog along with the class (role) we are testing. 
+
+NOTE: [resource collector ovverides](https://docs.puppetlabs.com/puppet/latest/reference/lang_resources_advanced.html#amending-attributes-with-a-collector) could be useful in this situation.
+
+## Lets go!
+
+Now to **run the spec tests** just do a:
+
+`bundler exec rake controlrepo_spec`
+
+## Acceptance testing
+
+Now that we have a lot of stuff set up, we can also run acceptance testing! This will do much the same thing as the spec testing, except on an actual box. (It will run `include role::your_role` on the server and check for errors)
+
+This does however take a little more preparation. The main thing we need is that we need to know which nodes to spin up in order to do the testing. We use Beaker to actually interact with the hypervisor of choice and therefore we use their [nodeset file syntax](https://github.com/puppetlabs/beaker/blob/master/docs/Example-Vagrant-Hosts-Files.md). The only thing we need to do is **name the nodes the same aswe do for spec tests** and **have all the nodes in the same file**.
+
+Here is an example:
+
+```yaml
+# spec/acceptance/nodesets/controlrepo.yaml
+HOSTS:
+  centos6a:
+    roles:
+      - agent
+    platform: el-6-64
+    box: puppetlabs/centos-6.6-64-puppet
+    box_url: https://atlas.hashicorp.com/puppetlabs/boxes/centos-6.6-64-puppet
+    hypervisor: vagrant_virtualbox
+  centos7b:
+    roles:
+      - agent
+    platform: el-7-64
+    box: puppetlabs/centos-7.0-64-puppet
+    box_url: https://atlas.hashicorp.com/puppetlabs/boxes/centos-7.0-64-puppet
+    hypervisor: vagrant_virtualbox
+  ubuntu1404a:
+    roles:
+      - agent
+    platform: ubuntu-14.04-64
+    box: puppetlabs/ubuntu-14.04-64-puppet
+    box_url: https://atlas.hashicorp.com/puppetlabs/boxes/ubuntu-14.04-64-puppet
+    hypervisor: vagrant_virtualbox
+```
+
+Now when we run:
+
+`bundle exec rake controlrepo_acceptance`
+
+It will use the same test matrix we have already defined in `controlrepo.yaml` and spin up each node and do the testing.
+
+NOTE: The same test deduplication will be applied here as it is in spec tests, also; macines will be classified with **one** role, run, destroyed, re-created and then classified with the next role.
+
+
+## Hard mode
 
 The point of *hard mode* is to give people who are familiar with RSpec testing with puppet a set of useful tools that they can mix into their tests to save some hassle. We also want to help in getting your tests set up by automatically generating `.fixtures.yml` and nodesets.
 

data/controlrepo.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "controlrepo"
-  s.version     = "1.0.0"
+  s.version     = "1.1.0"
   s.authors     = ["Dylan Ratcliffe"]
   s.email       = ["dylan.ratcliffe@puppetlabs.com"]
   s.homepage    = ""
@@ -22,5 +22,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rspec-puppet'
   s.add_runtime_dependency 'rspec'
   s.add_runtime_dependency 'bundler'
+  s.add_runtime_dependency 'r10k'
   s.add_runtime_dependency 'puppet'
 end

data/lib/controlrepo/beaker.rb

@@ -151,7 +151,7 @@ class Controlrepo
       network_manager = ::Beaker::NetworkManager.new(options,logger)
 
       # Hack the network manager to smash our host in there without provisioning
-      network_manager.instance_variable_set(:@hosts,host)
+      network_manager.instance_variable_set(:@hosts,[host])
 
       # Now that we have a working network manager object, we can provision, but only if
       # we need to, ahhh smart...
@@ -162,11 +162,6 @@ class Controlrepo
         network_manager.configure
       end
 
-      if opts[:deploy_controlrepo]
-        # Get the code onto the host
-        Controlrepo::Beaker.deploy_controlrepo_on(host,repo)
-      end
-
       # Actually run the tests
       manifest = "include #{puppet_class}"
 

data/lib/controlrepo/rake_tasks.rb

@@ -104,9 +104,10 @@ task :controlrepo_autotest_prep do
   # Deduplicate and write the tests (Spec and Acceptance)
   Controlrepo::Test.deduplicate(@config.tests).each do |test|
     @config.write_spec_test("#{@repo.tempdir}/spec/classes",test)
-    @config.write_acceptance_test("#{@repo.tempdir}/spec/acceptance",test)
   end
 
+  @config.write_acceptance_tests("#{@repo.tempdir}/spec/acceptance",Controlrepo::Test.deduplicate(@config.tests))
+
   # Parse the current hiera config, modify, and write it to the temp dir
   hiera_config = @repo.hiera_config
   hiera_config.each do |setting,value|
@@ -125,9 +126,16 @@ task :controlrepo_autotest_spec do
   Dir.chdir(@repo.tempdir) do
     #`bundle install --binstubs`
     #`bin/rake spec_standalone`
-    exec("bundle install --binstubs; bundle exec rake spec_standalone")
+    exec("bundle install --without acceptance; bundle exec rake spec_standalone")
+  end
+end
+
+task :controlrepo_autotest_acceptance do
+  Dir.chdir(@repo.tempdir) do
+    #`bundle install --binstubs`
+    #`bin/rake spec_standalone`
+    exec("bundle install; bundle exec rake acceptance")
   end
-  # TODO: Look at how this outputs and see if it needs to be improved
 end
 
 task :controlrepo_spec => [
@@ -135,6 +143,13 @@ task :controlrepo_spec => [
   :controlrepo_autotest_spec
   ]
 
+task :controlrepo_acceptance => [
+  :controlrepo_autotest_prep,
+  :controlrepo_autotest_acceptance
+  ]
+
+
+
 task :r10k_deploy_local do
   require 'controlrepo/testconfig'
   @repo = Controlrepo.new

data/lib/controlrepo/testconfig.rb

@@ -40,6 +40,17 @@ class Controlrepo
       end
     end
 
+    def pre_condition
+      # Read all the pre_conditions and return the string
+      spec_dir = Controlrepo.new.spec_dir
+      puppetcode = []
+      Dir["#{spec_dir}/pre_conditions/*.pp"].each do |condition_file|
+        puppetcode << File.read(condition_file)
+      end
+      return false if puppetcode.count == 0
+      puppetcode.join("\n")
+    end
+
     def r10k_deploy_local(repo = Controlrepo.new)
       require 'controlrepo'
       tempdir = Dir.mktmpdir('r10k')
@@ -74,12 +85,10 @@ class Controlrepo
       File.write("#{location}/#{randomness}_#{test.to_s}_spec.rb",ERB.new(spec_template, nil, '-').result(binding))
     end
 
-    def write_acceptance_test(location, test)
+    def write_acceptance_tests(location, tests)
       template_dir = File.expand_path('../../templates',File.dirname(__FILE__))
       acc_test_template = File.read(File.expand_path('./acceptance_test_spec.rb.erb',template_dir))
-      raise 'We only support writing acceptance tests for one node at the moment' unless test.nodes.count == 1
-      randomness = (0...6).map { (65 + rand(26)).chr }.join
-      File.write("#{location}/#{randomness}_#{test.to_s}_spec.rb",ERB.new(acc_test_template, nil, '-').result(binding))
+      File.write("#{location}/acceptance_spec.rb",ERB.new(acc_test_template, nil, '-').result(binding))
     end
 
     def write_spec_helper_acceptance(location, repo)

data/lib/controlrepo.rb

@@ -313,11 +313,4 @@ class Controlrepo
     end
     return nil
   end
-end
-
-
-
-
-
-
-
+end

data/templates/Gemfile.erb

@@ -1,5 +1,13 @@
-gem 'puppet'
-gem 'rspec'
-gem 'rspec-puppet'
-gem 'rake'
-gem 'puppetlabs_spec_helper'
+source 'https://rubygems.org'
+
+group :spec do
+  gem 'rspec-puppet'
+  gem 'puppetlabs_spec_helper'
+end
+
+group :acceptance do
+  gem 'beaker-rspec'
+  gem 'controlrepo', :git => 'https://github.com/dylanratcliffe/controlrepo_gem.git'
+end
+
+gem 'rake'

data/templates/Rakefile.erb

@@ -1 +1,6 @@
-require 'puppetlabs_spec_helper/rake_tasks'
+require 'puppetlabs_spec_helper/rake_tasks'
+
+desc "Run acceptance tests"
+RSpec::Core::RakeTask.new(:acceptance) do |t|
+  t.pattern = 'spec/acceptance'
+end

data/templates/acceptance_test_spec.rb.erb

@@ -1,18 +1,95 @@
 require 'spec_helper_acceptance'
 
+describe "Acceptance Testing" do
+  before :each do |test|
+    #try to find the indentation level and mirror it in beaker logger
+    padding = ""
+    # Get the depth and add that as padding
+    (test.metadata[:scoped_id].split(':').count - 1).times do
+      padding << "  "
+    end
+    logger.line_prefix = padding
+  end
+<% tests.each do |test| -%>
 <% test.nodes.each do |node| -%>
-describe '<%= node.name %>' do
-<% test.classes.each do |cls| %>
-  context 'when classified with <%= cls.name %>' do
-    role = '<%= cls.name %>'
-    apply_manifest(role, :catch_failures => true)
-<% if test.options[:runs_for_idempotency] -%>
-<% (test.options[:runs_for_idempotency] - 1).times do -%>
-    apply_manifest(role, :catch_failures => true)
+<% test.classes.each do |cls| -%>
+  describe "<%= cls.name %> on <%= node.name %>" do
+    after :all do
+      logger.line_prefix = "  "
+      $nwm.cleanup
+    end
+
+    describe "provisioning <%= node.name %>" do
+      #after :all do
+      #  # Reset the HOSTS hash to its original value
+      #  options[:HOSTS] = $original_hosts
+      #end
+
+      it "should be able to set up a Beaker Network Manger object to handle the hypervisors" do
+        current_opts = {}
+        OPTIONS.each do |opt,val|
+          if opt == :HOSTS
+            val.each do |k,v|
+              if k == :<%= node.name %>
+                current_opts[:HOSTS] = {k => v}
+              end
+            end
+          else
+            current_opts[opt] = val
+          end
+        end
+
+        # I copied this code off the internet, basically it allows us
+        # to refer to each key as either a string or an object
+        current_opts.default_proc = proc do |h, k|
+          case k
+            when String then sym = k.to_sym; h[sym] if h.key?(sym)
+            when Symbol then str = k.to_s; h[str] if h.key?(str)
+          end
+        end
+
+        expect {
+          $nwm = Beaker::NetworkManager.new(current_opts,logger)
+        }.to_not raise_exception
+      end
+
+      it "should be able to provision using Beaker" do
+        expect {
+          $nwm.provision
+          $nwm.proxy_package_manager
+          $nwm.validate
+          $nwm.configure
+          $hosts = $nwm.instance_variable_get(:@hosts)
+        }.not_to raise_exception
+      end
+    end
+
+    describe "copying code to <%= node.name %>" do
+      it "should copy the code successfully" do
+        expect {
+          scp_to $hosts, 'etc', '/'
+        }.not_to raise_exception
+      end
+    end
+
+    describe "running puppet" do
+      it "should run with no errors" do
+        expect {
+          apply_manifest_on($hosts,"include <%= cls.name %>",{:catch_failures => true})
+        }.not_to raise_exception
+      end
+    end
+
+    describe "checking for idempotency" do
+      it "should run with no changes" do
+        expect {
+          apply_manifest_on($hosts,"include <%= cls.name %>",{:catch_changes => true})
+        }.not_to raise_exception
+      end
+    end
+  end
+<% end -%>
 <% end -%>
 <% end -%>
-    apply_manifest(role, :catch_changes => true)
-  end
-<% end %>
 end
-<% end %>
+

data/templates/spec_helper_acceptance.rb.erb

@@ -1,24 +1,71 @@
-require 'beaker-rspec'
+require 'beaker'
+require 'beaker-rspec/beaker_shim' # This overloads Rspec's methods and provides the interface between beaker and RSpec
+require "beaker-rspec/helpers/serverspec"
+include BeakerRSpec::BeakerShim
+require 'controlrepo/beaker'
 
-scp_to hosts, '<%= repo.tempdir %>/etc', '/etc' # Check that this wil work recursively
 
+#scp_to hosts, '<%= repo.tempdir %>/etc', '/'
 RSpec.configure do |c|
-  # Project root
-  proj_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  # Enable color
+  c.color = true
+  c.tty = true
 
   # Readable test descriptions
   c.formatter = :documentation
 
+  # Define persistant hosts setting
+  c.add_setting :hosts, :default => []
+  # Define persistant options setting
+  c.add_setting :options, :default => {}
+  # Define persistant metadata object
+  c.add_setting :metadata, :default => {}
+  # Define persistant logger object
+  c.add_setting :logger, :default => nil
+  # Define persistant default node
+  c.add_setting :default_node, :default => nil
+
+  #default option values
+  defaults = {
+    :nodeset     => 'controlrepo',
+  }
+  #read env vars
+  env_vars = {
+    :color       => ENV['BEAKER_color'] || ENV['RS_COLOR'],
+    :nodeset     => ENV['BEAKER_set'] || ENV['RS_SET'],
+    :nodesetfile => ENV['BEAKER_setfile'] || ENV['RS_SETFILE'],
+    :provision   => ENV['BEAKER_provision'] || ENV['RS_PROVISION'],
+    :keyfile     => ENV['BEAKER_keyfile'] || ENV['RS_KEYFILE'],
+    :debug       => ENV['BEAKER_debug'] || ENV['RS_DEBUG'],
+    :destroy     => ENV['BEAKER_destroy'] || ENV['RS_DESTROY'],
+  }.delete_if {|key, value| value.nil?}
+  #combine defaults and env_vars to determine overall options
+  options = defaults.merge(env_vars)
+
+  # process options to construct beaker command string
+  nodesetfile = options[:nodesetfile] || File.join('spec/acceptance/nodesets',"#{options[:nodeset]}.yml")
+  fresh_nodes = options[:provision] == 'no' ? '--no-provision' : nil
+  keyfile = options[:keyfile] ? ['--keyfile', options[:keyfile]] : nil
+  debug = options[:debug] ? ['--log-level', 'debug'] : nil
+  color = options[:color] == 'no' ? ['--no-color'] : nil
+
   # Configure all nodes in nodeset
-  #c.before :suite do
-  #  # Install module
-  #  puppet_module_install(:source => proj_root, :module_name => 'virtualbox')
-  #  hosts.each do |host|
-  #    on host, puppet('module','install','puppetlabs-stdlib'), { :acceptable_exit_codes => [0,1] }
-  #    on host, puppet('module','install','puppetlabs-apt'), { :acceptable_exit_codes => [0,1] }
-  #    on host, puppet('module','install','stahnma-epel'), { :acceptable_exit_codes => [0,1] }
-  #    on host, puppet('module','install','camptocamp-archive'), { :acceptable_exit_codes => [0,1] }
-  #    on host, puppet('module','install','darin-zypprepo'), { :acceptable_exit_codes => [0,1] }
-  #  end
-  #end
-end
+  c.setup([fresh_nodes, '--hosts', nodesetfile, keyfile, debug, color].flatten.compact)
+  #c.provision
+  #c.validate
+  #c.configure
+
+  # Destroy nodes if no preserve hosts
+  c.after :suite do
+    case options[:destroy]
+    when 'no'
+      # Don't cleanup
+    when 'onpass'
+      c.cleanup if RSpec.world.filtered_examples.values.flatten.none?(&:exception)
+    else
+      c.cleanup
+    end
+  end
+end
+
+OPTIONS = options

data/templates/test_spec.rb.erb

@@ -5,6 +5,13 @@ describe "<%= cls.name %>" do
 <% test.nodes.each do |node| -%>
   context "using fact set <%= node.name %>" do
     let(:facts) { <%= node.fact_set %> }
+<% if pre_condition -%>
+    let(:pre_condition) { 
+      pp = <<END
+<%= pre_condition.chomp %>
+END
+    }
+<% end -%>
     it { should compile }
   end
 <% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: controlrepo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dylan Ratcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: r10k
+  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: puppet
   requirement: !ruby/object:Gem::Requirement