circleci_reporter 1.0.0

data/lib/circleci_reporter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'circleci_reporter/client'
+require_relative 'circleci_reporter/configuration'
+require_relative 'circleci_reporter/errors'
+require_relative 'circleci_reporter/runner'
+
+require_relative 'circleci_reporter/reporters/flow'
+require_relative 'circleci_reporter/reporters/link'
+require_relative 'circleci_reporter/reporters/rubycritic'
+require_relative 'circleci_reporter/reporters/simplecov'
+
+module CircleCIReporter
+  class << self
+    # Setters for shared global objects
+    # @api private
+    attr_writer :client, :configuration
+  end
+
+  # @return [Configuration]
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # @return [Client]
+  def self.client
+    @client ||= Client.new
+  end
+
+  # Yields the global configuration to a block.
+  #
+  # @yield [Configuration]
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  # @return [void]
+  def self.run
+    configuration.reporters.select!(&:active?)
+    configuration.dump
+    raise NoActiveReporter if configuration.reporters.empty?
+
+    Runner.new.tap(&:dump).run
+  end
+end

data/lib/circleci_reporter/artifact.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CircleCIReporter
+  # Encapsulate a CircleCI artifact
+  #
+  # @attr path [String] abstract path to the artifact in CircleCI container
+  # @attr url [String] URL of the artifact
+  # @attr node_index [Integer] the ID of the artifact's container
+  Artifact = Struct.new(:path, :url, :node_index) do
+    # @param value [String]
+    # @param node_index [Integer, nil]
+    # @return [Boolean]
+    def match?(value, node_index: nil)
+      path.end_with?(value) && (node_index.nil? || self.node_index == node_index)
+    end
+
+    # @return [String] content of the artifact
+    def body
+      @body ||= CircleCIReporter.client.get(url).body
+    end
+  end
+end

data/lib/circleci_reporter/build.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CircleCIReporter
+  # Encapsulate a CircleCI build
+  #
+  # @attr vcs_revision [String] revision of git
+  # @attr build_number [Integer] the ID of the CircleCI build
+  Build = Struct.new(:vcs_revision, :build_number) do
+    # @param revision [String]
+    # @return [Boolean]
+    def match?(revision)
+      vcs_revision.start_with?(revision)
+    end
+
+    # @return [Array<Artifact>]
+    def artifacts
+      @artifacts ||= CircleCIReporter.client.artifacts(build_number)
+    end
+
+    # @param string [String]
+    # @param node_index [Integer, nil]
+    # @return [Artifact, nil]
+    def find_artifact(string, node_index: nil)
+      artifacts.find { |artifact| artifact.match?(string, node_index: node_index) }
+    end
+  end
+end

