Porting functions to the modern Puppet 4.x API

lib/puppet/functions/openstack/device_for_network.rb

@@ -0,0 +1,55 @@
+# This is an autogenerated function, ported from the original legacy version.
+# It /should work/ as is, but will not have all the benefits of the modern
+# function API. You should see the function docs to learn how to add function
+# signatures for type safety and to document this function using puppet-strings.
+#
+# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+#
+# ---- original file header ----
+require "ipaddr"
+
+# ---- original file header ----
+#
+# @summary
+#   Returns the device for the given network in cidr notation
+#device_for_network("127.0.0.0/24") => lo0
+#
+#
+Puppet::Functions.create_function(:'openstack::device_for_network') do
+  # @param args
+  #   The original array of arguments. Port this to individually managed params
+  #   to get the full benefit of the modern function API.
+  #
+  # @return [Data type]
+  #   Describe what the function returns here
+  #
+  dispatch :default_impl do
+    # Call the method named 'default_impl' when this is matched
+    # Port this to match individual params for better type safety
+    repeated_param 'Any', :args
+  end
+
+
+  def default_impl(*args)
+
+    devices_in_range = []
+
+    range = IPAddr.new(args[0])
+    facts = compiler.node.facts.values
+    ip_addresses = facts.select { |key, value| key.match /^ipaddress_(.*)/ }
+
+    ip_addresses.each do |pair|
+      key = pair[0]
+      string_address = pair[1]
+      ip_address = IPAddr.new(string_address)
+      if range.include?(ip_address)
+        devices_in_range.push(key.gsub(/^ipaddress_/,""))
+      end
+    end
+
+    # TODO don't be a dork dork with the return
+    # handle multiple values!
+    return devices_in_range.first
+
+  end
+end

lib/puppet/functions/openstack/ip_for_network.rb

@@ -0,0 +1,56 @@
+# This is an autogenerated function, ported from the original legacy version.
+# It /should work/ as is, but will not have all the benefits of the modern
+# function API. You should see the function docs to learn how to add function
+# signatures for type safety and to document this function using puppet-strings.
+#
+# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+#
+# ---- original file header ----
+require "ipaddr"
+
+# ---- original file header ----
+#
+# @summary
+#   Returns an ip address for the given network in cidr notation
+#
+#ip_for_network("127.0.0.0/24") => 127.0.0.1
+#
+#
+Puppet::Functions.create_function(:'openstack::ip_for_network') do
+  # @param args
+  #   The original array of arguments. Port this to individually managed params
+  #   to get the full benefit of the modern function API.
+  #
+  # @return [Data type]
+  #   Describe what the function returns here
+  #
+  dispatch :default_impl do
+    # Call the method named 'default_impl' when this is matched
+    # Port this to match individual params for better type safety
+    repeated_param 'Any', :args
+  end
+
+
+  def default_impl(*args)
+
+    addresses_in_range = [] 
+
+    range = IPAddr.new(args[0])
+    facts = compiler.node.facts.values
+    ip_addresses = facts.select { |key, value| key =~ /^ipaddress/ }
+
+    ip_addresses.each do |pair|
+      key = pair[0]
+      string_address = pair[1]
+      ip_address = IPAddr.new(string_address)
+      if range.include?(ip_address)
+        addresses_in_range.push(string_address)
+      end
+    end
+
+    # TODO don't be a dork dork with the return
+    # handle multiple values!
+    return addresses_in_range
+
+  end
+end

spec/functions/openstack_device_for_network_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'openstack::device_for_network' do
+  # without knowing details about the implementation, this is the only test
+  # case that we can autogenerate. You should add more examples below!
+  it { is_expected.not_to eq(nil) }
+
+#################################
+# Below are some example test cases. You may uncomment and modify them to match
+# your needs. Notice that they all expect the base error class of `StandardError`.
+# This is because the autogenerated function uses an untyped array for parameters
+# and relies on your implementation to do the validation. As you convert your
+# function to proper dispatches and typed signatures, you should change the
+# expected error of the argument validation examples to `ArgumentError`.
+#
+# Other error types you might encounter include
+#
+# * StandardError
+# * ArgumentError
+# * Puppet::ParseError
+#
+# Read more about writing function unit tests at https://rspec-puppet.com/documentation/functions/
+#
+#   it 'raises an error if called with no argument' do
+#     is_expected.to run.with_params.and_raise_error(StandardError)
+#   end
+#
+#   it 'raises an error if there is more than 1 arguments' do
+#     is_expected.to run.with_params({ 'foo' => 1 }, 'bar' => 2).and_raise_error(StandardError)
+#   end
+#
+#   it 'raises an error if argument is not the proper type' do
+#     is_expected.to run.with_params('foo').and_raise_error(StandardError)
+#   end
+#
+#   it 'returns the proper output' do
+#     is_expected.to run.with_params(123).and_return('the expected output')
+#   end
+#################################
+
+end

spec/functions/openstack_ip_for_network_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'openstack::ip_for_network' do
+  # without knowing details about the implementation, this is the only test
+  # case that we can autogenerate. You should add more examples below!
+  it { is_expected.not_to eq(nil) }
+
+#################################
+# Below are some example test cases. You may uncomment and modify them to match
+# your needs. Notice that they all expect the base error class of `StandardError`.
+# This is because the autogenerated function uses an untyped array for parameters
+# and relies on your implementation to do the validation. As you convert your
+# function to proper dispatches and typed signatures, you should change the
+# expected error of the argument validation examples to `ArgumentError`.
+#
+# Other error types you might encounter include
+#
+# * StandardError
+# * ArgumentError
+# * Puppet::ParseError
+#
+# Read more about writing function unit tests at https://rspec-puppet.com/documentation/functions/
+#
+#   it 'raises an error if called with no argument' do
+#     is_expected.to run.with_params.and_raise_error(StandardError)
+#   end
+#
+#   it 'raises an error if there is more than 1 arguments' do
+#     is_expected.to run.with_params({ 'foo' => 1 }, 'bar' => 2).and_raise_error(StandardError)
+#   end
+#
+#   it 'raises an error if argument is not the proper type' do
+#     is_expected.to run.with_params('foo').and_raise_error(StandardError)
+#   end
+#
+#   it 'returns the proper output' do
+#     is_expected.to run.with_params(123).and_return('the expected output')
+#   end
+#################################
+
+end