Porting functions to the modern Puppet 4.x API

lib/puppet/functions/getEC2Hosts.rb

@@ -0,0 +1,81 @@
+# 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 ----
+# Copyright (C) 2014 Continuent, Inc.
+# 
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.  You may obtain
+# a copy of the License at
+# 
+#         http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+# ---- original file header ----
+#
+# @summary
+#   Summarise what the function does here
+#
+Puppet::Functions.create_function(:'getEC2Hosts') 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)
+
+    tag_group = Marshal.load(args[0])
+    include_short_hostname = args[1]
+    if include_short_hostname == nil
+      include_short_hostname = false
+    end
+
+    # Create a regex to match the local region
+    az = Facter.value('ec2_placement_availability_zone')
+    azre = Regexp.compile("#{az[0,az.length-1]}.*")
+
+    hosts = {}
+    tag_group.each{|id,details|
+      hostname = details['tags']['Name']
+      aliases = []
+      if include_short_hostname == true
+        hostname_parts = hostname.split(".")
+        if hostname_parts[0] != hostname
+          aliases << hostname_parts[0]
+        end
+      end
+
+      # If this host is in the local region, use its private address
+      if azre.match(details['az']) != nil
+        ip = details['private-address']
+      else
+        ip = details['public-address']
+      end
+      hosts[hostname] = {
+        "ip" => ip,
+        "host_aliases" => aliases,
+        "comment" => "Generated by ec2_hosts in #{details['region']}"
+      }
+    }
+    hosts
+
+  end
+end

spec/functions/_getEC2Hosts_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'getEC2Hosts' 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