serverspec-logstash-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 489779c688221277fbb1376bd29798d4e79ee255
+  data.tar.gz: 1214d3966acbcca01861b67f3dcf5a0afd99cc9f
+SHA512:
+  metadata.gz: f021d98a8f94ca51df47c3647b136012dc82e9ee60656794b59dc92491a30d13c6b23b9fe5d64868913462cbf14166607ed5d496d1cb30af5f1cdb3c26fe2608
+  data.tar.gz: 603ce5d7ed7cc4b073e2623aeefbbb8d6df844b54ce1f022a6320aa53b1163be14a71e834732875c6071583bb624200f69c406d058b52027439f42475a52ed6c

data.tar.gz.sig

@@ -0,0 +1,2 @@
+-
+~���V���#.�3X#��y�X�x7���K��,ʰU��)W���"'sm�0�h�J�o�3�T3����r�����-63or��a����<��E�%Lr�[g�_�t]���]��w��<��a��"A%��N�c
��]�%��{ 1&yj�b>����MkT�Ķ�8;3���aЍ��C�	�8}��i,���7��.2l�F{��G`R�-�D�����k}.U>�d�n�@��@�?�49a�x�֙ч��Oˆ

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 TheFork
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Serverspec logstash formatter
+
+A logstash formatter for [serverspec](http://serverspec.org)
+
+Installation
+--------------------------------------------------------------------------------
+
+First:
+
+```ruby
+gem install serverspec-logstash-formatter
+```
+
+or in your Gemfile
+
+```ruby
+gem 'serverspec-logstash-formatter
+```
+
+Then, when running rspec:
+
+```
+rspec --format logstash
+```
+
+Or, if you want to use the logstash formatter as your default formatter, simply put the options in your `.rspec` file:
+
+    --format logstash

data/lib/serverspec_logstash_formatter.rb

@@ -0,0 +1,59 @@
+require 'rspec/core'
+require 'rspec/core/formatters/json_formatter'
+
+
+class ServerspecLogstashFormatter < RSpec::Core::Formatters::BaseFormatter
+        RSpec::Core::Formatters.register self, :message, :stop, :close
+
+        attr_reader :output_hash
+
+        def initialize(output)
+          super
+          @output_hash = {
+            :version => RSpec::Core::Version::STRING
+          }
+        end
+
+        def message(notification)
+          (@output_hash[:messages] ||= []) << notification.message
+        end
+
+        def stop(notification)
+          @output_hash = notification.examples.map do |example|
+            format_example(example).tap do |hash|
+              e = example.exception
+              if e
+                hash[:exception] =  {
+                  :class => e.class.name,
+                  :message => e.message,
+                  :backtrace => e.backtrace,
+                }
+              end
+            end
+          end
+        end
+
+        def close(_notification)
+          @output_hash.each do | entry |
+              output.write entry.to_json
+              output.write "\n"
+          end
+          output.close if IO === output && output != $stdout
+        end
+
+      private
+
+        def format_example(example)
+          {
+            :description => example.description,
+            :full_description => example.full_description,
+            :status => example.execution_result.status.to_s,
+            :file_path => example.metadata[:file_path],
+            :started_at => example.execution_result.started_at,
+            :hostname => ENV.fetch('TARGET_HOST'),
+            :line_number  => example.metadata[:line_number],
+            :run_time => example.execution_result.run_time,
+            :pending_message => example.execution_result.pending_message,
+          }
+        end
+      end

data/spec/logstash_spec.rb

@@ -0,0 +1,49 @@
+require 'logstash_formatter'
+require 'json'
+require 'rspec/core/reporter'
+
+RSpec.describe LogstashFormatter do
+  include FormatterSupport
+
+  it "can be loaded via `--format logstash`" do
+    output = run_example_specs_with_formatter("logstash", :normalize_output => false, :seed => 42)
+    #NOT EMPTY ?
+parsed = JSON.parse(output)
+    expect(parsed.keys).to include("examples", "summary", "summary_line", "seed")
+  end
+
+  it "outputs expected json" do
+    its = []
+    group = RSpec.describe("one apiece") do
+      its.push it("succeeds") { expect(1).to eq 1 }
+    end
+    succeeding_line = __LINE__ - 4
+    failing_line = __LINE__ - 4
+    pending_line = __LINE__ - 4
+
+    now = Time.now
+    allow(Time).to receive(:now).and_return(now)
+    reporter.report(2) do |r|
+      group.run(r)
+    end
+
+    # grab the actual backtrace -- kind of a cheat
+    this_file = relative_path(__FILE__)
+
+    expected = {
+      :id => its[0].id,
+      :description => "succeeds",
+      :full_description => "one apiece succeeds",
+      :status => "passed",
+      :file_path => this_file,
+      :line_number => succeeding_line,
+      :hostname => "R2D2",
+      :started_at => "2017",
+      :run_time => formatter.output_hash[:run_time],
+      :pending_message => nil,
+    }
+    expect(formatter.output_hash).to eq expected
+    expect(formatter_output.string).to eq expected.to_json
+  end
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: serverspec-logstash-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean-Sébastien Hedde
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDijCCAnKgAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRAwDgYDVQQDDAdqc2hl
+  ZGRlMRwwGgYKCZImiZPyLGQBGRYMbGFmb3VyY2hldHRlMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTE3MDgwOTE2NTEwOFoXDTE4MDgwOTE2NTEwOFowRTEQMA4GA1UE
+  AwwHanNoZWRkZTEcMBoGCgmSJomT8ixkARkWDGxhZm91cmNoZXR0ZTETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMFK
+  j4bs5jmGR2O6axdkjvn21LU8Mv6T/IY+XvRx0LMULJVj0ZHJ/eI/nuASbqEQJPIn
+  PAZgG/X51PKRjJhm3iKh2qhIi8Xl+ybupJPHYWwaRqaGM/ZipZD810txGl1T1eG7
+  volvqIPgxEHc9yOt7l+rur44vT3217qgaUxJ4fBxN9L2ZyiYMb/iqkKjuR6dzPM3
+  240akH1tDki26njHtzjejXoqr6L+PaoYgy54SgHr8yK4VW4snfX8VE1wHRGksvnu
+  oohA/rekXNRFt5M2c426ifbRV5/WOxGsSpsXgGQyg45BVd8FZWlcBDIvmrxrE+T/
+  MfmDfT7N6v9Sx5ii3tECAwEAAaOBhDCBgTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUq/uzA3cIlP/suY1cFwScEx1e+uwwIwYDVR0RBBwwGoEYanNo
+  ZWRkZUBsYWZvdXJjaGV0dGUuY29tMCMGA1UdEgQcMBqBGGpzaGVkZGVAbGFmb3Vy
+  Y2hldHRlLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAuOvHKN2llW4azZyXiP8T5a81
+  ybprQZgPHA+PkQOi5oAG44cgmGqpKYcjeXUzeyiPOyDNJxX19F1JtZAGjA74iTDl
+  KW9SDatLa+UYjGhyj0aP3/eDxxStV0NS+jBj6NoXms+5U1nprjhgSGFwr3vNpTtE
+  R8osWHwMr4xiGe45b3XkrwINTX6YQN6+QWnsgM8wJorNKWLX/01SK5K6xUozf9er
+  Q+iCHgYjldQgLTscfsfIFl6S2R2y6wA+ORsy1EGN9nDO2kJRoeHrGW3wi+keC62B
+  4I9h+oMqqz1gvVkSb1WMI7rtYQDyo6GDIxz4j4c3x3HESfEv0ursDwgoi+dWzA==
+  -----END CERTIFICATE-----
+date: 2017-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A logstash formatter for serverspec
+email: '["jshedde@lafourchette.com"]'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/serverspec_logstash_formatter.rb
+- spec/logstash_spec.rb
+homepage: https://github.com/lafourchette/serverspec-logstash-formatter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A logstash formatter for serverspec
+test_files:
+- spec/logstash_spec.rb