beaker-testmode_switcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6ae9b72921551c471f35351e450aef008b10f53
+  data.tar.gz: 825aa5ae1c2dd6decad2b64763149d2e1ac4c124
+SHA512:
+  metadata.gz: f373d1afbf2f2e985bbf8df6ac7e3e1d1283c1d009bce8697e18bb2df1cd99f3ee2e2ec3d568c42a7227320ed202ea0f0df4d9f5bb2d8bd8bc5b12a61fd51e68
+  data.tar.gz: 4ccceec2ffa5f6de7992f6e601496cb82b7c4e234107df27f3a9237dded4a405b7f3cd8b8c61993bd458cb8a0e5ae24860773395bb88ffb1f4ab8f7de4c9d0bb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,27 @@
+# increase the default metric limits to more realistic levels
+Metrics/LineLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+
+# Don't be picky about string quoting
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+bundler_args: --without development
+rvm:
+  - 2.2.0
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Version 0.1.0
+
+Initial release.

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rubocop', require: false
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-rake'
+  gem 'guard-rspec'
+  gem 'pry-coolline'
+end

data/Guardfile

@@ -0,0 +1,44 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(lib spec) \
+  .select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") }
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard 'rake', task: 'default' do
+  watch(%r{^manifests\/(.+)\.pp$})
+end

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,72 @@
+# Beaker::TestmodeSwitcher
+
+When testing modules with beaker, you need to choose up-front whether to drive the tests using `puppet apply` or a master/agent setup. While choosing the apply approach is tempting due to the reduced resource usage, everyone is running master/agent setups, and those have subtle differences to `puppet apply` that might trip up your code. To solve this dilemma, use this gem to choose the test mode at runtime!
+
+Beaker::TestmodeSwitcher supports running tests in master/agent mode, or using `puppet apply` or locally without any setup.
+
+## Usage
+
+Set up you module for beaker testing as usual. Additionally add
+
+```ruby
+gem 'beaker-testmode_switcher'
+```
+
+to the `:system_tests` group in your module's Gemfile. Add
+
+```ruby
+require 'beaker/testmode_switcher/dsl'
+```
+
+to your `spec/spec_helper_acceptance.rb` to enable the DSL extensions. Instead of using `#apply_manifest_on` or `#run_agent_on` you can now use `#execute_manifest_on` and - depending on the test mode - will upload and execute the manifest on the right node(s).
+
+The `BEAKER_TESTMODE` environment variable determines how the tests are run:
+
+* `local`: No VMs are provisioned and tests are run with `puppet apply` using the context of your test runner. This mode uses the least resources and is great for development, but may require running the tests as root and could trash the system.
+* `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.
+
+## 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`.
+  `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.
+
+* `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.
+  * `:values`: pass a hash of key/value pairs which is passed on the commandline to `puppet resource` to influence the specified resource.
+  * `:dry_run`: set to true to skip executing the actual command.
+  * `:environment`: pass environment variables for the command as a hash.
+
+* `scp_to_ex(from, to)`: Copies the file `from` to the location `to` on all nodes.
+
+* `shell_ex(cmd, opts = {})`: Execute a shell command on the default node.
+  `opts` keys:
+  * `:dry_run`: set to true to skip executing the actual command.
+  * `:environment`: pass environment variables for the command as a hash.
+
+Other helpful methods:
+
+* `Beaker::TestmodeSwitcher.mode`: Returns the currently configured test mode.
+* `Beaker::TestmodeSwitcher.runner`: Returns the currently configured runner.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+
+  task default: [:spec, :rubocop]
+rescue LoadError # rubocop:disable Lint/HandleExceptions: rspec is optional
+  # no rspec available
+end

data/beaker-testmode_switcher.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.email         = ["modules-team@puppetlabs.com"]
+
+  spec.summary       = "Let's you run your puppet module tests in master/agent, apply or local mode."
+  spec.homepage      = "https://github.com/puppetlabs/beaker-testmode_switcher"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "beaker/testmode_switcher"
+
+# Add fixtures and/or initialization code here to make experimenting
+# with the gem easier.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/beaker/testmode_switcher.rb

@@ -0,0 +1,34 @@
+require 'beaker/testmode_switcher/beaker_runners'
+require 'beaker/testmode_switcher/local_runner'
+
+module Beaker
+  # Contains the bulk of the code for switching the test mode.
+  module TestmodeSwitcher
+    # 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
+    end
+
+    # creates a test runner implementing the specified mode
+    def self.create_runner(mode)
+      case mode
+      when :apply then
+        BeakerApplyRunner.new
+      when :agent then
+        BeakerAgentRunner.new
+      when :local
+        LocalRunner.new
+      end
+    end
+
+    # returns the current runner
+    def self.runner
+      @runner ||= create_runner(testmode)
+    end
+  end
+end

data/lib/beaker/testmode_switcher/beaker_runners.rb

