circleci-coverage_reporter 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27d4c9b0082fd4b0d64fe44a189c3de5264df6d9
-  data.tar.gz: 9913f567b1631f239340409dd5dafc6b120c6892
+  metadata.gz: 7043f473068bec23109876b4e38bf8aca96410f0
+  data.tar.gz: bfeb330edb4de8f150cb1fd4bd0183d33fee6720
 SHA512:
-  metadata.gz: 8eb86412bcf79cdb7582697158b9866492ab895cfd11ceb09380eb323583273b16cc4114160e6e28043bc54d4537478532bb7f383e1b94e7e8cb4633854873f6
-  data.tar.gz: 0123ffcd0dbaa933b133e9d5c38acd0abdf55be4bb5512184184d56f858a33583b33ca9a8af5f759e18c67477faba227984a8d9c6165dbd98c6c0e42ae8c16b8
+  metadata.gz: 32ade229dc33219e38c324737c98d8600b70c2bb4a792a486274cd16ccd1e7e0ce1b0ffc886a3251aa4b4a6ac440bed6dcdbad5b8e9d65dd3478e6413550a0f0
+  data.tar.gz: ca44ef9e3ca8faebec5b3510a48bb9142ebac517b66727373445d71e2f96c0d57fac9c4e112827827408e3ffd4d05ec0ba678734b6fbd1fda8546d2332ff04c3

data/.rubocop.yml

@@ -4,6 +4,9 @@ AllCops:
 Metrics/LineLength:
   Max: 125
 
+Style/AndOr:
+  EnforcedStyle: conditionals
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+
+## [0.1.3] - 2017-03-12
+### Fixed
+- Raise `RequestError` if some API reqeust fails
+- Show `NaN` if .last_run.json does not exist
+
 ## [0.1.2] - 2017-03-12
 ### Fixed
 
@@ -19,5 +26,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release
 
