rspec_logfmt_formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 211c7cbe090b13a9762b825d0cfeb2aecb4e43f2d44037147efd158883144565
+  data.tar.gz: 46c20ba3d51965bdd6f8ceee5bdf4a3f14d9efaf3af5efb73f154ac675a55057
+SHA512:
+  metadata.gz: 46ae8acd77714be862c4da0455cb5c553dbcc1fb05747e158f633323aa5246d46e72154ec0a346e042b735a5b1d645503a0ce5103242997116205ecf2bb86cf6
+  data.tar.gz: a95b1e04e094ae0067baeacffa3cce3a34a8097014c9066ebedbc6575999d22a957d0c7484981c73c3bb11bdc478134ea179f5386b6d357a6a430528e9fb1c67

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2022 carwow
+
+MIT License
+
+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,82 @@
+# RSpec logfmt Formatter
+
+[![CircleCI](https://circleci.com/gh/carwow/rspec_logfmt_formatter/tree/master.svg?style=svg)](https://circleci.com/gh/carwow/rspec_logfmt_formatter/tree/master)
+
+[RSpec][rspec] 3 results in the [logfmt][logfmt] format that you can push to you observability tool such as [Honeycomb][honeycomb]
+
+  [rspec]: http://rspec.info/
+  [logfmt]: https://brandur.org/logfmt
+  [honeycomb]: https://www.honeycomb.io/
+
+## Usage
+
+Install the gem:
+<details>
+<summary>WIP</summary>
+
+```sh
+gem install rspec_logfmt_formatter
+```
+
+</details>
+
+Use it:
+
+```sh
+rspec --format RspecLogfmtFormatter::Formatter --out rspec.txt
+```
+
+You'll get a file `rspec.txt` with your results in it.
+
+You can use it in combination with other [formatters][rspec-formatters], too:
+
+```sh
+rspec --format progress --format RspecLogfmtFormatter::Formatter --out rspec.txt
+```
+
+  [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
+
+### Using in your project with Bundler
+
+Add it to your Gemfile if you're using [Bundler][bundler]. Put it in the same groups as rspec.
+
+```ruby
+group :test do
+  gem "rspec"
+  gem "rspec_logfmt_formatter"
+end
+```
+
+Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
+
+```sh
+--format RspecLogfmtFormatter::Formatter
+--out rspec.txt
+```
+  [bundler]: https://bundler.io
+  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
+
+### Parallel tests
+
+For use with `parallel_tests`, add `$TEST_ENV_NUMBER` in the output file option (in `.rspec` or `.rspec_parallel`) to avoid concurrent process write conflicts.
+
+```sh
+--format RspecLogfmtFormatter::Formatter
+--out tmp/rspec<%= ENV["TEST_ENV_NUMBER"] %>.txt
+```
+
+### How to push to Honeycomb
+
+TODO
+
+## Development
+
+TODO
+
+## Releasing
+
+TODO
+
+## License
+
+The MIT License, see [LICENSE](./LICENSE).

data/lib/rspec_logfmt_formatter/formatter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'rspec/core/formatters/base_formatter'
+
+module RspecLogfmtFormatter
+  class Formatter < RSpec::Core::Formatters::BaseFormatter
+    RSpec::Core::Formatters.register self,
+      :start,
+      :stop,
+      :dump_summary
+
+    def start(notification)
+      @start_notification = notification
+      @started = Time.now
+      @retries = []
+      super
+    end
+
+    def stop(notification)
+      @examples_notification = notification
+    end
+
+    def dump_summary(notification)
+      @summary_notification = notification
+      fmt_dump
+    end
+
+    def retry(example)
+      @retries << example
+    end
+
+    private
+
+    attr_reader :started, :retries
+
+    def example_count
+      @summary_notification.example_count
+    end
+
+    def pending_count
+      @summary_notification.pending_count
+    end
+
+    def failure_count
+      @summary_notification.failure_count
+    end
+
+    def duration
+      @summary_notification.duration
+    end
+
+    def error_count
+      if @summary_notification.respond_to?(:errors_outside_of_examples_count)
+        @summary_notification.errors_outside_of_examples_count
+      else
+        0
+      end
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def fmt_dump
+      output << %( tests.name="rspec#{ENV['TEST_ENV_NUMBER']}")
+      output << %( tests.count="#{example_count}")
+      output << %( tests.skipped="#{pending_count}")
+      output << %( tests.failures="#{failure_count}")
+      output << %( tests.errors="#{error_count}")
+      output << %( tests.retries.count="#{retries.size}")
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/rspec_logfmt_formatter/version.rb

@@ -0,0 +1,3 @@
+module RspecLogfmtFormatter
+  VERSION = '0.0.1'.freeze
+end

data/lib/rspec_logfmt_formatter.rb

@@ -0,0 +1,2 @@
+require 'rspec_logfmt_formatter/formatter'
+require 'rspec_logfmt_formatter/version'

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: rspec_logfmt_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Richard Vickerstaff
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: carwow_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: ''
+email:
+- developers@carwow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rspec_logfmt_formatter.rb
+- lib/rspec_logfmt_formatter/formatter.rb
+- lib/rspec_logfmt_formatter/version.rb
+homepage: https://github.com/carwow/rspec_logfmt_formatter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: RSpec formatter that honeycomb can read
+test_files: []