@@ -0,0 +1,106 @@
+require 'beaker'
+require 'shellwords'
+require 'open3'
+
+module Beaker
+  module TestmodeSwitcher
+    # Re-used functionality for all beaker runners
+    class BeakerRunnerBase
+      include Beaker::DSL
+
+      # 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')
+        apply_manifest_on default, "file { '#{file_path}': ensure => present, content => '#{file_content}', mode => '#{mode}', user => '#{user}', group => '#{group}' }", catch_failures: true
+      end
+
+      # execute a puppet resource command on the default host
+      def resource(type, name, opts = {})
+        cmd = ["resource"]
+        cmd << "--debug" if opts[:debug]
+        cmd << "--noop" if opts[:noop]
+        cmd << "--trace" if opts[:trace]
+        cmd << type
+        cmd << name
+
+        if opts[:values]
+          opts[:values].each do |k, v|
+            cmd << "#{k}=#{v}"
+          end
+        end
+
+        on(default,
+           puppet(*cmd),
+           dry_run: opts[:dry_run],
+           environment: opts[:environment] || {},
+           acceptable_exit_codes: (0...256)
+          )
+      end
+
+      # copy a file using beaker's scp_to to all hosts
+      def scp_to_ex(from, to)
+        hosts.each do |host|
+          scp_to host, from, to
+        end
+      end
+
+      # execute an arbitrary command on the default host
+      def shell_ex(cmd)
+        shell(cmd)
+      end
+    end
+
+    # All functionality specific to running in 'agent' mode
+    class BeakerAgentRunner < BeakerRunnerBase
+      require 'master_manipulator'
+      include MasterManipulator::Site
+
+      # 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 = {})
+        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)
+        inject_site_pp(master, prod_env_site_pp_path, site_pp)
+
+        cmd = ['agent', '--test', '--environment production']
+        cmd << "--debug" if opts[:debug]
+        cmd << "--noop" if opts[:noop]
+        cmd << "--trace" if opts[:trace]
+
+        # acceptable_exit_codes are passed because we want detailed-exit-codes but want to
+        # make our own assertions about the responses
+        on(default,
+           puppet(*cmd),
+           dry_run: opts[:dry_run],
+           environment: opts[:environment] || {},
+           acceptable_exit_codes: (0...256)
+          )
+      end
+    end
+
+    # All functionality specific to running in 'apply' mode
+    class BeakerApplyRunner < BeakerRunnerBase
+      # execute the manifest by running puppet apply on the default node
+      def execute_manifest(manifest, opts = {})
+        # acceptable_exit_codes and expect_changes are passed because we want detailed-exit-codes but want to
+        # make our own assertions about the responses
+        apply_manifest(
+          manifest,
+          expect_changes: true,
+          debug: opts[:debug],
+          dry_run: opts[:dry_run],
+          environment: opts[:environment] || {},
+          noop: opts[:noop],
+          trace: opts[:trace],
+          acceptable_exit_codes: (0...256)
+        )
+      end
+    end
+  end
+end

data/lib/beaker/testmode_switcher/dsl.rb

@@ -0,0 +1,17 @@
+require 'beaker/testmode_switcher'
+
+module Beaker
+  module TestmodeSwitcher
+    # 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|
+        define_method(name) do |*args|
+          Beaker::TestmodeSwitcher.runner.send(name, *args)
+        end
+      end
+    end
+  end
+end
+
+include Beaker::TestmodeSwitcher::DSL

data/lib/beaker/testmode_switcher/local_runner.rb

