train-pgsql 1.0.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a5a7f95a8bbb5fa60e7582b24b6bd7ba271dd659ff66e524c13aa6f4790b86d
-  data.tar.gz: b9350bb9dcad6c1ed426b0a58ff663d4f676e3058494a047f3ba754c0d439368
+  metadata.gz: bf9046c760c47e717c33a05f1044d3142036509cc0fa883ab7ddc6b9664dc8e0
+  data.tar.gz: 901fc8f8862e6eb8ae21d9c8340927653d875d476d55db2accbdff90688a4b5e
 SHA512:
-  metadata.gz: 707700dcf6d3067f7082d2973a5c1f14235a78a4b026f3c042af70c1c9e63c20822b52fe0553731a05cb618f53e58833159e5f090d0a38068b17aaac5344552d
-  data.tar.gz: 2e7a11fa24fff87cb75d7effa39646276b6ab7e589d97de2dd176b33af3d9d04c2c6ba9541c10f0fc6178bc222221ea8f6a01f8a76b6a6edf67b84d8ebaccea6
+  metadata.gz: b34564dc3c47a2be228d7ee67e833d490e533b683775aaac3050dbc17d490509f5935046ecef1b71bef4dcb2af1a5dd0120aa74fd897040fb554889a1135756f
+  data.tar.gz: bba454681a04de826b47e109927189a030b9718d17b2c4351b2e293ae73679e594dd746a3e3e22794f238fc757b064dba53c060d7c1d3b81157d65a42749273b

data/README.md

@@ -5,26 +5,51 @@ This plugin allows applications that rely on Train to communicate via postgres S
 
 ## Installation
 
-You will have to build this gem yourself to install it as it is not yet on
-Rubygems.Org. For this there is a rake task which makes this a one-liner:
+This is published to rubygems.org at https://rubygems.org/gems/train-pgsql.
 
-```bash
-rake install:local
+You can install the gem directly:
+```sh
+gem install train-pgsql
+```
+
+Or you can install it as an `inspec` plugin:
+```sh
+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`     |
+
+
+## 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
+```
+
+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
+## Example use from Ruby
 
-This will work for a Cisco IOS XE device with Telnet enabled:
+This will work if you have postgresql running on `localhost`:
 ```ruby
 require "train"
 train  = Train.create("pgsql", {
@@ -35,4 +60,45 @@ train  = Train.create("pgsql", {
 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.
+
+### Requirements
+- Postgres running locally
+- docker
+
+### Steps
+1) Build the `train-pgsql` gem
+   ```
+   rake build
+   ```
+2) Build the docker image.
+   Be sure to set the appropriate GEM_VERSION arg based upon the value of the [version.rb](./lib/train-pgsql/version.rb)
+   ```
+   docker build --build-arg GEM_VERSION=1.0.0 . -t train-pgsql-test 
+   ```
+3) Run the test.rb file
+   ```
+   docker run -it --rm -v $(pwd)/test:/share -e PG_HOST="host.docker.internal" --entrypoint ruby train-pgsql-test test.rb
+   ```
+   _Note: This test assumes you are running postgres locally on a mac. If you are running postgres in some other location, update the `PG_HOST` environment variable appropriately. You may have to set the username/password in the `pgsql` train instantiation._
+
+   You should see output resembling the following:
+   ```
+   #<struct Train::Extras::CommandResult stdout="1", stderr="", exit_status=0>
+   ```
+
+## Deploy
+To publish a new version to RubyGems:
+1) Ensure the [version.rb](./lib/train-pgsql/version.rb) has been bumped with the appropriate semver update.
+2) Run rake release
+   ```
+   rake release
+   ```
+   _Note: you may have to authenticate with rubygems to publish. The `deploy@stridehealth.com` group has a rubygems [account](https://rubygems.org/profiles/stridehealth) that is an owner of this gem._
+
+# Acknowledgements
+* [train-telnet](https://github.com/tecracer-chef/train-telnet)
+* [train](https://github.com/inspec/train)

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)
@@ -33,16 +34,17 @@ module TrainPlugins
         exit_status = 0
 
         logger.debug format('[Pgsql] Sending command (%s) to %s:%d', query, @options[:host], @options[:port])
-        connection.exec(query) do |result|
-          result.each_row do |values|
-            stdout += values.join(', ') + "\n"
+        begin
+          connection.exec(query) do |result|
+            result.each_row do |values|
+              stdout += values.join(', ') + "\n"
+            end
+            stdout = stdout.strip
           end
-          stdout = stdout.strip
+        rescue PG::Error => e
+          stderr = e.message
         end
-
         CommandResult.new(stdout, stderr, exit_status)
-      rescue PG::Error => e
-        raise Train::TransportError, "Pgsql exec failed (#{e.message})"
       end
 
       def connection

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.0'.freeze
+    VERSION = '1.2.2'.freeze
   end
 end

metadata

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