Cleaned up and added unit tests

Signed-off-by: Ken Barber <[email protected]>

Author: kbarber

README.md

@@ -164,6 +164,39 @@ This will set the default database locale for all databases created with this mo
 ####`charset`
 This will set the default charset for all databases created with this module. On certain operating systems this will be used during the `template1` initialization as well so it becomes a default outside of the module as well. Defaults to `UTF8`.
 
+####`datadir`
+This setting can be used to override the default postgresql data directory for the target platform. If not specified, the module will use whatever directory is the default for your OS distro.
+
+####`confdir`
+This setting can be used to override the default postgresql configuration directory for the target platform. If not specified, the module will use whatever directory is the default for your OS distro.
+
+####`bindir`
+This setting can be used to override the default postgresql binaries directory for the target platform. If not specified, the module will use whatever directory is the default for your OS distro.
+
+####`client_package_name`
+This setting can be used to override the default postgresql client package name. If not specified, the module will use whatever package name is the default for your OS distro.
+
+####`server_package_name`
+This setting can be used to override the default postgresql server package name. If not specified, the module will use whatever package name is the default for your OS distro.
+
+####`devel_package_name`
+This setting can be used to override the default postgresql devel package name. If not specified, the module will use whatever package name is the default for your OS distro.
+
+####`java_package_name`
+This setting can be used to override the default postgresql java package name. If not specified, the module will use whatever package name is the default for your OS distro.
+
+####`service_name`
+This setting can be used to override the default postgresql service name. If not specified, the module will use whatever service name is the default for your OS distro.
+
+####`user`
+This setting can be used to override the default postgresql super user and owner of postgresql related files in the file system. If not specified, the module will use the user name 'postgres'.
+
+####`group`
+This setting can be used to override the default postgresql user group to be used for related files in the file system. If not specified, the module will use the group name 'postgres'.
+
+####`run_initdb`
+This setting can be used to explicitly call the initdb operation after server package is installed and before the postgresql service is started. If not specified, the module will decide whether to call initdb or not depending on your OS distro.
+
 ###Class: postgresql::server
 Here are the options that you can set in the `config_hash` parameter of `postgresql::server`:
 

lib/puppet/provider/postgresql_psql/ruby.rb

@@ -51,7 +51,8 @@ def run_unless_sql_command(sql)
   end
 
   def run_sql_command(sql)
