Merge pull request puppetlabs#100 from kbrezina/master

Support for tablespaces

Author: cprice404

manifests/database.pp

@@ -21,7 +21,8 @@
 
 define postgresql::database(
   $dbname  = $title,
-  $charset = 'UTF8')
+  $charset = 'UTF8',
+  $tablespace = undef)
 {
   include postgresql::params
 
@@ -33,7 +34,14 @@
     $public_revoke_privilege = "ALL"
   }
 
-  $createdb_command = "${postgresql::params::createdb_path} --template=template0 --encoding '${charset}' ${locale_option} '${dbname}'"
+  $createdb_command_tmp = "${postgresql::params::createdb_path} --template=template0 --encoding '${charset}' ${locale_option} '${dbname}'"
+
+  if($tablespace == undef) {
+    $createdb_command = $createdb_command_tmp
+  }
+  else {
+    $createdb_command = "${createdb_command_tmp} --tablespace='${tablespace}'"
+  }
 
   postgresql_psql { "Check for existence of db '$dbname'":
     command => "SELECT 1",

manifests/db.pp

@@ -16,6 +16,7 @@
 #                            function in this module
 #   [*charset*]     - database charset. defaults to 'utf8'
 #   [*grant*]       - privilege to grant user. defaults to 'all'.
+#   [*tablespace*]  - database tablespace. default to use the template database's tablespace.
 #
 # Actions:
 #
@@ -35,13 +36,15 @@
   $user,
   $password,
   $charset     = 'utf8',
-  $grant       = 'ALL'
-) {
+  $grant       = 'ALL',
+  $tablespace = undef)
+{
 
   postgresql::database { $name:
     # TODO: ensure is not yet supported
     #ensure     => present,
     charset     => $charset,
+    tablespace  => $tablespace,
     #provider   => 'postgresql',
     require     => Class['postgresql::server'],
   }

manifests/tablespace.pp

@@ -0,0 +1,54 @@
+# Define: postgresql::tablespace
+#
+# This module creates tablespace
+#
+# Parameters:
+#   [*title*]       - the name of a tablespace to be created. The name cannot begin with pg_, as such names are reserved for system tablespaces.
+#   [*owner*]       - the name of the user who will own the tablespace. If omitted, defaults to the user executing the command.
+#                     Only superusers can create tablespaces, but they can assign ownership of tablespaces to non-superusers.
+#   [*location*]    - The directory that will be used for the tablespace. The directory should be empty and must be owned by the PostgreSQL
+#                     system user. The directory must be specified by an absolute path name.
+#
+# Actions:
+#
+# Requires:
+#
+#   class postgresql::server
+#
+# Sample Usage:
+#
+#  postgresql::tablespace { 'dbspace':
+#    location => '/data/dbs',
+#  }
+#
+#
+define postgresql::tablespace(
+  $location,
+  $owner = undef,
+  $spcname  = $title)
+{
+  include postgresql::params
+
+  if ($owner == undef) {
+    $owner_section = ''
+  }
+  else {
+    $owner_section = "OWNER ${owner}"
+  }
+
+  $create_tablespace_command = "CREATE TABLESPACE ${spcname} ${owner_section} LOCATION '${location}'"
+
+  file { "${location}":
+    ensure => directory,
+    owner  => 'postgres',
+    group  => 'postgres',
+    mode => 700,
+  }
+
+  postgresql_psql { "Create tablespace '${spcname}'":
+    command => $create_tablespace_command,
+    unless  => "SELECT spcname FROM pg_tablespace WHERE spcname='${spcname}'",
+    cwd     => $postgresql::params::datadir,
+    require => [Class['postgresql::server'], File["${location}"]],
+  }
+}

spec/support/postgres_test_utils.rb

@@ -12,4 +12,18 @@ def sudo_and_log(vm, cmd)
   def sudo_psql_and_log(vm, psql_cmd, user = 'postgres')
     sudo_and_log(vm, "su #{user} -c 'psql #{psql_cmd}'")
   end
-end
+
+  def sudo_psql_and_expect_result(vm, psql_cmd, expected, user = 'postgres')
+    result = sudo_and_log(vm, "su #{user} -c 'psql -t #{psql_cmd}'")
+
+    result.sub!(/stdin: is not a tty/, '')
+    result.strip! 
+
+    ok = result == expected
+    @logger.debug("Expected: #{expected} => #{ok ? 'OK' : 'BAD'}")
+ 
+    if !ok
+      raise "An unexpected result returned - result: '#{result}' / expected: '#{expected}'"
+    end 
+  end
+end

spec/support/shared_examples/system_default_postgres.rb

@@ -134,4 +134,20 @@ def install_postgres
       sudo_and_log(vm, "puppet apply --detailed-exitcodes -e '#{test_pp}'; [ $? == 4 ]")
     end
   end
+
+  describe 'postgresql::tablespace' do
+    it 'should idempotently create tablespaces and databases that are using them' do
+      test_class = 'class {"postgresql_tests::system_default::test_tablespace": }'
+
+      # 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}'")
+        
+      # Check that databases use correct tablespaces
+      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 = \'"\'tablespacedb1\'"\'"', 'tablespace1')
+      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
 end

