onceover 3.0.4 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e331719150663a74f692d2459bd69c1743efc20b
-  data.tar.gz: 398b392ff989e0aee94c1d12f4d8059d1393bf42
+  metadata.gz: f9cca70e7c3e4acba9f3a2aa60ae16087f30261f
+  data.tar.gz: e1f6255a54a6be2d9985b57bc82ca97bc7487bf6
 SHA512:
-  metadata.gz: 1510032b56377bc1a5add18e8c0df518b8d58bf296a20a1dbc7c2b4545527a60c1d7362468a041cd480a59b4dcdbb1d795d4fdb2def5d794c39182f75f9ef4a0
-  data.tar.gz: 504c1a7da69bbd3a12119f1d08b8f0d119f7de859774b15fcfd1e7f4428129d109a7ebd55f328c68c0068640fded8e181734e6d32aa1b71692d374137795d7af
+  metadata.gz: 6af61ee99bc06e538611e109157b9e328f53d02b2b6a1eddd0af6a1841cc65f065b131e3792e64767bb4d53a2df9a0c7255c79e0753b829402db2e677545c84f
+  data.tar.gz: 888e3c95a2630cbc47016af32084ef402f0c928e6b2ce3b46003a3828000e8d8f0a1a6c6b37581c4391d5c2e049a36a5805a8b89add7411d558819f04a6273a8

data/README.md

