Merge pull request #1163 from alexjfisher/finish_postgresql_acls_to_resources_hash_conversion

Finish conversion of `postgresql_acls_to_resources_hash` function

Author: daianamezdrea

REFERENCE.md

@@ -61,14 +61,18 @@ _Private Classes_
 
 **Functions**
 
+_Public Functions_
+
 * [`postgresql::default`](#postgresqldefault): This function pull default values from the `params` class  or `globals` class if the value is not present in `params`.
-* [`postgresql::postgresql_acls_to_resources_hash`](#postgresqlpostgresql_acls_to_resources_hash): This internal function translates the ipv(4|6)acls format into a resource
 * [`postgresql::postgresql_escape`](#postgresqlpostgresql_escape): This function safely escapes a string using a consistent random tag
 * [`postgresql::postgresql_password`](#postgresqlpostgresql_password): This function returns the postgresql password hash from the clear text username / password
-* [`postgresql_acls_to_resources_hash`](#postgresql_acls_to_resources_hash): This internal function translates the ipv(4|6)acls format into a resource suitable for create_resources. It is not intended to be used outsid
 * [`postgresql_escape`](#postgresql_escape): This function safely escapes a string using a consistent random tag
 * [`postgresql_password`](#postgresql_password): DEPRECATED.  Use the namespaced function [`postgresql::postgresql_password`](#postgresqlpostgresql_password) instead.
 
+_Private Functions_
+
+* `postgresql::postgresql_acls_to_resources_hash`: This internal function translates the ipv(4|6)acls format into a resource suitable for create_resources.
+
 **Tasks**
 
 * [`sql`](#sql): Allows you to execute arbitary SQL
@@ -842,15 +846,15 @@ Default value: $postgresql::params::ip_mask_allow_all_users
 
 ##### `ipv4acls`
 
-Data type: `Any`
+Data type: `Array[String[1]]`
 
 Lists strings for access control for connection method, users, databases, IPv4 addresses;
 
 Default value: $postgresql::params::ipv4acls
 
 ##### `ipv6acls`
 
-Data type: `Any`
+Data type: `Array[String[1]]`
 
 Lists strings for access control for connection method, users, databases, IPv6 addresses.
 
@@ -2779,69 +2783,6 @@ Data type: `String`
 
 
 
-### postgresql::postgresql_acls_to_resources_hash
-
-Type: Ruby 4.x API
-
-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 ----
-postgresql_acls_to_resources_hash.rb
----- original file header ----
-
-   suitable for create_resources. It is not intended to be used outside of the
-   postgresql internal classes/defined resources.
-
-   @return This function accepts an array of strings that are pg_hba.conf rules. It
-   will return a hash that can be fed into create_resources to create multiple
-   individual pg_hba_rule resources.
-
-   The second parameter is an identifier that will be included in the namevar
-   to provide uniqueness. It must be a string.
-
-   The third parameter is an order offset, so you can start the order at an
-   arbitrary starting point.
-
-#### `postgresql::postgresql_acls_to_resources_hash(Any *$args)`
-
-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 ----
-postgresql_acls_to_resources_hash.rb
----- original file header ----
-
-   suitable for create_resources. It is not intended to be used outside of the
-   postgresql internal classes/defined resources.
-
-   @return This function accepts an array of strings that are pg_hba.conf rules. It
-   will return a hash that can be fed into create_resources to create multiple
-   individual pg_hba_rule resources.
-
-   The second parameter is an identifier that will be included in the namevar
-   to provide uniqueness. It must be a string.
-
-   The third parameter is an order offset, so you can start the order at an
-   arbitrary starting point.
-
-Returns: `Data type` Describe what the function returns here
-
-##### `*args`
-
-Data type: `Any`
-
-The original array of arguments. Port this to individually managed params
-to get the full benefit of the modern function API.
-
 ### postgresql::postgresql_escape
 
 Type: Ruby 4.x API
@@ -2891,40 +2832,6 @@ Data type: `Variant[String[1],Integer]`
 
 The clear text `password`
 
-### postgresql_acls_to_resources_hash
-
-Type: Ruby 3.x API
-
-This internal function translates the ipv(4|6)acls format into a resource
-suitable for create_resources. It is not intended to be used outside of the
-postgresql internal classes/defined resources.
-
-will return a hash that can be fed into create_resources to create multiple
-individual pg_hba_rule resources.
-
-The second parameter is an identifier that will be included in the namevar
-to provide uniqueness. It must be a string.
-
-The third parameter is an order offset, so you can start the order at an
-arbitrary starting point.
-
-#### `postgresql_acls_to_resources_hash()`
-
-This internal function translates the ipv(4|6)acls format into a resource
-suitable for create_resources. It is not intended to be used outside of the
-postgresql internal classes/defined resources.
-
-will return a hash that can be fed into create_resources to create multiple
-individual pg_hba_rule resources.
-
-The second parameter is an identifier that will be included in the namevar
-to provide uniqueness. It must be a string.
-
-The third parameter is an order offset, so you can start the order at an
-arbitrary starting point.
-
-Returns: `Any` This function accepts an array of strings that are pg_hba.conf rules. It
-
 ### postgresql_escape
 
 Type: Ruby 3.x API

lib/puppet/functions/postgresql/postgresql_acls_to_resources_hash.rb

@@ -1,80 +1,38 @@
-# 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 ----
-# postgresql_acls_to_resources_hash.rb
-# ---- original file header ----
-#
-# @summary
-#       This internal function translates the ipv(4|6)acls format into a resource
-#    suitable for create_resources. It is not intended to be used outside of the
-#    postgresql internal classes/defined resources.
-#
-#    @return This function accepts an array of strings that are pg_hba.conf rules. It
-#    will return a hash that can be fed into create_resources to create multiple
-#    individual pg_hba_rule resources.
-#
-#    The second parameter is an identifier that will be included in the namevar
-#    to provide uniqueness. It must be a string.
-#
-#    The third parameter is an order offset, so you can start the order at an
-#    arbitrary starting point.
-#
-#
+# @summary This internal function translates the ipv(4|6)acls format into a resource suitable for create_resources.
+# @api private
 Puppet::Functions.create_function(:'postgresql::postgresql_acls_to_resources_hash') 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
+  # @param acls
+  #   An array of strings that are pg_hba.conf rules.
+  # @param id
+  #   An identifier that will be included in the namevar to provide uniqueness.
+  # @param offset
+  #   An order offset, so you can start the order at an arbitrary starting point.
   #
+  # @return [Hash]
+  #   A hash that can be fed into create_resources to create multiple individual pg_hba_rule resources.
   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
+    param 'Array[String]', :acls
+    param 'String[1]', :id
+    param 'Integer[0]', :offset
   end
 
-  def default_impl(*args)
-    func_name = 'postgresql_acls_to_resources_hash()'
-
-    if args.size != 3
-      raise(Puppet::ParseError, "#{func_name}: Wrong number of arguments " \
-        "given (#{args.size} for 3)")
-    end
-
-    acls = args[0]
-    raise(Puppet::ParseError, "#{func_name}: first argument must be an array") \
-      unless acls.instance_of? Array
-
-    id = args[1]
-    raise(Puppet::ParseError, "#{func_name}: second argument must be a string") \
-      unless id.instance_of? String
-
-    offset = args[2].to_i
-    raise(Puppet::ParseError, "#{func_name}: third argument must be a number") \
-      unless offset.is_a? Integer
-
+  def default_impl(acls, id, offset)
     resources = {}
     acls.each do |acl|
       index = acls.index(acl)
 
       parts = acl.split
 
       unless parts.length >= 4
-        raise(Puppet::ParseError, "#{func_name}: acl line #{index} does not " \
+        raise(Puppet::ParseError, "postgresql::postgresql_acls_to_resources_hash(): acl line #{index} does not " \
           'have enough parts')
       end
 
       resource = {
-        'type' => parts[0],
+        'type'     => parts[0],
         'database' => parts[1],
-        'user' => parts[2],
-        'order' => format('%03d', offset + index), # rubocop:disable Style/FormatString
+        'user'     => parts[2],
+        'order'    => '%03d' % (offset + index),
       }
       if parts[0] == 'local'
         resource['auth_method'] = parts[3]

lib/puppet/parser/functions/postgresql_acls_to_resources_hash.rb

@@ -100,8 +100,8 @@
   $port                       = $postgresql::params::port,
   $ip_mask_deny_postgres_user = $postgresql::params::ip_mask_deny_postgres_user,
   $ip_mask_allow_all_users    = $postgresql::params::ip_mask_allow_all_users,
-  $ipv4acls                   = $postgresql::params::ipv4acls,
-  $ipv6acls                   = $postgresql::params::ipv6acls,
+  Array[String[1]] $ipv4acls  = $postgresql::params::ipv4acls,
+  Array[String[1]] $ipv6acls  = $postgresql::params::ipv6acls,
 
   $initdb_path                = $postgresql::params::initdb_path,
   $createdb_path              = $postgresql::params::createdb_path,

manifests/server.pp

@@ -88,18 +88,16 @@
       }
     }
 
-    # ipv4acls are passed as an array of rule strings, here we transform
-    # them into a resources hash, and pass the result to create_resources
-    $ipv4acl_resources = postgresql_acls_to_resources_hash($ipv4acls,
-    'ipv4acls', 10)
-    create_resources('postgresql::server::pg_hba_rule', $ipv4acl_resources)
-
-
-    # ipv6acls are passed as an array of rule strings, here we transform
-    # them into a resources hash, and pass the result to create_resources
-    $ipv6acl_resources = postgresql_acls_to_resources_hash($ipv6acls,
-    'ipv6acls', 102)
-    create_resources('postgresql::server::pg_hba_rule', $ipv6acl_resources)
+    # $ipv4acls and $ipv6acls are arrays of rule strings
+    # They are converted into hashes we can iterate over to create postgresql::server::pg_hba_rule resources.
+    (
+      postgresql::postgresql_acls_to_resources_hash($ipv4acls, 'ipv4acls', 10) +
+      postgresql::postgresql_acls_to_resources_hash($ipv6acls, 'ipv6acls', 102)
+    ).each | String $key, Hash $attrs| {
+      postgresql::server::pg_hba_rule { $key:
+        * => $attrs,
+      }
+    }
   }
 
   if $listen_addresses {