data/lib/circleci_reporter/client.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+require_relative 'artifact'
+require_relative 'build'
+require_relative 'errors'
+
+module CircleCIReporter
+  # CircleCI API client
+  class Client
+    CIRCLECI_ENDPOINT = 'https://circleci.com/api/v1.1'
+
+    # Fetch a build data from API and create a {Build} object for it.
+    #
+    # @param build_number [Integer, nil]
+    # @return [Build, nil]
+    # @raise [RequestError]
+    # @see https://circleci.com/docs/api/v1-reference/#build
+    def single_build(build_number)
+      return unless build_number
+
+      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
+
+    # Retrieve artifacts for the build.
+    #
+    # @param build_number [Integer]
+    # @return [Array<Artifact>]
+    # @raise [RequestError]
+    # @see https://circleci.com/docs/api/v1-reference/#build-artifacts
+    def artifacts(build_number)
+      resp = get(artifacts_url(build_number))
+      body = JSON.parse(resp.body)
+      raise RequestError.new(body['message'], resp) unless resp.success?
+
+      body.map{ |hash| create_artifact(hash) }
+    end
+
+    # Find the latest build number for the given vcs revision.
+    #
+    # @param revision [String]
+    # @param branch [String, nil]
+    # @return [Integer, nil]
+    def build_number_by_revision(revision, branch: nil)
+      build = recent_builds(branch).find { |recent_build| recent_build.match?(revision) }
+      build ? build.build_number : nil
+    end
+
+    # Raw entry point for GET APIs.
+    #
+    # @param url [String]
+    # @param params [Hash]
+    # @return [Faraday::Response]
+    def get(url, params = {})
+      params['circle-token'] = configuration.circleci_token
+      query_string = params.map { |key, value| "#{key}=#{value}" }.join('&')
+      Faraday.get("#{url}?#{query_string}")
+    end
+
+    private
+
+    # @return [Configuration]
+    def configuration
+      CircleCIReporter.configuration
+    end
+
+    # @param build_number [Integer]
+    # @return [String] URL for "Artifacts of a Bulid API"
+    def artifacts_url(build_number)
+      [
+        CIRCLECI_ENDPOINT,
+        'project',
+        configuration.vcs_type,
+        configuration.project,
+        build_number,
+        'artifacts'
+      ].join('/')
+    end
+
+    # @param branch [String, nil]
+    # @return [Array<Build>]
+    # @raise [RequestError]
+    def recent_builds(branch)
+      resp = get(recent_builds_url(branch), limit: 100)
+      body = JSON.parse(resp.body)
+      raise RequestError.new(body['message'], resp) unless resp.success?
+
+      body.map { |hash| create_build(hash) }
+    end
+
+    # @param branch [String, nil]
+    # @return [String]
+    def recent_builds_url(branch)
+      elements = [
+        CIRCLECI_ENDPOINT,
+        'project',
+        configuration.vcs_type,
+        configuration.project
+      ]
+      elements += ['tree', branch] if branch
+      elements.join('/')
+    end
+
+    # @param build_number [Integer]
+    # @return [String]
+    def single_build_url(build_number)
+      [
+        CIRCLECI_ENDPOINT,
+        'project',
+        configuration.vcs_type,
+        configuration.project,
+        build_number
+      ].join('/')
+    end
+
+    # @param hash [Hash]
+    # @return [Artifact]
+    def create_artifact(hash)
+      Artifact.new(hash['path'], hash['url'], hash['node_index'])
+    end
+
+    # @param hash [Hash]
+    # @return [Build]
+    def create_build(hash)
+      Build.new(hash['vcs_revision'], hash['build_num'])
+    end
+  end
+end

data/lib/circleci_reporter/configuration.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative 'reporters/flow'
+require_relative 'reporters/rubycritic'
+require_relative 'reporters/simplecov'
+
+module CircleCIReporter
+  class Configuration
+    DEFAULT_REPORTERS = [
+      Reporters::SimpleCov.new,
+      Reporters::Flow.new,
+      Reporters::RubyCritic.new
+    ].freeze
+    DEFAULT_VCS_TYPE = 'github'
+
+    attr_accessor :circleci_token, :vcs_token
+    attr_writer :artifacts_dir, :base_revision, :current_build_number,
+                :current_revision, :previous_build_number, :reporters, :repository_name,
+                :template, :template_safe_mode, :user_name, :vcs_type
+
+    # @return [String]
+    def project
+      "#{user_name}/#{repository_name}"
+    end
+
+    # @return [Array<Reporters::Base>]
+    def reporters
+      @reporters ||= DEFAULT_REPORTERS.dup
+    end
+
+    # @return [String]
+    def vcs_type
+      @vcs_type ||= DEFAULT_VCS_TYPE
+    end
+
+    # @return [String]
+    def artifacts_dir
+      @artifacts_dir ||= ENV['CIRCLE_ARTIFACTS']
+    end
+
+    # @return [String]
+    def base_revision
+      @base_revision ||= `git merge-base origin/master HEAD`.strip
+    end
+
+    # @return [Integer]
+    def current_build_number
+      @current_build_number ||= ENV['CIRCLE_BUILD_NUM']
+    end
+
+    # @return [String]
+    def current_revision
+      @current_revision ||= ENV['CIRCLE_SHA1']
+    end
+
+    # @return [Integer, nil]
+    def previous_build_number
+      @previous_build_number ||= ENV['CIRCLE_PREVIOUS_BUILD_NUM']&.to_i
+    end
+
+    # @return [String]
+    def repository_name
+      @repository_name ||= ENV['CIRCLE_PROJECT_REPONAME']
+    end
+
+    # @return [String]
+    def user_name
+      @user_name ||= ENV['CIRCLE_PROJECT_USERNAME']
+    end
+
+    # @return [void]
+    def dump
+      puts <<~CONFIGURATION
+        Configuration         | Value
+        ----------------------|----------------------------------------------------------------------------
+        artifacts_dir         | #{artifacts_dir.inspect}
+        base_revision         | #{base_revision.inspect}
+        circleci_token        | #{circleci_token[-4..].rjust(40, '*').inspect if circleci_token}
+        current_build_number  | #{current_build_number.inspect}
+        current_revision      | #{current_revision.inspect}
+        previous_build_number | #{previous_build_number.inspect}
+        reporters             | #{reporters.inspect}
+        repository_name       | #{repository_name.inspect}
+        user_name             | #{user_name.inspect}
+        vcs_token             | #{vcs_token[-4..].rjust(40, '*').inspect if vcs_token}
+        vcs_type              | #{vcs_type.inspect}
+      CONFIGURATION
+    end
+  end
+end

