rspec-sonarqube-formatter 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d03dc70a76120bbde342dc6f56331c72ae5248387f708e38536f9004e001bce0
-  data.tar.gz: 13d4cea8db2682c5bc4f5746d623d96e263ea1fb497be01f8cc74ecf5963d8f7
+  metadata.gz: 43dd43071c1162c5b6bb3c3395d22b03827928849d068b8ffca4164931ec39d0
+  data.tar.gz: e4d0f3225f626a658cd056557820cf3a27eac84e2b19c29cf71f9511b3afafd2
 SHA512:
-  metadata.gz: ab2aca3efd4faf359b44f2cd72de0577aaf36e107e0225cb8b0ab1ad87b61a8662a2793d15abe5729a5e5166c62e6f6e98cd77e5da01cafe139e39422e2ff970
-  data.tar.gz: 49264403b0ba4672af8e300745d16a62c57dc97304fd6f2483d481104394dde1ba7e39fe09276f44ad1cadb1123a1d73789584a0b4148b5ffaba8958e5ea12ac
+  metadata.gz: 4f9ad887a94fd832854c2141f437e344f42f964a4cc8ee30f6b01089d60405a12150f5e472bd8a255156b44c33e7979af457b73baa2ad5188afe62e564e57281
+  data.tar.gz: d6ee9483c963ee66665a39e87b7cfba4ae5b8bb6bbb787760d16d4878a6501111923969ab0b705ec49beef359aee89d5185331ec52615aebb6c0287471e8ba88

data/.codeclimate.yml

@@ -1,7 +1,5 @@
 version: "2"
 plugins:
-  git-legal:
-    enabled: true
   fixme:
     enabled: true
   bundler-audit:
@@ -10,4 +8,3 @@ plugins:
     enabled: true
   rubocop:
     enabled: true
-

data/.gitignore

@@ -35,3 +35,4 @@ rubocop.json
 *.gem
 .bundle/
 cc-test-reporter
+pkg/*

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - rake
   DisplayStyleGuide: true
   ExtraDetails: true
-  TargetRubyVersion: ~
+  TargetRubyVersion: 2.4
   Exclude:
     - 'vendor/**/*'
     - 'bin/**/*'
@@ -70,7 +70,3 @@ Layout/HashAlignment:
 # Align arguments with the same indentation level
 Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
-
-# Allow braces around hash parameters, context dependent
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent

data/.travis.yml

@@ -9,10 +9,10 @@ env:
     - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
 
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 before_install: gem install bundler
 
@@ -42,19 +42,19 @@ notifications:
 
 deploy:
   - provider: rubygems
-    skip_cleanup: true
+    cleanup: false
     api_key:
       secure: fThOZtHGWfz6JCETpxPtY5/Q/2JwuRMPdtnkUH+591p8ymLfCPW/1UlmJiETvKVVScFh5tLnCKp7bFPhi3/U3Ld1A1c/sG7A+ibpi4kWegiz4V99aAl8Rn/GxL/Bfzx/JTFKXtdgVig5m2vvhSiOHnN/8go18YUXsMKdC9s9pRQBNnv+reVUgiGj88W0NjhtPrBGNtKqk/eekGdjEvdwAYlAAgQ6ZeXgepKtbA3ZU1EwvMsl7RyjLtJ+Bk/nafFWYASbt9RDo2quGYEpSdviIPT8T4ssYT+GNbxOoJ0DVPF/xPreruue58Xa2bvClCU/kb4JUXKIrVbPT4sYJTKZl8LQ/AkjO6NAvsc+MM5wjcJMDLiSgLNa3FMsO58mLYpwS+UG8n09qHD9kSaILyWhhg3A4uXODuL5y942tvEkMt0ZmkVl1i2Ey/5RD7AfFCqz2j+/iJdbUsMBZtZ1iT5h4/W3FGDd5neXTgZJ5qVsxxbt0GyPkg9Du3hgPYpUX9T/CX4FcAKJiilhayw+NDR4wO3Q9ILL+JZwojpNUv0A4EKTDzJ6xeU0iEqyKTtYqiWvHdgCjBXk1RLmLugmAt3391Rjty5wgIiawoTGvNv26tOPk94Iic6Xo4P9vZRtu3YDjXZ4JofFRGOhUazWgVfH9JRYHsT7XOBOPuOMx8aK83w=
     gem: rspec-sonarqube-formatter
     on:
       tags: true