@@ -19,6 +19,7 @@ Onceover is a tool to automatically run basic tests on an entire Puppet controlr
   - [Acceptance testing](#acceptance-testing)
   - [Using Workarounds](#using-workarounds)
   - [Extra tooling](#extra-tooling)
+    - [Accessing Onceover in a traditional RSpec test](#accessing-onceover-in-a-traditional-rspec-test)
     - [Accessing fact sets in a traditional RSpec test](#accessing-fact-sets-in-a-traditional-rspec-test)
     - [Accessing Roles in a traditional RSpec test](#accessing-roles-in-a-traditional-rspec-test)
     - [Filtering](#filtering)
@@ -369,6 +370,32 @@ Here we are specifying custom commands to run for starting, stopping and checkin
 
 Is this all too simple for you? Great! This is supposed to be a gateway to writing your own super-awesome really complicated tests using more traditional tools. If you want to ditch this tool in favour of doing it yourself, go ahead, but take these ruby methods as a parting gift:
 
+### Accessing Onceover in a traditional RSpec test
+
+If you would like to use `onceover.yaml` to manage which tests you want to run, but want more than just `it { should_compile }` tests to be run you can write you own as follows:
+
+```ruby
+# spec/classes/role_spec.rb
+require 'spec_helper'
+require 'onceover/controlrepo'
+require 'helpers/shared_examples'
+
+Onceover::Controlrepo.new.spec_tests do |class_name,node_name,facts,pre_conditions|
+  describe class_name do
+    context "on #{node_name}" do
+      let(:facts) { facts }
+      let(:pre_condition) { pre_conditions }
+
+      it_behaves_like 'soe'
+    end
+  end
+end
+```
+
+This will use the `soe` [shared example](https://www.relishapp.com/rspec/rspec-core/docs/example-groups/shared-examples) on all of the tests that are configured in your `onceover.yaml` including any [pre_conditions](#using-workarounds) that you have set up.
+
+**Note:** Onceover will automatically run any extra Rspec tests that it finds in the normal directories `spec/{classes,defines,unit,functions,hosts,integration,types}` so you can easily use auto-generated spec tests in conjunction with your own Rspec tests.
+
 ### Accessing fact sets in a traditional RSpec test
 
 We can access all of our fact sets using `Onceover::Controlrepo.facts`. Normally it would be implemented something like this:
@@ -382,9 +409,9 @@ Onceover::Controlrepo.facts.each do |facts|
 end
 ```
 
-### Accessing Roles in a traditional RSpec test
+### Other (possibly less useful) methods
 
-The following code will test all roles on all nodes in native rspec:
+The following code will test all roles that onceover can find (ignoring the ones configured in `onceover.yaml`) on all nodes in native rspec:
 
 ```ruby
 require 'spec_helper'

data/controlrepo.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "onceover"
-  s.version     = "3.0.4"
+  s.version     = "3.0.5"
   s.authors     = ["Dylan Ratcliffe"]
   s.email       = ["dylan.ratcliffe@puppet.com"]
   s.homepage    = "https://github.com/dylanratcliffe/onceover"

data/lib/onceover/cli.rb

@@ -25,7 +25,7 @@ class Onceover
         optional nil, :nodeset_file, 'YAML file containing node definitions'
         optional nil, :tempdir, 'Temp directory to use, defaults to .controlrepo'
         optional nil, :manifest, 'Path fo find manifests'
-        optional nil, :controlrepo_yaml, 'Path of controlrepo.yaml'
+        optional nil, :onceover_yaml, 'Path of controlrepo.yaml'
 
         run do |opts, args, cmd|
           puts cmd.help(:verbose => opts[:verbose])

data/lib/onceover/cli/run.rb

@@ -38,7 +38,7 @@ This includes deploying using r10k and running all custom tests.
 
             run do |opts, args, cmd|
               repo = Onceover::Controlrepo.new(opts)
-              runner = Onceover::Runner.new(repo,Onceover::TestConfig.new(repo.controlrepo_yaml,opts),:spec)
+              runner = Onceover::Runner.new(repo,Onceover::TestConfig.new(repo.onceover_yaml,opts),:spec)
               runner.prepare!
               runner.run_spec!
             end
@@ -55,7 +55,7 @@ This includes deploying using r10k and running all custom tests.
 
             run do |opts, args, cmd|
               repo = Onceover::Controlrepo.new(opts)
-              runner = Onceover::Runner.new(repo,Onceover::TestConfig.new(repo.controlrepo_yaml,opts),:acceptance)
+              runner = Onceover::Runner.new(repo,Onceover::TestConfig.new(repo.onceover_yaml,opts),:acceptance)
               runner.prepare!
               runner.run_acceptance!
             end

data/lib/onceover/controlrepo.rb

@@ -28,7 +28,7 @@ class Onceover
     attr_accessor :nodeset_file
     attr_accessor :manifest
     attr_accessor :tempdir
-    attr_accessor :controlrepo_yaml
+    attr_accessor :onceover_yaml
     attr_accessor :opts
 
     # Create methods on self so that we can access these basic things without
@@ -83,7 +83,22 @@ class Onceover
 
     def initialize(opts = {})
       # When we initialize the object it is going to set some instance vars
-      @root             = opts[:path] || Dir.pwd
+
+      # We want people to be able to run this from anywhere within the repo
+      # so traverse up until we think we are in a controlrepo.
+      if opts[:path]
+        @root = opts[:path]
+      else
+        @root = Dir.pwd
+        until File.exist?(File.expand_path('./environment.conf',@root)) do
+          # Throw an exception if we can't go any further up
+          throw "Could not file root of the controlrepo anywhere above #{Dir.pwd}" if @root == File.expand_path('../',@root)
+
+          # Step up and try again
+          @root = File.expand_path('../',@root)
+        end
+      end
+
       @environmentpath  = opts[:environmentpath] || 'etc/puppetlabs/code/environments'
       @puppetfile       = opts[:puppetfile] || File.expand_path('./Puppetfile',@root)
       @environment_conf = opts[:environment_conf] || File.expand_path('./environment.conf',@root)
@@ -93,10 +108,10 @@ class Onceover
       @nodeset_file     = opts[:nodeset_file] || File.expand_path('./spec/acceptance/nodesets/onceover-nodes.yml',@root)
       @role_regex       = /role[s]?:{2}/
       @profile_regex    = /profile[s]?:{2}/
-      @tempdir          = opts[:tempdir] || ENV['CONTROLREPO_temp'] || File.absolute_path('./.onceover')
+      @tempdir          = opts[:tempdir] || File.expand_path('./.onceover',@root)
       $temp_modulepath  = nil
       @manifest         = opts[:manifest] || config['manifest'] ? File.expand_path(config['manifest'],@root) : nil
-      @controlrepo_yaml = opts[:controlrepo_yaml] || "#{@spec_dir}/onceover.yaml"
+      @onceover_yaml    = opts[:onceover_yaml] || "#{@spec_dir}/onceover.yaml"
       @opts             = opts
       logger.level = :debug if @opts[:debug]
     end
@@ -113,7 +128,7 @@ class Onceover
       #{'nodeset_file'.green}     #{@nodeset_file}
       #{'roles'.green}            #{roles}
       #{'profiles'.green}         #{profiles}
-      #{'controlrepo.yaml'.green} #{@controlrepo_yaml}
+      #{'onceover.yaml'.green} #{@onceover_yaml}
       END
     end
 
@@ -371,7 +386,7 @@ class Onceover
       require 'pathname'
       require 'colored'
 
-      Onceover::Controlrepo.init_write_file(generate_controlrepo_yaml(repo),repo.controlrepo_yaml)
+      Onceover::Controlrepo.init_write_file(generate_onceover_yaml(repo),repo.onceover_yaml)
       Onceover::Controlrepo.init_write_file(generate_nodesets(repo),repo.nodeset_file)
       Onceover::Controlrepo.init_write_file(Onceover::Controlrepo.evaluate_template('pre_conditions_README.md.erb',binding),File.expand_path('./pre_conditions/README.md',repo.spec_dir))
       Onceover::Controlrepo.init_write_file(Onceover::Controlrepo.evaluate_template('factsets_README.md.erb',binding),File.expand_path('./factsets/README.md',repo.spec_dir))
@@ -393,7 +408,7 @@ class Onceover
       end
     end
 
-    def self.generate_controlrepo_yaml(repo)
+    def self.generate_onceover_yaml(repo)
       # This will return a controlrepo.yaml that can be written to a file
       Onceover::Controlrepo.evaluate_template('controlrepo.yaml.erb',binding)
     end
@@ -466,6 +481,22 @@ class Onceover
       end
     end
 
+    # Returns the deduplicted and verified output of testconfig.spec_tests for
+    # use in Rspec tests so that we don't have to deal with more than one object
+    def spec_tests(&block)
+      require 'onceover/testconfig'
+
+      # Load up all of the tests and deduplicate them
+      testconfig = Onceover::TestConfig.new(@onceover_yaml,@opts)
+      testconfig.spec_tests.each { |tst| testconfig.verify_spec_test(self,tst) }
+      tests = testconfig.run_filters(Onceover::Test.deduplicate(testconfig.spec_tests))
+
+      # Loop over each test, executing the user's block on each
+      tests.each do |tst|
+        block.call(tst.classes[0].name,tst.nodes[0].name,tst.nodes[0].fact_set,testconfig.pre_condition)
+      end
+    end
+
     private
 
     def read_facts(facts_file)

data/lib/onceover/rake_tasks.rb

@@ -29,12 +29,12 @@ task :controlrepo_details do
   puts Onceover::Controlrepo.new.to_s
 end
 
-task :generate_controlrepo_yaml do
+task :generate_onceover_yaml do
   require 'onceover/controlrepo'
   repo = Onceover::Controlrepo.new
   template_dir = File.expand_path('../../templates',File.dirname(__FILE__))
-  controlrepo_yaml_template = File.read(File.expand_path('./controlrepo.yaml.erb',template_dir))
-  puts ERB.new(controlrepo_yaml_template, nil, '-').result(binding)
+  onceover_yaml_template = File.read(File.expand_path('./controlrepo.yaml.erb',template_dir))
+  puts ERB.new(onceover_yaml_template, nil, '-').result(binding)
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onceover
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.0.5
 platform: ruby
 authors:
 - Dylan Ratcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake