beaker-testmode_switcher 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e11986d5a67ffd960f9c786ff8536b2b505d5b81
-  data.tar.gz: b0c43f008a61c19804a16f41f3470bcdb7cd4c41
+  metadata.gz: 0b6fa280da0e2d74f94c99172bbdc84a0fd136eb
+  data.tar.gz: b7d5add69806870c20e23ee07e24412678c98dae
 SHA512:
-  metadata.gz: 6ed863db3115f3166f1b64ac59e110d5f70652f17a61ea864654c2e710728471acdcaaa7139c1a3c770c889beb6596948dee28b570f09b8b798990f88a8653d8
-  data.tar.gz: 6306bad36cc1db0b325b55e5d9a77eb3bee9a75ef504e8f48853bc93956d1b2b9837e50f962fca4be7da59dec79fe09e791e0f5ea46044b12e8a4e929dfb5b72
+  metadata.gz: 43b4c25be5bdd16a76c56d57e7e8935ccc5e58cb83fa275f57404fc20218d8f93c876389ed5e367d99622fdf161313f0a6922d54efb1f1bfc5fde0242f6318d2
+  data.tar.gz: bb9b824bfd40e4dd11da7ca1bf3948cc83a3c1b61ab97c89ab96c48f706aec78f2f183418020ec3d0bd72d1b7c1a1a323f1b52063bf49ca7f0cd2e31ef3f4617

data/CHANGELOG.md

@@ -1,6 +1,10 @@
-# Version 0.1.0
+# 2017-03-03 Version 0.2.0
+### Summary
+Make use of catch_changes, catch_failures, expect_changes and expect_failures. This makes beaker-testmode_switcher easier to integrate into modules.
 
-Initial release.
+### Features
+- Implement catch_changes, catch_failures, expect_changes and expect_failures in beaker_runners
+- Fix docs issue where `execute_manifest` options were listed under `resource
 
 # 2017-01-19 - Version 0.1.1
 ###Summary
@@ -11,3 +15,7 @@ This release adds a feature that provides control of specific nodes you would li
 - Add execute_manifest_on() function
 - Add MAINTAINERS file
 - Addressing Rubocop errors
+
+# Version 0.1.0
+
+Initial release.

data/README.md

@@ -45,13 +45,26 @@ This experimental version supports only a minimal set of functionality from the
 * `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_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.
+  * `:catch_failures` enables detailed exit codes and causes a test failure if the puppet run indicates there was a failure during its execution.
+  * `:catch_changes` enables detailed exit codes and causes a test failure if the puppet run indicates that there were changes or failures during its execution.
+  * `:expect_changes` enables detailed exit codes and causes a test failure if the puppet run indicates that there were no resource changes during its execution.
+  * `:expect_failures` enables detailed exit codes and causes a test failure if the puppet run indicates there were no failure during its execution.
 
