train-pgsql 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a5a7f95a8bbb5fa60e7582b24b6bd7ba271dd659ff66e524c13aa6f4790b86d
-  data.tar.gz: b9350bb9dcad6c1ed426b0a58ff663d4f676e3058494a047f3ba754c0d439368
+  metadata.gz: 9b350bc75289acf2790bd703acea6fe334651aa0b57408a1efb40026f8728eab
+  data.tar.gz: 6be610b670d7839f092bf7496b62d9281c905e18933df18dc93dc584ca5e88c6
 SHA512:
-  metadata.gz: 707700dcf6d3067f7082d2973a5c1f14235a78a4b026f3c042af70c1c9e63c20822b52fe0553731a05cb618f53e58833159e5f090d0a38068b17aaac5344552d
-  data.tar.gz: 2e7a11fa24fff87cb75d7effa39646276b6ab7e589d97de2dd176b33af3d9d04c2c6ba9541c10f0fc6178bc222221ea8f6a01f8a76b6a6edf67b84d8ebaccea6
+  metadata.gz: f1a6e6455f31b4a2c254ff4e2165df2572656d26fa1021d96d9bcda302077a97b6c1df7c95ca17dfbb798a2a866f8a24228a87d66a895026f542dc2e8e9d99e1
+  data.tar.gz: 84f7f92b4d39d343e583e9ffbe4794413e149b0631ed10d396466cad439a3b3d204948a8a38c99591192018f5e53a7e07c5ac80d1e28581aa7d73d0be37049a9

data/README.md

@@ -5,11 +5,16 @@ 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
@@ -35,4 +40,46 @@ 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

@@ -33,16 +33,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/version.rb

@@ -1,5 +1,5 @@
 module TrainPlugins
   module Pgsql
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.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.0.1
 platform: ruby
 authors:
 - Cris Barbero
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train