@@ -0,0 +1,156 @@
+require 'shellwords'
+require 'open3'
+
+module Beaker
+  module TestmodeSwitcher
+    # All functionality specific to running in 'local' mode
+    class LocalRunner
+      # creates the file on the local machine and adjusts permissions
+      # the opts hash allows the following keys: :mode, :user, :group
+      def create_remote_file_ex(file_path, file_content, opts = {})
+        File.open(file_path, 'w') { |file| file.write(file_content) }
+
+        file_path_escaped = file_path.shellescape
+        commands = []
+        commands << "chmod #{opts[:mode].shellescape} #{file_path_escaped}" if opts[:mode]
+        commands << "chown #{opts[:user].shellescape} #{file_path_escaped}" if opts[:user]
+        commands << "chgrp #{opts[:group].shellescape} #{file_path_escaped}" if opts[:group]
+        if commands.empty?
+          success_result
+        else
+          use_local_shell(commands.join(' && '), opts)
+        end
+      end
+
+      # executes the supplied manifest using bundle and puppet apply
+      # the opts hash works like the opts of [apply_manifest_on](http://www.rubydoc.info/github/puppetlabs/beaker/Beaker/DSL/Helpers/PuppetHelpers#apply_manifest_on-instance_method) in the Beaker DSL.
+      # it accepts the following keys: :dry_run, :environment, :trace, :noop, and :debug
+      def execute_manifest(manifest, opts = {})
+        puts "Applied manifest [#{manifest}]" if ENV['DEBUG_MANIFEST']
+        cmd = ["bundle exec puppet apply -e #{manifest.delete("\n").shellescape} --detailed-exitcodes --modulepath spec/fixtures/modules --libdir lib"]
+        cmd << "--debug" if opts[:debug]
+        cmd << "--noop" if opts[:noop]
+        cmd << "--trace" if opts[:trace]
+        use_local_shell(cmd.join(' '), opts)
+      end
+
+      # build and execute complex puppet resource commands locally
+      # the type argument is the name of the resource type
+      # the name argument is the namevar of the resource
+      # the opts hash works like the opts of [apply_manifest_on](http://www.rubydoc.info/github/puppetlabs/beaker/Beaker/DSL/Helpers/PuppetHelpers#apply_manifest_on-instance_method) in the Beaker DSL.
+      # it accepts the following keys: :dry_run, :environment, :trace, :noop, and :debug
+      # additionally opts[:values] can be set to a hash of resource values to pass on the command line
+      def resource(type, name, opts = {})
+        cmd = ["bundle exec puppet resource --modulepath spec/fixtures/modules --libdir lib"]
+        cmd << "--debug" if opts[:debug]
+        cmd << "--noop" if opts[:noop]
+        cmd << "--trace" if opts[:trace]
+        cmd << type.shellescape
+        cmd << name.shellescape
+
+        if opts[:values]
+          opts[:values].each do |k, v|
+            cmd << "#{k.shellescape}=#{v.shellescape}"
+          end
+        end
+
+        # apply the command
+        use_local_shell(cmd.join(' '), opts)
+      end
+
+      # copies the file locally
+      def scp_to_ex(from, to)
+        FileUtils.cp(from, to)
+        success_result
+      end
+
+      # run a command through a local shell
+      # Pass options to alter execution through `opts`:
+      # * `:environment`: default: `{}`; these will be treated as extra environment variables that should be set before running the command
+      def shell_ex(cmd, opts = {})
+        use_local_shell(cmd, opts)
+      end
+
+      private
+
+      # build a Beaker::Result with a successful exit_code and no output
+      def success_result
+        result = Beaker::Result.new(:localhost, "")
+        result.exit_code = 0
+        result.finalize!
+        result
+      end
+
+      # fork/exec a process and collect its output
+      def use_local_shell(cmd, opts)
+        if opts[:dry_run]
+          puts "Would have run '#{cmd}'"
+          success_result
+        else
+          capture_command(cmd, opts[:environment] || {})
+        end
+      end
+
+      # runs a command and captures its output in a Beaker::Result
+      def capture_command(cmd, environment)
+        blocks = {
+          combined: [],
+          out: [],
+          err: []
+        }
+        exit_code = -1
+        Open3.popen3(environment, cmd) do |stdin, stdout, stderr, wait_thr|
+          # TODO: pass through $stdin/terminal to subprocess to allow interaction - e.g. pry - the subprocess
+          stdin.close_write
+
+          files = [stdout, stderr]
+
+          until files.all?(&:eof)
+            ready = IO.select(files)
+            next unless ready
+
+            ready[0].each do |f|
+              fileno = f.fileno
+              begin
+                data = f.read_nonblock(1024)
+                until data.empty?
+                  $stdout.write(data)
+
+                  # create a combined block list for better output interleaving
+                  blocks[:combined] << data
+
+                  # store each stream separately for the Beaker::Result API
+                  if fileno == stdout.fileno
+                    blocks[:out] << data
+                  else
+                    blocks[:err] << data
+                  end
+
+                  # try reading more data
+                  # when the command writes more than 1k at a time, this is required to drain buffers
+                  # and avoid stdout/stderr interleaving
+                  begin
+                    data = f.read_nonblock(1024)
+                  rescue IO::EAGAINWaitReadable
+                    data = ""
+                  end
+                end
+              rescue EOFError # rubocop:disable Lint/HandleExceptions: expected exception
+                # pass on EOF
+              end
+            end
+          end
+
+          exit_code = wait_thr.value.exitstatus
+        end
+        result = Beaker::Result.new(:localhost, cmd)
+        result.stdout = blocks[:out].join
+        result.stderr = blocks[:err].join
+        result.output = blocks[:combined].join
+        result.exit_code = exit_code
+        result.finalize!
+        result
+      end
+    end
+  end
+end

data/lib/beaker/testmode_switcher/version.rb

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: beaker-testmode_switcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Puppet Labs
+- David Schmitt
+- Gareth Rushgrove
+- Greg Hardy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-06 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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- beaker-testmode_switcher.gemspec
+- bin/console
+- bin/setup
+- lib/beaker/testmode_switcher.rb
+- lib/beaker/testmode_switcher/beaker_runners.rb
+- lib/beaker/testmode_switcher/dsl.rb
+- lib/beaker/testmode_switcher/local_runner.rb
+- lib/beaker/testmode_switcher/version.rb
+homepage: https://github.com/puppetlabs/beaker-testmode_switcher
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Let's you run your puppet module tests in master/agent, apply or local mode.
+test_files: []