beaker 1.1.0 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzczNTY1ZTQ2MDkwOWE2YzhhNDhmMjVlNGVkZGQ0YmY4MTcwYjk2NA==
+    MWYxNzhkNWRkYTM2NzkxODFjODhjMDlhMmE2YWZhOWI0OWU1NjM3ZQ==
   data.tar.gz: !binary |-
-    ZmEwZWVjOGUwZGMyZjJmMGVjZWMxMWRjYmJkY2ZlYmU4Njc4MDMzYw==
+    ZWM4OWNhOTU3NzRlZGU1ZmUzODkyN2M5MmI1ZTRmYWEzYmNlY2I5Mw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWVmNmJjZGFlOTFkN2RiM2FiNjBiZDZlZThmMThkNDQ0NzY3YjE1OTYxMmY1
-    Zjg2NTk2NDA3NzkyYjYyNTU4ZDVlYWI5MDBiMWVjMjEyM2E2ZWViNTk0Zjg0
-    M2ZiNmVkMzYwNWQ5MDRkNzY2ZGE3YjQ5ZDY1ZDI0YjFkMjdjMzU=
+    NmZiYzYyYWQ5MDY1NGE0MmI2ZjZhY2QxZWVkZmE4OTY0MWI0ZjA2MDlkYjQx
+    ZTczY2E5ODUzMzcyY2QxNjg1YzllNjNiZDIzNjQwNDRlODRiNzJmMGZjZWY0
+    YTI4ZGEyN2FjOWEzOGI1MDI3MmY2ZGE0Mzk5MDcwMDlhMzZmOTA=
   data.tar.gz: !binary |-
-    YzdlM2U2Njk1MjAxYTg5MmMyNWU0Mzg0NGI5OWI2ZTMwMDgyODQwZGM4NDY2
-    MWYyY2E0ZDU2ZWQ5MjQwYWMzMzEzY2ViNjllNmQzMTI2YzAwNzFlZDQ0NDE3
-    OTJmN2E0NjBhOTczNjc5MGY5ZjkwNTMyZDRkMmNiMDVlY2ZlYzA=
+    NzgxNDdiNjYyMDEwMTYzM2I0M2RlZWU2NmMzNTVhZGQxMGZkMWUzOGQ5Mjc0
+    M2Q0YmIyMzZmOGQzZDVlYzZiMzRiOTJiZmQyYmJhNDJmNDhjMTczNjg4NDk1
+    MmFhMjM1YjUwYzRmNTBkOTkxMDZiM2M2ZDM3OTE1YmRhYTNkMzI=

data/beaker.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "beaker"
-  s.version     = '1.1.0'
+  s.version     = '1.2.0'
   s.authors     = ["Puppetlabs"]
   s.email       = ["delivery@puppetlabs.com"]
   s.homepage    = "https://github.com/puppetlabs/beaker"

data/lib/beaker/dsl/helpers.rb

@@ -636,13 +636,28 @@ module Beaker
       #                         the "--trace" command line parameter will be
       #                         passed to the 'puppet apply' command.
       #
+      # @option opts [Array<Integer>] :acceptable_exit_codes ([0]) The list of exit
+      #                          codes that will NOT raise an error when found upon
+      #                          command completion.  If provided, these values will
+      #                          be combined with those used in :catch_failures and
+      #                          :expect_failures to create the full list of 
+      #                          passing exit codes.
+      #
+      # @options opts [Hash]    :environment Additional environment variables to be
+      #                         passed to the 'puppet apply' command
+      #
       # @option opts [Boolean]  :catch_failures (false) By default
-      #                         "puppet --apply" will exit with 0,
+      #                         `puppet --apply` will exit with 0,
       #                         which does not count as a test
       #                         failure, even if there were errors applying
       #                         the manifest. This option enables detailed
       #                         exit codes and causes a test failure if
-      #                         "puppet --apply" indicates there was a
+      #                         `puppet --apply` indicates there was a
+      #                         failure during its execution.
+      #
+      # @option opts [Boolean]  :expect_failures (false) This option enables
+      #                         detailed exit codes and causes a test failure
+      #                         if `puppet --apply` indicates there were no
       #                         failure during its execution.
       #
       # @param [Block] block This method will yield to a block of code passed
@@ -651,20 +666,31 @@ module Beaker
       #
       def apply_manifest_on(host, manifest, opts = {}, &block)
         on_options = {:stdin => manifest + "\n"}
-        on_options[:acceptable_exit_codes] = opts.delete(:acceptable_exit_codes)
+        on_options[:acceptable_exit_codes] = Array(opts.delete(:acceptable_exit_codes)) 
         args = ["--verbose"]
         args << "--parseonly" if opts[:parseonly]
         args << "--trace" if opts[:trace]
 