-* `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 = {})`.
+* `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`. Calls execute_manifest_on when `BEAKER_TESTMODE`=`agent`
+  
+  `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.
+  * `:catch_failures` enables detailed exit codes and causes a test failure if the puppet run indicates there was a failure during its execution.
+  * `:catch_changes` enables detailed exit codes and causes a test failure if the puppet run indicates that there were changes or failures during its execution.
+  * `:expect_changes` enables detailed exit codes and causes a test failure if the puppet run indicates that there were no resource changes during its execution.
+  * `:expect_failures` enables detailed exit codes and causes a test failure if the puppet run indicates there were no failure during its execution.
 
 * `resource(type, name, opts = {})`: Runs `puppet resource` with the specified `type` and `name` arguments.
   `opts` keys:

data/lib/beaker/testmode_switcher/beaker_runners.rb

@@ -1,11 +1,12 @@
 require 'beaker'
 require 'shellwords'
 require 'open3'
+require_relative 'runner_base'
 
 module Beaker
   module TestmodeSwitcher
     # Re-used functionality for all beaker runners
-    class BeakerRunnerBase
+    class BeakerRunnerBase < RunnerBase
       include Beaker::DSL
 
       attr_accessor :hosts, :logger
@@ -81,18 +82,21 @@ module Beaker
         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 = ['agent', '--test', '--environment production', '--detailed-exitcodes']
         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(hosts,
-           puppet(*cmd),
-           dry_run: opts[:dry_run],
-           environment: opts[:environment] || {},
-           acceptable_exit_codes: (0...256))
+        res = on(hosts,
+                 puppet(*cmd),
+                 dry_run: opts[:dry_run],
+                 environment: opts[:environment] || {},
+                 acceptable_exit_codes: (0...256))
+
+        handle_puppet_run_returned_exit_code(get_acceptable_puppet_run_exit_codes(opts), res.exit_code)
+        res
       end
     end
 
@@ -102,16 +106,18 @@ module Beaker
       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(
+        res = 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)
-        )
+          expect_failures: true,
+          acceptable_exit_codes: (0...256))
+
+        handle_puppet_run_returned_exit_code(get_acceptable_puppet_run_exit_codes(opts), res.exit_code)
+        res
       end
     end
   end

data/lib/beaker/testmode_switcher/local_runner.rb

@@ -1,10 +1,11 @@
 require 'shellwords'
 require 'open3'
+require_relative 'runner_base'
 
 module Beaker
   module TestmodeSwitcher
     # All functionality specific to running in 'local' mode
-    class LocalRunner
+    class LocalRunner < RunnerBase
       # 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 = {})
@@ -31,7 +32,11 @@ module Beaker
         cmd << "--debug" if opts[:debug]
         cmd << "--noop" if opts[:noop]
         cmd << "--trace" if opts[:trace]
-        use_local_shell(cmd.join(' '), opts)
+
+        res = use_local_shell(cmd.join(' '), opts)
+        handle_puppet_run_returned_exit_code(get_acceptable_puppet_run_exit_codes(opts), res.exit_code)
+
+        res
       end
 
       # build and execute complex puppet resource commands locally

data/lib/beaker/testmode_switcher/runner_base.rb

@@ -0,0 +1,35 @@
+module Beaker
+  module TestmodeSwitcher
+    # A standard error to be raised by runner classes when an unexpected exit code is returned
+    class UnacceptableExitCodeError < RuntimeError
+    end
+
+    # Contains functions used in both local runner and beaker runners
+    class RunnerBase
+      def get_acceptable_puppet_run_exit_codes(opts = {})
+        # Ensure only one option given
+        if [opts[:catch_changes], opts[:catch_failures], opts[:expect_failures], opts[:expect_changes]].compact.length > 1
+          raise(ArgumentError,
+                'Cannot specify more than one of `catch_failures`, \
+                 `catch_changes`, `expect_failures`, or `expect_changes` \
+                  for a single manifest')
+        end
+
+        # Return appropriate exit code
+        return [0]        if opts[:catch_changes]
+        return [0, 2]     if opts[:catch_failures]
+        return [1, 4, 6]  if opts[:expect_failures]
+        return [2]        if opts[:expect_changes]
+
+        # If no option supplied, return all exit codes, as an array,
+        # as acceptable so beaker returns a detailed output
+        (0...256)
+      end
+
+      def handle_puppet_run_returned_exit_code(acceptable_exit_codes, returned_exit_code)
+        return if acceptable_exit_codes.include?(returned_exit_code)
+        raise UnacceptableExitCodeError, "Unacceptable exit code returned: #{returned_exit_code}. Acceptable code(s): #{acceptable_exit_codes.join(', ')}"
+      end
+    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.1".freeze
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker-testmode_switcher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Puppet Labs
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-19 00:00:00.000000000 Z
+date: 2017-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaker
@@ -67,6 +67,7 @@ files:
 - lib/beaker/testmode_switcher/beaker_runners.rb
 - lib/beaker/testmode_switcher/dsl.rb
 - lib/beaker/testmode_switcher/local_runner.rb
+- lib/beaker/testmode_switcher/runner_base.rb
 - lib/beaker/testmode_switcher/version.rb
 homepage: https://github.com/puppetlabs/beaker-testmode_switcher
 licenses: []