letitcrash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9730e1009fb2c24101ec788ca6c2b7b1018d6947
+  data.tar.gz: 795be7e067ad540b7f1c8c937956a9ad76e429a3
+SHA512:
+  metadata.gz: 0f62201242d45e2983322d87bb96f930cdd085cf56610f3697a0550fa10f7ddf313b36d91bc7fd769fe6ed8b42da0547f86ff3a45803f15398fe114a0953b731
+  data.tar.gz: 3d9530be2bbcee55e9fad0e7dfccafc602c1f864c898abe217a29cacdc77c2a65eb2be88e829d30a2125627ee35c5da45b0729ce4571ed8f766e7142d1d05118

data/lib/letitcrash/builders/file_builder.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'simplecov'
+
+module LetItCrash
+  module Builders
+    class FileBuilder
+      extend Forwardable
+
+      def_delegators :file, :filename, :lines
+
+      def self.build(file:, rewriter:)
+        new(file: file, rewriter: rewriter).build
+      end
+
+      def initialize(file:, rewriter:)
+        @file = file
+        @rewriter = rewriter
+      end
+
+      def build
+        Proto::File.new(
+          path: path,
+          digest: digest,
+          lines: relevant_lines,
+          coverage: coverage,
+        )
+      end
+
+      private
+
+      attr_reader :file, :rewriter
+
+      def path
+        Proto::File::Path.new(
+          relative: relative,
+          rewritten: rewritten,
+        )
+      end
+
+      def relevant_lines
+        @relevant_lines ||= lines.each_with_object({}) do |line, ret|
+          number = line.line_number
+          relevant = sanitizer.include?(number) && !line.skipped?
+          ret[number] = line.coverage.to_i if relevant
+        end
+      end
+
+      def coverage
+        relevant_lines.values.count(&:positive?) / relevant_lines.count.to_f
+      end
+
+      def relative
+        pathname = Pathname.new(filename)
+        pathname.absolute? ? pathname.relative_path_from(ROOT).to_s : filename
+      end
+
+      def rewritten
+        rewriter ? rewriter.call(relative) : ''
+      end
+
+      def digest
+        Digest::SHA256.file(filename).hexdigest
+      end
+
+      def sanitizer
+        @sanitizer ||= Sanitizer.from_path(path: filename)
+      end
+
+      ROOT = Pathname.new(SimpleCov.root)
+      private_constant :ROOT
+    end # class FileBuilder
+  end # module Builders
+end # module LetItCrash

data/lib/letitcrash/builders/report_builder.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module LetItCrash
+  module Builders
+    class ReportBuilder
+      extend Forwardable
+
+      def_delegators :matcher, :matches?, :branch, :sha
+
+      # @param result: result [SimpleCov::Result]
+      # @param rewriter: rewriter [Proc]
+      #
+      # @return [LetItCrash::Proto::Report]
+      def self.build(environment:, result:, rewriter:)
+        new(environment: environment, result: result, rewriter: rewriter).build
+      end
+
+      def initialize(environment:, result:, rewriter:)
+        @environment = environment
+        @result = result
+        @rewriter = rewriter
+      end
+
+      def build
+        Proto::Report.new(commit: commit, files: files)
+      end
+
+      private
+
+      attr_reader :environment, :result, :rewriter
+
+      def commit
+        raise MatcherMissing unless matches?
+        Proto::Report::Commit.new(branch: branch, sha: sha)
+      end
+
+      def files
+        result.files.map do |file|
+          FileBuilder.build(file: file, rewriter: rewriter)
+        end
+      end
+
+      def matcher
+        @matcher ||= Matcher.new(environment: environment)
+      end
+
+      class MatcherMissing < RuntimeError; end
+    end # class ReportBuilder
+  end # module Builders
+end # module LetItCrash

data/lib/letitcrash/formatter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  class Formatter
+    def initialize(rewriter: nil, reporters: [Reporters::Upload.from_env])
+      @rewriter = rewriter
+      @reporters = reporters
+    end
+
+    def format(result)
+      report = Builders::ReportBuilder.build(
+        environment: ENV,
+        result: result,
+        rewriter: rewriter,
+      )
+      reporters.each { |reporter| reporter.report(report) }
+    end
+
+    # This unfortunate trick is required since SimpleCov expects formatters to
+    # be classes rather than instances, and calls `new` on them.
+    def new
+      self
+    end
+
+    private
+
+    attr_reader :rewriter, :reporters
+  end # class Formatter
+end # module LetItCrash

