FM-6445 add a task

Author: tphoney

CHANGELOG.md

@@ -1,3 +1,10 @@
+## Supported Release 5.3.0
+### Summary
+Adds tasks to the Postgres module.
+
+#### Added
+- Adds the execute sql task.
+
 ## Supported Release 5.2.0
 ### Summary
 Adds several new features including some work around OS support. Also includes a couple of fixes to tests and the removal of unsupported Ubuntu versions.

README.md

@@ -20,6 +20,7 @@
     * [Defined Types](#defined-types)
     * [Types](#types)
     * [Functions](#functions)
+    * [Tasks](#tasks)
 5. [Limitations - OS compatibility, etc.](#limitations)
 6. [Development - Guide for contributing to the module](#development)
     * [Contributors - List of module contributors](#contributors)
@@ -365,6 +366,8 @@ The postgresql module comes with many options for configuring the server. While
 * [postgresql_password](#function-postgresql_password)
 * [postgresql_acls_to_resources_hash](#function-postgresql_acls_to_resources_hashacl_array-id-order_offset)
 
+**Tasks:**
+
 ### Classes
 
 #### postgresql::client
@@ -1820,6 +1823,10 @@ This internal function converts a list of `pg_hba.conf` based ACLs (passed in as
 
 **This function should only be used internally by the module**.
 
+### Tasks
+
+The Postgresql module has an example task that allows a user to execute arbitary SQL against a database. Please refer to to the [PE documentation](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html) or [Bolt documentation](https://puppet.com/docs/bolt/latest/bolt.html) on how to execute a task. 
+
 ## Limitations
 
 Works with versions of PostgreSQL from 8.1 through 9.5.

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "puppetlabs-postgresql",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "author": "Inkling/Puppet Labs",
   "summary": "Offers support for basic management of PostgreSQL databases.",
   "license": "Apache-2.0",

spec/acceptance/sql_task_spec.rb

@@ -0,0 +1,17 @@
+# run a test task
+require 'spec_helper_acceptance'
+
+describe 'puppet_conf task' do
+  describe 'puppet configuration file', if: pe_install? && puppet_version =~ %r{(5\.\d\.\d)} do
+    pp = <<-EOS
+      class { 'postgresql::server': }
+    EOS
+
+    apply_manifest(pp, :catch_failures => true)
+
+    it 'set/get a puppet configuration' do
+      result = run_task(task_name: 'sql', params: 'sql="show databases;"')
+      expect_multiple_regexes(result: result, regexes: [%r{information_schema}, %r{performance_schema}, %r{Job completed. 1/1 nodes succeeded}])
+    end
+  end
+end

spec/spec_helper_acceptance.rb

@@ -3,6 +3,18 @@
 require 'beaker/puppet_install_helper'
 require 'beaker/module_install_helper'
 
+def install_bolt_on(hosts)
+  on(hosts, "/opt/puppetlabs/puppet/bin/gem install --source http://rubygems.delivery.puppetlabs.net bolt -v '> 0.0.1'", acceptable_exit_codes: [0, 1]).stdout
+end
+
+def pe_install?
+  ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i
+end
+
+def puppet_version
+  (on default, puppet('--version')).output.chomp
+end
+
 run_puppet_install_helper
 install_ca_certs unless ENV['PUPPET_INSTALL_TYPE'] =~ /pe/i
 
@@ -35,10 +47,48 @@ def module_dependencies_from_metadata
   end
 end
 
+
+install_bolt_on(hosts) unless ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i
 install_module_on(hosts)
 install_module_dependencies_on(hosts)
 install_module_from_forge_on(hosts,'puppetlabs/apt','< 4.2.0')
 
+DEFAULT_PASSWORD = if default[:hypervisor] == 'vagrant'
+                     'vagrant'
+                   elsif default[:hypervisor] == 'vcloud'
+                     'Qu@lity!'
+                   end
+
+def run_puppet_access_login(user:, password: '~!@#$%^*-/ aZ', lifetime: '5y')
+  on(master, puppet('access', 'login', '--username', user, '--lifetime', lifetime), stdin: password)
+end
+
+def pe_install?
+  ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i
+end
+
+def run_task(task_name:, params: nil, password: DEFAULT_PASSWORD)
+  if pe_install?
+    run_puppet_task(task_name: task_name, params: params)
+  else
+    run_bolt_task(task_name: task_name, params: params, password: password)
+  end
+end
+
+def run_bolt_task(task_name:, params: nil, password: DEFAULT_PASSWORD)
+  on(master, "/opt/puppetlabs/puppet/bin/bolt task run #{task_name} --modules /etc/puppetlabs/code/modules/service --nodes localhost --password #{password} #{params}", acceptable_exit_codes: [0, 1]).stdout # rubocop:disable Metrics/LineLength
+end
+
+def run_puppet_task(task_name:, params: nil)
+  on(master, puppet('task', 'run', task_name, '--nodes', fact_on(master, 'fqdn'), params.to_s), acceptable_exit_codes: [0, 1]).stdout
+end
+
+def expect_multiple_regexes(result:, regexes:)
+  regexes.each do |regex|
+    expect(result).to match(regex)
+  end
+end
+
 class String
   # Provide ability to remove indentation from strings, for the purpose of
   # left justifying heredoc blocks.
@@ -78,6 +128,7 @@ def psql(psql_cmd, user = 'postgres', exit_codes = [0,1], &block)
 
   # Configure all nodes in nodeset
   c.before :suite do
+    run_puppet_access_login(user: 'admin') if pe_install?
     # Set up selinux if appropriate.
     if fact('osfamily') == 'RedHat' && fact('selinux') == 'true'
       pp = <<-EOS

tasks/sql.json

@@ -0,0 +1,18 @@
+{
+  "description": "Allows you to execute arbitary SQL",
+  "input_method": "stdin",
+  "parameters": {
+    "database": {
+      "description": "Database to connect to",
+      "type": "Optional[String[1]]"
+    },
+     "sql": {
+      "description": "The SQL you want to execute",
+      "type": "String[1]"
+    },
+    "user": {
+      "description": "The user",
+      "type": "Optional[String[1]]"
+    }
+  }
+}

tasks/sql.rb

@@ -0,0 +1,27 @@
+#!/opt/puppetlabs/puppet/bin/ruby
+require 'json'
+require 'open3'
+require 'puppet'
+
+def get(sql, database, user)
+  cmd_string = "psql -c \"#{sql}\""
+  cmd_string << " -d #{database}" unless database.nil?
+  cmd_string << " -U #{user}" unless user.nil?
+  stdout, stderr, status = Open3.capture3(cmd_string)
+  raise Puppet::Error, stderr if status != 0
+  { status: stdout.strip }
+end
+
+params = JSON.parse(STDIN.read)
+database = params['database']
+user = params['user']
+sql = params['sql']
+
+begin
+  result = get(sql, database, user)
+  puts result.to_json
+  exit 0
+rescue Puppet::Error => e
+  puts({ status: 'failure', error: e.message }.to_json)
+  exit 1
+end