spec/test_module/manifests/system_default/test_tablespace.pp

@@ -0,0 +1,65 @@
+# puppet-postgresql
+# For all details and documentation:
+# http://github.com/inkling/puppet-postgresql
+#
+# Copyright 2012- Inkling Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class postgresql_tests::system_default::test_tablespace {
+
+  include postgresql::server
+
+  file { '/tmp':
+    ensure => 'directory',
+  }
+  file { '/tmp/pg_tablespaces':
+    ensure => 'directory',
+    owner  => 'postgres',
+    group  => 'postgres',
+    mode   => 700,
+    require => File['/tmp'],
+  }
+
+  postgresql::tablespace{ 'tablespace1':
+    location => '/tmp/pg_tablespaces/space1',
+    require => [Class['postgresql::server'], File['/tmp/pg_tablespaces']],
+  }
+  postgresql::database{ 'tablespacedb1':
+    charset => 'utf8',
+    tablespace => 'tablespace1',
+    require => Postgresql::Tablespace['tablespace1'],
+  }
+  postgresql::db{ 'tablespacedb2':
+    user => 'dbuser2',
+    password => 'dbuser2',
+    tablespace => 'tablespace1',
+    require => Postgresql::Tablespace['tablespace1'],
+  }
+
+  postgresql::database_user{ 'spcuser':
+    password_hash => postgresql_password('spcuser', 'spcuser'),
+    require       => Class['postgresql::server'],
+  }
+  postgresql::tablespace{ 'tablespace2':
+    location => '/tmp/pg_tablespaces/space2',
+    owner => 'spcuser',
+    require => [Postgresql::Database_user['spcuser'], File['/tmp/pg_tablespaces']],
+  }
+  postgresql::database{ 'tablespacedb3':
+    charset => 'utf8',
+    tablespace => 'tablespace2',
+    require => Postgresql::Tablespace['tablespace2'],
+  }
+  
+}

tests/postgresql_tablespace.pp

@@ -0,0 +1,73 @@
+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',
+    },
+}
+
+file { '/tmp':
+  ensure => 'directory',
+}
+file { '/tmp/pg_tablespaces':
+  ensure => 'directory',
+  owner  => 'postgres',
+  group  => 'postgres',
+  mode   => 700,
+  require => File['/tmp'],
+}
+
+postgresql::tablespace{ 'tablespace1':
+  location => '/tmp/pg_tablespaces/space1',
+  require => [Class['postgresql::server'], File['/tmp/pg_tablespaces']],
+}
+postgresql::database{ 'tablespacedb1':
+  # TODO: ensure not yet supported
+  #ensure  => present,
+  charset => 'utf8',
+  require => Class['postgresql::server'],
+}
+postgresql::database{ 'tablespacedb2':
+  # TODO: ensure not yet supported
+  #ensure  => present,
+  charset => 'utf8',
+  tablespace => 'tablespace1',
+  require => Postgresql::Tablespace['tablespace1'],
+}
+postgresql::db{ 'tablespacedb3':
+  # TODO: ensure not yet supported
+  #ensure  => present,
+  user => 'dbuser1',
+  password => 'dbuser1',
+  require => Class['postgresql::server'],
+}
+postgresql::db{ 'tablespacedb4':
+  # TODO: ensure not yet supported
+  #ensure  => present,
+  user => 'dbuser2',
+  password => 'dbuser2',
+  tablespace => 'tablespace1',
+  require => Postgresql::Tablespace['tablespace1'],
+}
+
+postgresql::database_user{ 'spcuser':
+  # TODO: ensure is not yet supported
+  #ensure        => present,
+  password_hash => postgresql_password('spcuser', 'spcuser'),
+  require       => Class['postgresql::server'],
+}
+postgresql::tablespace{ 'tablespace2':
+  location => '/tmp/pg_tablespaces/space2',
+  owner => 'spcuser',
+  require => [Postgresql::Database_user['spcuser'], File['/tmp/pg_tablespaces']],
+}
+postgresql::database{ 'tablespacedb5':
+  # TODO: ensure not yet supported
+  #ensure  => present,
+  charset => 'utf8',
+  tablespace => 'tablespace2',
+  require => Postgresql::Tablespace['tablespace2'],
+}
+