Puppet Function: validate_legacy

Defined in:
vendor_modules/stdlib/lib/puppet/functions/validate_legacy.rb
Function type:
Ruby 4.x API

Summary

Validate a value against both the target_type (new) and the previous_validation function (old).

Overview

Signatures:

  • validate_legacy(Any $scope, Type $target_type, String $function_name, Any $value, Any *$args) ⇒ Any

    The function checks a value against both the target_type (new) and the previous_validation function (old).

    Parameters:

    • scope (Any) —

      The main value that will be passed to the method

    • target_type (Type)
    • function_name (String)
    • value (Any)
    • *args (Any) —

      Any additional values that are to be passed to the method

    Returns:

    • (Any) —

      A boolean value (`true` or `false`) returned from the called function.

  • validate_legacy(Any $scope, String $type_string, String $function_name, Any $value, Any *$args) ⇒ Any

    Returns Legacy validation method.

    Parameters:

    • scope (Any) —

      The main value that will be passed to the method

    • type_string (String)
    • function_name (String)
    • value (Any)
    • *args (Any) —

      Any additional values that are to be passed to the method

    Returns:

    • (Any) —

      Legacy validation method



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'vendor_modules/stdlib/lib/puppet/functions/validate_legacy.rb', line 5

Puppet::Functions.create_function(:validate_legacy) do
  # The function checks a value against both the target_type (new) and the previous_validation function (old).
  # @param scope
  #   The main value that will be passed to the method
  # @param target_type
  # @param function_name
  # @param value
  # @param args
  #   Any additional values that are to be passed to the method
  # @return
  #   A boolean value (`true` or `false`) returned from the called function.
  dispatch :validate_legacy do
    param 'Any', :scope
    param 'Type', :target_type
    param 'String', :function_name
    param 'Any', :value
    repeated_param 'Any', :args
  end

  # @param scope
  #   The main value that will be passed to the method
  # @param type_string
  # @param function_name
  # @param value
  # @param args Any additional values that are to be passed to the method
  # @return Legacy validation method
  #
  dispatch :validate_legacy_s do
    param 'Any', :scope
    param 'String', :type_string
    param 'String', :function_name
    param 'Any', :value
    repeated_param 'Any', :args
  end

  # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff-
  #   c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
  def call(scope, *args)
    manipulated_args = [scope] + args
    self.class.dispatcher.dispatch(self, scope, manipulated_args)
  end

  def validate_legacy_s(scope, type_string, *args)
    t = Puppet::Pops::Types::TypeParser.new.parse(type_string, scope)
    validate_legacy(scope, t, *args)
  end

  def validate_legacy(scope, target_type, function_name, value, *prev_args)
    if assert_type(target_type, value)
      if previous_validation(scope, function_name, value, *prev_args)
        # Silently passes
      else
        Puppet.notice("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("validate_legacy(#{function_name})", target_type, inferred_type)
      if previous_validation(scope, function_name, value, *prev_args)
        call_function('deprecation', 'validate_legacy', error_msg)
      else
        call_function('fail', error_msg)
      end
    end
  end

  def previous_validation(scope, function_name, value, *prev_args)
    # Call the previous validation function and catch any errors. Return true if no errors are thrown.

    scope.send("function_#{function_name}".to_s, [value, *prev_args])
    true
  rescue Puppet::ParseError
    false
  end

  def assert_type(type, value)
    Puppet::Pops::Types::TypeCalculator.instance?(type, value)
  end
end