summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHunter Haugen <hunter@puppetlabs.com>2016-03-15 16:48:50 -0700
committerHunter Haugen <hunter@puppetlabs.com>2016-03-15 16:48:50 -0700
commit72f6e379a647396c276d7f216b307361ac76f376 (patch)
treeffc8b06eaa817edf29b48254f3e06959c0f90090
parent69ca8d09c6124e9b5bd98e62fb201e734ae5bd05 (diff)
parent0378336f9cefea65675d03f1d7107c75cb950fb6 (diff)
downloadpuppet-stdlib-72f6e379a647396c276d7f216b307361ac76f376.tar.gz
puppet-stdlib-72f6e379a647396c276d7f216b307361ac76f376.tar.bz2
Merge pull request #577 from EmilienM/enclose_ipv6
Add enclose_ipv6 function
-rw-r--r--README.markdown5
-rw-r--r--lib/puppet/parser/functions/enclose_ipv6.rb45
-rw-r--r--spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb69
3 files changed, 119 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 994c22e..c9bbdad 100644
--- a/README.markdown
+++ b/README.markdown
@@ -344,6 +344,11 @@ Converts the case of a string or of all strings in an array to lowercase. *Type*
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.
+#### `enclose_ipv6`
+
+Takes an array of ip addresses and encloses the ipv6 addresses with square
+brackets. *Type*: rvalue.
+
#### `ensure_packages`
Takes a list of packages and only installs them if they don't already exist. It optionally takes a hash as a second parameter to be passed as the third argument to the `ensure_resource()` function. *Type*: statement.
diff --git a/lib/puppet/parser/functions/enclose_ipv6.rb b/lib/puppet/parser/functions/enclose_ipv6.rb
new file mode 100644
index 0000000..80ffc3a
--- /dev/null
+++ b/lib/puppet/parser/functions/enclose_ipv6.rb
@@ -0,0 +1,45 @@
+#
+# enclose_ipv6.rb
+#
+
+module Puppet::Parser::Functions
+ newfunction(:enclose_ipv6, :type => :rvalue, :doc => <<-EOS
+Takes an array of ip addresses and encloses the ipv6 addresses with square brackets.
+ EOS
+ ) do |arguments|
+
+ require 'ipaddr'
+
+ rescuable_exceptions = [ ArgumentError ]
+ if defined?(IPAddr::InvalidAddressError)
+ rescuable_exceptions << IPAddr::InvalidAddressError
+ end
+
+ if (arguments.size != 1) then
+ raise(Puppet::ParseError, "enclose_ipv6(): Wrong number of arguments "+
+ "given #{arguments.size} for 1")
+ end
+ unless arguments[0].is_a?(String) or arguments[0].is_a?(Array) then
+ raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument type "+
+ "given #{arguments[0].class} expected String or Array")
+ end
+
+ input = [arguments[0]].flatten.compact
+ result = []
+
+ input.each do |val|
+ unless val == '*'
+ begin
+ ip = IPAddr.new(val)
+ rescue *rescuable_exceptions
+ raise(Puppet::ParseError, "enclose_ipv6(): Wrong argument "+
+ "given #{val} is not an ip address.")
+ end
+ val = "[#{ip.to_s}]" if ip.ipv6?
+ end
+ result << val
+ end
+
+ return result.uniq
+ end
+end
diff --git a/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb
new file mode 100644
index 0000000..b162127
--- /dev/null
+++ b/spec/unit/puppet/parser/functions/enclose_ipv6_spec.rb
@@ -0,0 +1,69 @@
+#! /usr/bin/env ruby -S rspec
+require 'spec_helper'
+
+describe "the enclose_ipv6 function" do
+ let(:scope) { PuppetlabsSpec::PuppetInternals.scope }
+
+ it "should exist" do
+ expect(Puppet::Parser::Functions.function("enclose_ipv6")).to eq("function_enclose_ipv6")
+ end
+
+ it "should raise a ParseError if there is less than 1 arguments" do
+ expect { scope.function_enclose_ipv6([]) }.to( raise_error(Puppet::ParseError) )
+ end
+
+ it "should raise a ParseError if there is more than 1 arguments" do
+ expect { scope.function_enclose_ipv6(['argument1','argument2']) }.to( raise_error(Puppet::ParseError) )
+ end
+
+ it "should raise a ParseError when given garbage" do
+ expect { scope.function_enclose_ipv6(['garbage']) }.to( raise_error(Puppet::ParseError) )
+ end
+
+ it "should raise a ParseError when given something else than a string or an array" do
+ expect { scope.function_enclose_ipv6([['1' => '127.0.0.1']]) }.to( raise_error(Puppet::ParseError) )
+ end
+
+ it "should not raise a ParseError when given a single ip string" do
+ expect { scope.function_enclose_ipv6(['127.0.0.1']) }.to_not raise_error
+ end
+
+ it "should not raise a ParseError when given * as ip string" do
+ expect { scope.function_enclose_ipv6(['*']) }.to_not raise_error
+ end
+
+ it "should not raise a ParseError when given an array of ip strings" do
+ expect { scope.function_enclose_ipv6([['127.0.0.1','fe80::1']]) }.to_not raise_error
+ end
+
+ it "should not raise a ParseError when given differently notations of ip addresses" do
+ expect { scope.function_enclose_ipv6([['127.0.0.1','fe80::1','[fe80::1]']]) }.to_not raise_error
+ end
+
+ it "should raise a ParseError when given a wrong ipv4 address" do
+ expect { scope.function_enclose_ipv6(['127..0.0.1']) }.to( raise_error(Puppet::ParseError) )
+ end
+
+ it "should raise a ParseError when given a ipv4 address with square brackets" do
+ expect { scope.function_enclose_ipv6(['[127.0.0.1]']) }.to( raise_error(Puppet::ParseError) )
+ end
+
+ it "should raise a ParseError when given a wrong ipv6 address" do
+ expect { scope.function_enclose_ipv6(['fe80:::1']) }.to( raise_error(Puppet::ParseError) )
+ end
+
+ it "should embrace ipv6 adresses within an array of ip addresses" do
+ result = scope.function_enclose_ipv6([['127.0.0.1','fe80::1','[fe80::2]']])
+ expect(result).to(eq(['127.0.0.1','[fe80::1]','[fe80::2]']))
+ end
+
+ it "should embrace a single ipv6 adresse" do
+ result = scope.function_enclose_ipv6(['fe80::1'])
+ expect(result).to(eq(['[fe80::1]']))
+ end
+
+ it "should not embrace a single ipv4 adresse" do
+ result = scope.function_enclose_ipv6(['127.0.0.1'])
+ expect(result).to(eq(['127.0.0.1']))
+ end
+end