-      rvm: 2.6
+      rvm: 2.7
   - provider: releases
     file_glob: true
     api_key:
       secure: Qfkej2Tk4iyZS/yzL+g1TMHi+K+8TSCUtYENW3w9daR+0iejicwVHTT01wQT77zUaJ+n5i5B6lXfYIjqA7MivBHf27qJy+6cf4iFZB0kU7KGNv9bXZlXW9T5GZQ8jx1QsIefdqNqmu7Eqjuq9EhrhqrR3dfAeaBXdMX2HiIOEYzhjckJBtGrwPB96SNGTbSnVwwHa8+aHe58DrAvuh6WYBGu8NLJYKpyj8LY7iOBpm15+nx0Lkofj8p0jtUWXCFMOEoWJICY7+Rzqf9badTQJVvcIyJsr9I5GsOkrzrW07DrCsDC1EZHYep2LDjdI5LVU3i8uIfY6MBhvRzATrka7Ho1HDKxTSSLuK7vUxERlb/uf19MYbcV9SniMRwspds2/r+W6YRwM9Yrk0sfo6ZVg3qXs7Ll3jbs7nUjBq8yVIIXLVgwQ7JgmnPgsMQ05PcSc1GZG5rJ+sgbapbTLhss3ygsXPpJg7Tfu3JzJ6zAHrPc/I3HWVvYV2mz7rqhKiXVHKEDN9yULDGIBKgrNZmvyinJhPQay1a1h/jLfX5hp0wSjUeiyZKmdKYOu/6a4myrq+GHaUwtGyWcAk1DzX0d1sMptSKKmj56vjAiLZtGawVazkMdYzMZ5szOCI2wz1ps2A+3h28TL8UOSGCjZgx3dyuXBY9QHweEAJqDy7FlFN8=
     file: "*.gem"
-    skip_cleanup: true
+    cleanup: false
     on:
       tags: true
-      rvm: 2.6
+      rvm: 2.7

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    rspec-sonarqube-formatter (1.0.0)
+    rspec-sonarqube-formatter (1.0.0.pre.local)
+      htmlentities (~> 4.3.3)
       rspec (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -16,13 +17,15 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.2)