+        # From puppet help:
+        # "... an exit code of '2' means there were changes, an exit code of
+        # '4' means there were failures during the transaction, and an exit
+        # code of '6' means there were both changes and failures."
+        if opts[:catch_failures] and opts[:expect_failures]
+          raise(ArgumentError, "Cannot specify both `catch_failures` and `expect_failures` for a single manifest")
+        end
         if opts[:catch_failures]
           args << '--detailed-exitcodes'
 
-          # From puppet help:
-          # "... an exit code of '2' means there were changes, an exit code of
-          # '4' means there were failures during the transaction, and an exit
-          # code of '6' means there were both changes and failures."
-          # We're after failures specifically so catch exit codes 4 and 6 only.
+          # We're after only complete success so allow exit codes 0 and 2 only.
           on_options[:acceptable_exit_codes] |= [0, 2]
+        elsif opts[:expect_failures]
+          args << '--detailed-exitcodes'
+
+          # We're after failures specifically so allow exit codes 1, 4, and 6 only.
+          on_options[:acceptable_exit_codes] |= [1, 4, 6]
+        else
+          # Either use the provided acceptable_exit_codes or default to [0]
+          on_options[:acceptable_exit_codes] |= [0]
         end
 
         # Not really thrilled with this implementation, might want to improve it

data/spec/beaker/dsl/helpers_spec.rb

@@ -297,6 +297,33 @@ describe ClassMixedWithDSLHelpers do
   end
 
   describe '#apply_manifest_on' do
+    it 'calls puppet' do
+      subject.should_receive( :puppet ).
+        with( 'apply', '--verbose').
+        and_return( 'puppet_command' )
+
+      subject.should_receive( :on ).
+        with( 'my_host', 'puppet_command',
+              :acceptable_exit_codes => [0],
+              :stdin => "class { \"boo\": }\n" )
+
+      subject.apply_manifest_on( 'my_host', 'class { "boo": }')
+    end
+    it 'adds acceptable exit codes with :catch_failures' do
+      subject.should_receive( :puppet ).
+        with( 'apply', '--verbose', '--trace', '--detailed-exitcodes' ).
+        and_return( 'puppet_command' )
+
+      subject.should_receive( :on ).
+        with( 'my_host', 'puppet_command',
+              :acceptable_exit_codes => [0,2],
+              :stdin => "class { \"boo\": }\n" )
+
+      subject.apply_manifest_on( 'my_host',
+                                'class { "boo": }',
+                                :trace => true,
+                                :catch_failures => true )
+    end
     it 'allows acceptable exit codes through :catch_failures' do
       subject.should_receive( :puppet ).
         with( 'apply', '--verbose', '--trace', '--detailed-exitcodes' ).
@@ -313,6 +340,56 @@ describe ClassMixedWithDSLHelpers do
                                 :trace => true,
                                 :catch_failures => true )
     end
+    it 'enforces exit codes through :expect_failures' do
+      subject.should_receive( :puppet ).
+        with( 'apply', '--verbose', '--trace', '--detailed-exitcodes' ).
+        and_return( 'puppet_command' )
+
+      subject.should_receive( :on ).with(
+        'my_host',
+        'puppet_command',
+        :acceptable_exit_codes => [1,4,6],
+        :stdin                 => "class { \"boo\": }\n"
+      )
+
+      subject.apply_manifest_on(
+        'my_host',
+        'class { "boo": }',
+        :trace           => true,
+        :expect_failures => true
+      )
+    end
+    it 'enforces exit codes through :expect_failures' do
+      expect {
+        subject.apply_manifest_on(
+          'my_host',
+          'class { "boo": }',
+          :trace           => true,
+          :expect_failures => true,
+          :catch_failures  => true
+        )
+      }.to raise_error ArgumentError, /catch_failures.+expect_failures/
+    end
+    it 'enforces added exit codes through :expect_failures' do
+      subject.should_receive( :puppet ).
+        with( 'apply', '--verbose', '--trace', '--detailed-exitcodes' ).
+        and_return( 'puppet_command' )
+
+      subject.should_receive( :on ).with(
+        'my_host',
+        'puppet_command',
+        :acceptable_exit_codes => [1,2,3,4,5,6],
+        :stdin                 => "class { \"boo\": }\n"
+      )
+
+      subject.apply_manifest_on(
+        'my_host',
+        'class { "boo": }',
+        :acceptable_exit_codes => (1..5),
+        :trace                 => true,
+        :expect_failures       => true
+      )
+    end
   end
 
   describe "#apply_manifest" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Puppetlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-04 00:00:00.000000000 Z
+date: 2013-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec