beaker-testmode_switcher 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6ae9b72921551c471f35351e450aef008b10f53
-  data.tar.gz: 825aa5ae1c2dd6decad2b64763149d2e1ac4c124
+  metadata.gz: e11986d5a67ffd960f9c786ff8536b2b505d5b81
+  data.tar.gz: b0c43f008a61c19804a16f41f3470bcdb7cd4c41
 SHA512:
-  metadata.gz: f373d1afbf2f2e985bbf8df6ac7e3e1d1283c1d009bce8697e18bb2df1cd99f3ee2e2ec3d568c42a7227320ed202ea0f0df4d9f5bb2d8bd8bc5b12a61fd51e68
-  data.tar.gz: 4ccceec2ffa5f6de7992f6e601496cb82b7c4e234107df27f3a9237dded4a405b7f3cd8b8c61993bd458cb8a0e5ae24860773395bb88ffb1f4ab8f7de4c9d0bb
+  metadata.gz: 6ed863db3115f3166f1b64ac59e110d5f70652f17a61ea864654c2e710728471acdcaaa7139c1a3c770c889beb6596948dee28b570f09b8b798990f88a8653d8
+  data.tar.gz: 6306bad36cc1db0b325b55e5d9a77eb3bee9a75ef504e8f48853bc93956d1b2b9837e50f962fca4be7da59dec79fe09e791e0f5ea46044b12e8a4e929dfb5b72

data/.rubocop.yml

@@ -1,4 +1,7 @@
 # increase the default metric limits to more realistic levels
+Metrics/BlockLength:
+  Max: 200
+
 Metrics/LineLength:
   Max: 200
 
@@ -25,3 +28,32 @@ Style/PercentLiteralDelimiters:
 Style/StringLiterals:
   Enabled: false
 
+Style/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+# Disabling unrealistic rubocop RSpec cops
+RSpec/HookArgument:
+   Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+# We want to call gem files multiple times if they have a ruby version dependency
+Bundler/DuplicatedGem:
+  Enabled: false
+
+# When there are dependencies we have duplicate gems so they cant be ordered
+Bundler/OrderedGems:
+  Enabled: false

data/.travis.yml

@@ -2,5 +2,8 @@ language: ruby
 cache: bundler
 bundler_args: --without development
 rvm:
-  - 2.2.0
-  - 2.0.0
+  - 2.3.1
+  - 2.1.6
+env:
+  - TEST_FRAMEWORK="beaker-rspec"
+  - TEST_FRAMEWORK="beaker"

data/CHANGELOG.md

@@ -1,3 +1,13 @@
 # Version 0.1.0
 
 Initial release.
+
+# 2017-01-19 - Version 0.1.1
+###Summary
+
+This release adds a feature that provides control of specific nodes you would like to run an agent run on. Previously it was only possible to run on the default node.
+
+###Features
+- Add execute_manifest_on() function
+- Add MAINTAINERS file
+- Addressing Rubocop errors

data/Gemfile

@@ -3,12 +3,19 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'beaker' if RUBY_VERSION > '2.1.6'
+  gem 'beaker', '2.42.0' if RUBY_VERSION <= '2.1.6'
+  gem 'bundler', '~> 1.9'
+  gem 'rake', '~> 10.0'
+  gem 'rspec', '~> 3' unless ENV['TEST_FRAMEWORK'] && ENV['TEST_FRAMEWORK'] == 'beaker' # Don't install rpsec if the module is in beaker only mode
   gem 'rubocop', require: false
 end
 
 group :development do
   gem 'guard'
   gem 'guard-rake'
-  gem 'guard-rspec'
+  gem 'guard-rspec' unless ENV['TEST_FRAMEWORK'] && ENV['TEST_FRAMEWORK'] == 'beaker'
+  gem 'listen', '= 3.0.7' # last version to support ruby 1.9; the proper fix would be to not install the development group in our internal CI
+  gem 'pry'
   gem 'pry-coolline'
 end

data/MAINTAINERS

@@ -0,0 +1,16 @@
+{
+  "version": 1,
+  "file_format": "This MAINTAINERS file format is described at http://pup.pt/maintainers",
+  "people": [
+    {
+      "github": "pmcmaw",
+      "email": "paula@puppet.com",
+      "name": "Paula McMaw"
+    },
+    {
+      "github": "HelenCampbell",
+      "email": "helen@puppet.com",
+      "name": "Helen Campbell"
+    }
+  ]
+}

data/README.md