data/lib/circleci_reporter/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CircleCIReporter
+  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
+
+  class NoActiveReporter < Error; end
+end

data/lib/circleci_reporter/rake_task.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'circleci_reporter'
+
+namespace :circleci_reporter do
+  desc 'Report test coverage'
+  task :coverage do
+    abort unless ENV['CIRCLECI']
+
+    CircleCIReporter.configure do |config|
+      config.circleci_token = ENV['CIRCLECI_REPORTER_CIRCLECI_TOKEN']
+      config.vcs_token = ENV['CIRCLECI_REPORTER_VCS_TOKEN']
+    end
+
+    CircleCIReporter.run
+  end
+end

data/lib/circleci_reporter/report.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module CircleCIReporter
+  # Encapsulate a report created by a reporter.
+  #
+  # @see Reporters::Base#report
+  class Report
+    # @param reporter [Reporters::Base] the reporter of the report
+    # @param current [Result]
+    # @param base [Result, nil] result at master branch
+    # @param previous [Result, nil] result at previous build in same branch
+    def initialize(reporter, current, base: nil, previous: nil)
+      @reporter = reporter
+      @current_result = current
+      @base_result = base
+      @previous_result = previous
+    end
+
+    # @return [String]
+    def to_s
+      "#{link}: #{current_result.pretty_coverage}#{emoji}#{progress}"
+    end
+
+    private
+
+    attr_reader :reporter, :current_result, :base_result, :previous_result
+
+    # @return [String]
+    def link
+      "[#{reporter.name}](#{current_result.url})"
+    end
+
+    # @return [String]
+    def emoji
+      if base_diff.nil? || base_diff.nan? || base_diff.round(2).zero?
+        ''
+      elsif base_diff.positive?
+        ':chart_with_upwards_trend:'
+      else
+        ':chart_with_downwards_trend:'
+      end
+    end
+
+    # @return [String]
+    def progress
+      progresses.empty? ? '' : "(#{progresses.join(', ')})"
+    end
+
+    # @return [Array<String>]
+    def progresses
+      [base_progress, branch_progress].compact
+    end
+
+    # @return [String, nil]
+    def base_progress
+      base_diff ? "[master](#{base_result.url}): #{pretty_base_diff}" : nil
+    end
+
+    # @return [String, nil]
+    def branch_progress
+      branch_diff ? "[previous](#{previous_result.url}): #{pretty_branch_diff}" : nil
+    end
+
+    # @return [String, nil]
+    def pretty_base_diff
+      return unless base_diff
+
+      pretty_diff(base_diff.round(2))
+    end
+
+    # @return [String, nil]
+    def pretty_branch_diff
+      return unless branch_diff
+
+      pretty_diff(branch_diff.round(2))
+    end
+
+    # @return [Float, nil]
+    def base_diff
+      return unless base_result
+
+      current_result.coverage - base_result.coverage
+    end
+
+    # @return [Float, nil]
+    def branch_diff
+      return unless previous_result
+
+      current_result.coverage - previous_result.coverage
+    end
+
+    # @param diff [Float]
+    # @return [String]
+    def pretty_diff(diff)
+      if diff.nan?
+        'NaN'
+      elsif diff.positive?
+        "+#{diff}"
+      elsif diff.negative?
+        diff.to_s
+      else
+        '±0'
+      end
+    end
+  end
+end