train-pgsql 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b350bc75289acf2790bd703acea6fe334651aa0b57408a1efb40026f8728eab
-  data.tar.gz: 6be610b670d7839f092bf7496b62d9281c905e18933df18dc93dc584ca5e88c6
+  metadata.gz: 6cc43010edf32c388d28ccc471efab2426f34929ee85ab8740aa8ea1c966c8fe
+  data.tar.gz: baa255ee6e272fb9c5adefcffe319b4bf3f5379866b9944e432302a8638d9151
 SHA512:
-  metadata.gz: f1a6e6455f31b4a2c254ff4e2165df2572656d26fa1021d96d9bcda302077a97b6c1df7c95ca17dfbb798a2a866f8a24228a87d66a895026f542dc2e8e9d99e1
-  data.tar.gz: 84f7f92b4d39d343e583e9ffbe4794413e149b0631ed10d396466cad439a3b3d204948a8a38c99591192018f5e53a7e07c5ac80d1e28581aa7d73d0be37049a9
+  metadata.gz: 1dfb0415d0c437914a18021c87456687887b38e2f51013610599b5fb2a28683a181291fe08664299ca2e900b03920eb5b5c48365919d274661783d30a77e0297
+  data.tar.gz: 4d8b58bfeea0f915a1a2aea0ffcc3d306972abcab389bc894f2cf6c4a8df7aed11eb616a8af5b746661a125c84499f85a28467948d3593a5f132bd515353856d

data/README.md

@@ -19,17 +19,45 @@ inspec plugin install train-pgsql
 
 ## Transport parameters
 
-| Option     | Explanation         | Default    |
-| ---------- | ------------------- | ---------- |
-| `host`     | Hostname            | (required) |
-| `user`     | Username to connect | (required) |
-| `password` | Password to connect | (required) |
-| `database` | Database to connect | `postgres` |
-| `port`     | Remote port         | `5432`     |
+| Option     | Explanation         | Default    | ENV VAR      |
+| ---------- | ------------------- | ---------- | ------------ |
+| `host`     | Hostname            | (required) | `PGHOST`     |
+| `user`     | Username to connect | (required) | `PGUSER`     |
+| `password` | Password to connect | (required) | `PGPASSWORD` |
+| `database` | Database to connect | `postgres` | `PGDATABASE` |
+| `port`     | Remote port         | `5432`     | `PGPORT`     |
+
+## Transport CommandResult
+`connection.run_command('SQL HERE')` returns a CommandResult object. The `stdout` value is set to a hash with `fields` and `values`.
+
+For Example:
+```
+#<struct Train::Extras::CommandResult stdout={"fields"=>["name", "owner", "acl"], "values"=>[["public", "postgres", "postgres=UC/postgres"], ["public", "postgres", "=UC/postgres"]]}, stderr="", exit_status=0>
+```
+
 
-## Example use
+## Example use in inspec
+Connect to the postgresql target as such:
+```bash
+inspec shell -t pgsql://db.host.name --user 'username' --password 'supersecret' --insecure boolean
+```
+or
+```bash
+inspec exec -t pgsql://db.host.name --user 'username' --password 'supersecret' --insecure boolean
+```
 
-This will work for a Cisco IOS XE device with Telnet enabled:
+Alternatively you can set all these as environment variables using the following variables and authenticate without the parameters in in the inspec command or the target
+```bash
+export PGHOST='db.host.name'
+export PGUSER='username'
+export PGPASSWORD='supersecret'
+export PGDATABASE='somedatabase'
+inspec exec -t pgsql://
+```
+
+## Example use from Ruby
+
+This will work if you have postgresql running on `localhost`:
 ```ruby
 require "train"
 train  = Train.create("pgsql", {
@@ -41,7 +69,6 @@ conn   = train.connection
 result = conn.run_command("show version\n")
 conn.close
 ```
-
 ## Local development
 If you are building this on a Mac you may run into an issue trying to install this locally due to the `PG` gem not installing due to code signing issues.
 You can build it and run it in a docker container.

data/lib/train-pgsql/connection.rb

@@ -6,6 +6,7 @@ module TrainPlugins
     class Connection < Train::Plugins::Transport::BaseConnection
       def initialize(options)
         super(options)
+        enable_cache(:command)
       end
 
       def platform
@@ -24,7 +25,7 @@ module TrainPlugins
       end
 
       def uri
-        "pgsql://#{options[:user]}@#{@options[:host]}:#{@options[:port]}/"
+        "pgsql://#{options[:user]}@#{@options[:host]}:#{@options[:port]}/#{@options[:database]}"
       end
 
       def run_command_via_connection(query)
@@ -35,10 +36,11 @@ module TrainPlugins
         logger.debug format('[Pgsql] Sending command (%s) to %s:%d', query, @options[:host], @options[:port])
         begin
           connection.exec(query) do |result|
-            result.each_row do |values|
-              stdout += values.join(', ') + "\n"
-            end
-            stdout = stdout.strip
+            stdout = {
+              'fields' => result.fields,
+              'values' => result.values
+             }
+            # stdout = result.values
           end
         rescue PG::Error => e
           stderr = e.message

data/lib/train-pgsql/transport.rb

@@ -1,22 +1,22 @@
-require "train-pgsql/connection"
+require 'train-pgsql/connection'
 
 module TrainPlugins
   module Pgsql
     class Transport < Train.plugin(1)
-      name "pgsql"
+      name 'pgsql'
 
-      option :host,     required: true
-      option :user,     required: true
-      option :password, required: true
-      option :database, default: "postgres"      
-      option :port,     default: 5432
+      option :host,     required: true,  default: ENV['PGHOST']
+      option :user,     required: true,  default: ENV['PGUSER']
+      option :password, required: true,  default: ENV['PGPASSWORD']
+      option :database, required: false, default: ENV['PGDATABASE'] || 'postgres'
+      option :port,     required: false, default: ENV['PGPORT'] || 5432
 
       # Non documented options for development
-      option :debug_pgsql,   default: false
+      option :debug_pgsql, default: false
 
       def connection(_instance_opts = nil)
         @connection ||= TrainPlugins::Pgsql::Connection.new(@options)
       end
     end
   end
-end
+end

data/lib/train-pgsql/version.rb

@@ -1,5 +1,5 @@
 module TrainPlugins
   module Pgsql
-    VERSION = '1.0.1'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-pgsql
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Cris Barbero
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train