summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.markdown2
-rw-r--r--lib/facter/puppet_settings.rb35
-rw-r--r--lib/facter/puppet_vardir.rb26
-rw-r--r--lib/puppet/functions/validate_absolute_path.rb3
-rw-r--r--lib/puppet/functions/validate_array.rb3
-rw-r--r--lib/puppet/functions/validate_bool.rb3
-rw-r--r--lib/puppet/functions/validate_hash.rb3
-rw-r--r--lib/puppet/functions/validate_integer.rb3
-rw-r--r--lib/puppet/functions/validate_ip_address.rb3
-rw-r--r--lib/puppet/functions/validate_ipv4_address.rb3
-rw-r--r--lib/puppet/functions/validate_ipv6_address.rb3
-rw-r--r--lib/puppet/functions/validate_numeric.rb3
-rw-r--r--lib/puppet/functions/validate_re.rb3
-rw-r--r--lib/puppet/functions/validate_string.rb3
-rw-r--r--lib/puppet/parser/functions/dig44.rb37
-rw-r--r--lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb21
-rwxr-xr-xspec/acceptance/validate_array_spec.rb16
-rwxr-xr-xspec/acceptance/validate_bool_spec.rb16
-rwxr-xr-xspec/acceptance/validate_hash_spec.rb16
-rw-r--r--spec/functions/dig44_spec.rb119
20 files changed, 177 insertions, 144 deletions
diff --git a/README.markdown b/README.markdown
index 5130f64..667da33 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1437,7 +1437,7 @@ Example:
#### `validate_numeric`
-Validates that the first argument is a numeric value (or an array of numeric values). Aborts catalog compilation if any of the checks fail.
+Validates that the first argument is a numeric value (or an array or string of numeric values). Aborts catalog compilation if any of the checks fail.
The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max.
diff --git a/lib/facter/puppet_settings.rb b/lib/facter/puppet_settings.rb
new file mode 100644
index 0000000..e6a066a
--- /dev/null
+++ b/lib/facter/puppet_settings.rb
@@ -0,0 +1,35 @@
+# These facter facts return the value of the Puppet vardir and environment path
+# settings for the node running puppet or puppet agent. The intent is to
+# enable Puppet modules to automatically have insight into a place where they
+# can place variable data, or for modules running on the puppet master to know
+# where environments are stored.
+#
+# The values should be directly usable in a File resource path attribute.
+#
+begin
+ require 'facter/util/puppet_settings'
+rescue LoadError => e
+ # puppet apply does not add module lib directories to the $LOAD_PATH (See
+ # #4248). It should (in the future) but for the time being we need to be
+ # defensive which is what this rescue block is doing.
+ rb_file = File.join(File.dirname(__FILE__), 'util', 'puppet_settings.rb')
+ load rb_file if File.exists?(rb_file) or raise e
+end
+
+
+# These will be nil if Puppet is not available.
+Facter.add(:puppet_vardir) do
+ setcode do
+ Facter::Util::PuppetSettings.with_puppet do
+ Puppet[:vardir]
+ end
+ end
+end
+
+Facter.add(:puppet_environmentpath) do
+ setcode do
+ Facter::Util::PuppetSettings.with_puppet do
+ Puppet[:environmentpath]
+ end
+ end
+end
diff --git a/lib/facter/puppet_vardir.rb b/lib/facter/puppet_vardir.rb
deleted file mode 100644
index 0e6af40..0000000
--- a/lib/facter/puppet_vardir.rb
+++ /dev/null
@@ -1,26 +0,0 @@
-# This facter fact returns the value of the Puppet vardir setting for the node
-# running puppet or puppet agent. The intent is to enable Puppet modules to
-# automatically have insight into a place where they can place variable data,
-# regardless of the node's platform.
-#
-# The value should be directly usable in a File resource path attribute.
-
-
-begin
- require 'facter/util/puppet_settings'
-rescue LoadError => e
- # puppet apply does not add module lib directories to the $LOAD_PATH (See
- # #4248). It should (in the future) but for the time being we need to be
- # defensive which is what this rescue block is doing.
- rb_file = File.join(File.dirname(__FILE__), 'util', 'puppet_settings.rb')
- load rb_file if File.exists?(rb_file) or raise e
-end
-
-Facter.add(:puppet_vardir) do
- setcode do
- # This will be nil if Puppet is not available.
- Facter::Util::PuppetSettings.with_puppet do
- Puppet[:vardir]
- end
- end
-end
diff --git a/lib/puppet/functions/validate_absolute_path.rb b/lib/puppet/functions/validate_absolute_path.rb
deleted file mode 100644
index 5ae9d29..0000000
--- a/lib/puppet/functions/validate_absolute_path.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_absolute_path", "Stdlib::Compat::Absolute_Path")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_array.rb b/lib/puppet/functions/validate_array.rb
deleted file mode 100644
index 9155784..0000000
--- a/lib/puppet/functions/validate_array.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_array", "Stdlib::Compat::Array")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_bool.rb b/lib/puppet/functions/validate_bool.rb
deleted file mode 100644
index 10f6edf..0000000
--- a/lib/puppet/functions/validate_bool.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_bool", "Stdlib::Compat::Bool")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_hash.rb b/lib/puppet/functions/validate_hash.rb
deleted file mode 100644
index 5349664..0000000
--- a/lib/puppet/functions/validate_hash.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_hash", "Stdlib::Compat::Hash")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_integer.rb b/lib/puppet/functions/validate_integer.rb
deleted file mode 100644
index 2c4645d..0000000
--- a/lib/puppet/functions/validate_integer.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_integer", "Stdlib::Compat::Integer")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_ip_address.rb b/lib/puppet/functions/validate_ip_address.rb
deleted file mode 100644
index 15a710e..0000000
--- a/lib/puppet/functions/validate_ip_address.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ip_address", "Stdlib::Compat::Ip_Address")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_ipv4_address.rb b/lib/puppet/functions/validate_ipv4_address.rb
deleted file mode 100644
index 8e1bc59..0000000
--- a/lib/puppet/functions/validate_ipv4_address.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv4_address", "Stdlib::Compat::Ipv4_Address")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_ipv6_address.rb b/lib/puppet/functions/validate_ipv6_address.rb
deleted file mode 100644
index 865648a..0000000
--- a/lib/puppet/functions/validate_ipv6_address.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_ipv6_address", "Stdlib::Compat::Ipv6_address")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_numeric.rb b/lib/puppet/functions/validate_numeric.rb
deleted file mode 100644
index 0c2e1f2..0000000
--- a/lib/puppet/functions/validate_numeric.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_numeric", "Stdlib::Compat::Numeric")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_re.rb b/lib/puppet/functions/validate_re.rb
deleted file mode 100644
index d63ed42..0000000
--- a/lib/puppet/functions/validate_re.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_re", "Stdlib::Compat::Re")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/functions/validate_string.rb b/lib/puppet/functions/validate_string.rb
deleted file mode 100644
index a196f43..0000000
--- a/lib/puppet/functions/validate_string.rb
+++ /dev/null
@@ -1,3 +0,0 @@
-require 'puppet_x/puppetlabs/stdlib/deprecation_gen'
-PuppetX::Puppetlabs::Stdlib.deprecation_gen("validate_string", "Stdlib::Compat::String")
-# Puppet::Functions.create_function
diff --git a/lib/puppet/parser/functions/dig44.rb b/lib/puppet/parser/functions/dig44.rb
index a7de363..1e7c318 100644
--- a/lib/puppet/parser/functions/dig44.rb
+++ b/lib/puppet/parser/functions/dig44.rb
@@ -3,21 +3,28 @@
#
module Puppet::Parser::Functions
- newfunction(:dig44, :type => :rvalue, :doc => <<-EOS
+ newfunction(
+ :dig44,
+ :type => :rvalue,
+ :arity => -2,
+ :doc => <<-eos
DEPRECATED: This function has been replaced in puppet 4.5.0.
-Looks up into a complex structure of arrays and hashes and returns nil
+Looks up into a complex structure of arrays and hashes and returns a value
or the default value if nothing was found.
-Path is an array of keys to be looked up in data argument. The function
-will go down the structure and try to extract the required value.
+Key can contain slashes to describe path components. The function will go down
+the structure and try to extract the required value.
$data = {
'a' => {
'b' => [
'b1',
'b2',
- 'b3' ]}}
+ 'b3',
+ ]
+ }
+}
$value = dig44($data, ['a', 'b', '2'], 'not_found')
=> $value = 'b3'
@@ -29,18 +36,18 @@ b -> second hash key
not_found -> (optional) will be returned if there is no value or the path
did not match. Defaults to nil.
-In addition to the required "path" argument, "dig44" accepts default
+In addition to the required "key" argument, the function accepts a default
argument. It will be returned if no value was found or a path component is
missing. And the fourth argument can set a variable path separator.
- EOS
- ) do |arguments|
+ eos
+ ) do |arguments|
# Two arguments are required
raise(Puppet::ParseError, "dig44(): Wrong number of arguments " +
"given (#{arguments.size} for at least 2)") if arguments.size < 2
data, path, default = *arguments
- if !(data.is_a?(Hash) || data.is_a?(Array))
+ unless data.is_a?(Hash) or data.is_a?(Array)
raise(Puppet::ParseError, "dig44(): first argument must be a hash or an array, " <<
"given #{data.class.name}")
end
@@ -50,7 +57,17 @@ missing. And the fourth argument can set a variable path separator.
"given #{path.class.name}")
end
- value = path.reduce(data) { |h, k| (h.is_a?(Hash) || h.is_a?(Array)) ? h[k] : break }
+ value = path.reduce(data) do |structure, key|
+ if structure.is_a? Hash or structure.is_a? Array
+ if structure.is_a? Array
+ key = Integer key rescue break
+ end
+ break if structure[key].nil? or structure[key] == :undef
+ structure[key]
+ else
+ break
+ end
+ end
value.nil? ? default : value
end
end
diff --git a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb b/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb
deleted file mode 100644
index a3d830b..0000000
--- a/lib/puppet_x/puppetlabs/stdlib/deprecation_gen.rb
+++ /dev/null
@@ -1,21 +0,0 @@
-# Creates a Puppet 4 function for the corresponding puppet 3 validate function, who's name will be passed as an argument, alongside the type for deprecation output purposes.
-module PuppetX
- module Puppetlabs
- module Stdlib
- def self.deprecation_gen(funct, type)
- Puppet::Functions.create_function(funct, Puppet::Functions::InternalFunction) do
- @@funct = funct
- @@type = type
- dispatch :deprecation_gen do
- scope_param
- optional_repeated_param 'Any', :args
- end
- def deprecation_gen(scope, *args)
- call_function('deprecation', 'puppet_3_type_check', "This method is deprecated, please use the stdlib validate_legacy function, with #{@@type}. There is further documentation for validate_legacy function in the README.")
- scope.send("function_#{@@funct}", args)
- end
- end
- end
- end
- end
-end
diff --git a/spec/acceptance/validate_array_spec.rb b/spec/acceptance/validate_array_spec.rb
index 2f549d5..b53e98c 100755
--- a/spec/acceptance/validate_array_spec.rb
+++ b/spec/acceptance/validate_array_spec.rb
@@ -20,14 +20,14 @@ describe 'validate_array function', :unless => UNSUPPORTED_PLATFORMS.include?(fa
apply_manifest(pp, :catch_failures => true)
end
- [
- %{validate_array({'a' => 'hash' })},
- %{validate_array('string')},
- %{validate_array(false)},
- %{validate_array(undef)}
- ].each do |pp|
- it "rejects #{pp.inspect}" do
- expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not an Array\. It looks to be a/)
+ it 'validates a non-array' do
+ {
+ %{validate_array({'a' => 'hash' })} => "Hash",
+ %{validate_array('string')} => "String",
+ %{validate_array(false)} => "FalseClass",
+ %{validate_array(undef)} => "String"
+ }.each do |pp,type|
+ expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/)
end
end
end
diff --git a/spec/acceptance/validate_bool_spec.rb b/spec/acceptance/validate_bool_spec.rb
index 5c52d0f..c837f08 100755
--- a/spec/acceptance/validate_bool_spec.rb
+++ b/spec/acceptance/validate_bool_spec.rb
@@ -20,14 +20,14 @@ describe 'validate_bool function', :unless => UNSUPPORTED_PLATFORMS.include?(fac
apply_manifest(pp, :catch_failures => true)
end
- [
- %{validate_bool('true')},
- %{validate_bool('false')},
- %{validate_bool([true])},
- %{validate_bool(undef)}
- ].each do |pp|
- it "rejects #{pp.inspect}" do
- expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/is not a boolean\. It looks to be a/)
+ it 'validates a non-bool' do
+ {
+ %{validate_bool('true')} => "String",
+ %{validate_bool('false')} => "String",
+ %{validate_bool([true])} => "Array",
+ %{validate_bool(undef)} => "String",
+ }.each do |pp,type|
+ expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/)
end
end
end
diff --git a/spec/acceptance/validate_hash_spec.rb b/spec/acceptance/validate_hash_spec.rb
index 637df0a..52fb615 100755
--- a/spec/acceptance/validate_hash_spec.rb
+++ b/spec/acceptance/validate_hash_spec.rb
@@ -20,14 +20,14 @@ describe 'validate_hash function', :unless => UNSUPPORTED_PLATFORMS.include?(fac
apply_manifest(pp, :catch_failures => true)
end
- [
- %{validate_hash('{ "not" => "hash" }')},
- %{validate_hash('string')},
- %{validate_hash(["array"])},
- %{validate_hash(undef)}
- ].each do |pp|
- it "rejects #{pp.inspect}" do
- expect(apply_manifest(pp, :expect_failures => true).stderr).to match(//)
+ it 'validates a non-hash' do
+ {
+ %{validate_hash('{ "not" => "hash" }')} => "String",
+ %{validate_hash('string')} => "String",
+ %{validate_hash(["array"])} => "Array",
+ %{validate_hash(undef)} => "String",
+ }.each do |pp,type|
+ expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/a #{type}/)
end
end
end
diff --git a/spec/functions/dig44_spec.rb b/spec/functions/dig44_spec.rb
index fd451ff..4f7408d 100644
--- a/spec/functions/dig44_spec.rb
+++ b/spec/functions/dig44_spec.rb
@@ -1,44 +1,105 @@
require 'spec_helper'
describe 'dig44' do
- it "should exist" do
- expect(Puppet::Parser::Functions.function("dig44")).to eq("function_dig44")
+
+ let(:data) do
+ {
+ 'a' => {
+ 'g' => '2',
+ 'e' => [
+ 'f0',
+ 'f1',
+ {
+ 'x' => {
+ 'y' => 'z'
+ }
+ },
+ 'f3',
+ ]
+ },
+ 'b' => true,
+ 'c' => false,
+ 'd' => '1',
+ 'e' => :undef,
+ 'f' => nil,
+ }
end
- it "should raise a ParseError if there are less than 2 arguments" do
- expect { scope.function_dig44([]) }.to raise_error(Puppet::ParseError)
- end
+ context 'single values' do
+ it 'should exist' do
+ is_expected.not_to be_nil
+ end
- it "should raise a ParseError if the first argument isn't a hash or array" do
- expect { scope.function_dig44(['bad', []]) }.to raise_error(Puppet::ParseError)
- end
+ it 'should require two arguments' do
+ is_expected.to run.with_params().and_raise_error(ArgumentError)
+ end
- it "should raise a ParseError if the second argument isn't an array" do
- expect { scope.function_dig44([{}, 'bad']) }.to raise_error(Puppet::ParseError)
- end
+ it 'should fail if the data is not a structure' do
+ is_expected.to run.with_params('test', []).and_raise_error(Puppet::Error)
+ end
- it "should return an empty hash when given empty parameters" do
- result = scope.function_dig44([{}, []])
- expect(result).to(eq({}))
- end
+ it 'should fail if the path is not an array' do
+ is_expected.to run.with_params({}, '').and_raise_error(Puppet::Error)
+ end
- it "should return value when given simple hash" do
- result = scope.function_dig44([{"a" => "b"}, ["a"]])
- expect(result).to(eq("b"))
- end
+ it 'should return the value if the value is string' do
+ is_expected.to run.with_params(data, ['d'], 'default').and_return('1')
+ end
- it "should find hash values two levels deep" do
- result = scope.function_dig44([{"a" => {"b" => "c"}}, ["a", "b"]])
- expect(result).to(eq("c"))
- end
+ it 'should return true if the value is true' do
+ is_expected.to run.with_params(data, ['b'], 'default').and_return(true)
+ end
- it "should return default value if nothing was found" do
- result = scope.function_dig44([{}, ["a", "b"], "d"])
- expect(result).to(eq("d"))
+ it 'should return false if the value is false' do
+ is_expected.to run.with_params(data, ['c'], 'default').and_return(false)
+ end
+
+ it 'should return the default if the value is nil' do
+ is_expected.to run.with_params(data, ['f'], 'default').and_return('default')
+ end
+
+ it 'should return the default if the value is :undef (same as nil)' do
+ is_expected.to run.with_params(data, ['e'], 'default').and_return('default')
+ end
+
+ it 'should return the default if the path is not found' do
+ is_expected.to run.with_params(data, ['missing'], 'default').and_return('default')
+ end
end
- it "should work on booleans as well as strings" do
- result = scope.function_dig44([{"a" => false}, ["a"]])
- expect(result).to(eq(false))
+ context 'structure values' do
+
+ it 'should be able to extract a deeply nested hash value' do
+ is_expected.to run.with_params(data, %w(a g), 'default').and_return('2')
+ end
+
+ it 'should return the default value if the path is too long' do
+ is_expected.to run.with_params(data, %w(a g c d), 'default').and_return('default')
+ end
+
+ it 'should support an array index (number) in the path' do
+ is_expected.to run.with_params(data, ['a', 'e', 1], 'default').and_return('f1')
+ end
+
+ it 'should support an array index (string) in the path' do
+ is_expected.to run.with_params(data, %w(a e 1), 'default').and_return('f1')
+ end
+
+ it 'should return the default value if an array index is not a number' do
+ is_expected.to run.with_params(data, %w(a b c), 'default').and_return('default')
+ end
+
+ it 'should return the default value if and index is out of array length' do
+ is_expected.to run.with_params(data, %w(a e 5), 'default').and_return('default')
+ end
+
+ it 'should be able to path though both arrays and hashes' do
+ is_expected.to run.with_params(data, %w(a e 2 x y), 'default').and_return('z')
+ end
+
+ it 'should return "nil" if value is not found and no default value is provided' do
+ is_expected.to run.with_params(data, %w(a 1)).and_return(nil)
+ end
+
end
end