codeclimate-test-reporter 0.6.0 → 1.0.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cd8a8c9a256eaa43954362eb4464ec24052339f
-  data.tar.gz: 27dfdf9c5b98659eb38a466bdae29ff3e735f27d
+  metadata.gz: 08921de545ca6789aaad9546a08c077a4ae10f05
+  data.tar.gz: c23c5e94c1d64063616484ba416276aa03f5dd24
 SHA512:
-  metadata.gz: bbd7b0ca4af91a6a2e07fb1674987565ee0201a3f57fced7191b68950728dfd1e3502f2aa6cf3cc5e6c0d603668533fedcb75d1abb5f1e1ba9cc3bfc56b455ef
-  data.tar.gz: 328c8b4f3575f1a513e0858c5b03090216ad8776ab342220bebed58c95e2f0fa13a8fd72a75d2f8e2d21e1d1fa99870b7cb52d1b4dfb83dc0a360486951e2c9c
+  metadata.gz: 46ba88ff210d1e46cbf827e346bedb1e265a8f74dc57195884361c02ad63afb79f24ad744d0ad59a68c5825d4c4a776a405d83c4d1b082c968209190fc36b94a
+  data.tar.gz: 8d78f59904fce2fc618ea4cbe911ef13c091d6f4283e44f7630021d6b5fcdb92bfc7f649ae2defb97c003e2c5122f81275b8808b97df919eaed5700ea1f48f8d

data/README.md

