Enable module to not use default options

Author: Maurice Meyer

README.md

@@ -91,6 +91,9 @@ replicate-do-db = base2
 
 To implement version specific parameters, specify the version, such as [mysqld-5.5]. This allows one config for different versions of MySQL.
 
+If you don’t want to use the default configuration, you can also supply your options to the `$options` parameter instead of `$override_options`.
+Please note that `$options` and `$override_options` are mutually exclusive, you can only use one of them.
+
 ### Create a database
 
 To create a database with a user and some assigned privileges:

locales/puppetlabs-mysql.pot

@@ -77,6 +77,12 @@ msgid ""
 "future release."
 msgstr ""
 
+#. ./manifests/server.pp:122
+msgid ""
+"You can\'t specify $options and $override_options simultaneously, see the "
+"README section \'Customize server options\'!"
+msgstr ""
+
 #: ./lib/puppet/parser/functions/mysql_deepmerge.rb:22
 msgid ""
 "mysql_deepmerge(): wrong number of arguments (%{args_length}; must be at "

manifests/server.pp

@@ -19,6 +19,8 @@
 #   Path to secret file containing temporary root password.
 # @param manage_config_file
 #   Whether the MySQL configuration file should be managed. Valid values are `true`, `false`. Defaults to `true`.
+# @param options
+#   A hash of options structured like the override_options, but not merged with the default options. Use this if you don’t want your options merged with the default options.
 # @param override_options
 #   Specifies override options to pass into MySQL. Structured like a hash in the my.cnf file:  See  above for usage details.
 # @param package_ensure
@@ -52,11 +54,11 @@
 # @param create_root_my_cnf
 #   Whether to create `/root/.my.cnf`. Valid values are `true`, `false`. Defaults to `true`. `create_root_my_cnf` allows creation of `/root/.my.cnf` independently of `create_root_user`. You can use this for a cluster setup with Galera where you want `/root/.my.cnf` to exist on all nodes.
 # @param users
-#   Optional hash of users to create, which are passed to [mysql_user](#mysql_user). 
+#   Optional hash of users to create, which are passed to [mysql_user](#mysql_user).
 # @param grants
-#   Optional hash of grants, which are passed to [mysql_grant](#mysql_grant). 
+#   Optional hash of grants, which are passed to [mysql_grant](#mysql_grant).
 # @param databases
-#   Optional hash of databases to create, which are passed to [mysql_database](#mysql_database). 
+#   Optional hash of databases to create, which are passed to [mysql_database](#mysql_database).
 # @param enabled
 #   _Deprecated_
 # @param manage_service
@@ -70,6 +72,7 @@
   $install_options         = undef,
   $install_secret_file     = $mysql::params::install_secret_file,
   $manage_config_file      = $mysql::params::manage_config_file,
+  $options                 = {},
   $override_options        = {},
   $package_ensure          = $mysql::params::server_package_ensure,
   $package_manage          = $mysql::params::server_package_manage,
@@ -115,8 +118,16 @@
     warning(translate('The `old_root_password` attribute is no longer used and will be removed in a future release.'))
   }
 
-  # Create a merged together set of options.  Rightmost hashes win over left.
-  $options = mysql::normalise_and_deepmerge($mysql::params::default_options, $override_options)
+  if ! empty($options) and ! empty($override_options) {
+    fail(translate('You can\'t specify $options and $override_options simultaneously, see the README section \'Customize server options\'!'))
+  }
+
+  # If override_options are set, create a merged together set of options. Rightmost hashes win over left.
+  # If options are set, just use them.
+  $_options = empty($options) ? {
+    true  => mysql::normalise_and_deepmerge($mysql::params::default_options, $override_options),
+    false => $options,
+  }
 
   Class['mysql::server::root_password'] -> Mysql::Db <| |>
 

manifests/server/binarylog.pp

@@ -5,7 +5,7 @@
 #
 class mysql::server::binarylog {
 
-  $options = $mysql::server::options
+  $options = $mysql::server::_options
   $includedir = $mysql::server::includedir
 
   $logbin = pick($options['mysqld']['log-bin'], $options['mysqld']['log_bin'], false)

manifests/server/config.pp

@@ -5,7 +5,7 @@
 #
 class mysql::server::config {
 
-  $options = $mysql::server::options
+  $options = $mysql::server::_options
   $includedir = $mysql::server::includedir
 
   File {

manifests/server/installdb.pp

@@ -1,19 +1,19 @@
-# @summary 
+# @summary
 #   Builds initial databases on installation.
 #
 # @api private
 #
 class mysql::server::installdb {
-  $options = $mysql::server::options
+  $options = $mysql::server::_options
 
   if $mysql::server::package_manage {
 
     # Build the initial databases.
-    $mysqluser = $mysql::server::options['mysqld']['user']
-    $datadir = $mysql::server::options['mysqld']['datadir']
-    $basedir = $mysql::server::options['mysqld']['basedir']
+    $mysqluser = $mysql::server::_options['mysqld']['user']
+    $datadir = $mysql::server::_options['mysqld']['datadir']
+    $basedir = $mysql::server::_options['mysqld']['basedir']
     $config_file = $mysql::server::config_file
-    $log_error = $mysql::server::options['mysqld']['log-error']
+    $log_error = $mysql::server::_options['mysqld']['log-error']
 
     if $mysql::server::manage_config_file and $config_file != $mysql::params::config_file {
       $_config_file=$config_file

manifests/server/root_password.pp

@@ -5,7 +5,7 @@
 #
 class mysql::server::root_password {
 
-  $options = $mysql::server::options
+  $options = $mysql::server::_options
   $secret_file = $mysql::server::install_secret_file
   $login_file = $mysql::server::login_file
 

manifests/server/service.pp

@@ -4,7 +4,7 @@
 # @api private
 #
 class mysql::server::service {
-  $options = $mysql::server::options
+  $options = $mysql::server::_options
 
   if $mysql::server::real_service_manage {
     if $mysql::server::real_service_enabled {

spec/classes/mysql_server_spec.rb

@@ -34,6 +34,31 @@
         it { is_expected.not_to contain_service('mysqld') }
       end
 
+      context 'configuration options' do
+        context 'when specifying both $override_options and $options' do
+          let(:params) do
+            {
+              override_options: { 'mysqld' => { 'datadir' => '/tmp' } },
+              options: { 'mysqld' => { 'max_allowed_packet' => '12M' } },
+            }
+          end
+
+          it { is_expected.to compile.and_raise_error(%r{You can't specify \$options and \$override_options simultaneously, see the README section 'Customize server options'!}) }
+        end
+
+        context 'when specifying $options' do
+          let(:params) do
+            {
+              options: { 'mysqld' => { 'datadir' => '/tmp' } },
+            }
+          end
+
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_mysql_datadir('/tmp') }
+          it { is_expected.not_to contain_mysql_bind_addr('127.0.0.1') }
+        end
+      end
+
       context 'mysql::server::install' do
         it 'contains the package by default' do
           is_expected.to contain_package('mysql-server').with(ensure: :present)