-    command = %{psql #{"-d #{resource[:db]}" if resource[:db]} -t -c "#{sql.gsub('"', '\"')}"}
+    command = %{#{resource[:psql_path]} #{"-d #{resource[:db]}" if resource[:db]} -t -c "#{sql.gsub('"', '\"')}"}
+
     if resource[:cwd]
       Dir.chdir resource[:cwd] do
         Puppet::Util::SUIDManager.run_and_capture(command, resource[:psql_user], resource[:psql_group])

lib/puppet/type/postgresql_psql.rb

@@ -54,10 +54,6 @@ def sync(refreshing = false)
     defaultto("psql")
   end
 
-  newparam(:library_path) do
-    desc "The path to postgresql libraries."
-  end
-
   newparam(:psql_user) do
     desc "The system user account under which the psql command should be executed."
     defaultto("postgres")

manifests/database.pp

@@ -27,15 +27,15 @@
 ) {
   include postgresql::params
 
-  # Optionally set the locale switch. Older versions of createdb may not accept
-  # --locale, so if the parameter is undefined its safer not to pass it.
+  # Set the defaults for the postgresql_psql resource
   Postgresql_psql {
     psql_user    => $postgresql::params::user,
     psql_group   => $postgresql::params::group,
     psql_path    => $postgresql::params::psql_path,
-    library_path => $postgresql::params::library_path,
   }
 
+  # Optionally set the locale switch. Older versions of createdb may not accept
+  # --locale, so if the parameter is undefined its safer not to pass it.
   if ($postgresql::params::version != '8.1') {
     $locale_option = $locale ? {
       undef   => '',
@@ -59,23 +59,20 @@
   postgresql_psql { "Check for existence of db '${dbname}'":
     command => 'SELECT 1',
     unless  => "SELECT datname FROM pg_database WHERE datname='${dbname}'",
-    cwd     => $postgresql::params::datadir,
     require => Class['postgresql::server']
   } ~>
 
   exec { $createdb_command :
     refreshonly => true,
-    user      => $postgresql::params::user,
-    cwd       => $postgresql::params::datadir,
-    logoutput => on_failure,
+    user        => $postgresql::params::user,
+    logoutput   => on_failure,
   } ~>
 
   # This will prevent users from connecting to the database unless they've been
   #  granted privileges.
   postgresql_psql {"REVOKE ${public_revoke_privilege} ON DATABASE \"${dbname}\" FROM public":
     db          => $postgresql::params::user,
     refreshonly => true,
-    cwd         => $postgresql::params::datadir,
   }
 
 }

manifests/database_grant.pp

@@ -25,21 +25,20 @@
 #  in the modules or not.
 
 define postgresql::database_grant(
-    # TODO: mysql supports an array of privileges here.  We should do that if we
-    #  port this to ruby.
-    $privilege,
-    $db,
-    $role,
-    $psql_db   = $postgresql::params::user,
-    $psql_user = $postgresql::params::user
+  # TODO: mysql supports an array of privileges here.  We should do that if we
+  #  port this to ruby.
+  $privilege,
+  $db,
+  $role,
+  $psql_db   = $postgresql::params::user,
+  $psql_user = $postgresql::params::user
 ) {
   include postgresql::params
 
   Postgresql_psql {
     psql_user    => $postgresql::params::user,
     psql_group   => $postgresql::params::group,
     psql_path    => $postgresql::params::psql_path,
-    library_path => $postgresql::params::library_path,
   }
 
   # TODO: FIXME: only works on databases, due to using has_database_privilege
@@ -61,7 +60,5 @@
     db           => $psql_db,
     psql_user    => $psql_user,
     unless       => "SELECT 1 WHERE has_database_privilege('${role}', '${db}', '${unless_privilege}')",
-    cwd          => $postgresql::params::datadir,
   }
 }
-

manifests/database_user.pp

@@ -38,12 +38,12 @@
 #
 
 define postgresql::database_user(
-    $password_hash,
-    $createdb   = false,
-    $createrole = false,
-    $db         = $postgresql::params::user,
-    $superuser  = false,
-    $user       = $title
+  $password_hash,
+  $createdb   = false,
+  $createrole = false,
+  $db         = $postgresql::params::user,
+  $superuser  = false,
+  $user       = $title
 ) {
   postgresql::role { $user:
     db              => $db,

manifests/init.pp

@@ -10,7 +10,7 @@
 # For examples, see the files in the `tests` directory; in particular,
 # `/server-yum-postgresql-org.pp`.
 #
-# Parameters:
+# === Parameters
 #
 # [*version*]
 #    The postgresql version to install.  If not specified, the
@@ -48,11 +48,6 @@
 #    binaries directory for the target platform. If not
 #    specified, the module will use whatever directory is the
 #    default for your OS distro.
-# [*libdir*]
-#    This setting can be used to override the default postgresql
-#    lib directory for the target platform. If not
-#    specified, the module will assume that the libraries are
-#    loaded without the explicit library location.
 # [*client_package_name*]
 #    This setting can be used to override the default
 #    postgresql client package name. If not specified, the module
@@ -63,6 +58,16 @@
 #    postgresql server package name. If not specified, the module
 #    will use whatever package name is the default for your
 #    OS distro.
+# [*devel_package_name*]
+#    This setting can be used to override the default
+#    postgresql devel package name. If not specified, the module
+#    will use whatever package name is the default for your
+#    OS distro.
+# [*java_package_name*]
+#    This setting can be used to override the default
+#    postgresql java package name. If not specified, the module
+#    will use whatever package name is the default for your
+#    OS distro.
 # [*service_name*]
 #    This setting can be used to override the default
 #    postgresql service name. If not specified, the module
@@ -79,13 +84,13 @@
 #    in the file system. If not specified, the module will use
 #    the group name 'postgres'.
 # [*run_initdb*]
-#    This setting can be used to explicitly call the inidb
+#    This setting can be used to explicitly call the initdb
 #    operation after server package is installed and before
 #    the postgresql service is started. If not specified, the
 #    module will decide whether to call initdb or not depending
 #    on your OS distro.
 #
-# === Examples:
+# === Examples
 #
 #   class { 'postgresql':
 #     version               => '9.2',
@@ -102,15 +107,15 @@
   $datadir             = undef,
   $confdir             = undef,
   $bindir              = undef,
-  $libdir              = undef,
   $client_package_name = undef,
   $server_package_name = undef,
   $devel_package_name  = undef,
   $java_package_name   = undef,
   $service_name        = undef,
   $user                = undef,
   $group               = undef,
-  $run_initdb          = undef,) {
+  $run_initdb          = undef
+) {
 
   class { 'postgresql::params':
     version                    => $version,
@@ -121,7 +126,6 @@
     custom_datadir             => $datadir,
     custom_confdir             => $confdir,
     custom_bindir              => $bindir,
-    custom_libdir              => $libdir,
     custom_client_package_name => $client_package_name,
     custom_server_package_name => $server_package_name,
     custom_devel_package_name  => $devel_package_name,

manifests/params.pp

@@ -36,7 +36,6 @@
   $custom_datadir             = undef,
   $custom_confdir             = undef,
   $custom_bindir              = undef,
-  $custom_libdir              = undef,
   $custom_client_package_name = undef,
   $custom_server_package_name = undef,
   $custom_devel_package_name  = undef,
@@ -58,32 +57,32 @@
 
 
   if ($manage_package_repo) {
-      case $::osfamily {
-        'RedHat': {
-          $rh_pkg_source = pick($package_source, 'yum.postgresql.org')
-
-          case $rh_pkg_source {
-            'yum.postgresql.org': {
-              class { 'postgresql::package_source::yum_postgresql_org':
-                version => $version
-              }
+    case $::osfamily {
+      'RedHat': {
+        $rh_pkg_source = pick($package_source, 'yum.postgresql.org')
+
+        case $rh_pkg_source {
+          'yum.postgresql.org': {
+            class { 'postgresql::package_source::yum_postgresql_org':
+              version => $version
             }
+          }
 
-            default: {
-              fail("Unsupported package source '${rh_pkg_source}' for ${::osfamily} OS family. Currently the only supported source is 'yum.postgresql.org'")
-            }
+          default: {
+            fail("Unsupported package source '${rh_pkg_source}' for ${::osfamily} OS family. Currently the only supported source is 'yum.postgresql.org'")
           }
         }
+      }
 
-        'Debian': {
-          class { 'postgresql::package_source::apt_postgresql_org': }
-        }
+      'Debian': {
+        class { 'postgresql::package_source::apt_postgresql_org': }
+      }
 
-        default: {
-          fail("Unsupported osfamily: ${::osfamily} operatingsystem: ${::operatingsystem}, module ${module_name} currently only supports osfamily RedHat and Debian")
-        }
+      default: {
+        fail("Unsupported osfamily: ${::osfamily} operatingsystem: ${::operatingsystem}, module ${module_name} currently only supports osfamily RedHat and Debian")
       }
     }
+  }
 
 
   # This is a bit hacky, but if the puppet nodes don't have pluginsync enabled,
@@ -116,7 +115,6 @@
         $java_package_name   = pick($custom_java_package_name, 'postgresql-jdbc')
         $service_name = pick($custom_service_name, 'postgresql')
         $bindir       = pick($custom_bindir, '/usr/bin')
-        $libdir       = $custom_libdir
         $datadir      = pick($custom_datadir, '/var/lib/pgsql/data')
         $confdir      = pick($custom_confdir, $datadir)
       } else {
@@ -128,7 +126,6 @@
         $java_package_name   = pick($custom_java_package_name, "postgresql${package_version}-jdbc")
         $service_name = pick($custom_service_name, "postgresql-${version}")
         $bindir       = pick($custom_bindir, "/usr/pgsql-${version}/bin")
-        $libdir       = $custom_libdir
         $datadir      = pick($custom_datadir, "/var/lib/pgsql/${version}/data")
         $confdir      = pick($custom_confdir, $datadir)
       }
@@ -145,7 +142,7 @@
 
       case $::operatingsystem {
         'Debian': {
-            $service_name = pick($custom_service_name, 'postgresql')
+          $service_name = pick($custom_service_name, 'postgresql')
         }
         'Ubuntu': {
           # thanks, ubuntu
@@ -162,7 +159,6 @@
       $devel_package_name  = pick($custom_devel_package_name, 'libpq-dev')
       $java_package_name   = pick($custom_java_package_name, 'libpostgresql-jdbc-java')
       $bindir              = pick($custom_bindir, "/usr/lib/postgresql/${version}/bin")
-      $libdir              = $custom_libdir
       $datadir             = pick($custom_datadir, "/var/lib/postgresql/${version}/main")
       $confdir             = pick($custom_confdir, "/etc/postgresql/${version}/main")
       $service_status      = "/etc/init.d/${service_name} status | /bin/egrep -q 'Running clusters: .+|online'"
@@ -176,7 +172,6 @@
   $initdb_path          = "${bindir}/initdb"
   $createdb_path        = "${bindir}/createdb"
   $psql_path            = "${bindir}/psql"
-  $library_path         = $libdir
   $pg_hba_conf_path     = "${confdir}/pg_hba.conf"
   $postgresql_conf_path = "${confdir}/postgresql.conf"
 

manifests/psql.pp

@@ -34,12 +34,7 @@
     $no_password_option = '--no-password'
   }
 
-  $psql_core = "${postgresql::params::psql_path} ${no_password_option} --tuples-only --quiet --dbname ${db}"
-
-  $psql = $postgresql::params::library_path ? {
-    undef   => $psql_core,
-    default => "LD_LIBRARY_PATH=\"${postgresql::params::library_path}\" ${psql_core}"
-  }
+  $psql = "${postgresql::params::psql_path} ${no_password_option} --tuples-only --quiet --dbname ${db}"
 
   $quoted_command = regsubst($command, '"', '\\"', 'G')
   $quoted_unless  = regsubst($unless,  '"', '\\"', 'G')

manifests/role.pp

@@ -31,7 +31,6 @@
     psql_user    => $postgresql::params::user,
     psql_group   => $postgresql::params::group,
     psql_path    => $postgresql::params::psql_path,
-    library_path => $postgresql::params::library_path,
   }
 
   $login_sql      = $login      ? { true => 'LOGIN'     , default => 'NOLOGIN' }
@@ -41,9 +40,8 @@
 
   # TODO: FIXME: Will not correct the superuser / createdb / createrole / login status of a role that already exists
   postgresql_psql {"CREATE ROLE \"${username}\" ENCRYPTED PASSWORD '${password_hash}' ${login_sql} ${createrole_sql} ${createdb_sql} ${superuser_sql}":
-    db           => $db,
-    psql_user    => $postgresql::params::user,
-    unless       => "SELECT rolname FROM pg_roles WHERE rolname='${username}'",
-    cwd          => $postgresql::params::datadir,
+    db        => $db,
+    psql_user => $postgresql::params::user,
+    unless    => "SELECT rolname FROM pg_roles WHERE rolname='${username}'",
   }
 }