train-pgsql 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41f6374cac9f6ad319f2e7621de2d5495e89818f344ea523fff0d9998d183afc
-  data.tar.gz: c5293e0436f3b9bf3855d95d2fb0d9aa945c14c23c92afdf44fe045d5e84695d
+  metadata.gz: bf9046c760c47e717c33a05f1044d3142036509cc0fa883ab7ddc6b9664dc8e0
+  data.tar.gz: 901fc8f8862e6eb8ae21d9c8340927653d875d476d55db2accbdff90688a4b5e
 SHA512:
-  metadata.gz: 1e7be15922b050254346bf41c6981bc98668f28fdeee08e5407d02906557a10ce8273cc3790437f8ca588e930c009dcae5581f296e49ff77c8460891cc68f2bd
-  data.tar.gz: fba0f35259a18f66f9de918b75e3e967b237ad0fc5e496b796c435473955bfb1ccd667230c9008b396e7a3fb9c71c8634e9a4815070ef41b1be3350e9305c1d9
+  metadata.gz: b34564dc3c47a2be228d7ee67e833d490e533b683775aaac3050dbc17d490509f5935046ecef1b71bef4dcb2af1a5dd0120aa74fd897040fb554889a1135756f
+  data.tar.gz: bba454681a04de826b47e109927189a030b9718d17b2c4351b2e293ae73679e594dd746a3e3e22794f238fc757b064dba53c060d7c1d3b81157d65a42749273b

data/README.md

@@ -19,17 +19,37 @@ 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
+```
 
-## Example use
+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://
+```
 
-This will work for a Cisco IOS XE device with Telnet enabled:
+## Example use from Ruby
+
+This will work if you have postgresql running on `localhost`:
 ```ruby
 require "train"
 train  = Train.create("pgsql", {
@@ -41,7 +61,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/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.2.1'.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.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Cris Barbero
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train