acceptance_test_fixes

Author: pmcmaw

README.md

@@ -1163,6 +1163,8 @@ Converts the case of a string or of all strings in an array to lowercase.
 
 #### `empty`
 
+**Deprecated. Puppet 5.5.0 has introduced an inbuilt `empty` function, that will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value.
 
 *Type*: rvalue.
@@ -1274,6 +1276,8 @@ fact('vmware."VRA.version"')
 
 #### `flatten`
 
+**Deprecated. Puppet 5.5.0 has introduced an inbuilt `flatten` function, that will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Flattens deeply nested arrays and returns a single flat array as a result.
 
 For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c'].
@@ -1631,6 +1635,8 @@ Returns `true` if the variable passed to this function is a string.
 
 #### `join`
 
+**Deprecated. Puppet 5.5.0 has introduced an inbuilt `join` function, that will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c".
 
 *Type*: rvalue.
@@ -1647,12 +1653,16 @@ For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a i
 
 #### `keys`
 
+**Deprecated. Puppet 5.5.0 has introduced an inbuilt `keys` function, that will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns the keys of a hash as an array.
 
 *Type*: rvalue.
 
 #### `length`
 
+**Deprecated. Puppet 5.5.0 has introduced an inbuilt `length` function, that will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns the length of a given string, array or hash. Replaces the deprecated `size()` function.
 
 *Type*: rvalue.
@@ -2774,6 +2784,8 @@ validate_x509_rsa_key_pair($cert, $key)
 
 #### `values`
 
+**Deprecated. Puppet 5.5.0 has introduced an inbuilt `values` function, that will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns the values of a given hash.
 
 For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3].

lib/puppet/functions/length.rb

@@ -1,7 +1,8 @@
 # A function to eventually replace the old size() function for stdlib - The original size function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution.
 Puppet::Functions.create_function(:length) do
-  dispatch :length do
-    param 'Variant[String,Array,Hash]', :value
+  dispatch :deprecation_gen do
+    scope_param
+    optional_repeated_param 'Any', :args
   end
   def length(value)
     if value.is_a?(String)
@@ -10,5 +11,8 @@ def length(value)
       result = value.size
     end
     result
+  def deprecation_gen(scope, *args)
+    call_function('deprecation', 'length', "This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.")
+    scope.send("function_length", args)
   end
 end

lib/puppet/parser/functions/empty.rb

@@ -7,6 +7,8 @@ module Puppet::Parser::Functions
   DOC
              ) do |arguments|
 
+    function_deprecation([:empty, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.'])
+
     raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
     value = arguments[0]
 

lib/puppet/parser/functions/flatten.rb

@@ -14,6 +14,8 @@ module Puppet::Parser::Functions
   DOC
              ) do |arguments|
 
+    function_deprecation([:flatten, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes'])
+
     raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
     array = arguments[0]

lib/puppet/parser/functions/join.rb

@@ -13,6 +13,8 @@ module Puppet::Parser::Functions
     DOC
              ) do |arguments|
 
+    function_deprecation([:join, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes'])
+
     # Technically we support two arguments but only first is mandatory ...
     raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 

lib/puppet/parser/functions/keys.rb

@@ -7,6 +7,8 @@ module Puppet::Parser::Functions
     DOC
              ) do |arguments|
 
+    function_deprecation([:keys, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.'])
+
     raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     hash = arguments[0]

lib/puppet/parser/functions/values.rb

@@ -20,6 +20,8 @@ module Puppet::Parser::Functions
     DOC
              ) do |arguments|
 
+    function_deprecation([:values, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.'])
+
     raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     hash = arguments[0]

spec/acceptance/values_spec.rb

@@ -23,7 +23,8 @@
       notice(inline_template('<%= @output.inspect %>'))
     DOC
     it 'handles non-hash arguments' do
-      expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash})
+      expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) if return_puppet_version < '5.5.0'
+      expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{expects a Hash value}) if return_puppet_version >= '5.5.0'
     end
   end
 end

spec/functions/empty_spec.rb

@@ -2,7 +2,7 @@
 
 describe 'empty' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
   it {
     pending('Current implementation ignores parameters after the first.')
     is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError)

spec/functions/flatten_spec.rb

@@ -2,10 +2,10 @@
 
 describe 'flatten' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) }
-  it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) }
-  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) }
-  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
   it { is_expected.to run.with_params([]).and_return([]) }
   it { is_expected.to run.with_params(['one']).and_return(['one']) }
   it { is_expected.to run.with_params([['one']]).and_return(['one']) }

spec/functions/join_spec.rb

@@ -2,13 +2,13 @@
 
 describe 'join' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0'
   it {
     pending('Current implementation ignores parameters after the second.')
     is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i)
   }
-  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) }
-  it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) }
+  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } if Puppet.version < '5.5.0'
 
   it { is_expected.to run.with_params([]).and_return('') }
   it { is_expected.to run.with_params([], ':').and_return('') }

spec/functions/keys_spec.rb

@@ -2,22 +2,22 @@
 
 describe 'keys' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0'
   it {
     pending('Current implementation ignores parameters after the first.')
     is_expected.to run.with_params({}, {}).and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i)
   }
-  it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
-  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
-  it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
+  it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
   it { is_expected.to run.with_params({}).and_return([]) }
   it { is_expected.to run.with_params('key' => 'value').and_return(['key']) }
-  it 'returns the array of keys' do
+  it 'returns the array of keys', if: Puppet.version < '5.5.0' do
     result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }])
     expect(result).to match_array(%w[key1 key2])
   end
 
-  it 'runs with UTF8 and double byte characters' do
+  it 'runs with UTF8 and double byte characters', if: Puppet.version < '5.5.0' do
     result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }])
     expect(result).to match_array(%w[ҝểү キー])
   end

spec/functions/length_spec.rb

@@ -4,8 +4,8 @@
   it { is_expected.not_to eq(nil) }
   it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'length' expects 1 argument, got none}) }
   it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, %r{'length' expects 1 argument, got 2}) }
-  it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) }
-  it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) }
+  it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } if Puppet.version < '5.5.0'
   it { is_expected.to run.with_params('1').and_return(1) }
   it { is_expected.to run.with_params('1.0').and_return(3) }
   it { is_expected.to run.with_params([]).and_return(0) }

spec/functions/values_spec.rb

@@ -2,22 +2,22 @@
 
 describe 'values' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0'
   it {
     pending('Current implementation ignores parameters after the first.')
     is_expected.to run.with_params({}, 'extra').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i)
   }
-  it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
-  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
-  it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
+  it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
   it { is_expected.to run.with_params({}).and_return([]) }
   it { is_expected.to run.with_params('key' => 'value').and_return(['value']) }
-  it 'returns the array of values' do
+  it 'returns the array of values', if: Puppet.version < '5.5.0' do
     result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2', 'duplicate_value_key' => 'value2' }])
     expect(result).to match_array(%w[value1 value2 value2])
   end
 
-  it 'runs with UTF8 and double byte characters' do
+  it 'runs with UTF8 and double byte characters', if: Puppet.version < '5.5.0' do
     result = subject.call([{ 'かぎ' => '使用', 'ҝĕұ' => '√ẩŀứệ', 'ҝĕұďŭрļǐçằťè' => '√ẩŀứệ' }])
     expect(result).to match_array(['使用', '√ẩŀứệ', '√ẩŀứệ'])
   end