+[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.0...v0.1.1

data/README.md

@@ -4,6 +4,10 @@
 
 **CircleCI::CoverageReporter** reports test coverage to your GitHub repository.
 
+## Example
+
+![image](https://cloud.githubusercontent.com/assets/96157/23824715/e16f0eac-06be-11e7-81e8-f818b14a52b4.png)
+
 ## Getting started
 
 1.  Add CircleCI::CoverageReporter to your `Gemfile` and `bundle install`:
@@ -18,14 +22,14 @@
     require 'circleci/coverage_reporter/rake_task' if ENV['CIRCLECI']
     ```
 
-3.  Issue CircleCI and GitHub token and add them to build environment variables with the following nameing convention:
+3.  Issue CircleCI and GitHub tokens and add them to build environment variables as follows:
 
     Name                               | Value
     -----------------------------------|----------------------------------------------------------------
     `COVERAGE_REPORTER_CIRCLECI_TOKEN` | CircleCI API token with "view-builds" scope
     `COVERAGE_REPORTER_VCS_TOKEN`      | GitHub personal access token with "repo" or "public_repo" scope
 
-4.  Add the following steop to your `circle.yml`:
+4.  Add the following step to your `circle.yml`:
 
     ```yaml
     test:
@@ -33,23 +37,41 @@
       - bundle exec circleci:report_coverage
     ```
 
-## Example
+## Run manually
 
-![image](https://cloud.githubusercontent.com/assets/96157/23824715/e16f0eac-06be-11e7-81e8-f818b14a52b4.png)
-
-## Configuring CircleCI::CoverageReporter
+You must configure `circleci_token` and `vcr_token` before `CircleCI::CoverageReporter.run`:
 
 ```ruby
 CircleCI::CoverageReporter.configure do |config|
   config.circleci_token = YOUR_CIRCLECI_API_TOKEN
   config.vcr_token = YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
 end
+
+CircleCI::CoverageReporter.run
 ```
 
-then:
+## Reporters
+### SimpleCov
+
+`CircleCI::CoverageReporter::SimpleCov::Reporter` handles coverage files generated by
+[SimpleCov](https://github.com/colszowka/simplecov). It is used by default.
+
+It expects that coverage files are located in `$CIRCLE_ARTIFACTS/coverage` directory:
 
 ```ruby
-CircleCI::CoverageReporter.run
+# spec/spec_helper.rb
+require 'simplecov'
+# Save to CircleCI's artifacts directory if we're on CircleCI
+SimpleCov.coverage_dir(File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')) if ENV['CIRCLECI']
+SimpleCov.start
+```
+
+If you put files in directory, say `$CIRCLE_ARTIFACTS/foo/bar`, you have to set reporter as follows:
+
+```ruby
+CircleCI::CoverageReporter.configure do |config|
+  config.reporters = [CircleCI::CoverageReporter::SimpleCov::Reporter.new('foo/bar')]
+end
 ```
 
 ## License

data/lib/circleci/coverage_reporter/client.rb

@@ -2,6 +2,7 @@ require 'faraday'
 
 require_relative 'artifact'
 require_relative 'build'
+require_relative 'errors'
 
 module CircleCI
   module CoverageReporter
@@ -18,17 +19,23 @@ module CircleCI
 
       # @param build_number [Integer, nil]
       # @return [Build, nil]
+      # @raise [RequestError]
       def single_build(build_number)
         return unless build_number
-        create_build(JSON.parse(get(single_build_url(build_number)).body))
+        resp = get(single_build_url(build_number))
+        body = JSON.parse(resp.body)
+        raise RequestError.new(body['message'], resp) unless resp.success?
+        create_build(body)
       end
 
       # @param build_number [Integer]
       # @return [Array<Artifact>]
+      # @raise [RequestError]
       def artifacts(build_number)
-        JSON.parse(get(artifacts_url(build_number)).body).map do |hash|
-          Artifact.new(hash['path'], hash['pretty_path'], hash['node_index'], hash['url'])
-        end
+        resp = get(artifacts_url(build_number))
+        body = JSON.parse(resp.body)
+        raise RequestError.new(body['message'], resp) unless resp.success?
+        body.map(&method(:create_artifact))
       end
 
       # @param revision [String]
@@ -64,8 +71,12 @@ module CircleCI
 
       # @param branch [String, nil]
       # @return [Array<Build>]
+      # @raise [RequestError]
       def recent_builds(branch)
-        JSON.parse(get(recent_builds_url(branch), limit: 100).body).map(&method(:create_build))
+        resp = get(recent_builds_url(branch), limit: 100)
+        body = JSON.parse(resp.body)
+        raise RequestError.new(body['message'], resp) unless resp.success?
+        body.map(&method(:create_build))
       end
 
       # @param branch [String, nil]
@@ -93,6 +104,12 @@ module CircleCI
         ].join('/')
       end
 
+      # @param hash [Hash]
+      # @return [Artifact]
+      def create_artifact(hash)
+        Artifact.new(hash['path'], hash['pretty_path'], hash['node_index'], hash['url'])
+      end
+
       # @param hash [Hash]
       # @return [Build]
       def create_build(hash)

data/lib/circleci/coverage_reporter/errors.rb

@@ -0,0 +1,17 @@
+module CircleCI
+  module CoverageReporter
+    class Error < StandardError; end
+
+    class RequestError < Error
+      attr_reader :resp
+
+      # @param message [String]
+      # @param resp [Faraday::Response]
+      def initialize(message, resp)
+        @message = message
+        @resp = resp
+        super(message)
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/github_client.rb

@@ -1,4 +1,5 @@
 require_relative 'abstract_vcs_client'
+require_relative 'errors'
 
 module CircleCI
   module CoverageReporter
@@ -6,7 +7,18 @@ module CircleCI
       # @note Implement {AbstractVCSClient#create_comment}
       # @param reports [Array<Report>]
       # @return [void]
+      # @raise [RequestError]
       def create_comment(reports)
+        resp = request(reports)
+        body = JSON.parse(resp.body)
+        raise RequestError.new(body['message'], resp) unless resp.success?
+      end
+
+      private
+
+      # @param reports [Array<Report>]
+      # @return [Faraday::Response]
+      def request(reports)
         Faraday.new(url: 'https://api.github.com').post do |req|
           req.url ['/repos', configuration.project, 'commits', configuration.current_revision, 'comments'].join('/')
           req.headers['Authorization'] = "token #{token}"
@@ -15,8 +27,6 @@ module CircleCI
         end
       end
 
-      private
-
       # @return [Client]
       def configuration
         CoverageReporter.client.configuration

data/lib/circleci/coverage_reporter/report.rb

@@ -59,7 +59,9 @@ module CircleCI
       # @return [String]
       def diff(after_result, before_result)
         value = (after_result.coverage - before_result.coverage).round(2)
-        if value.positive?
+        if value.nan?
+          'NaN'
+        elsif value.positive?
           "+#{value}"
         elsif value.negative?
           value.to_s

data/lib/circleci/coverage_reporter/runner.rb

@@ -5,12 +5,24 @@ module CircleCI
     class Runner
       # @return [void]
       def run
+        dump
         reports = reporters.map { |reporter| reporter.report(base_build, previous_build) }
         vcs_client.create_comment(reports)
       end
 
       private
 
+      # @return [void]
+      def dump
+        puts <<-EOF
+Runner            | Value
+------------------|-----------------------------------------------------------------------------------
+base_build        | #{base_build.inspect}
+base_build_number | #{base_build_number.inspect}
+previous_build    | #{previous_build.inspect}
+        EOF
+      end
+
       # @return [AbstractVCSClient]
       def vcs_client
         case client.configuration.vcs_type

data/lib/circleci/coverage_reporter/simplecov/build_result.rb

@@ -12,13 +12,15 @@ module CircleCI
         # @note Implement {AbstractResult#coverage}
         # @return [Float]
         def coverage
-          JSON.parse(find_artifact('.last_run.json').body)['result']['covered_percent']
+          last_run_json = find_artifact('.last_run.json') or return Float::NaN
+          JSON.parse(last_run_json.body)['result']['covered_percent']
         end
 
         # @note Implement {AbstractResult#url}
         # @return [String]
         def url
-          find_artifact('index.html').url
+          index_html = find_artifact('index.html') or return '#'
+          index_html.url
         end
 
         private

data/lib/circleci/coverage_reporter/version.rb

@@ -3,7 +3,7 @@ module CircleCI
     module Version
       MAJOR = 0
       MINOR = 1
-      PATCH = 2
+      PATCH = 3
 
       def self.to_s
         [MAJOR, MINOR, PATCH].join('.')

data/lib/circleci/coverage_reporter.rb

@@ -23,24 +23,26 @@ module CircleCI
 
     # @return [void]
     def self.run
-      Runner.new.run
-    rescue
       dump
-      raise
+      Runner.new.run
     end
 
     # @return [void]
-    def self.dump
+    def self.dump # rubocop:disable AbcSize
       puts <<-EOF
-  CircleCI::CoverageReporter.configure do |config|
-    config.base_revision = '#{configuration.base_revision}'
-    config.current_build_number = '#{configuration.current_build_number}'
-    config.current_revision = '#{configuration.current_revision}'
-    config.previous_build_number = '#{configuration.previous_build_number}'
-    config.repository_name = '#{configuration.repository_name}'
-    config.user_name = '#{configuration.user_name}'
-    config.vcs_type = '#{configuration.vcs_type}'
-  end
+Configuration         | Value
+----------------------|----------------------------------------------------------------------------
+artifacts_dir         | #{configuration.artifacts_dir.inspect}
+base_revision         | #{configuration.base_revision.inspect}
+circleci_token        | #{configuration.circleci_token[-4..-1].rjust(40, '*').inspect}
+current_build_number  | #{configuration.current_build_number.inspect}
+current_revision      | #{configuration.current_revision.inspect}
+previous_build_number | #{configuration.previous_build_number.inspect}
+reporters             | #{configuration.reporters.inspect}
+repository_name       | #{configuration.repository_name.inspect}
+user_name             | #{configuration.user_name.inspect}
+vcs_token             | #{configuration.vcs_token[-4..-1].rjust(40, '*').inspect}
+vcs_type              | #{configuration.vcs_type.inspect}
       EOF
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circleci-coverage_reporter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Yuku Takahashi
@@ -64,6 +64,7 @@ files:
 - lib/circleci/coverage_reporter/build.rb
 - lib/circleci/coverage_reporter/client.rb
 - lib/circleci/coverage_reporter/configuration.rb
+- lib/circleci/coverage_reporter/errors.rb
 - lib/circleci/coverage_reporter/github_client.rb
 - lib/circleci/coverage_reporter/rake_task.rb
 - lib/circleci/coverage_reporter/report.rb