implement key parameter for config_entry defined resource

* postgres instances require unique resource titles

Author: SimonHoenscheid

manifests/server/config_entry.pp

@@ -1,11 +1,13 @@
 # @summary Manage a postgresql.conf entry.
 #
 # @param ensure Removes an entry if set to 'absent'.
+# @param key Defines the key/name for the setting. Defaults to $name
 # @param value Defines the value for the setting.
 # @param path Path for postgresql.conf
 #
 define postgresql::server::config_entry (
   Enum['present', 'absent']                               $ensure = 'present',
+  String[1]                                               $key    = $name,
   Optional[Variant[String[1], Numeric, Array[String[1]]]] $value  = undef,
   Variant[Boolean, String[1]]                             $path   = false
 ) {
@@ -70,9 +72,9 @@
     'max_pred_locks_per_transaction'      => undef,
   }
 
-  if ! ($name in $requires_restart_until and (
-      ! $requires_restart_until[$name] or
-      versioncmp($postgresql::server::_version, $requires_restart_until[$name]) < 0
+  if ! ($key in $requires_restart_until and (
+      ! $requires_restart_until[$key] or
+      versioncmp($postgresql::server::_version, $requires_restart_until[$key]) < 0
   )) {
     Postgresql_conf {
       notify => Class['postgresql::server::reload'],
@@ -90,6 +92,7 @@
   postgresql_conf { $name:
     ensure  => $ensure,
     target  => $target,
+    name    => $key,
     value   => $value,
     require => Class['postgresql::server::initdb'],
   }

manifests/server/instance/config.pp

@@ -149,7 +149,8 @@
   }
 
   if $listen_addresses {
-    postgresql::server::config_entry { 'listen_addresses':
+    postgresql::server::config_entry { "listen_addresses_for_instance_${name}":
+      key   => 'listen_addresses',
       value => $listen_addresses,
     }
   }
@@ -182,37 +183,42 @@
     exec { "/usr/sbin/semanage port -a -t postgresql_port_t -p tcp ${port}":
       command => $exec_command,
       unless  => $exec_unless,
-      before  => Postgresql::Server::Config_entry['port'],
+      before  => Postgresql::Server::Config_entry["port_for_instance_${name}"],
       require => Package[$package_name],
     }
   }
 
-  postgresql::server::config_entry { 'port':
+  postgresql::server::config_entry { "port_for_instance_${name}":
+    key   => 'port',
     value => $port,
   }
 
   if ($password_encryption) and (versioncmp($version, '10') >= 0) {
-    postgresql::server::config_entry { 'password_encryption':
+    postgresql::server::config_entry { "password_encryption_for_instance_${name}":
+      key   => 'password_encryption',
       value => $password_encryption,
     }
   }
 
-  postgresql::server::config_entry { 'data_directory':
+  postgresql::server::config_entry { "data_directory_for_instance_${name}":
+    key   => 'data_directory',
     value => $datadir,
   }
   if $timezone {
-    postgresql::server::config_entry { 'timezone':
+    postgresql::server::config_entry { "timezone_for_instance_${name}":
+      key   => 'timezone',
       value => $timezone,
     }
   }
   if $logdir {
-    postgresql::server::config_entry { 'log_directory':
+    postgresql::server::config_entry { "log_directory for instance ${name}":
       value => $logdir,
     }
   }
   # Allow timestamps in log by default
   if $log_line_prefix {
-    postgresql::server::config_entry { 'log_line_prefix':
+    postgresql::server::config_entry { "log_line_prefix_for_instance_${name}":
+      key   => 'log_line_prefix',
       value => $log_line_prefix,
     }
   }

spec/classes/server/config_spec.rb

@@ -15,7 +15,7 @@
 
       expect(subject).to contain_exec('/usr/sbin/semanage port -a -t postgresql_port_t -p tcp 5432')
         .with(unless: '/usr/sbin/semanage port -l | grep -qw 5432')
-        .that_comes_before('Postgresql::Server::Config_entry[port]')
+        .that_comes_before('Postgresql::Server::Config_entry[port_for_instance_main]')
         .that_requires('Package[policycoreutils-python]')
     end
 
@@ -60,7 +60,7 @@ class { 'postgresql::server': }
 
       expect(subject).to contain_exec('/usr/sbin/semanage port -a -t postgresql_port_t -p tcp 5432')
         .with(unless: '/usr/sbin/semanage port -l | grep -qw 5432')
-        .that_comes_before('Postgresql::Server::Config_entry[port]')
+        .that_comes_before('Postgresql::Server::Config_entry[port_for_instance_main]')
         .that_requires('Package[policycoreutils-python-utils]')
     end
 
@@ -105,7 +105,7 @@ class { 'postgresql::server': }
 
       expect(subject).to contain_exec('/usr/sbin/semanage port -a -t postgresql_port_t -p tcp 5432')
         .with(unless: '/usr/sbin/semanage port -l | grep -qw 5432')
-        .that_comes_before('Postgresql::Server::Config_entry[port]')
+        .that_comes_before('Postgresql::Server::Config_entry[port_for_instance_main]')
         .that_requires('Package[policycoreutils-python-utils]')
     end
 
@@ -150,7 +150,7 @@ class { 'postgresql::server': }
 
       expect(subject).to contain_exec('/usr/sbin/semanage port -a -t postgresql_port_t -p tcp 5432')
         .with(unless: '/usr/sbin/semanage port -l | grep -qw 5432')
-        .that_comes_before('Postgresql::Server::Config_entry[port]')
+        .that_comes_before('Postgresql::Server::Config_entry[port_for_instance_main]')
         .that_requires('Package[policycoreutils]')
     end
   end

spec/classes/server_spec.rb

@@ -114,7 +114,7 @@ class { 'postgresql::globals':
     it { is_expected.to contain_class('postgresql::server') }
 
     it {
-      expect(subject).not_to contain_Postgresql_conf('data_directory').that_notifies('Class[postgresql::server::service]')
+      expect(subject).not_to contain_Postgresql_conf('data_directory_for_instance_main').that_notifies('Class[postgresql::server::service]')
     }
 
     it 'validates connection' do
@@ -129,9 +129,11 @@ class { 'postgresql::globals':
     it { is_expected.to contain_class('postgresql::server') }
 
     it {
-      expect(subject).to contain_Postgresql_conf('data_directory').that_notifies('Class[postgresql::server::service]')
+      expect(subject).to contain_Postgresql_conf('data_directory_for_instance_main').that_notifies('Class[postgresql::server::service]')
     }
 
+    it { is_expected.to contain_postgresql__server__config_entry('data_directory_for_instance_main') }
+
     it 'validates connection' do
       expect(subject).to contain_postgresql_conn_validator('validate_service_is_running')
     end

spec/unit/provider/postgresql_conf/parsed_spec.rb

@@ -21,20 +21,20 @@
 
   describe 'simple configuration that should be allowed' do
     it 'parses a simple ini line' do
-      expect(provider.parse_line("listen_addreses = '*'")).to eq(
-        name: 'listen_addreses', value: '*', comment: nil, record_type: :parsed,
+      expect(provider.parse_line("listen_addresses = '*'")).to eq(
+        key: 'listen_addresses', value: '*', comment: nil, record_type: :parsed,
       )
     end
 
     it 'parses a simple ini line (2)' do
-      expect(provider.parse_line("   listen_addreses = '*'")).to eq(
-        name: 'listen_addreses', value: '*', comment: nil, record_type: :parsed,
+      expect(provider.parse_line("   listen_addresses = '*'")).to eq(
+        key: 'listen_addresses', value: '*', comment: nil, record_type: :parsed,
       )
     end
 
     it 'parses a simple ini line (3)' do
-      expect(provider.parse_line("listen_addreses = '*' # dont mind me")).to eq(
-        name: 'listen_addreses', value: '*', comment: 'dont mind me', record_type: :parsed,
+      expect(provider.parse_line("listen_addresses = '*' # dont mind me")).to eq(
+        key: 'listen_addresses', value: '*', comment: 'dont mind me', record_type: :parsed,
       )
     end
 
@@ -52,13 +52,13 @@
 
     it 'allows includes' do
       expect(provider.parse_line('include puppetextra')).to eq(
-        name: 'include', value: 'puppetextra', comment: nil, record_type: :parsed,
+        key: 'include', value: 'puppetextra', comment: nil, record_type: :parsed,
       )
     end
 
     it 'allows numbers through without quotes' do
       expect(provider.parse_line('wal_keep_segments = 32')).to eq(
-        name: 'wal_keep_segments', value: '32', comment: nil, record_type: :parsed,
+        key: 'wal_keep_segments', value: '32', comment: nil, record_type: :parsed,
       )
     end
 
@@ -70,7 +70,7 @@
 
     it 'parses keys with dots' do
       expect(provider.parse_line('auto_explain.log_min_duration = 1ms')).to eq(
-        name: 'auto_explain.log_min_duration', value: '1ms', comment: nil, record_type: :parsed,
+        key: 'auto_explain.log_min_duration', value: '1ms', comment: nil, record_type: :parsed,
       )
     end
   end
@@ -89,61 +89,61 @@
     end
 
     it 'sets simple configuration' do
-      expect(provider.to_line(name: 'listen_addresses', value: '*', comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'listen_addresses', value: '*', comment: nil, record_type: :parsed)).to eq(
         "listen_addresses = '*'",
       )
     end
 
     it 'sets simple configuration with period in name' do
-      expect(provider.to_line(name: 'auto_explain.log_min_duration', value: '100ms', comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'auto_explain.log_min_duration', value: '100ms', comment: nil, record_type: :parsed)).to eq(
         'auto_explain.log_min_duration = 100ms',
       )
     end
 
     it 'sets simple configuration even with comments' do
-      expect(provider.to_line(name: 'listen_addresses', value: '*', comment: 'dont mind me', record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'listen_addresses', value: '*', comment: 'dont mind me', record_type: :parsed)).to eq(
         "listen_addresses = '*' # dont mind me",
       )
     end
 
     it 'quotes includes' do
-      expect(provider.to_line(name: 'include', value: 'puppetextra', comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'include', value: 'puppetextra', comment: nil, record_type: :parsed)).to eq(
         "include 'puppetextra'",
       )
     end
 
     it 'quotes multiple words' do
-      expect(provider.to_line(name: 'archive_command', value: 'rsync up', comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'archive_command', value: 'rsync up', comment: nil, record_type: :parsed)).to eq(
         "archive_command = 'rsync up'",
       )
     end
 
     it 'does not quote numbers' do
-      expect(provider.to_line(name: 'wal_segments', value: '32', comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'wal_segments', value: '32', comment: nil, record_type: :parsed)).to eq(
         'wal_segments = 32',
       )
     end
 
     it 'allows numbers' do
-      expect(provider.to_line(name: 'integer', value: 42, comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'integer', value: 42, comment: nil, record_type: :parsed)).to eq(
         'integer = 42',
       )
     end
 
     it 'allows floats' do
-      expect(provider.to_line(name: 'float', value: 2.71828182845, comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'float', value: 2.71828182845, comment: nil, record_type: :parsed)).to eq(
         'float = 2.71828182845',
       )
     end
 
     it 'quotes single string address' do
-      expect(provider.to_line(name: 'listen_addresses', value: '0.0.0.0', comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'listen_addresses', value: '0.0.0.0', comment: nil, record_type: :parsed)).to eq(
         "listen_addresses = '0.0.0.0'",
       )
     end
 
     it 'quotes an array of addresses' do
-      expect(provider.to_line(name: 'listen_addresses', value: ['0.0.0.0', '127.0.0.1'], comment: nil, record_type: :parsed)).to eq(
+      expect(provider.to_line(key: 'listen_addresses', value: ['0.0.0.0', '127.0.0.1'], comment: nil, record_type: :parsed)).to eq(
         "listen_addresses = '0.0.0.0, 127.0.0.1'",
       )
     end