@@ -26,18 +26,33 @@ The `BEAKER_TESTMODE` environment variable determines how the tests are run:
 * `apply`: VMs are provisioned as normal (determined by the nodeset) and tests are run with `puppet apply` on the specified node. This mode only requires a single VM and is great for running the tests in an isolated environment. When the nodeset has more than one node, exactly one has to have the 'default' role assigned. This will be the node to execute the manifests.
 * `agent`: VMs are provisioned as normal (determined by the nodeset). When running tests, the manifest is uploaded to the master and a full `puppet agent` run is kicked off on the specified node. This mode requires multiple VMs and a more involved provisioning step, but the tests run in a very production-like environment to ensure highest fidelity of the test results. The nodeset needs to contain one node with the 'master' role assigned. This will be the node to receive the manifest. When the nodeset has more than one node, exactly one has to have the 'default' role assigned. This will be the node to execute the puppet agent.
 
+## Acceptance tests
+
+Beaker and Beaker-rspec frameworks are supported. The environment variable `TEST_FRAMEWORK` MUST be set before the gem/bundle install.
+
+The `TEST_FRAMEWORK` environment variable determines the gem support for the test run:
+* `beaker` Beaker only support.
+* `beaker-rspec` Beaker-rspec support.
+
+The acceptance tests will immediately fail if the environment variable is not set.
+
+To run the tests `bundle exec rake`
+
 ## Reference
 
 This experimental version supports only a minimal set of functionality from the beaker DSL:
 
 * `create_remote_file_ex(file_path, file_content, opts = {})`: Creates a file at `file_path` with the content specified in `file_content` on the default node. `opts` can have the keys `:mode`, `:user`, and `:group` to specify the permissions, owner, and group respectively.
 
-* `execute_manifest(manifest, opts = {})`: Execute the manifest on the default node. Depending on the `BEAKER_TESTMODE` environment variable, this may use `puppet agent` or `puppet apply`.
+* `execute_manifest_on(hosts, manifest, opts = {})`: Execute the manifest on all nodes. This will only work when `BEAKER_TESTMODE`, is set to `agent` and it will run a `puppet agent` run.
   `opts` keys:
   * `:debug`, `:trace`, `:noop`: set to true to enable the puppet option of the same name.
   * `:dry_run`: set to true to skip executing the actual command.
   * `:environment`: pass environment variables for the command as a hash.
 
+* `execute_manifest(manifest, opts = {})`: Execute the manifest on the default node. Depending on the `BEAKER_TESTMODE` environment variable, this may use `puppet agent` or `puppet apply`.
+  `opts` This makes use of `execute_manifest_on(hosts, manifest, opts = {})`.
+
 * `resource(type, name, opts = {})`: Runs `puppet resource` with the specified `type` and `name` arguments.
   `opts` keys:
   * `:debug`, `:trace`, `:noop`: set to true to enable the puppet option of the same name.

data/Rakefile

@@ -1,13 +1,36 @@
 require "bundler/gem_tasks"
 
-begin
+def beaker_command
+  cmd_parts = []
+  cmd_parts << "beaker"
+  cmd_parts << "--debug"
+  cmd_parts << "--test spec/test"
+  cmd_parts << "--load-path lib"
+  cmd_parts.flatten.join(" ")
+end
+
+if ENV['TEST_FRAMEWORK'] && ENV['TEST_FRAMEWORK'] == 'beaker'
+  task spec: [:beaker]
+else
+  task spec: [:rspec]
+end
+
+task :rspec do
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
+end
+
+task :beaker do
+  abort "Beaker test failed" unless system(beaker_command) == true
+end
 
+task :rubocop do
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
+end
 
+begin
   task default: [:spec, :rubocop]
-rescue LoadError # rubocop:disable Lint/HandleExceptions: rspec is optional
-  # no rspec available
+rescue LoadError => error
+  raise "LoadError for default rake target. [#{error}] "
 end

data/beaker-testmode_switcher.gemspec

@@ -6,7 +6,7 @@ require 'beaker/testmode_switcher/version'
 Gem::Specification.new do |spec|
   spec.name          = "beaker-testmode_switcher"
   spec.version       = Beaker::TestmodeSwitcher::VERSION
-  spec.authors       = ["Puppet Labs", "David Schmitt", "Gareth Rushgrove", "Greg Hardy"]
+  spec.authors       = ["Puppet Labs", "David Schmitt", "Gareth Rushgrove", "Greg Hardy", "Paula McMaw"]
   spec.email         = ["modules-team@puppetlabs.com"]
 
   spec.summary       = "Let's you run your puppet module tests in master/agent, apply or local mode."
@@ -19,9 +19,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "beaker"
   spec.add_dependency "master_manipulator"
-
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3"
 end

data/lib/beaker/testmode_switcher.rb

@@ -7,28 +7,25 @@ module Beaker
     # returns the current test mode
     def self.testmode
       mode = ENV['BEAKER_TESTMODE'] || 'apply'
