controlrepo 2.0.8 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c0027f7a17919e9ea429031c4943f27160ea94d
-  data.tar.gz: 9cf2082e28f4c65aec53786cdfdb16f61b2eda21
+  metadata.gz: affb2688b3eb2928b20eba2d86c4d895e8d898aa
+  data.tar.gz: c2e4ce0fb4ac6f4c9fd9491c0448a0a11fa9d942
 SHA512:
-  metadata.gz: 8e367e9f4c634276b21199377fc9994b947d2a4b402b074bdbfb2d0f494b5292ddac880f91fcd29cc5bf9cb0af3d23ccfb51127a28150555e04d1a2d7a1b423f
-  data.tar.gz: d45b5d43bff11b379100be482e1ff9f07633e9d5ca0a7c87e095d0f06576a1a3ec35fddd69a925899c6fd3be495b4a4471a8ae6b8cfe2ff0c51cb56348cfc64a
+  metadata.gz: 7b2062b4ba321ca836a92c013b26153376e1bda26352a9d87a08146cdf1fb9efa83f965e05c7c63caf00920f5cfb1597fa484593400ace6ccaf29e8052745d93
+  data.tar.gz: 926e529e9e74fe13897c769cc38f075782e6173c8c78de9a2b4aa9dd8359be06d57ffbbd6e42e777d21ee24512e4c6c4f227d391e91bba9e2799c39371d50a27

data/README.md

