X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fpostgresql%2Fmanifests%2Fvalidate_db_connection.pp;fp=3rdparty%2Fmodules%2Fpostgresql%2Fmanifests%2Fvalidate_db_connection.pp;h=10e5ecccdd6190a628dd01cae7266d8c44e92ee3;hb=a69999e580f8b3abd12446c2d6ad59e517651813;hp=b843e6e32d60aa09e9dcdd495009c250c94c958f;hpb=e7b6b352165009c385c52fcfe5a1055690dbfa4b;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/postgresql/manifests/validate_db_connection.pp b/3rdparty/modules/postgresql/manifests/validate_db_connection.pp
index b843e6e32..10e5ecccd 100644
--- a/3rdparty/modules/postgresql/manifests/validate_db_connection.pp
+++ b/3rdparty/modules/postgresql/manifests/validate_db_connection.pp
@@ -1,66 +1,82 @@
-# Define: postgresql::validate_db_connection
-#
 # This type validates that a successful postgres connection can be established
 # between the node on which this resource is run and a specified postgres
 # instance (host/port/user/password/database name).
 #
-# Parameters:
-#   [*database_host*]       - the hostname or IP address of the machine where the
-#                             postgres server should be running.
-#   [*database_port*]       - the port on which postgres server should be
-#                             listening (defaults to 5432).
-#   [*database_username*]   - the postgres username
-#   [*database_password*]   - the postgres user's password
-#   [*database_name*]       - the database name that the connection should be
-#                             established against
-#
-# NOTE: to some degree this type assumes that you've created the corresponding
-# postgres database instance that you are validating by using the
-# `postgresql::db` or `postgresql::database` type provided by this module
-# elsewhere in your manifests.
-#
-# Actions:
-#
-# Attempts to establish a connection to the specified postgres database.  If
-#  a connection cannot be established, the resource will fail; this allows you
-#  to use it as a dependency for other resources that would be negatively
-#  impacted if they were applied without the postgres connection being available.
-#
-# Requires:
-#
-#  `psql` commandline tool (will automatically install the system's postgres
-#                           client package if it is not already installed.)
-#
-# Sample Usage:
-#
-#  postgresql::validate_db_connection { 'validate my postgres connection':
-#      database_host           => 'my.postgres.host',
-#      database_username       => 'mydbuser',
-#      database_password       => 'mydbpassword',
-#      database_name           => 'mydbname',
-#  }
-#
-
+# See README.md for more details.
 define postgresql::validate_db_connection(
-  $database_host,
-  $database_name,
-  $database_password,
-  $database_username,
-  $database_port = 5432
+  $database_host     = undef,
+  $database_name     = undef,
+  $database_password = undef,
+  $database_username = undef,
+  $database_port     = undef,
+  $connect_settings  = undef,
+  $run_as            = undef,
+  $sleep             = 2,
+  $tries             = 10,
+  $create_db_first   = true
 ) {
-  require postgresql::client
+  include postgresql::client
+  include postgresql::params
+
+  warning('postgresql::validate_db_connection is deprecated, please use postgresql_conn_validator.')
 
-  # TODO: port to ruby
-  $psql = "${postgresql::params::psql_path} --tuples-only --quiet -h ${database_host} -U ${database_username} -p ${database_port} --dbname ${database_name}"
+  $psql_path = $postgresql::params::psql_path
+  $module_workdir = $postgresql::params::module_workdir
+  $validcon_script_path = $postgresql::client::validcon_script_path
+
+  $cmd_init = "${psql_path} --tuples-only --quiet "
+  $cmd_host = $database_host ? {
+    undef   => '',
+    default => "-h ${database_host} ",
+  }
+  $cmd_user = $database_username ? {
+    undef   => '',
+    default => "-U ${database_username} ",
+  }
+  $cmd_port = $database_port ? {
+    undef   => '',
+    default => "-p ${database_port} ",
+  }
+  $cmd_dbname = $database_name ? {
+    undef   => "--dbname ${postgresql::params::default_database} ",
+    default => "--dbname ${database_name} ",
+  }
+  $pass_env = $database_password ? {
+    undef   => undef,
+    default => "PGPASSWORD=${database_password}",
+  }
+  $cmd = join([$cmd_init, $cmd_host, $cmd_user, $cmd_port, $cmd_dbname], ' ')
+  $validate_cmd = "${validcon_script_path} ${sleep} ${tries} '${cmd}'"
+
+  # This is more of a safety valve, we add a little extra to compensate for the
+  # time it takes to run each psql command.
+  $timeout = (($sleep + 2) * $tries)
+
+  # Combine $database_password and $connect_settings into an array of environment
+  # variables, ensure $database_password is last, allowing it to override a password
+  # from the $connect_settings hash
+  if $connect_settings != undef {
+    if $pass_env != undef {
+      $env = concat(join_keys_to_values( $connect_settings, '='), $pass_env)
+    } else {
+      $env = join_keys_to_values( $connect_settings, '=')
+    }
+  } else {
+    $env = $pass_env
+  }
+
+  $exec_name = "validate postgres connection for ${database_username}@${database_host}:${database_port}/${database_name}"
 
-  $exec_name = "validate postgres connection for ${database_host}/${database_name}"
   exec { $exec_name:
-    command     => '/bin/false',
-    unless      => "/bin/echo \"SELECT 1\" | ${psql}",
-    cwd         => '/tmp',
-    environment => "PGPASSWORD=${database_password}",
+    command     => "echo 'Unable to connect to defined database using: ${cmd}' && false",
+    unless      => $validate_cmd,
+    cwd         => $module_workdir,
+    environment => $env,
     logoutput   => 'on_failure',
-    require     => Package['postgresql-client'],
+    user        => $run_as,
+    path        => '/bin:/usr/bin:/usr/local/bin',
+    timeout     => $timeout,
+    require     => Class['postgresql::client'],
   }
 
   # This is a little bit of puppet magic.  What we want to do here is make
@@ -72,6 +88,7 @@ define postgresql::validate_db_connection(
   # We accomplish this by using Puppet's resource collection syntax to search
   # for the Database resource in our current catalog; if it exists, the
   # appropriate relationship is created here.
-  Database<|title == $database_name|> -> Exec[$exec_name]
+  if($create_db_first) {
+    Postgresql::Server::Database<|title == $database_name|> -> Exec[$exec_name]
+  }
 }
-