-      if %w(apply agent local).include? mode
-        return mode.to_sym
-      else
-        fail ArgumentError, "Unknown BEAKER_TESTMODE supplied: '#{mode}'"
-      end
+      return mode.to_sym if %w(apply agent local).include? mode
+      raise ArgumentError, "Unknown BEAKER_TESTMODE supplied: '#{mode}'"
     end
 
     # creates a test runner implementing the specified mode
-    def self.create_runner(mode)
+    def self.create_runner(mode, hosts, logger)
       case mode
       when :apply then
-        BeakerApplyRunner.new
+        BeakerApplyRunner.new hosts, logger
       when :agent then
-        BeakerAgentRunner.new
+        BeakerAgentRunner.new hosts, logger
       when :local
         LocalRunner.new
       end
     end
 
     # returns the current runner
-    def self.runner
-      @runner ||= create_runner(testmode)
+    def self.runner(hosts, logger)
+      @runner ||= create_runner testmode, hosts, logger
     end
   end
 end

data/lib/beaker/testmode_switcher/beaker_runners.rb

@@ -8,14 +8,21 @@ module Beaker
     class BeakerRunnerBase
       include Beaker::DSL
 
+      attr_accessor :hosts, :logger
+
+      def initialize(hosts, logger)
+        self.hosts = hosts
+        self.logger = logger
+      end
+
       # create a remote file (using puppet apply) on the default host
       def create_remote_file_ex(file_path, file_content, options = {})
         mode = options[:mode] || '0644'
         user = options[:user] || 'root'
         group = options[:group] || 'root'
-        file_content.gsub!(/\\/, '\\')
-        file_content.gsub!(/'/, "\\'")
-        file_content.gsub!(/\n/, '\\n')
+        file_content.tr!(/\\/, '\\')
+        file_content.tr!(/'/, "\\'")
+        file_content.tr!(/\n/, '\\n')
         apply_manifest_on default, "file { '#{file_path}': ensure => present, content => '#{file_content}', mode => '#{mode}', user => '#{user}', group => '#{group}' }", catch_failures: true
       end
 
@@ -44,7 +51,7 @@ module Beaker
 
       # copy a file using beaker's scp_to to all hosts
       def scp_to_ex(from, to)
-        hosts.each do |host|
+        @hosts.each do |host|
           scp_to host, from, to
         end
       end
@@ -63,6 +70,12 @@ module Beaker
       # upload the manifest to the master and inject it into the site.pp
       # then run a puppet agent on the default host
       def execute_manifest(manifest, opts = {})
+        execute_manifest_on(default, manifest, opts)
+      end
+
+      # upload the manifest to the master and inject it into the site.pp
+      # then run a puppet agent on all hosts
+      def execute_manifest_on(hosts, manifest, opts = {})
         environment_base_path = on(master, puppet('config', 'print', 'environmentpath')).stdout.rstrip
         prod_env_site_pp_path = File.join(environment_base_path, 'production', 'manifests', 'site.pp')
         site_pp = create_site_pp(master, manifest: manifest)
@@ -75,12 +88,11 @@ module Beaker
 
         # acceptable_exit_codes are passed because we want detailed-exit-codes but want to
         # make our own assertions about the responses
-        on(default,
+        on(hosts,
            puppet(*cmd),
            dry_run: opts[:dry_run],
            environment: opts[:environment] || {},
-           acceptable_exit_codes: (0...256)
-          )
+           acceptable_exit_codes: (0...256))
       end
     end
 

data/lib/beaker/testmode_switcher/dsl.rb

@@ -5,9 +5,9 @@ module Beaker
     # include this module into your namespace to access the DSL parts of TestmodeSwitcher
     module DSL
       # pass through methods to the runner
-      [:create_remote_file_ex, :scp_to_ex, :shell_ex, :resource, :execute_manifest].each do |name|
+      [:create_remote_file_ex, :scp_to_ex, :shell_ex, :resource, :execute_manifest, :execute_manifest_on].each do |name|
         define_method(name) do |*args|
-          Beaker::TestmodeSwitcher.runner.send(name, *args)
+          Beaker::TestmodeSwitcher.runner(hosts, logger).send(name, *args)
         end
       end
     end

data/lib/beaker/testmode_switcher/version.rb

@@ -1,6 +1,6 @@
 module Beaker
   # central definition of this gem's version
   module TestmodeSwitcher
-    VERSION = "0.1.0"
+    VERSION = "0.1.1".freeze
   end
 end

metadata

@@ -1,102 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: beaker-testmode_switcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Puppet Labs
 - David Schmitt
 - Gareth Rushgrove
 - Greg Hardy
+- Paula McMaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker
   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: master_manipulator
   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: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
 description: 
 email:
 - modules-team@puppetlabs.com
@@ -104,14 +49,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
+- MAINTAINERS
 - README.md
 - Rakefile
 - beaker-testmode_switcher.gemspec
@@ -131,17 +77,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Let's you run your puppet module tests in master/agent, apply or local mode.