Porting functions to the modern Puppet 4.x API

lib/puppet/functions/aurora/ensure_bool.rb

@@ -0,0 +1,68 @@
+# 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 ----
+#
+# ensure_bool.rb
+#
+
+# ---- original file header ----
+#
+# @summary
+#       Converts a string with correct boolean value to a boolean type. Converts the values:
+#      'false' to false
+#      'true' to true
+#    Requires a single boolean or string as an input.
+#
+#
+Puppet::Functions.create_function(:'aurora::ensure_bool') do
+  # @param arguments
+  #   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', :arguments
+  end
+
+
+  def default_impl(*arguments)
+
+    fail(Puppet::ParseError, 'ensure_bool(): Wrong number of arguments ' \
+      "given (#{arguments.size} for 1)") if arguments.size != 1
+
+    string = arguments[0]
+
+    # If string is already Boolean, return it
+    return string if !!string == string
+
+    unless string.is_a?(String)
+      fail(Puppet::ParseError, 'ensure_bool(): Requires String or Boolean as input')
+    end
+
+    result = case string
+      # The following  cases convert a string with value 'true' to be boolean with value true, and
+      # convert a string with value'false' to be boolean with value false
+
+      # An empty string should return an error
+      when /^$/, '' then fail(Puppet::ParseError, 'ensure_bool(): an empty string is not a valid boolean')
+      when /^(true)$/  then true
+      when /^(false)$/  then false
+
+      when /^(undef|undefined)$/ then fail(Puppet::ParseError, 'ensure_bool(): Undefined argument given')
+      else
+        fail(Puppet::ParseError, 'ensure_bool(): Unknown type of boolean given')
+    end
+
+    return result
+
+  end
+end

spec/functions/aurora_ensure_bool_spec.rb

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