(WIP) Addition of validate legacy function

Author: Helen Campbell

lib/puppet/functions/validate_legacy.rb

@@ -0,0 +1,58 @@
+Puppet::Functions.create_function(:validate_legacy, Puppet::Functions::InternalFunction) do
+  # The function checks a value against both the target_type (new) and the previous_validation function (old).
+  
+  dispatch :validate_legacy do
+    param 'Type', :target_type
+    param 'String', :previous_validation #Needs to be the name of the function previously used
+    param 'NotUndef', :value #Really not sure what all this could be
+    optional_param 'Any', :args # /need special stuff for any number of args herei
+  end
+  dispatch :validate_legacy_s do
+    scope_param
+    param 'String', :type_string
+    param 'String', :previous_validation
+    param 'NotUndef', :value
+    optional_param 'Any', :args
+  end
+
+  def validate_legacy_s(scope, type_string, *args)
+    t = Puppet::Pops::Types::TypeParser.new.parse(type_string, scope)
+    validate_legacy(t, *args)
+  end
+
+  def validate_legacy(target_type, previous_validation, value, *prev_args)
+    if assert_type(target_type, value)
+      if previous_validation(previous_validation, value, *prev_args)
+        puts 'Pass'
+        # silently passes
+      else
+        # succeed with warning "Accepting previously invalid value for target_type"
+        Puppet.warn("Accepting previously invalid value for target_type '#{target_type}'")
+      end
+    else
+      inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value)
+      error_msg = Puppet::Pops::Types::TypeMismatchDescriber.new.describe_mismatch(previous_validation, target_type, inferred_type)
+      if previous_validation(previous_validation, value, *prev_args)
+        # succeed with deprecation warning (use new error message)
+        Puppet.warn(error_msg)
+      else
+        # fail with new error message
+        call_function('fail', error_msg)
+      end
+    end
+  end
+
+  def previous_validation(previous_validation, value, *prev_args)
+    # Call the previous validation function and catch any errors
+    begin
+      call_function(previous_validation, value, *prev_args)
+      true
+    rescue Puppet::ParseError
+      false
+    end
+  end
+
+  def assert_type(type, value)
+    Puppet::Pops::Types::TypeCalculator.instance?(type, value)
+  end
+end

spec/classes/validate_legacy_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+if Puppet.version.to_f >= 4.0
+  describe 'test::validate_legacy', type: :class do
+    
+    describe 'validate_legacy passes assertion of type but not previous validation' do
+      let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: 5, previous_args1: ["^\\d+$", ""] }}
+      it { Puppet.expects(:warn).with(includes('Accepting previously invalid value for target_type'))
+      is_expected.to compile }
+    end
+
+    describe 'validate_legacy passes assertion of type and previous validation' do
+      let(:params) {{ type: "Optional[String]", prev_validation: "validate_re", value: "5", previous_args1: ["."] }}
+      it { is_expected.to compile }
+    end
+
+    describe 'validate_legacy fails assertion of type and passes previous validation' do
+      let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: "5", previous_args1: ["."] }}
+      it { Puppet.expects(:warn).with(includes('expected'))
+      is_expected.to compile }
+    end
+
+    describe 'validate_legacy fails assertion and fails previous validation' do
+      let(:params) {{ type: "Optional[Integer]", prev_validation: "validate_re", value: "5", previous_args1: ["thisisnotright"] }}      
+      it { is_expected.to compile.and_raise_error(/Error while evaluating a Function Call, \w* expected an \w* value, got \w*/) }
+    end
+
+  end
+end

spec/fixtures/test/manifests/validate_legacy.pp

@@ -0,0 +1,9 @@
+# Class to test stdlib validate_legacy function
+
+class test::validate_legacy( $type, $prev_validation, $value, $previous_args1
+    ) {
+
+  validate_legacy( $type, $prev_validation, $value, $previous_args1 )
+  notice("Success")
+
+}