@@ -2,23 +2,10 @@
 
 [![Code Climate](https://codeclimate.com/github/codeclimate/ruby-test-reporter/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/ruby-test-reporter)
 
-Collects test coverage data from your Ruby test suite and sends it to Code
-Climate's hosted, automated code review service. Based on SimpleCov.
+Posts SimpleCov test coverage data from your Ruby test suite to Code Climate's hosted, automated code review service.
 
 Code Climate - [https://codeclimate.com](https://codeclimate.com)
 
-# Important FYIs
-
-Across the many different testing frameworks, setups, and environments, there are lots of variables at play. Before setting up test coverage, it's important to understand what we do and do not currently support:
-
-* **Default branch only:** We only support test coverage for your [default branch](http://docs.codeclimate.com/article/151-glossary-default-branch). Be sure to check out this branch before running your tests.
-* **Single payload:** We currently only support a single test coverage payload per commit. If you run your tests in multiple steps, or via parallel tests, Code Climate will only process the first payload that we receive. If you are using a CI, be sure to check if you are running your tests in a parallel mode.
-
-  **Note:** There is one exception to this rule. We've specifically built an integration with [Solano Labs](https://www.solanolabs.com/) to support parallel tests.
-
-  **Note:** If you've configured Code Climate to analyze multiple languages in the same repository (e.g., Ruby and JavaScript), we can nonetheless only process test coverage information for one of these languages. We'll process the first payload that we receive.
-* **Invalid File Paths:** By default, our test reporters expect your application to exist at the root of your repository. If this is not the case, the file paths in your test coverage payload will not match the file paths that Code Climate expects. For our Ruby test reporter, [we have a work-around to this issue](http://docs.codeclimate.com/article/220-help-im-having-trouble-with-test-coverage#ruby_sub_folder).
-
 ## Installation
 
 This gem requires a user, but not necessarily a paid account, on Code Climate, so if you don't have one the
@@ -28,116 +15,17 @@ first step is to signup at: [https://codeclimate.com](https://codeclimate.com).
 
         gem "codeclimate-test-reporter", group: :test
 
-1. Start the test reporter **on the very first line** of your `test_helper.rb` or
-  `spec_helper.rb` file:
+1. Start SimpleCov as you normally would (more information here: https://github.com/colszowka/simplecov)
 
-        require "codeclimate-test-reporter"
-        CodeClimate::TestReporter.start
+1. Set the `CODECLIMATE_REPO_TOKEN` environment variable (provided after you add your repo to your Code Climate account by clicking on "Setup Test Coverage" on the right hand side of your feed)
 
-Then set the `CODECLIMATE_REPO_TOKEN` environment variable when you run your build
-on your CI server, and the results will show up in your Code Climate account.
-
-The `CODECLIMATE_REPO_TOKEN` value is provided after you add your repo to your
-Code Climate account by clicking on "Setup Test Coverage" on the right hand side of your feed.
+1. Run the `codeclimate-test-reporter` executable at the end of your test suite
 
 Please contact hello@codeclimate.com if you need any assistance setting this up.
 
-## Configuration
-
-Certain behaviors of the test reporter can be configured. See the `Configuration`
-class for more details. For example, you can change the logging level to not
-print info messages:
-
-*Note that the configuration block must come before TestReporter.start.*
-
-```ruby
-CodeClimate::TestReporter.configure do |config|
-  config.logger.level = Logger::WARN
-end
-
-CodeClimate::TestReporter.start
-```
-
-Another example for when your Rails application root is not at the root of the git repository root
-
-```ruby
-CodeClimate::TestReporter.configure do |config|
-  config.path_prefix = "app_root" #the root of your Rails application relative to the repository root
-  config.git_dir = "../" #the relative or absolute location of your git root compared to where your tests are run
-end
-
-CodeClimate::TestReporter.start
-```
-
-## Troubleshooting
-
-If you're having trouble setting up or working with our test coverage feature, [see our detailed help doc](http://docs.codeclimate.com/article/220-help-im-having-trouble-with-test-coverage), which covers the most common issues encountered.
-
-## Extending Simplecov with other formatters
-
-Since ruby-test-reporter 0.4.0 you can use `CodeClimate::TestReporter::Formatter` as a Simplecov formatter directly. Just add the formatter to your Simplecov formatter in addition to the rest of your configuration:
-
-```ruby
-require 'codeclimate-test-reporter'
-SimpleCov.start do
-  formatter SimpleCov::Formatter::MultiFormatter.new([
-    SimpleCov::Formatter::HTMLFormatter,
-    CodeClimate::TestReporter::Formatter
-  ])
-  ...
-end
-```
-
-## Using with [parallel_tests](https://github.com/grosser/parallel_tests)
-
-Note: This may work with other parallel test runners as long as they run on the same machine.
-
-Be sure you're using `simplecov` `>= 0.9.0`.
-
-Add the following to your `test_helper.rb`/`spec_helper.rb` instead of what is normally required.
-
-```ruby
-require 'simplecov'
-require 'codeclimate-test-reporter'
-SimpleCov.add_filter 'vendor'
-SimpleCov.formatters = []
-SimpleCov.start CodeClimate::TestReporter.configuration.profile
-```
-
-Then after all your tests run, in a rake task or as a build step do:
-
-```
-require 'simplecov'
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter::Formatter.new.format(SimpleCov.result)
-```
-
-## Using with multiple machines
-
-For the time-being, we don't officially support coverage data from parallel test runs. That said, [codeclimate batch](https://github.com/grosser/codeclimate_batch) is a handy work-around that was created by one of our customers.
-
-Note that this solution requires standing up a separate server (like a Heroku instance) that sits between your testing environment and Code Climate. Though this option is not formally supported, if you have an immediate need for parallel testing support, [codeclimate batch](https://github.com/grosser/codeclimate_batch) is a helpful interim solution until we can release our official support for this.
-
-## Help! Your gem is raising a ...
-
-### VCR::Errors::UnhandledHTTPRequestError
-
-Add the following to your spec or test helper:
-
-        VCR.configure do |config|
-          # your existing configuration
-          config.ignore_hosts 'codeclimate.com'
-        end
-
-### WebMock::NetConnectNotAllowedError
-
-Add the following to your spec or test helper:
-
-        WebMock.disable_net_connect!(:allow => "codeclimate.com")
-
-### Other communication failures
+## Troubleshooting / FYIs
 
-If you are using a web stubbing library similar to VCR or WebMock which prevent external requests during test runs, you will need configure these libraries to allow Code Climate to make external requests.
+Across the many different testing frameworks, setups, and environments, there are lots of variables at play. If you're having any trouble with your test coverage reporting or the results are confusing, please see our full documentation here: https://docs.codeclimate.com/docs/setting-up-test-coverage
 
 ## Contributions
 

data/bin/cc-tddium-post-worker

@@ -7,7 +7,7 @@ if ENV["CODECLIMATE_REPO_TOKEN"]
   tmpdir = Dir.tmpdir
   puts "Searching #{tmpdir} for files to POST."
   coverage_report_files = Dir.glob("#{tmpdir}/codeclimate-test-coverage-*")
-  if coverage_report_files.size > 0
+  if coverage_report_files.any?
     puts "Found: "
     puts coverage_report_files.join("\n")
     client = CodeClimate::TestReporter::Client.new

data/bin/codeclimate-test-reporter

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require "codeclimate-test-reporter"
+
+COVERAGE_FILE = "coverage/.resultset.json".freeze
+
+if ENV["CODECLIMATE_REPO_TOKEN"]
+  if File.exist?(COVERAGE_FILE)
+    begin
+      results = JSON.parse(File.read(COVERAGE_FILE))
+    rescue JSON::ParserError => e
+      $stderr.puts "Error encountered while parsing #{COVERAGE_FILE}: #{e}"
+      exit(1)
+    end
+
+    CodeClimate::TestReporter.run(results)
+  else
+    $stderr.puts "Coverage results not found"
+    exit(1)
+  end
+else
+  $stderr.puts "Cannot post results: environment variable CODECLIMATE_REPO_TOKEN must be set."
+  exit(0)
+end

data/lib/code_climate/test_reporter.rb

@@ -1,14 +1,23 @@
 module CodeClimate
   module TestReporter
+    WARNING_MESSAGE = <<-EOS.freeze
+      This usage of the Code Climate Test Reporter is now deprecated. Since version
+      1.0, we now require you to run `SimpleCov` in your test/spec helper, and then
+      run the provided `codeclimate-ruby` binary separately to report your results
+      to Code Climate.
+
+      More information here: https://github.com/codeclimate/ruby-test-reporter/blob/master/README.md
+    EOS
+
     def self.start
-      if run?
-        require "simplecov"
-        ::SimpleCov.add_filter "vendor"
-        ::SimpleCov.formatter = Formatter
-        ::SimpleCov.start(configuration.profile) do
-          skip_token CodeClimate::TestReporter.configuration.skip_token
-        end
-      end
+      logger.warn(WARNING_MESSAGE)
+      exit(1)
+    end
+
+    def self.run(results)
+      return unless CodeClimate::TestReporter.run?
+      formatted_results = CodeClimate::TestReporter::Formatter.new.format(results)
+      CodeClimate::TestReporter::PostResults.new(formatted_results).post
     end
 
     def self.run?
@@ -50,5 +59,13 @@ module CodeClimate
     def self.logger
       CodeClimate::TestReporter.configuration.logger
     end
+
+    def self.tddium?
+      ci_service_data && ci_service_data[:name] == "tddium"
+    end
+
+    def self.ci_service_data
+      Ci.service_data
+    end
   end
 end

data/lib/code_climate/test_reporter/calculate_blob.rb

@@ -1,7 +1,6 @@
 module CodeClimate
   module TestReporter
     class CalculateBlob
-
       def initialize(file_path)
         @file_path = file_path
       end
@@ -10,7 +9,7 @@ module CodeClimate
         calculate_with_file or calculate_with_git
       end
 
-    private
+      private
 
       def calculate_with_file
         File.open(@file_path, "rb") do |file|
@@ -31,7 +30,6 @@ module CodeClimate
 
         output
       end
-
     end
   end
 end

data/lib/code_climate/test_reporter/client.rb

@@ -5,9 +5,8 @@ require "net/https"
 module CodeClimate
   module TestReporter
     class Client
-
       DEFAULT_TIMEOUT = 5 # in seconds
-      USER_AGENT = "Code Climate (Ruby Test Reporter v#{VERSION})"
+      USER_AGENT = "Code Climate (Ruby Test Reporter v#{CodeClimate::TestReporter::VERSION})".freeze
 
       def host
         ENV["CODECLIMATE_API_HOST"] ||
@@ -72,7 +71,7 @@ module CodeClimate
         end
       end
 
-    private
+      private
 
       def http_client(uri)
         Net::HTTP.new(uri.host, uri.port).tap do |http|

data/lib/code_climate/test_reporter/exception_message.rb

@@ -6,9 +6,9 @@ module CodeClimate
       end
 
       def instructions
-      <<-STR
+        <<-STR
   WebMock.disable_net_connect!(:allow => "codeclimate.com")
-STR
+        STR
       end
     end
 
@@ -18,21 +18,20 @@ STR
       end
 
       def instructions
-      <<-STR
+        <<-STR
   VCR.configure do |config|
     # your existing configuration
     config.ignore_hosts 'codeclimate.com'
   end
-STR
+        STR
       end
     end
 
     class ExceptionMessage
-
       HTTP_STUBBING_MESSAGES = {
-        "VCR::Errors::UnhandledHTTPRequestError" => VCRMessage,
-        "WebMock::NetConnectNotAllowedError"     => WebMockMessage
-      }
+        "VCR::Errors::UnhandledHTTPRequestError".freeze => VCRMessage,
+        "WebMock::NetConnectNotAllowedError".freeze => WebMockMessage,
+      }.freeze
 
       def initialize(exception)
         @exception = exception
@@ -59,7 +58,7 @@ Add the following to your spec or test helper to ensure codeclimate-test-reporte
         parts.join("\n")
       end
 
-    private
+      private
 
       def exception_class
         @exception.class.to_s

data/lib/code_climate/test_reporter/formatter.rb

@@ -12,41 +12,27 @@ require "code_climate/test_reporter/payload_validator"
 module CodeClimate
   module TestReporter
     class Formatter
-      def format(result)
-        return true unless CodeClimate::TestReporter.run?
+      class InvalidSimpleCovResultError < StandardError; end
 
-        print "Coverage = #{result.source_files.covered_percent.round(2)}%. "
-
-        payload = to_payload(result)
-        PayloadValidator.validate(payload)
-        if write_to_file?
-          file_path = File.join(Dir.tmpdir, "codeclimate-test-coverage-#{SecureRandom.uuid}.json")
-          print "Coverage results saved to #{file_path}... "
-          File.open(file_path, "w") { |file| file.write(payload.to_json) }
-        else
-          client = Client.new
-          print "Sending report to #{client.host} for branch #{Git.branch_from_git_or_ci}... "
-          client.post_results(payload)
+      def format(results)
+        begin
+          validated_results = results.values.fetch(0).fetch("coverage")
+        rescue NoMethodError, KeyError => ex
+          raise InvalidSimpleCovResultError, ex.message
         end
 
-        puts "done."
-        true
-      rescue => ex
-        puts ExceptionMessage.new(ex).message
-        false
-      end
+        simplecov_results = SimpleCov::Result.new(validated_results)
 
-      # actually private ...
-      def short_filename(filename)
-        return filename unless ::SimpleCov.root
-        filename = filename.gsub(/^#{::SimpleCov.root}/, ".").gsub(/^\.\//, "")
-        apply_prefix filename
+        payload = to_payload(simplecov_results)
+        PayloadValidator.validate(payload)
+
+        payload
       end
 
-    private
+      private
 
       def partial?
-        tddium?
+        CodeClimate::TestReporter.tddium?
       end
 
       def to_payload(result)
@@ -62,7 +48,7 @@ module CodeClimate
           end
 
           {
-            name:             short_filename(file.filename),
+            name:             ShortenFilename.new(file.filename).short_filename,
             blob_id:          CalculateBlob.new(file.filename).blob_id,
             coverage:         file.coverage.to_json,
             covered_percent:  round(file.covered_percent, 2),
@@ -70,8 +56,8 @@ module CodeClimate
             line_counts: {
               total:    file.lines.count,
               covered:  file.covered_lines.count,
-              missed:   file.missed_lines.count
-            }
+              missed:   file.missed_lines.count,
+            },
           }
         end
 
@@ -89,36 +75,17 @@ module CodeClimate
             pwd:            Dir.pwd,
             rails_root:     (Rails.root.to_s rescue nil),
             simplecov_root: ::SimpleCov.root,
-            gem_version:    VERSION
+            gem_version:    VERSION,
           },
-          ci_service: ci_service_data
+          ci_service: CodeClimate::TestReporter.ci_service_data,
         }
       end
 
-      def tddium?
-        ci_service_data && ci_service_data[:name] == "tddium"
-      end
-
       # Convert to Float before rounding.
       # Fixes [#7] possible segmentation fault when calling #round on a Rational
       def round(numeric, precision)
         Float(numeric).round(precision)
       end
-
-      def write_to_file?
-        warn "TO_FILE is deprecated, use CODECLIMATE_TO_FILE" if ENV["TO_FILE"]
-        tddium? || ENV["CODECLIMATE_TO_FILE"] || ENV["TO_FILE"]
-      end
-
-      def apply_prefix filename
-        prefix = CodeClimate::TestReporter.configuration.path_prefix
-        return filename if prefix.nil?
-        "#{prefix}/#{filename}"
-      end
-
-      def ci_service_data
-        @ci_service_data ||= Ci.service_data
-      end
     end
   end
 end

data/lib/code_climate/test_reporter/git.rb

@@ -1,7 +1,6 @@
 module CodeClimate
   module TestReporter
     class Git
-
       class << self
         def info
           {
@@ -17,16 +16,16 @@ module CodeClimate
 
         def clean_service_branch
           ci_branch = String(Ci.service_data[:branch])
-          clean = ci_branch.strip.sub(/^origin\//, "")
+          clean = ci_branch.strip.sub(%r{^origin/}, "")
 
-          clean.size > 0 ? clean : nil
+          !clean.empty? ? clean : nil
         end
 
         def clean_git_branch
           git_branch = String(branch_from_git)
-          clean = git_branch.sub(/^origin\//, "") unless git_branch.start_with?("(")
+          clean = git_branch.sub(%r{^origin/}, "") unless git_branch.start_with?("(")
 
-          clean.size > 0 ? clean : nil
+          !clean.empty? ? clean : nil
         end
 
         private
@@ -65,4 +64,3 @@ module CodeClimate
     end
   end
 end
-

data/lib/code_climate/test_reporter/payload_validator.rb

@@ -20,7 +20,7 @@ module CodeClimate
         true
       end
 
-    private
+      private
 
       def commit_sha
         commit_sha_from_git || commit_sha_from_ci_service

data/lib/code_climate/test_reporter/post_results.rb

@@ -0,0 +1,30 @@
+module CodeClimate
+  module TestReporter
+    class PostResults
+      def initialize(results)
+        @results = results
+      end
+
+      def post
+        if write_to_file?
+          file_path = File.join(Dir.tmpdir, "codeclimate-test-coverage-#{SecureRandom.uuid}.json")
+          print "Coverage results saved to #{file_path}... "
+          File.open(file_path, "w") { |file| file.write(@results.to_json) }
+        else
+          client = Client.new
+          print "Sending report to #{client.host} for branch #{Git.branch_from_git_or_ci}... "
+          client.post_results(@results)
+        end
+
+        puts "done."
+      end
+
+      private
+
+      def write_to_file?
+        warn "TO_FILE is deprecated, use CODECLIMATE_TO_FILE" if ENV["TO_FILE"]
+        CodeClimate::TestReporter.tddium? || ENV["CODECLIMATE_TO_FILE"] || ENV["TO_FILE"]
+      end
+    end
+  end
+end

data/lib/code_climate/test_reporter/shorten_filename.rb

@@ -0,0 +1,24 @@
+module CodeClimate
+  module TestReporter
+    class ShortenFilename
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def short_filename
+        return @filename unless ::SimpleCov.root
+        apply_prefix @filename.gsub(/^#{::SimpleCov.root}/, ".").gsub(%r{^\./}, "")
+      end
+
+      private
+
+      def apply_prefix(filename)
+        if (prefix = CodeClimate::TestReporter.configuration.path_prefix)
+          File.join(prefix, filename)
+        else
+          filename
+        end
+      end
+    end
+  end
+end

data/lib/code_climate/test_reporter/version.rb

@@ -1,5 +1,5 @@
 module CodeClimate
   module TestReporter
-    VERSION = "0.6.0".freeze
+    VERSION = "1.0.0-rc1".freeze
   end
 end

data/lib/codeclimate-test-reporter.rb

@@ -2,6 +2,8 @@ require "code_climate/test_reporter"
 require "code_climate/test_reporter/calculate_blob"
 require "code_climate/test_reporter/version"
 require "code_climate/test_reporter/client"
+require "code_climate/test_reporter/post_results"
+require "code_climate/test_reporter/shorten_filename"
 require "code_climate/test_reporter/formatter"
 require "code_climate/test_reporter/configuration"
 require "code_climate/test_reporter/git"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-test-reporter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0.pre.rc1
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,12 +100,14 @@ email:
 - bryan@brynary.com
 executables:
 - cc-tddium-post-worker
+- codeclimate-test-reporter
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
 - bin/cc-tddium-post-worker
+- bin/codeclimate-test-reporter
 - config/cacert.pem
 - lib/code_climate/test_reporter.rb
 - lib/code_climate/test_reporter/calculate_blob.rb
@@ -122,6 +118,8 @@ files:
 - lib/code_climate/test_reporter/formatter.rb
 - lib/code_climate/test_reporter/git.rb
 - lib/code_climate/test_reporter/payload_validator.rb
+- lib/code_climate/test_reporter/post_results.rb
+- lib/code_climate/test_reporter/shorten_filename.rb
 - lib/code_climate/test_reporter/version.rb
 - lib/codeclimate-test-reporter.rb
 homepage: https://github.com/codeclimate/ruby-test-reporter
@@ -139,9 +137,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -149,3 +147,4 @@ signing_key:
 specification_version: 4
 summary: Uploads Ruby test coverage data to Code Climate.
 test_files: []
+has_rdoc: