From be2dd0fe82262b4cbd29f4a524a9a10509b3c3c6 Mon Sep 17 00:00:00 2001
From: Ben Ford <ben.ford@puppetlabs.com>
Date: Fri, 3 Jan 2020 17:22:29 -0800
Subject: [PATCH] Porting functions to the modern Puppet 4.x API

---
 lib/puppet/functions/validate_vnc_servers.rb | 74 ++++++++++++++++++++
 spec/functions/_validate_vnc_servers_spec.rb | 41 +++++++++++
 2 files changed, 115 insertions(+)
 create mode 100644 lib/puppet/functions/validate_vnc_servers.rb
 create mode 100644 spec/functions/_validate_vnc_servers_spec.rb

diff --git a/lib/puppet/functions/validate_vnc_servers.rb b/lib/puppet/functions/validate_vnc_servers.rb
new file mode 100644
index 0000000..1cf6b77
--- /dev/null
+++ b/lib/puppet/functions/validate_vnc_servers.rb
@@ -0,0 +1,74 @@
+# 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 ----
+
+# ---- original file header ----
+#
+# @summary
+#   
+#Given an array of hashes, validates the following:
+#  - The passed parameter is an array
+#  - Array member objects are hashes
+#  - Each hash has a 'user' and 'args' key
+#
+#If an empty array is passed, then this function validates successfully.
+#
+#Passing Examples:
+#
+#  $vnc_arusso = { 'user' => 'arusso',
+#                  'args' => '' }
+#  $vnc_brusso = { 'user' => 'brusso',
+#                  'args' => '' }
+#  validate_vnc_servers([ $vnc_arusso ])
+#  validate_vnc_servers([ $vnc_arusso, $vnc_brusso ])
+#  validate_vnc_servers([ ])
+#
+#Failing Examples:
+#
+#   $vnc_arusso = { 'user' => 'arusso',
+#                   'arg' => '' }
+#   validate_vnc_servers([ $vnc_arusso ]) # args key not specified
+#   validate_vnc_servers([ '' ]) # array member not a hash
+#   validate_vnc_servers($vnc_arusso) # array not passed
+#
+#
+#
+Puppet::Functions.create_function(:'validate_vnc_servers') 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)
+    
+    server_array = args[0]
+    if server_array.is_a?(Array)
+      server_array.each do |sh|
+        if sh.is_a?(Hash)
+          raise Puppet::ParseError, \
+            "Hash object must have 'user' and 'args' keys" \
+            unless sh.has_key?('user') and sh.has_key?('args')
+        else
+          raise Puppet::ParseError, "Array member not a Hash"
+        end
+      end
+    else
+      raise Puppet::ParseError, "Parameter must be an Array"
+    end
+  
+  end
+end
diff --git a/spec/functions/_validate_vnc_servers_spec.rb b/spec/functions/_validate_vnc_servers_spec.rb
new file mode 100644
index 0000000..0f3cd8f
--- /dev/null
+++ b/spec/functions/_validate_vnc_servers_spec.rb
@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'validate_vnc_servers' 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