-    jaro_winkler (1.5.4)
-    json (2.2.0)
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    htmlentities (4.3.4)
+    json (2.3.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -36,37 +39,41 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    rubocop (0.77.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.0.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    simplecov-json (0.2)
+    simplecov-json (0.2.1)
       json
       simplecov
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (0.20.3)
     tins (1.22.2)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0.2)
+  bundler (~> 2.1.0)
   coveralls (~> 0.8.23)
   rake (~> 13.0.1)
   rspec-sonarqube-formatter!
-  rubocop (~> 0.77.0)
+  rubocop (~> 1.0.0)
   simplecov (~> 0.16.1)
   simplecov-json (~> 0.2.0)
 

data/README.md

@@ -1,6 +1,7 @@
 # RSpec SonarQube Formatter
 
-Rspec formatter to generates an xml file for SonarQube, using the generec-test-data format, 
+[RSpec 3](https://rspec.info/) formatter that generates an XML file for [SonarQube](https://www.sonarqube.org/) 6.2+, using 
+the [Generic Test Data](https://docs.sonarqube.org/latest/analysis/generic-test/) format.
 
 [![Gem Version](https://img.shields.io/gem/v/rspec-sonarqube-formatter)][rubygems]
 [![Downloads](https://img.shields.io/gem/dt/rspec-sonarqube-formatter)][rubygems]
@@ -19,12 +20,87 @@ Rspec formatter to generates an xml file for SonarQube, using the generec-test-d
 [sonarqube]: https://sonarcloud.io/dashboard?id=otherguy_rspec-sonarqube-formatter
 [license]: https://github.com/otherguy/rspec-sonarqube-formatter/blob/master/LICENSE.md
 
+## Features 🌈
 
-## Development
+This formatter generates an XML report that can be read by [SonarQube](https://www.sonarqube.org/) 6.2+. 
+Out of the box, SonarQube 6.2+ supports generic formats for test coverage and test execution import. Using the XML file 
+generated by this gem, you get an overview of test executions (`passed`, `skipped`, `failed`)
+and the time in milliseconds it took to execute these. 
 
+[![Sonarcloud.io](documentation/sonarcloud.png)][sonarqube]️
+
+## Installation 🚀
+
+Add the gem to your application's `Gemfile`:
+
+```ruby
+# RSpec formatters
+gem 'rspec-sonarqube-formatter', '~> 1.4', require: false
+```
+
+Then, update your bundle:
+
+    $ bundle install
+
+Or install it manually using:
+
+    $ gem install rspec-sonarqube-formatter
+
+
+## Usage 🛠
+
+Add the following code to your `spec_helper.rb`:
+
+```ruby
+RSpec.configure do |c|
+  c.formatter = 'documentation'
+  c.add_formatter('RspecSonarqubeFormatter', 'out/test-report.xml')
+  ...
+end
+```
+
+Alternatively, edit your `.rspec` file to define your formatters there:
+
+```bash
+# .rspec
+--require spec_helper
+--color
+--format RspecSonarqubeFormatter
+--out out/test-report.xml
+--format documentation
+```
+
+To make SonarQube read the test report, specify the path to the generated XML in your 
+[`sonar-project.properties`](sonar-project.properties) or configure it in the SonarQube GUI. 
+
+```bash
+# sonar-project.properties
+sonar.testExecutionReportPaths=out/test-report.xml
+```
+
+## Inspiration 💅
+
+The only [existing formatter](https://github.com/witjoh/rspec_sonar_formatter) does not work out of the box and is not
+published to [RubyGems.org](https://rubygems.org/gems/rspec-sonarqube-formatter), so I created my own.
+
+Thank you to [`@witjoh`](https://github.com/witjoh) for the original work ♥️!
+
+
+## Contributing 🚧
+
+Bug reports and pull requests are welcome on GitHub at [`otherguy/rspec-sonarqube-formatter`](https://github.com/otherguy/rspec-sonarqube-formatter).
+
+After checking out the repository, you need to install dependencies:
+
+```bash
 gem install bundler -v 2.0.2
 bundle install
+```
+
+Then, run `bundle exec rake spec` to run the test suite. 
+
+To install this gem on your local machine, run `bundle exec rake install`.
 
+Please check your contributions with RuboCop by running `bundle exec rubocop`. 
 
-Tests:
-bundle exec rake spec
+Releases are built from tags automatically on [Travis][travis] and pushed to [RubyGems.org][rubygems].

data/SECURITY.md

@@ -0,0 +1,20 @@
+# Security Policy
+
+## Supported Versions
+
+These versions are supported:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.1.0   | :white_check_mark: |
+| 1.0.0   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Please report any vulnerabilities 
+[as an issue](https://github.com/otherguy/rspec-sonarqube-formatter/issues) 
+and tag it with `security`.
+
+Expect a response within 24 hours. Any vulnerabilities will be fixed
+within a reasonable time frame.

data/lib/rspec_sonarqube_formatter.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'htmlentities'
+
 class RspecSonarqubeFormatter
-  ::RSpec::Core::Formatters.register self, :example_group_started, :example_started, :example_passed,
-    :example_pending, :example_failed, :start, :stop, :exam
+  ::RSpec::Core::Formatters.register self,
+    :start, :stop, :example_group_started, :example_started, :example_passed, :example_failed, :example_pending
 
   def initialize(output)
     @output             = output
@@ -29,25 +31,31 @@ class RspecSonarqubeFormatter
     @current_file = notification.group.metadata[:file_path]
   end
 
-  def example_started(notification)
-    @output.puts "    <testCase name=\"#{clean_string(notification.example.description)}\" duration=\"#{(notification.example.execution_result.run_time.to_f * 1000).round}\">"
+  def example_started(_notification)
+    # Do nothing
   end
 
-  def example_failed(notification)
-    @output.puts "      <failure message=\"#{notification.exception}\" stacktrace=\"#{notification.example.location}\" />"
-    @output.puts '    </testCase>'
+  def example_passed(notification)
+    @output.puts "    <testCase name=\"#{clean_string(notification.example.description)}\" duration=\"#{duration(notification.example)}\" />"
   end
 
-  def example_passed(_notification)
+  def example_failed(notification)
+    @output.puts "    <testCase name=\"#{clean_string(notification.example.description)}\" duration=\"#{duration(notification.example)}\">"
+    @output.puts "      <failure message=\"#{clean_string(notification.exception)}\" stacktrace=\"#{clean_string(notification.example.location)}\" />"
     @output.puts '    </testCase>'
   end
 
   def example_pending(notification)
+    @output.puts "    <testCase name=\"#{clean_string(notification.example.description)}\" duration=\"#{duration(notification.example)}\">"
     @output.puts "      <skipped message=\"#{clean_string(notification.example.execution_result.pending_message)}\" />"
     @output.puts '    </testCase>'
   end
 
   def clean_string(input)
-    input.to_s.gsub(/\e\[\d;*\d*m/, '').tr('"', "'")
+    HTMLEntities.new.encode input.to_s.gsub(/\e\[\d;*\d*m/, '').tr('"', "'")
+  end
+
+  def duration(example)
+    (example.execution_result.run_time.to_f * 1000).round
   end
 end

data/rspec-sonarqube-formatter.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'rspec-sonarqube-formatter'
 
   # rubocop:disable Gemspec/DuplicatedAssignment
-  spec.version       = '1.0.0-pre'
+  spec.version       = '1.0.0-local'
   spec.version       = ENV.fetch('TRAVIS_TAG') { spec.version }.to_s if ENV['TRAVIS']
   # rubocop:enable Gemspec/DuplicatedAssignment
 
@@ -31,11 +31,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'bundler', '~> 2.0.2'
-  spec.add_development_dependency 'coveralls', '~> 0.8.23'
-  spec.add_development_dependency 'rake', '~> 13.0.1'
-  spec.add_development_dependency 'rubocop', '~> 0.77.0'
-  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_dependency 'htmlentities', '~> 4.3.3'
+  spec.add_dependency 'rspec',        '~> 3.0'
+
+  spec.add_development_dependency 'bundler',        '~> 2.1.0'
+  spec.add_development_dependency 'coveralls',      '~> 0.8.23'
+  spec.add_development_dependency 'rake',           '~> 13.0.1'
+  spec.add_development_dependency 'rubocop',        '~> 1.0.0'
+  spec.add_development_dependency 'simplecov',      '~> 0.16.1'
   spec.add_development_dependency 'simplecov-json', '~> 0.2.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sonarqube-formatter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Alexander Graf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,8 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- SECURITY.md
+- documentation/sonarcloud.png
 - lib/rspec_sonarqube_formatter.rb
 - rspec-sonarqube-formatter.gemspec
 - sonar-project.properties
@@ -149,15 +165,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Generic test data formatter for SonarQube