rspec-nagios-formatter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d58a49d2635f47cc08c23104166cb3d47983fd4f
-  data.tar.gz: 3c64f85521fa092f5ae9e1db8592e5cd6db2b84a
+  metadata.gz: 8b72496752c108b2f355a8f5368425e3eb2cbc48
+  data.tar.gz: fd03b3be2958a68fe30797d394f42b9d8a45fb1c
 SHA512:
-  metadata.gz: c9f7d2a813a6fe2cceb5b7f9353fa12cac5d52e0740c21737a6ff4d305da20b2ffff17d0bf617a6047731287df3b502f16eef68215f221e6adb4f1f2e62b7f67
-  data.tar.gz: a39d2dce238ef7679b366af96c24df1ce464fb204cf92f9cbdb6f626fb91f369e62240b32c0202b4eb0857a7112e23a84f50d0cbd7c25a6da20f4094de300e2a
+  metadata.gz: 68e4276d41375c06a5bec19e0f4a821c6dd63962524a195bdd02a19424373dfc98e064ccde41284e2201cc1e06d3183f62679aad20331a8f3d7b0f9aceac290b
+  data.tar.gz: ffe8f0b808867c264b8e3d82043768129b0c0f2c8ea2e59d84d9d7e1d48c9a0c153b7b62aee4d1348a2555568418b3e94f161037755f5fcc486ac179ec5676bc

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/
+spec/fixtures/
+Gemfile.lock
+*.orig
+*.rej
+*.patch

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (C) 2013 Joshua Hoblitt <jhoblitt@cpan.org>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,57 @@
+Ruby rspec-nagios-formatter Gem
+===============================
+
+[![Build Status](https://travis-ci.org/jhoblitt/rspec-nagios-formatter.png)](https://travis-ci.org/jhoblitt/rspec-nagios-formatter)
+
+
+Description
+-----------
+
+This `gem` provides a simple [RSpec](http://rspec.info/) [custom formatter](https://www.relishapp.com/rspec/rspec-core/docs/formatters/custom-formatters) that reports `rspec` results in the Nagios/Icigna [plugin](http://docs.icinga.org/latest/en/pluginapi.html#outputspec) output format.
+
+Install
+-------
+
+### via rubygems
+
+    gem install rspec-nagios-formatter
+
+### from git repo
+
+    bundle install
+    bundle exec rake install
+
+
+Usage
+-----
+
+    rspec -f RSpec::Nagios::Formatter
+
+See the documentation on [rspec --format](https://www.relishapp.com/rspec/rspec-core/v/2-6/docs/command-line/format-option)
+for more information.
+
+
+Demo
+----
+
+Demonstration of running this gem's `rspec` tests with it's own formatter
+(after it's been installed).
+
+### Default RSpec formatter
+
+    $ bundle exec rspec
+    .......
+
+    Finished in 0.00268 seconds
+    7 examples, 0 failures
+
+### Formatted with RSpec::Nagios::Formatter
+
+    $  bundle exec rspec -f RSpec::Nagios::Formatter
+    RSPEC OK - 7 examples, 0 failures, finished in 0.00244 seconds | examples=7 passing=7 failures=0 pending=0 conformance=100% time=0.00244s
+
+
+Support
+-------
+
+Please log tickets and issues at [github](https://github.com/jhoblitt/rspec-nagios-formatter)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [
+  :spec,
+]

data/lib/rspec/nagios.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Nagios
+    require 'rspec/nagios/formatter'
+  end
+end

data/lib/rspec/nagios/formatter.rb

@@ -0,0 +1,49 @@
+require 'rspec/nagios'
+require 'rspec/core/formatters/base_formatter'
+
+class RSpec::Nagios::Formatter < RSpec::Core::Formatters::BaseFormatter
+  def initialize(output)
+    super(output)
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    super(duration, example_count, failure_count, pending_count)
+    output.puts summary_line(duration, example_count, failure_count, pending_count)
+  end
+
+  def summary_line(duration, example_count, failure_count, pending_count)
+    passing_count = example_count - failure_count
+    # conformance is expressed as a percentage
+    # if example_count is zero we need to aviod div by 0
+    if example_count > 0
+      conformance  = passing_count / example_count.to_f
+      conformance *= 100
+      #conformance   = "%.2f" % conformance
+      conformance  = conformance.round(0)
+    else
+      conformance  = 0
+    end
+    # limit duration precision to microseconds
+    time          = duration.round(6)
+
+    summary = 'RSPEC'
+    if failure_count == 0
+      summary << " OK"
+    else
+      summary << " Critical"
+    end
+    summary << " - " << pluralize(example_count, "example")
+    summary << ", " << pluralize(failure_count, "failure")
+    summary << ", #{pending_count} pending" if pending_count > 0
+    summary << ", finished in #{time} seconds"
+
+    summary << " | examples=#{example_count}"
+    summary << " passing=#{example_count - failure_count}"
+    summary << " failures=#{failure_count}"
+    summary << " pending=#{pending_count}"
+    summary << " conformance=#{conformance}%"
+    summary << " time=#{time}s"
+
+    summary
+  end
+end

data/lib/rspec/nagios/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Nagios
+    VERSION = '0.0.3'
+  end
+end

data/lib/rspec_nagios_formatter.rb

@@ -0,0 +1,3 @@
+require 'rspec/nagios/formatter'
+
+RSpecNagiosFormatter = RSpec::Nagios::Formatter 

data/rspec-nagios-formatter.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "rspec/nagios/version"
+
+Gem::Specification.new do |s|
+  s.name              = "rspec-nagios-formatter"
+  s.version           = RSpec::Nagios::VERSION
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = ["Joshua Hoblitt"]
+  s.email             = ["jhoblitt@cpan.org"]
+  s.homepage          = "https://github.com/jhoblitt/rspec-nagios-formatter"
+  s.summary           = %q{A RSpec formatter for the Nagios/Icinga plugin format}
+  s.description       = %q{A RSpec formatter for the Nagios/Icinga plugin format}
+  s.license           = "Apache 2.0"
+
+  s.required_ruby_version = ">= 1.9.2"
+  s.add_runtime_dependency("rspec-core", ">= 2.0.0")
+  s.add_development_dependency("rspec", ">= 2.0.0")
+  s.add_development_dependency("rspec-expectations", ">= 2.0.0")
+  s.add_development_dependency("rspec-mocks", ">= 2.0.0")
+  s.add_development_dependency("rake", ">= 10.0.0")
+
+  s.rubygems_version = ">= 1.6.1"
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+#  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_path     = "lib"
+end

data/spec/rspec_nagios_formatter_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe RSpec::Nagios::Formatter do
+  let(:output) { StringIO.new }
+  let(:formatter) { RSpec::Nagios::Formatter.new(output) }
+
+  describe "#summary_line" do
+    context 'status OK' do
+      it do
+        expect(formatter.summary_line(42,0,0,0)).to eq(
+          "RSPEC OK - 0 examples, 0 failures, finished in 42.0 seconds" +
+          " | examples=0 passing=0 failures=0 pending=0 conformance=0% time=42.0s"
+        )
+      end
+
+      it do
+        expect(formatter.summary_line(42,1,0,0)).to eq(
+          "RSPEC OK - 1 example, 0 failures, finished in 42.0 seconds" +
+          " | examples=1 passing=1 failures=0 pending=0 conformance=100% time=42.0s"
+        )
+      end
+
+      it do
+        expect(formatter.summary_line(42,2,0,1)).to eq(
+          "RSPEC OK - 2 examples, 0 failures, 1 pending, finished in 42.0 seconds" +
+          " | examples=2 passing=2 failures=0 pending=1 conformance=100% time=42.0s"
+        )
+      end
+    end
+
+    context 'status Critical' do
+      it do
+        expect(formatter.summary_line(42,1,1,0)).to eq(
+          "RSPEC Critical - 1 example, 1 failure, finished in 42.0 seconds" +
+          " | examples=1 passing=0 failures=1 pending=0 conformance=0% time=42.0s"
+        )
+      end
+
+      it do
+        expect(formatter.summary_line(42,2,1,1)).to eq(
+          "RSPEC Critical - 2 examples, 1 failure, 1 pending, finished in 42.0 seconds" +
+          " | examples=2 passing=1 failures=1 pending=1 conformance=50% time=42.0s"
+        )
+      end
+
+      it do
+        expect(formatter.summary_line(42,6,2,2)).to eq(
+          "RSPEC Critical - 6 examples, 2 failures, 2 pending, finished in 42.0 seconds" +
+          " | examples=6 passing=4 failures=2 pending=2 conformance=67% time=42.0s"
+        )
+      end
+    end
+  end
+end

data/spec/shim_spec.rb

@@ -0,0 +1,11 @@
+require 'rspec_nagios_formatter'
+require 'spec_helper'
+
+describe RSpecNagiosFormatter do
+  let(:output) { StringIO.new }
+  let(:formatter) { RSpecNagiosFormatter.new(output) }
+
+  it 'should be an alias of RSpec::Nagios::Formatter' do
+    formatter.should be_kind_of(RSpec::Nagios::Formatter)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec/nagios/formatter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-nagios-formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Joshua Hoblitt
@@ -86,7 +86,21 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec/nagios.rb
+- lib/rspec/nagios/formatter.rb
+- lib/rspec/nagios/version.rb
+- lib/rspec_nagios_formatter.rb
+- rspec-nagios-formatter.gemspec
+- spec/rspec_nagios_formatter_spec.rb
+- spec/shim_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jhoblitt/rspec-nagios-formatter
 licenses:
 - Apache 2.0
@@ -111,4 +125,7 @@ rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: A RSpec formatter for the Nagios/Icinga plugin format
-test_files: []
+test_files:
+- spec/rspec_nagios_formatter_spec.rb
+- spec/shim_spec.rb
+- spec/spec_helper.rb