summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff McCune <jeff@puppetlabs.com>2011-08-04 16:05:49 -0700
committerJeff McCune <jeff@puppetlabs.com>2011-08-04 16:07:46 -0700
commit7e3b9b728acc0d6b563b096957e030ce583ee15f (patch)
treea8aa7f916e6c64be66207d504a00a20d623e79c8
parent66cfee6f22e474b05dc1d6001a6e1636d8c33bf1 (diff)
parent7393de98955892a3f32416a65a31852d797da9a6 (diff)
downloadpuppet-stdlib-7e3b9b728acc0d6b563b096957e030ce583ee15f.tar.gz
puppet-stdlib-7e3b9b728acc0d6b563b096957e030ce583ee15f.tar.bz2
Merge branch 'ticket/master/8678_validate_array_string'
* ticket/master/8678_validate_array_string: (#8678) Add validate_array and validate_string functions
-rw-r--r--lib/puppet/parser/functions/validate_array.rb35
-rw-r--r--lib/puppet/parser/functions/validate_string.rb35
-rw-r--r--spec/unit/puppet/parser/functions/validate_array_spec.rb63
-rw-r--r--spec/unit/puppet/parser/functions/validate_string_spec.rb83
4 files changed, 216 insertions, 0 deletions
diff --git a/lib/puppet/parser/functions/validate_array.rb b/lib/puppet/parser/functions/validate_array.rb
new file mode 100644
index 0000000..a7a7165
--- /dev/null
+++ b/lib/puppet/parser/functions/validate_array.rb
@@ -0,0 +1,35 @@
+module Puppet::Parser::Functions
+
+ newfunction(:validate_array, :doc => <<-'ENDHEREDOC') do |args|
+ Validate all passed values are a Array data structure
+ value does not pass the check.
+
+ Example:
+
+ These values validate
+
+ $my_array = [ 'one', 'two' ]
+ validate_array($my_array)
+
+ These values do NOT validate
+
+ validate_array(true)
+ validate_array('some_string')
+ $undefined = undef
+ validate_array($undefined)
+
+ ENDHEREDOC
+
+ unless args.length > 0 then
+ raise Puppet::ParseError, ("validate_array(): wrong number of arguments (#{args.length}; must be > 0)")
+ end
+
+ args.each do |arg|
+ unless arg.is_a?(Array)
+ raise Puppet::ParseError, ("#{arg.inspect} is not an Array. It looks to be a #{arg.class}")
+ end
+ end
+
+ end
+
+end
diff --git a/lib/puppet/parser/functions/validate_string.rb b/lib/puppet/parser/functions/validate_string.rb
new file mode 100644
index 0000000..d0e1376
--- /dev/null
+++ b/lib/puppet/parser/functions/validate_string.rb
@@ -0,0 +1,35 @@
+module Puppet::Parser::Functions
+
+ newfunction(:validate_string, :doc => <<-'ENDHEREDOC') do |args|
+ Validate all passed values are a string data structure
+ value does not pass the check.
+
+ Example:
+
+ These values validate
+
+ $my_string = "one two"
+ validate_string($my_string)
+
+ These values do NOT validate
+
+ validate_string(true)
+ validate_string([ 'some', 'array' ])
+ $undefined = undef
+ validate_string($undefined)
+
+ ENDHEREDOC
+
+ unless args.length > 0 then
+ raise Puppet::ParseError, ("validate_string(): wrong number of arguments (#{args.length}; must be > 0)")
+ end
+
+ args.each do |arg|
+ unless arg.is_a?(String)
+ raise Puppet::ParseError, ("#{arg.inspect} is not a string. It looks to be a #{arg.class}")
+ end
+ end
+
+ end
+
+end
diff --git a/spec/unit/puppet/parser/functions/validate_array_spec.rb b/spec/unit/puppet/parser/functions/validate_array_spec.rb
new file mode 100644
index 0000000..37ae09d
--- /dev/null
+++ b/spec/unit/puppet/parser/functions/validate_array_spec.rb
@@ -0,0 +1,63 @@
+require 'puppet'
+
+# We don't need this for the basic tests we're doing
+# require 'spec_helper'
+
+# Dan mentioned that Nick recommended the function method call
+# to return the string value for the test description.
+# this will not even try the test if the function cannot be
+# loaded.
+describe Puppet::Parser::Functions.function(:validate_array) do
+
+ # Pulled from Dan's create_resources function
+ def get_scope
+ @topscope = Puppet::Parser::Scope.new
+ # This is necessary so we don't try to use the compiler to discover our parent.
+ @topscope.parent = nil
+ @scope = Puppet::Parser::Scope.new
+ @scope.compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("floppy", :environment => 'production'))
+ @scope.parent = @topscope
+ @compiler = @scope.compiler
+ end
+
+ describe 'when calling validate_array from puppet' do
+
+ %w{ true false }.each do |the_string|
+
+ it "should not compile when #{the_string} is a string" do
+ Puppet[:code] = "validate_array('#{the_string}')"
+ get_scope
+ expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not an Array/)
+ end
+
+ it "should not compile when #{the_string} is a bare word" do
+ Puppet[:code] = "validate_array(#{the_string})"
+ get_scope
+ expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not an Array/)
+ end
+
+ end
+
+ it "should compile when multiple array arguments are passed" do
+ Puppet[:code] = <<-'ENDofPUPPETcode'
+ $foo = [ ]
+ $bar = [ 'one', 'two' ]
+ validate_array($foo, $bar)
+ ENDofPUPPETcode
+ get_scope
+ @scope.compiler.compile
+ end
+
+ it "should not compile when an undef variable is passed" do
+ Puppet[:code] = <<-'ENDofPUPPETcode'
+ $foo = undef
+ validate_array($foo)
+ ENDofPUPPETcode
+ get_scope
+ expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not an Array/)
+ end
+
+ end
+
+end
+
diff --git a/spec/unit/puppet/parser/functions/validate_string_spec.rb b/spec/unit/puppet/parser/functions/validate_string_spec.rb
new file mode 100644
index 0000000..92392da
--- /dev/null
+++ b/spec/unit/puppet/parser/functions/validate_string_spec.rb
@@ -0,0 +1,83 @@
+require 'puppet'
+
+# We don't need this for the basic tests we're doing
+# require 'spec_helper'
+
+# Dan mentioned that Nick recommended the function method call
+# to return the string value for the test description.
+# this will not even try the test if the function cannot be
+# loaded.
+describe Puppet::Parser::Functions.function(:validate_string) do
+
+ # Pulled from Dan's create_resources function
+ def get_scope
+ @topscope = Puppet::Parser::Scope.new
+ # This is necessary so we don't try to use the compiler to discover our parent.
+ @topscope.parent = nil
+ @scope = Puppet::Parser::Scope.new
+ @scope.compiler = Puppet::Parser::Compiler.new(Puppet::Node.new("floppy", :environment => 'production'))
+ @scope.parent = @topscope
+ @compiler = @scope.compiler
+ end
+
+ describe 'when calling validate_string from puppet' do
+
+ %w{ foo bar baz }.each do |the_string|
+
+ it "should compile when #{the_string} is a string" do
+ Puppet[:code] = "validate_string('#{the_string}')"
+ get_scope
+ @scope.compiler.compile
+ end
+
+ it "should compile when #{the_string} is a bare word" do
+ Puppet[:code] = "validate_string(#{the_string})"
+ get_scope
+ @scope.compiler.compile
+ end
+
+ end
+
+ %w{ true false }.each do |the_string|
+ it "should compile when #{the_string} is a string" do
+ Puppet[:code] = "validate_string('#{the_string}')"
+ get_scope
+ @scope.compiler.compile
+ end
+
+ it "should not compile when #{the_string} is a bare word" do
+ Puppet[:code] = "validate_string(#{the_string})"
+ get_scope
+ expect { @scope.compiler.compile }.should raise_error(Puppet::ParseError, /is not a string/)
+ end
+ end
+
+ it "should compile when multiple string arguments are passed" do
+ Puppet[:code] = <<-'ENDofPUPPETcode'
+ $foo = ''
+ $bar = 'two'
+ validate_string($foo, $bar)
+ ENDofPUPPETcode
+ get_scope
+ @scope.compiler.compile
+ end
+
+ it "should compile when an explicitly undef variable is passed (NOTE THIS MAY NOT BE DESIRABLE)" do
+ Puppet[:code] = <<-'ENDofPUPPETcode'
+ $foo = undef
+ validate_string($foo)
+ ENDofPUPPETcode
+ get_scope
+ @scope.compiler.compile
+ end
+
+ it "should compile when an undefined variable is passed (NOTE THIS MAY NOT BE DESIRABLE)" do
+ Puppet[:code] = <<-'ENDofPUPPETcode'
+ validate_string($foobarbazishouldnotexist)
+ ENDofPUPPETcode
+ get_scope
+ @scope.compiler.compile
+ end
+ end
+end
+