data/lib/letitcrash/matcher.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module LetItCrash
+  class Matcher < Matchers::Base
+    extend Forwardable
+
+    def_delegators :matcher, :branch, :sha
+
+    # This method performs a :reek:NilCheck.
+    def matches?
+      !matcher.nil?
+    end
+
+    private
+
+    def matcher
+      @matcher ||= MATCHERS.each do |klass|
+        instance = klass.new(environment: environment)
+        return instance if instance.matches?
+      end
+      nil
+    end
+
+    MATCHERS = [
+      Matchers::AppVeyor,
+      Matchers::Buildkite,
+      Matchers::CircleCI,
+      Matchers::Codefresh,
+      Matchers::Codeship,
+      Matchers::Drone,
+      Matchers::GitLabCI,
+      Matchers::Jenkins,
+      Matchers::Semaphore,
+      Matchers::Shippable,
+      Matchers::SnapCI,
+      Matchers::SolanoCI,
+      Matchers::TeamCity,
+      Matchers::TravisCI,
+      Matchers::Wercker,
+      Matchers::Git # This is a fallback.
+    ].freeze
+    private_constant :MATCHERS
+  end # class Matcher
+end # module LetItCrash

data/lib/letitcrash/matchers/app_veyor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class AppVeyor < Base
+      def matches?
+        ci? && environment['APPVEYOR'] == 'true'
+      end
+
+      def branch
+        environment['APPVEYOR_REPO_BRANCH']
+      end
+
+      def sha
+        environment['APPVEYOR_REPO_COMMIT']
+      end
+    end # class AppVeyor
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Base
+      def initialize(environment:)
+        @environment = environment
+      end
+
+      def matches?
+        raise NotImplementedError
+      end
+
+      def branch
+        raise NotImplementedError
+      end
+
+      def sha
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :environment
+
+      def ci?
+        environment['CI'] == 'true'
+      end
+    end # class Base
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/buildkite.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Buildkite < Base
+      def matches?
+        ci? && environment['BUILDKITE'] == 'true'
+      end
+
+      def branch
+        environment['BUILDKITE_BRANCH']
+      end
+
+      def sha
+        environment['BUILDKITE_COMMIT']
+      end
+    end # class Buildkite
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/circle_ci.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class CircleCI < Base
+      def matches?
+        ci? && environment['CIRCLECI'] == 'true'
+      end
+
+      def branch
+        environment['CIRCLE_BRANCH']
+      end
+
+      def sha
+        environment['CIRCLE_SHA1']
+      end
+    end # class CircleCI
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/codefresh.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Codefresh < Base
+      # This method performs a :reek:NilCheck.
+      def matches?
+        !branch.nil?
+      end
+
+      def branch
+        environment['CF_BRANCH']
+      end
+
+      def sha
+        environment['CF_REVISION']
+      end
+    end # class Codefresh
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/codeship.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Codeship < Base
+      def matches?
+        ci? && environment['CI_NAME'] == 'codeship'
+      end
+
+      def branch
+        environment['CI_BRANCH']
+      end
+
+      def sha
+        environment['CI_COMMIT_ID']
+      end
+    end # class Codeship
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/drone.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Drone < Base
+      def matches?
+        ci? && environment['DRONE'] == 'true'
+      end
+
+      def branch
+        environment['DRONE_BRANCH']
+      end
+
+      def sha
+        environment['DRONE_COMMIT']
+      end
+    end # class Drone
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/git.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Git < Base
+      STATUS_CMD = 'git status'
+      BRANCH_CMD = 'git rev-parse --abbrev-ref HEAD'
+      SHA_CMD    = 'git rev-parse HEAD'
+
+      # This method reeks of :reek:UtilityFunction.
+      def matches?
+        IO.popen(STATUS_CMD).read.start_with?('On branch')
+      end
+
+      # This method reeks of :reek:UtilityFunction.
+      def branch
+        ret = IO.popen(BRANCH_CMD).read.strip
+        ret == 'HEAD' ? 'master' : ret
+      end
+
+      # This method reeks of :reek:UtilityFunction.
+      def sha
+        IO.popen(SHA_CMD).read.strip
+      end
+    end # class Git
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/gitlab_ci.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class GitLabCI < Base
+      # This method performs a :reek:NilCheck.
+      def matches?
+        !environment['GITLAB_CI'].nil?
+      end
+
+      def branch
+        environment['CI_BUILD_REF_NAME'] || environment['CI_COMMIT_REF_NAME']
+      end
+
+      def sha
+        environment['CI_BUILD_REF'] || environment['CI_COMMIT_SHA']
+      end
+    end # class GitLabCI
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/jenkins.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Jenkins < Base
+      # This method performs a :reek:NilCheck.
+      def matches?
+        !environment['JENKINS_URL'].nil?
+      end
+
+      def branch
+        environment['ghprbSourceBranch'] || environment['GIT_BRANCH']
+      end
+
+      def sha
+        environment['ghprbActualCommit'] || environment['GIT_COMMIT']
+      end
+    end # class Jenkins
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/semaphore.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Semaphore < Base
+      def matches?
+        ci? && environment['SEMAPHORE'] == 'true'
+      end
+
+      def branch
+        environment['BRANCH_NAME']
+      end
+
+      def sha
+        environment['REVISION']
+      end
+    end # class Semaphore
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/shippable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Shippable < Base
+      def matches?
+        ci? && environment['SHIPPABLE'] == 'true'
+      end
+
+      def branch
+        environment['BRANCH']
+      end
+
+      def sha
+        environment['COMMIT']
+      end
+    end # class Shippable
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/snap_ci.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class SnapCI < Base
+      def matches?
+        ci? && environment['SNAP_CI'] == 'true'
+      end
+
+      def branch
+        environment['SNAP_BRANCH'] || environment['SNAP_UPSTREAM_BRANCH']
+      end
+
+      def sha
+        environment['SNAP_COMMIT'] || environment['SNAP_UPSTREAM_COMMIT']
+      end
+    end # class SnapCI
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/solano_ci.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class SolanoCI < Base
+      def matches?
+        environment['TDDIUM'] == 'true'
+      end
+
+      def branch
+        environment['TDDIUM_CURRENT_BRANCH']
+      end
+
+      def sha
+        environment['TDDIUM_CURRENT_COMMIT']
+      end
+    end # class SolanoCI
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/team_city.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class TeamCity < Base
+      def matches?
+        environment['CI_SERVER_NAME'] == 'TeamCity'
+      end
+
+      def branch
+        environment['TEAMCITY_BUILD_BRANCH']
+      end
+
+      def sha
+        environment['TEAMCITY_BUILD_COMMIT']
+      end
+    end # class TeamCity
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/travis_ci.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class TravisCI < Base
+      def matches?
+        ci? && environment['TRAVIS'] == 'true'
+      end
+
+      def branch
+        environment['TRAVIS_BRANCH']
+      end
+
+      def sha
+        environment['TRAVIS_COMMIT']
+      end
+    end # class TravisCI
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/matchers/wercker.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Matchers
+    class Wercker < Base
+      # This method performs a :reek:NilCheck.
+      def matches?
+        ci? && !branch.nil?
+      end
+
+      def branch
+        environment['WERCKER_GIT_BRANCH']
+      end
+
+      def sha
+        environment['WERCKER_GIT_COMMIT']
+      end
+    end # class Wercker
+  end # module Matchers
+end # module LetItCrash