@@ -12,6 +12,7 @@
     - [Hiera Data](#hiera-data)
     - [R10k.yaml](#r10kyaml)
   - [Spec testing](#spec-testing)
+    - [Adding your own spec tests](#adding-your-own-spec-tests)
   - [Acceptance testing](#acceptance-testing)
   - [Using Workarounds](#using-workarounds)
   - [Extra tooling](#extra-tooling)
@@ -299,6 +300,10 @@ This will do the following things:
   4. Install required gems into temp dir using Bundler
   5. Run the tests
 
+### Adding your own spec tests
+
+When using this gem adding your own spec tests is exactly the same as if you were to add them to a module, simply create them under `spec/{classes,defines,etc.}` in the Controlrepo and they will be run like normal, along with all of the `it { should compile }` tests.
+
 ## Acceptance testing
 
 Acceptance testing works in much the same way as spec testing except that it requires a nodeset file along with `controlrepo.yaml`
@@ -375,47 +380,122 @@ Here we are specifying custom commands to run for starting, stopping and checkin
 
 **NOTE:** If you need to run some pre_conditions during acceptance tests but not spec tests or vice versa you can check the status of the `$controlrepo_accpetance` variable. It will be `true` when run as an acceptance test and `undef` otherwise. If you want to limit pre_conditions to only certain nodes just use conditional logic based on facts like you normally would.
 
-### Other Rake tasks
+## Extra Tooling
 
-I have included a couple of little rake tasks to help get you started with testing your control repos. Set them up by adding this to your `Rakefile`
+I have provided some extra tools to use if you would prefer to write your own tests which I will go over here.
+
+### Accessing fact sets in a traditional RSpec test
+
+We can access all of our fact sets using `Controlrepo.facts`. Normally it would be implemented something like this:
 
 ```ruby
-require 'controlrepo/rake_tasks'
+Controlrepo.facts.each do |facts|
+  context "on #{facts['fqdn']}" do
+    let(:facts) { facts }
+    it { should compile }
+  end
+end
 ```
 
-The tasks are as follows:
+### Accessing Roles in a traditional RSpec test
 
-#### generate_controlrepo_yaml
+This gem allows us to easily and dynamically test all of the roles and profiles in our environment against fact sets from all of the nodes to which they will be applied. All we need to do is create a spec test that calls out to the `Controlrepo` ruby class:
 
-`bundle exec rake generate_controlrepo_yaml`
+```ruby
+require 'spec_helper'
+require 'controlrepo'
+
+Controlrepo.roles.each do |role|
+  describe role do
+    Controlrepo.facts.each do |facts|
+      context "on #{facts['fqdn']}" do
+        let(:facts) { facts }
+        it { should compile }
+      end
+    end
+  end
+end
+```
 
-This will try to generate a `controlrepo.yaml` file, it will:
+This will iterate over each role in the controlrepo and test that it compiles with each set of facts.
 
-  - Parse your environment.conf to work out where your roles and profiles might live
-  - Find your roles classes and pre-polulate them into the "classes" section
-  - Look though all of the factsets that ship with the gem, and also the ones you have created under `spec/factsets/*.json`
-  - Populate the "nodes" section with all of the factsets it finds
-  - Create node groups of windows and non-windows nodes
-  - Create a basic test_matrix
+The same can also be done with profiles just by using the profiles method instead:
+
+```ruby
+require 'spec_helper'
+require 'controlrepo'
+
+Controlrepo.profiles.each do |profile|
+  describe profile do
+    Controlrepo.facts.each do |facts|
+      context "on #{facts['fqdn']}" do
+        let(:facts) { facts }
+        it { should compile }
+      end
+    end
+  end
+end
+```
 
+It is not limited to just doing simple "It should compile" tests. You can put any tests you want in here.
 
-#### generate_nodesets
+Also since the `profiles`, `roles` and `facts` methods simply return arrays, you can iterate over them however you would like i.e. you could write a different set of tests for each profile and then just use the `facts` method to run those tests on every fact set.
 
-`bundle exec rake generate_nodesets`
+### Filtering
 
-This task will generate nodeset file required by beaker, based on the factsets that exist in the repository. If you have any fact sets for which puppetlabs has a compatible vagrant box (i.e. centos, debian, ubuntu) it will detect the version specifics and set up the nodeset file, complete with box URL. If it doesn't know how to deal with a fact set it will output a boilerplate nodeset section and comment it out.
+You can also filter your fact sets based on the value of any fact, including structured facts. (It will drill down into nested hashes and match those too, it's not just a dumb equality match)
 
-#### controlrepo_temp_create
+Just pass a hash to the `facts` method and it will return only the fact sets with facts that match the hash e.g. Testing a certain profile on against only your Windows fact sets:
 
-This will create a directory including the Controlrepo and all required modules where the environment variable `CONTROLREPO_temp` is set to. This is designed to make it easier to rebuild a cache when you are caching the modules on a build server.
+```ruby
+require 'spec_helper'
+require 'controlrepo'
+
+describe 'profile::windows_appserver' do
+  Controlrepo.facts({
+    'kernel' => 'windows'
+    }).each do |facts|
+    context "on #{facts['fqdn']}" do
+      let(:facts) { facts }
+      it { should compile }
+    end
+  end
+end
+```
 
-#### hiera_setup
+### Using hiera data (In manual tests)
 
-`bundle exec rake hiera_setup`
+You can also point these tests at your hiera data, you do this as you [normally would](https://github.com/rodjek/rspec-puppet#enabling-hiera-lookups) with rspec tests. However we do provide one helper to make this marginally easier. `Controlrepo.hiera_config` will look for hiera.yaml in the root of your control repo and also the spec directory, you will however need to set up the file itself e.g.
 
-Automatically modifies your hiera.yaml to point at the hieradata relative to it's position.
+```ruby
+require 'controlrepo'
 
-This rake task will look for a hiera.yaml file (Using the same method we use for [this](#using-hiera-data)). It will then look for a hieradata directory in the root for your control repo (needs to match [this](http://rubular.com/?regex=%2Fhiera%28%3F%3A.%2Adata%29%3F%2Fi)). It will then modify the datadirs of any backends it finds in `hiera.yaml` to point at these directories.
+RSpec.configure do |c|
+  c.hiera_config = Controlrepo.hiera_config_file
+end
+```
+
+### Extra Configuration
+
+You can modify the regexes that the gem uses to filter classes that it finds into roles and profiles. Just set up a Controlrepo object and pass regexes to the below settings.
+
+```ruby
+repo = Controlrepo.new()
+repo.role_regex = /.*/ # Tells the class how to find roles, will be applied to repo.classes
+repo.profile_regex = /.*/ # Tells the class how to find profiles, will be applied to repo.classes
+```
+
+Note that you will need to call the `roles` and `profiles` methods on the object you just instantiated, not the main class e.g. `repo.roles` not `Controlrepo.roles`
+
+### Rake tasks
+
+I have included a couple of little rake tasks to help get you started with testing your control repos. Set them up by adding this to your `Rakefile`
+
+```ruby
+require 'controlrepo/rake_tasks'
+```
+
+The tasks are as follows:
 
 #### generate_fixtures
 
@@ -456,3 +536,31 @@ fixtures:
 ```
 
 Notice that the symlinks are not the ones that we provided in `environment.conf`? This is because the rake task will go into each of directories, find the modules and create a symlink for each of them (This is what rspec expects).
+
+#### generate_controlrepo_yaml
+
+`bundle exec rake generate_controlrepo_yaml`
+
+This will try to generate a `controlrepo.yaml` file, it will:
+
+  - Parse your environment.conf to work out where your roles and profiles might live
+  - Find your roles classes and pre-polulate them into the "classes" section
+  - Look though all of the factsets that ship with the gem, and also the ones you have created under `spec/factsets/*.json`
+  - Populate the "nodes" section with all of the factsets it finds
+  - Create node groups of windows and non-windows nodes
+  - Create a basic test_matrix
+
+
+#### generate_nodesets
+
+`bundle exec rake generate_nodesets`
+
+This task will generate nodeset file required by beaker, based on the factsets that exist in the repository. If you have any fact sets for which puppetlabs has a compatible vagrant box (i.e. centos, debian, ubuntu) it will detect the version specifics and set up the nodeset file, complete with box URL. If it doesn't know how to deal with a fact set it will output a boilerplate nodeset section and comment it out.
+
+#### hiera_setup
+
+`bundle exec rake hiera_setup`
+
+Automatically modifies your hiera.yaml to point at the hieradata relative to it's position.
+
+This rake task will look for a hiera.yaml file (Using the same method we use for [this](#using-hiera-data)). It will then look for a hieradata directory in the root for your control repo (needs to match [this](http://rubular.com/?regex=%2Fhiera%28%3F%3A.%2Adata%29%3F%2Fi)). It will then modify the datadirs of any backends it finds in `hiera.yaml` to point at these directories.

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     = "2.0.8"
+  s.version     = "2.0.10"
   s.authors     = ["Dylan Ratcliffe"]
   s.email       = ["dylan.ratcliffe@puppetlabs.com"]
   s.homepage    = "https://github.com/dylanratcliffe/controlrepo_gem"
@@ -16,15 +16,14 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
   # Runtime dependencies, but also probably dependencies of requiring projects
-  s.add_runtime_dependency 'rake'
-  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'rake', '>= 10.0.0'
+  s.add_runtime_dependency 'json', '>= 1.8.2'
   s.add_runtime_dependency 'beaker-rspec'
-  s.add_runtime_dependency 'rspec-puppet'
-  s.add_runtime_dependency 'puppetlabs_spec_helper'
-  s.add_runtime_dependency 'rspec'
+  s.add_runtime_dependency 'rspec-puppet' # TODO: This needs to be updated once the relese is tagged
+  s.add_runtime_dependency 'puppetlabs_spec_helper', ">= 0.4.0"
+  s.add_runtime_dependency 'rspec', '>= 3.0.0'
   s.add_runtime_dependency 'bundler'
-  s.add_runtime_dependency 'r10k'
+  s.add_runtime_dependency 'r10k', '>=2.1.0'
   s.add_runtime_dependency 'puppet'
   s.add_runtime_dependency 'git'
-  s.add_runtime_dependency 'vagrant-wrapper'
 end

data/lib/controlrepo/rake_tasks.rb

@@ -99,8 +99,8 @@ task :controlrepo_autotest_prep do
   FileUtils.mkdir_p("#{@repo.tempdir}/spec/classes")
   FileUtils.mkdir_p("#{@repo.tempdir}/spec/acceptance/nodesets")
 
-  # Copy our nodesets over
-  FileUtils.cp_r("#{@repo.spec_dir}/acceptance/nodesets","#{@repo.tempdir}/spec/acceptance")
+  # Copy our entire spec directory over
+  FileUtils.cp_r("#{@repo.spec_dir}","#{@repo.tempdir}")
 
   # Create the Rakefile so that we can take advantage of the existing tasks
   @config.write_rakefile(@repo.tempdir, "spec/classes/**/*_spec.rb")

data/templates/acceptance_test_spec.rb.erb

@@ -112,4 +112,3 @@ CODE
 <% end -%>
 <% end -%>
 end
-

data/templates/spec_helper_acceptance.rb.erb

@@ -12,8 +12,8 @@ require "beaker-rspec/helpers/serverspec"
 include BeakerRSpec::BeakerShim
 require 'controlrepo/beaker'
 
-
 #scp_to hosts, '<%= repo.tempdir %>/etc', '/'
+
 RSpec.configure do |c|
   # Enable color
   c.color = true
@@ -67,4 +67,4 @@ end
 # Set the number of lines it will print
 options[:trace_limit] = 1000
 
-OPTIONS = options
+OPTIONS = options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: controlrepo
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.10
 platform: ruby
 authors:
 - Dylan Ratcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: beaker-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: vagrant-wrapper
-  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'
 description: Testing tools for Puppet controlrepos
 email:
 - dylan.ratcliffe@puppetlabs.com