Merge pull request puppetlabs#105 from kbrezina/feature/master/adding-include-to-pg-conf

Support for included configuration file

Author: cprice404

README.md

@@ -12,7 +12,7 @@ postgresql
 8. [Disclaimer - Licensing information](#disclaimer)
 9. [Transfer Notice - Notice of authorship change](#transfer-notice)
 10. [Contributors - List of module contributors](#contributors)
-8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
+11. [Release Notes - Notes on the most recent updates to the module](#release-notes)
 
 
 Overview
@@ -72,6 +72,9 @@ Once you've completed your configuration of `postgresql::server`, you can test o
 
 If you get an error message from these commands, it means that your permissions are set in a way that restricts access from where you’re trying to connect. That might be a good thing or a bad thing, depending on your goals.
 
+Advanced configuration setting parameters can be placed into `postgresql_puppet_extras.conf` (located in the same folder as `postgresql.conf`). You can manage that file as a normal puppet file resource, or however you see fit; which gives you complete control over the settings. Any value you specify in that file will override any existing value set in the templated version.  
+For more details about server configuration parameters see http://www.postgresql.org/docs/9.2/static/runtime-config.html.
+
 ###Configuring the database
 
 There are many ways to set up a postgres database using the `postgresql::db` class. For instance, to set up a database for PuppetDB (this assumes you’ve already got the `postgresql::server` set up to your liking in your manifest, as discussed above):
@@ -199,6 +202,10 @@ This class is used to manage the basic postgresql client packages (which include
 
 This defined type can be used to create a database with no users and no permissions, which is a rare use case. 
 
+**postgresql::tablespace** 
+
+This defined type can be used to create a tablespace.
+
 **postgresql_psql**
 
 This defined type manages the command line tool for the postgresql module.

manifests/config/beforeservice.pp

@@ -62,13 +62,28 @@
 
   # We must set a "listen_addresses" line in the postgresql.conf if we
   #  want to allow any connections from remote hosts.
-  file_line { 'postgresql.conf':
+  file_line { 'postgresql.conf#listen_addresses':
     path        => $postgresql_conf_path,
     match       => '^listen_addresses\s*=.*$',
     line        => "listen_addresses = '${listen_addresses}'",
     notify      => Service['postgresqld'],
   }
 
+  # Here we are adding an 'include' line so that users have the option of
+  # managing their own settings in a second conf file.
+  file_line { 'postgresql.conf#include':
+    path        => $postgresql_conf_path,
+    line        => "include 'postgresql_puppet_extras.conf'",
+    notify      => Service['postgresqld'],
+  }
+
+  # Since we're adding an "include" for this extras config file, we need
+  # to make sure it exists.
+  exec { "touch `dirname $postgresql_conf_path`/postgresql_puppet_extras.conf" :
+    path   => "/usr/bin:/bin",
+    unless => "[ -f `dirname $postgresql_conf_path`/postgresql_puppet_extras.conf ]"
+  }
+
   # TODO: is this a reasonable place for this firewall stuff?
   # TODO: figure out a way to make this not platform-specific; debian and ubuntu have
   #        an out-of-the-box firewall configuration that seems trickier to manage

manifests/server.pp

@@ -8,6 +8,12 @@
 # [*package_name*] - name of package
 # [*service_name*] - name of service
 #
+# Configuration:
+#   Advanced configuration setting parameters can be placed into 'postgresql_puppet_extras.conf' (located in the same
+#   folder as 'postgresql.conf'). You can manage that file as a normal puppet file resource, or however you see fit;
+#   which gives you complete control over the settings. Any value you specify in that file will override any existing
+#   value set in the templated version.
+#
 # Actions:
 #
 # Requires:
@@ -61,5 +67,4 @@
     onlyif      => $service_status,
     refreshonly => true,
   }
-
 }

spec/README.md

@@ -27,3 +27,8 @@ instead do something like:
 
 For some options that might speed up the testing process a bit during development,
 please see `spec/support/postgres_test_config.rb`.
+
+By default the sahara gem restores VMs to a snapshot state after each test,
+to make sure that the individual tests aren't polluting the ones that are run later.
+If you want to disable this during development, you can set HardCoreTesting to false
+in `spec/support/postgres_test_config.rb`.

spec/support/postgres_test_utils.rb

@@ -9,8 +9,8 @@ def sudo_and_log(vm, cmd)
     result
   end
 
-  def sudo_psql_and_log(vm, psql_cmd, user = 'postgres')
-    sudo_and_log(vm, "su #{user} -c 'psql #{psql_cmd}'")
+  def sudo_psql_and_log(vm, psql_cmd, user = 'postgres', extras = '')
+    sudo_and_log(vm, "su #{user} -c 'psql #{psql_cmd}' #{extras}")
   end
 
   def sudo_psql_and_expect_result(vm, psql_cmd, expected, user = 'postgres')

spec/support/shared_examples/system_default_postgres.rb

@@ -150,4 +150,24 @@ def install_postgres
       sudo_psql_and_expect_result(vm, '--command="select ts.spcname from pg_database db, pg_tablespace ts where db.dattablespace = ts.oid and db.datname = \'"\'tablespacedb3\'"\'"', 'tablespace2')
     end
   end
+
+  describe 'postgresql.conf include' do
+    it "should support an 'include' directive at the end of postgresql.conf" do
+      test_class = 'class {"postgresql_tests::system_default::test_pgconf_include": }'
+
+      # Run once to check for crashes
+      sudo_and_log(vm, "puppet apply -e '#{test_class}'")
+
+      # Run again to check for idempotence
+      sudo_and_log(vm, "puppet apply --detailed-exitcodes -e '#{test_class}'")
+
+      sudo_and_log(vm, "service #{service_name} restart")
+
+      # Check that the user can create a table in the database
+      sudo_psql_and_expect_result(vm, '--command="show max_connections" -t', '123', 'postgres')
+
+      cleanup_class = 'class {"postgresql_tests::system_default::test_pgconf_include_cleanup": }'
+      sudo_and_log(vm, "puppet apply -e '#{cleanup_class}'")
+    end
+  end
 end

spec/test_module/manifests/system_default/test_pgconf_include.pp

@@ -0,0 +1,10 @@
+class postgresql_tests::system_default::test_pgconf_include {
+
+  require postgresql::params
+
+  $pg_conf_include_file = "${postgresql::params::confdir}/postgresql_puppet_extras.conf"
+
+  file { $pg_conf_include_file :
+    content => 'max_connections = 123'
+  }
+}

spec/test_module/manifests/system_default/test_pgconf_include_cleanup.pp

@@ -0,0 +1,11 @@
+class postgresql_tests::system_default::test_pgconf_include_cleanup {
+
+  require postgresql::params
+
+  $pg_conf_include_file = "${postgresql::params::confdir}/postgresql_puppet_extras.conf"
+
+  file { $pg_conf_include_file :
+    ensure => absent
+  }
+
+}

tests/postgresql_pgconf_extras.pp

@@ -0,0 +1,19 @@
+class { 'postgresql::server':
+    config_hash => {
+        'ip_mask_deny_postgres_user' => '0.0.0.0/32',
+        'ip_mask_allow_all_users'    => '0.0.0.0/0',
+        'listen_addresses'           => '*',
+        'manage_redhat_firewall'     => true,
+        'postgres_password'          => 'postgres',
+    },
+}
+
+include "postgresql::params"
+
+$pg_conf_include_file = "${postgresql::params::confdir}/postgresql_puppet_extras.conf"
+
+file { $pg_conf_include_file:
+  content => 'max_connections = 123',
+  notify  => Service['postgresqld'],
+}
+