codeclimate_circle_ci_coverage 0.0.6 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTA0MzhhYmJkZmM2NjIxMGJmYTYxZTY2MDBmMDRkNmQ4ZGZjYzI1Mw==
-  data.tar.gz: !binary |-
-    OWY5NDMwYzA0MjljNDdjNjIxOGQyY2IyN2Y1MDY3NGU0MGE0Yjg2OQ==
+SHA1:
+  metadata.gz: 77c9a114b6d1c02f0ac91c9ad154f7e64f0e0511
+  data.tar.gz: 31b1711f5cbfe8eaebc4a9203931a1e8dca3f8c6
 SHA512:
-  metadata.gz: !binary |-
-    Zjk0MTQzYjQ4ODE0ZTQ3MDZmYTI2NWQ3Mzk5MDBjN2M5ZmIwODVhNGQzZGQ0
-    MjQ3ZGU1ZjcwZTVmZGU4NTNkMWU1YzU0N2RkZTVmNGYxOTllNjM4OGFiZmQ3
-    ZmU2OWMwOGU3MjQ5YTAyZGZiN2Q2MzlkZmIzYWUzY2M5ZGIyOTY=
-  data.tar.gz: !binary |-
-    YmY3MjhjMjkxOGQ5NmQ1Mzg0MTUzYmYzZGU0MTM0ZTg1ZTM0NmE1NTgyOTBm
-    NTZiOTFhZTdkODBhZWNhY2QzMTE1NTM5NTc3YmY4Yjc0NDFhZTNkMzA4YmNj
-    OGExOTcyNDBmNWNkMTBjNDBiYzk2Zjc3YWQ5NGU3MmZhNTRiMzc=
+  metadata.gz: 6c4a73570d3ae41ce42241b2c7155226ce61fdd7dcefa61580a83ac8c3be71a7c5467029849ebfff81636e81d3719f330db27c6a01abb5cc6194cedc663eb183
+  data.tar.gz: dc1447ec095c3e0fe3519408d11cf6761a4721a3a104963293bbabf41fabe73445a4987cf779b7ab5574cd61116d23de72a8ba160d9091bd67b64a8f31cb4672

data/bin/report_coverage

@@ -14,4 +14,8 @@ OptionParser.new do |opts|
 end.parse!
 
 reporter = CoverageReporter.new(options[:branch])
-reporter.run
+if reporter.run
+  exit(0)
+else
+  abort "Error running report_coverage"
+end

data/lib/codeclimate_circle_ci_coverage/coverage_reporter.rb

@@ -27,11 +27,18 @@ class CoverageReporter
     ENV['CIRCLE_NODE_INDEX'].to_i
   end
 
+  # Returns false if unsuccessful
+  # Returns true if successful
   def run
     # Only submit coverage to codeclimate on target branch
-    return if current_branch != target_branch
+    if current_branch != target_branch
+      puts "Current branch #{current_branch} is not the target branch #{target_branch}"
+      puts "No Coverage will be reported"
+      return false
+    end
+
     # Only run on node0
-    return unless current_node.zero?
+    return false unless current_node.zero?
 
     all_coverage_dir = File.join("all_coverage")
     download_files(all_coverage_dir)
@@ -41,6 +48,7 @@ class CoverageReporter
     output_result_html(merged_result)
     upload_result_file(merged_result)
     store_code_climate_payload(merged_result)
+    true
   end
 
   # Public: Download the .resultset.json files from each of the nodes
@@ -79,14 +87,7 @@ class CoverageReporter
       resultset = JSON.load(File.read(file))
       resultset.each do |_command_name, data|
         result = SimpleCov::Result.from_hash(['command', i].join => data)
-
-        puts "Resetting result #{i} created_at from #{result.created_at} to #{Time.now}"
-        # It appears that sometimes the nodes provided by CircleCI have
-        # clocks which are not accurate/synchronized
-        # So we always set the created_at to Time.now so that the ResultMerger
-        # doesn't discard any results
-        result.created_at = Time.now
-
+        check_and_fix_result_time(result)
         SimpleCov::ResultMerger.store_result(result)
       end
     end
@@ -96,6 +97,18 @@ class CoverageReporter
     merged_result
   end
 
+  def check_and_fix_result_time(result)
+    if Time.now - result.created_at >= SimpleCov.merge_timeout
+      puts "result #{i} has a created_at from #{result.created_at} (current time #{Time.now})"
+      puts "This will prevent coverage from being combined. Please check your tests for Stub-Time-related issues"
+      put "Setting result created_at to current time to avoid this issue"
+      # If the result is timestamped old, it is ignored by SimpleCov
+      # So we always set the created_at to Time.now so that the ResultMerger
+      # doesn't discard any results
+      result.created_at = Time.now
+    end
+  end
+
   def output_result_html(merged_result)
     # Format merged result with html
     html_formatter = SimpleCov::Formatter::HTMLFormatter.new
@@ -108,8 +121,8 @@ class CoverageReporter
     codeclimate_formatter.format(merged_result)
   end
 
-  # Internal: Debug function, in use to try to determine why codeclimate
-  # is marking some lines of comments as "relevant" lines.
+  # Internal: Debug function, in use to log the exact file which is sent to codeclimate
+  # for use when troubleshooting.
   def store_code_climate_payload(merged_result)
     ENV["CODECLIMATE_TO_FILE"] = "true"
     codeclimate_formatter = CodeClimate::TestReporter::Formatter.new

data/lib/codeclimate_circle_ci_coverage.rb

@@ -1,2 +1,3 @@
+require "codeclimate_circle_ci_coverage/version"
 require "codeclimate_circle_ci_coverage/patch_simplecov"
 require "codeclimate_circle_ci_coverage/coverage_reporter"

data/spec/coverage_reporter_spec.rb

@@ -1,9 +1,24 @@
 require 'spec_helper'
 
 describe CoverageReporter do
-  describe "#initial_test" do
-    it "passes" do
-      expect(1).to eq(1)
+  let(:reporter) { described_class.new("master") }
+
+  describe "#run" do
+    it "returns false on mismatch branch names" do
+      allow(reporter).to receive(:current_branch).and_return("develop")
+      expect(reporter.run).to be_falsey
+    end
+
+    it "returns false on incorrect node number" do
+      allow(reporter).to receive(:current_branch).and_return("master")
+      allow(reporter).to receive(:current_node).and_return(1)
+      expect(reporter.run).to be_falsey
+    end
+
+    it "returns true when branch and node are correct" do
+      allow(reporter).to receive(:current_branch).and_return("master")
+      allow(reporter).to receive(:current_node).and_return(0)
+      expect(reporter.run).to be_truthy
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,98 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'codeclimate_circle_ci_coverage'
-
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
-end

metadata

@@ -1,71 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate_circle_ci_coverage
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Robin Dunlop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.38'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.38'
 description: A set of tools to support reporting SimpleCov Coverage to CodeClimate
   with Parallel tests on CircleCI
 email: robin@dunlopweb.com
@@ -90,17 +118,17 @@ 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.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: CodeClimate Code Coverage reporting script for CircleCI