data/lib/letitcrash/proto/structs.rb

@@ -0,0 +1,34 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: proto/structs.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "LetItCrash.Proto.File" do
+    optional :path, :message, 1, "LetItCrash.Proto.File.Path"
+    optional :digest, :string, 2
+    map :lines, :int32, :int32, 3
+    optional :coverage, :double, 4
+  end
+  add_message "LetItCrash.Proto.File.Path" do
+    optional :relative, :string, 1
+    optional :rewritten, :string, 2
+  end
+  add_message "LetItCrash.Proto.Report" do
+    optional :commit, :message, 1, "LetItCrash.Proto.Report.Commit"
+    repeated :files, :message, 2, "LetItCrash.Proto.File"
+  end
+  add_message "LetItCrash.Proto.Report.Commit" do
+    optional :branch, :string, 1
+    optional :sha, :string, 2
+  end
+end
+
+module LetItCrash
+  module Proto
+    File = Google::Protobuf::DescriptorPool.generated_pool.lookup("LetItCrash.Proto.File").msgclass
+    File::Path = Google::Protobuf::DescriptorPool.generated_pool.lookup("LetItCrash.Proto.File.Path").msgclass
+    Report = Google::Protobuf::DescriptorPool.generated_pool.lookup("LetItCrash.Proto.Report").msgclass
+    Report::Commit = Google::Protobuf::DescriptorPool.generated_pool.lookup("LetItCrash.Proto.Report.Commit").msgclass
+  end # module Proto
+end # module LetItCrash

data/lib/letitcrash/reporters/stream.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LetItCrash
+  module Reporters
+    class Stream
+      def initialize(output:)
+        @output = output
+      end
+
+      def report(input)
+        output.write(input.to_json)
+      end
+
+      private
+
+      attr_reader :output
+    end # class Stream
+  end # module Reporters
+end # module LetItCrash

data/lib/letitcrash/reporters/upload.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
+module LetItCrash
+  module Reporters
+    class Upload
+      TOKEN_HEADER = 'X-LetItCrash-Token'
+
+      def self.from_env
+        endpoint = ENV.fetch(
+          'LETITCRASH_ENDPOINT',
+          'https://integrations.letitcrash.io/simplecov',
+        )
+        new(endpoint: endpoint, token: ENV.fetch('LETITCRASH_TOKEN'))
+      end
+
+      def initialize(endpoint:, token:)
+        @endpoint = endpoint
+        @token = token
+      end
+
+      def report(input)
+        RestClient.post(endpoint, input.to_json, headers)
+      end
+
+      private
+
+      attr_reader :endpoint, :token
+
+      def headers
+        {
+          content_type: :json,
+          accept: :json,
+          TOKEN_HEADER => token
+        }
+      end
+    end # class Upload
+  end # module Reporters
+end # module LetItCrash