(MODULES-8886) Rename deepmerge to normalise_and_deepmerge

Author: eimlav

lib/puppet/functions/mysql/deepmerge.rb lib/puppet/functions/mysql/normalise_and_deepmerge.rb

@@ -1,28 +1,29 @@
-# @summary Recursively merges two or more hashes together and returns the resulting hash.
+# @summary Recursively merges two or more hashes together, normalises keys with differing use of dashesh and underscores,
+#   then returns the resulting hash.
 #
 # @example
 #   $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
 #   $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
-#   $merged_hash = mysql::deepmerge($hash1, $hash2)
+#   $merged_hash = mysql::normalise_and_deepmerge($hash1, $hash2)
 #   # The resulting hash is equivalent to:
 #   # $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
 #
 # - When there is a duplicate key that is a hash, they are recursively merged.
 # - When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
 # - When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win.
 #
-Puppet::Functions.create_function(:'mysql::deepmerge') do
-  def deepmerge(*args)
+Puppet::Functions.create_function(:'mysql::normalise_and_deepmerge') do
+  def normalise_and_deepmerge(*args)
     if args.length < 2
-      raise Puppet::ParseError, _('mysql::deepmerge(): wrong number of arguments (%{args_length}; must be at least 2)') % { args_length: args.length }
+      raise Puppet::ParseError, _('mysql::normalise_and_deepmerge(): wrong number of arguments (%{args_length}; must be at least 2)') % { args_length: args.length }
     end
 
     result = {}
     args.each do |arg|
       next if arg.is_a?(String) && arg.empty? # empty string is synonym for puppet's undef
       # If the argument was not a hash, skip it.
       unless arg.is_a?(Hash)
-        raise Puppet::ParseError, _('mysql::deepmerge: unexpected argument type %{arg_class}, only expects hash arguments.') % { args_class: args.class }
+        raise Puppet::ParseError, _('mysql::normalise_and_deepmerge: unexpected argument type %{arg_class}, only expects hash arguments.') % { args_class: args.class }
       end
 
       # We need to make a copy of the hash since it is frozen by puppet

manifests/backup/mysqlbackup.pp

@@ -93,7 +93,7 @@
       'password'               => $backuppassword,
     }
   }
-  $options = mysql::deepmerge($default_options, $mysql::server::override_options)
+  $options = mysql::normalise_and_deepmerge($default_options, $mysql::server::override_options)
 
   file { 'mysqlbackup-config-file':
     path    => '/etc/mysql/conf.d/meb.cnf',

manifests/server.pp

@@ -116,7 +116,7 @@
   }
 
   # Create a merged together set of options.  Rightmost hashes win over left.
-  $options = mysql::deepmerge($mysql::params::default_options, $override_options)
+  $options = mysql::normalise_and_deepmerge($mysql::params::default_options, $override_options)
 
   Class['mysql::server::root_password'] -> Mysql::Db <| |>
 

spec/functions/mysql_deepmerge_spec.rb spec/functions/mysql_normalise_and_deepmerge_spec.rb

@@ -1,8 +1,6 @@
-#! /usr/bin/env ruby -S rspec # rubocop:disable Lint/ScriptPermission
-
 require 'spec_helper'
 
-describe 'mysql::deepmerge' do
+describe 'mysql::normalise_and_deepmerge' do
   it 'exists' do
     is_expected.not_to eq(nil)
   end
@@ -22,14 +20,14 @@
   # rubocop:disable RSpec/NamedSubject
   index_values = ['one', 'two', 'three']
   expected_values_one = ['1', '2', '2']
-  it 'is able to mysql_deepmerge two hashes' do
+  it 'merge two hashes' do
     new_hash = subject.execute({ 'one' => '1', 'two' => '1' }, 'two' => '2', 'three' => '2')
     index_values.each_with_index do |index, expected|
       expect(new_hash[index]).to eq(expected_values_one[expected])
     end
   end
 
-  it 'mysql_deepmerges multiple hashes' do
+  it 'merges multiple hashes' do
     hash = subject.execute({ 'one' => 1 }, { 'one' => '2' }, 'one' => '3')
     expect(hash['one']).to eq('3')
   end
@@ -39,7 +37,7 @@
   end
 
   expected_values_two = [1, 2, 'four' => 4]
-  it 'mysql_deepmerges subhashes' do
+  it 'merges subhashes' do
     hash = subject.execute({ 'one' => 1 }, 'two' => 2, 'three' => { 'four' => 4 })
     index_values.each_with_index do |index, expected|
       expect(hash[index]).to eq(expected_values_two[expected])