simplecov-buildkite 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 983bfc983d04ce54e3ce8ff6e42a1fae9a5ff44692ddffdfeb9f49e9f05561ff
-  data.tar.gz: ef42a76b01d7ab95c5ad61e89bf0e7d85f8a6c179523e9c042efb77347cfaa99
+  metadata.gz: e36c234f39a45a5ad45377384e89fb607ff930845c4721ffd7401137d29f45e7
+  data.tar.gz: dbdfe7265bd71b56a98fb622fb26a0d8dcd42e58f473db653e1d0a7cfa2c3c4f
 SHA512:
-  metadata.gz: 2bea09dc88c7c1304c0a9f9b622905728b1151fef54c186b12d0ad2d42ea6c3e9bb59343e89927136433abb6935cb5daa2d6d4aebde5a269ec9941f128f02744
-  data.tar.gz: 35d47820c5eaf13bf7a51ac38d0e1e089d8b4db7496dc91f47a0aaca4588332207b7315b5f0b794b63022f0d48a8c06bb3b47f1fc16fb950b3d93b1f061b7a36
+  metadata.gz: c017b754d7276b541cdbe4f1ceb72ed91325c60d223fb02d80cb7861f963480ab3a0b40390e528b3c17748c0a6b77b989fb39ad0438a0579517000d3a2466581
+  data.tar.gz: 21de73e229ee87dc405e4004b85752d74a8c8f2196dc2da6f4013950f75ed0f398cad02b0ab2d2f0f0f41dd120e069d2674e557b63f31b7122d18ff4a0d85c96

data/CHANGELOG.md

@@ -4,18 +4,46 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+[Unreleased]: https://github.com/buildkite/simplecov-buildkite/compare/v0.3.0...HEAD
+
+- Nothing yet.
+
+## [0.3.0] - 2024-01-10
+[0.3.0]: https://github.com/buildkite/simplecov-buildkite/compare/v0.2.0...v0.3.0
+
+### Added
+- Set the annotation title with the `SIMPLECOV_BUILDKITE_TITLE` env var
+  ([#21](https://github.com/buildkite/simplecov-buildkite/pull/21))
+- Set the annotation context with the `SIMPLECOV_BUILDKITE_CONTEXT` env var. This is useful for
+  adding multiple annotations to a single build
+  ([#18](https://github.com/buildkite/simplecov-buildkite/pull/18),
+  [#21](https://github.com/buildkite/simplecov-buildkite/pull/21))
+
+## [0.2.0] - 2020-09-08
+[0.2.0]: https://github.com/buildkite/simplecov-buildkite/compare/v0.1.1...v0.2.0
+
+### Changed
+- git integration: SimpleCov groups are automatically generated based on branch
+  and commit metadata.
+  ([#2](https://github.com/buildkite/simplecov-buildkite/pull/2),
+  [#8](https://github.com/buildkite/simplecov-buildkite/pull/8))
+- Headers are now in sentence case
+  ([#9](https://github.com/buildkite/simplecov-buildkite/pull/9))
+- Update specs for SimpleCov 0.19.0
+  ([#12](https://github.com/buildkite/simplecov-buildkite/pull/12))
+
 ## [0.1.1] - 2018-05-30
+[0.1.1]: https://github.com/buildkite/simplecov-buildkite/compare/v0.1.0...v0.1.1
+
 ### Changed
 - Output is now enclosed in a `<details>` for a brief summary with expandable
   group stats
 
 ## [0.1.0] - 2018-05-30
+[0.1.0]: https://github.com/buildkite/simplecov-buildkite/commits/v0.1.0
+
 ### Added
 - New gem, simplecov-buildkite. 🎉
 - Buildkite annotation formatter to consolidate reports from multiple simplecov
   runs into a Buildkite annotation.
-
-  [Unreleased]: https://github.com/ticky/simplecov-buildkite/compare/v0.1.1...HEAD
-  [0.1.1]: https://github.com/ticky/simplecov-buildkite/compare/v0.1.0...v0.1.1
-  [0.1.0]: https://github.com/ticky/simplecov-buildkite/commits/v0.1.0
-

data/README.md

@@ -1,5 +1,7 @@
 # SimpleCov::Buildkite
 
+[![Gem Version](https://badge.fury.io/rb/simplecov-buildkite.svg)](https://rubygems.org/gems/simplecov-buildkite) [![Build Status](https://travis-ci.org/buildkite/simplecov-buildkite.svg?branch=develop)](https://travis-ci.org/buildkite/simplecov-buildkite)
+
 Generate [Buildkite annotations] from your [SimpleCov] coverage reports when running your build on [Buildkite].
 
   [Buildkite]: https://buildkite.com
@@ -34,6 +36,8 @@ require "simplecov"
 require "simplecov-buildkite"
 
 SimpleCov.start "rails" do
+  load_profile "buildkite"
+
   formatter SimpleCov::Formatter::MultiFormatter.new([
     SimpleCov::Formatter::HTMLFormatter,
     SimpleCov::Buildkite::AnnotationFormatter,
@@ -41,9 +45,24 @@ SimpleCov.start "rails" do
 end
 ```
 
-When run on Buildkite, this will also output a pretty Buildkite annotation:
+When run on Buildkite with the `"buildkite"` profile enabled, this will also output a pretty Buildkite annotation, with coverage change breakdowns for the current PR or branch and commit:
+
+<img width="577" alt="Buildkite build showing a SimpleCov report in a Buildkite annotation" src="https://user-images.githubusercontent.com/282113/42116587-c2e9731e-7bac-11e8-9d2f-50fa7f071f09.png">
 
-<img width="473" alt="Buildkite build showing a SimpleCov report in a Buildkite annotation" src="https://user-images.githubusercontent.com/282113/40627591-b8de5bc4-6274-11e8-8483-245e35c873af.png">
+You can customize the title and annotation context using environment variables in your Pipeline. You can provide multiple coverage reports for a single build by providing distinct values for the annotation context.
+
+```yaml
+steps:
+- command: bin/rails engine1:spec
+  env:
+    SIMPLECOV_BUILDKITE_TITLE: "Engine 1 Coverage"
+    SIMPLECOV_BUILDKITE_CONTEXT: "engine-1-coverage"
+
+- command: bin/rails engine2:spec
+  env:
+    SIMPLECOV_BUILDKITE_TITLE: "Engine 2 Coverage"
+    SIMPLECOV_BUILDKITE_CONTEXT: "engine-2-coverage"
+```
 
   [Rails]: https://rubyonrails.org
   [RSpec]: http://rspec.info
@@ -56,7 +75,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ticky/simplecov-buildkite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant] code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/buildkite/simplecov-buildkite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant] code of conduct.
 
   [Contributor Covenant]: http://contributor-covenant.org
 
@@ -66,4 +85,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SimpleCov::Buildkite project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ticky/simplecov-buildkite/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SimpleCov::Buildkite project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/buildkite/simplecov-buildkite/blob/master/CODE_OF_CONDUCT.md).

data/lib/simplecov/buildkite/annotation_formatter.rb

@@ -1,19 +1,65 @@
+require "shellwords"
+
 module SimpleCov::Buildkite
   class AnnotationFormatter
+    GIT_ANNOTATION_FORMAT_REGEX = /^Files (?<action>changed|added) in (?<changeset>[a-zA-Z0-9.]+)$/
+
     def format(result)
+      git_results, general_results = filter_git_groups(ignore_empty_groups(result.groups))
+                                     .values_at(:git, :general)
+
       message = <<~MESSAGE
-        <details>
-        <summary>#{format_element(result)}</summary>
-        <ul>
-        #{result.groups.map do |name, group|
-          "<li><strong>#{name}</strong>: #{format_element(group)}</li>"
-        end.join("\n")}
-        </ul>
-        </details>
+        #### #{annotation_title}
+
+        <dl class="flex flex-wrap m1 mxn2">
       MESSAGE
 
-      if ENV["BUILDKITE"]
-        system "buildkite-agent", "annotate", "--context", "simplecov", "--style", "info", message
+      git_results.to_a.reverse.each do |git_result|
+        name, group = git_result
+
+        matches = name.match GIT_ANNOTATION_FORMAT_REGEX
+
+        type = if matches[:action] == 'added'
+                 'New files'
+               else
+                 'Files changed'
+               end
+
+        changeset = if matches[:changeset].include?('...')
+                      'branch'
+                    else
+                      'commit'
+                    end
+
+        message += format_as_metric "#{type} in #{changeset}",
+                                    group,
+                                    changeset: matches[:changeset]
+      end
+
+      message += format_as_metric 'All files', result
+
+      message += <<~MESSAGE
+        </dl>
+      MESSAGE
+
+      if general_results.any?
+        message += <<~MESSAGE
+          <details><summary>Coverage breakdown</summary>
+
+            #{general_results.map do |name, group|
+              "- **#{name}**: #{format_group(group)}"
+            end.join("\n")}
+
+          </details>
+        MESSAGE
+      end
+
+      if ENV['BUILDKITE']
+        system 'buildkite-agent',
+               'annotate',
+               '--context', annotation_context,
+               '--style', 'info',
+               message
       else
         puts message
       end
@@ -21,12 +67,63 @@ module SimpleCov::Buildkite
 
     private
 
-    def format_element(element)
-      "#{element.covered_percent.round(2)}% coverage: #{format_integer(element.covered_lines)} of #{format_integer(element.covered_lines + element.missed_lines)} lines"
+    def annotation_title
+      ENV.fetch("SIMPLECOV_BUILDKITE_TITLE", "Coverage")
+    end
+
+    def annotation_context
+      Shellwords.shellescape(ENV.fetch("SIMPLECOV_BUILDKITE_CONTEXT", "simplecov"))
+    end
+
+    def ignore_empty_groups(groups)
+      groups.select do |_name, group|
+        (group.covered_lines + group.missed_lines).positive?
+      end
+    end
+
+    def filter_git_groups(groups)
+      groups.each_with_object(git: {}, general: {}) do |unzipped_group, cats|
+        name, group = unzipped_group
+
+        if name.match? GIT_ANNOTATION_FORMAT_REGEX
+          cats[:git][name] = group
+        else
+          cats[:general][name] = group
+        end
+      end
     end
 
     def format_integer(integer)
-      integer.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+      Kernel.format('%<integer>d', integer: integer).gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+    end
+
+    def format_float(float)
+      Kernel.format('%<floored_float>g', floored_float: float.floor(2))
+    end
+
+    def format_as_metric(name, element, changeset: nil)
+      metric = <<~METRIC_HEADER
+        <div class="m2"><dt#{changeset.nil? ? '' : " title=\"#{changeset}\""}>#{name}</dt><dd>
+      METRIC_HEADER
+
+      metric += <<~METRIC_VALUE
+
+        **<span class="h2 regular">#{format_float(element.covered_percent)}</span>%**
+        #{format_line_count(element)}
+
+      METRIC_VALUE
+
+      metric += <<~METRIC_FOOTER
+        </dd></div>
+      METRIC_FOOTER
+    end
+
+    def format_group(element)
+      "#{format_float(element.covered_percent)}% coverage: #{format_line_count(element)}"
+    end
+
+    def format_line_count(element)
+      "#{format_integer(element.covered_lines)} of #{format_integer(element.covered_lines + element.missed_lines)} lines"
     end
   end
 end

data/lib/simplecov/buildkite/profiles.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module SimpleCov::Buildkite::Profiles
+  def self.run(*args)
+    IO.popen(args, &:read).tap do
+      $?.success? or fail("Command exited with status #{$?.exitstatus}: #{args.join(" ")}")
+    end.chomp
+  end
+
+  def self.git(*args)
+    run 'git',
+        *args
+  end
+
+  def self.git_diff_names(*args, diff_filter: '')
+    git('diff',
+        '--name-only',
+        "--diff-filter=#{diff_filter}",
+        *args).split "\n"
+  end
+
+  def self.git_short_commit(commit)
+    git 'rev-parse',
+        '--short',
+        commit
+  end
+
+  def self.git_merge_base(*refs)
+    git 'merge-base',
+        *refs
+  end
+
+  SimpleCov.profiles.define 'buildkite' do
+    STDERR.puts 'SimpleCov::Buildkite profile initialising...'
+    fail('Not running on Buildkite') unless ENV['BUILDKITE'] == 'true'
+
+    branch_name = ENV['BUILDKITE_BRANCH']
+
+    STDERR.puts "branch_name=#{branch_name}"
+
+    base_branch_name = ENV['BUILDKITE_PULL_REQUEST_BASE_BRANCH']
+    if base_branch_name.nil? || base_branch_name.empty?
+      base_branch_name = ENV['BUILDKITE_PIPELINE_DEFAULT_BRANCH']
+    end
+
+    STDERR.puts "base_branch_name=#{base_branch_name}"
+
+    current_commit = ENV['BUILDKITE_COMMIT']
+
+    STDERR.puts "current_commit=#{current_commit}"
+
+    current_commit_short = git_short_commit(current_commit)
+
+    STDERR.puts "current_commit_short=#{current_commit_short}"
+
+    changed_files_in_commit = git_diff_names(current_commit,
+                                             diff_filter: 'd')
+
+    STDERR.puts "changed_files_in_commit.count=#{changed_files_in_commit.count}"
+
+    add_group "Files changed in #{current_commit_short}" do |tested_file|
+      changed_files_in_commit.detect do |changed_file|
+        tested_file.filename.end_with?(changed_file)
+      end
+    end
+
+    added_files_in_commit = git_diff_names(current_commit,
+                                           diff_filter: 'A')
+
+    STDERR.puts "added_files_in_commit.count=#{added_files_in_commit.count}"
+
+    add_group "Files added in #{current_commit_short}" do |tested_file|
+      added_files_in_commit.detect do |added_file|
+        tested_file.filename.end_with?(added_file)
+      end
+    end
+
+    # Compare with the base branch if it's not this branch
+    if base_branch_name && base_branch_name != branch_name
+      merge_base = git_merge_base(current_commit,
+                                  base_branch_name)
+
+      merge_base_short = git_short_commit(merge_base)
+
+      STDERR.puts "merge_base=#{merge_base}"
+      STDERR.puts "merge_base_short=#{merge_base_short}"
+
+      changed_files_in_branch = git_diff_names(merge_base,
+                                               current_commit,
+                                               diff_filter: 'd')
+
+      STDERR.puts "changed_files_in_branch.count=#{changed_files_in_branch.count}"
+
+      add_group "Files changed in #{merge_base_short}...#{current_commit_short}" do |tested_file|
+        changed_files_in_branch.detect do |changed_file|
+          tested_file.filename.end_with?(changed_file)
+        end
+      end
+
+      added_files_in_branch = git_diff_names(merge_base,
+                                             current_commit,
+                                             diff_filter: 'A')
+
+      STDERR.puts "added_files_in_branch.count=#{added_files_in_branch.count}"
+
+      add_group "Files added in #{merge_base_short}...#{current_commit_short}" do |tested_file|
+        added_files_in_branch.detect do |added_file|
+          tested_file.filename.end_with?(added_file)
+        end
+      end
+    end
+  rescue RuntimeError => error
+    STDERR.puts error
+  end
+end

data/lib/simplecov/buildkite/version.rb

@@ -1,3 +1,3 @@
 module SimpleCov::Buildkite
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/lib/simplecov/buildkite.rb

@@ -5,3 +5,4 @@ end
 
 require "simplecov/buildkite/version"
 require "simplecov/buildkite/annotation_formatter"
+require "simplecov/buildkite/profiles"

metadata

@@ -1,35 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-buildkite
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
-- Jessica Stokes
-- Samuel Cochran
-autorequire: 
+- Buildkite
+autorequire:
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDKDCCAhCgAwIBAgIBBTANBgkqhkiG9w0BAQUFADA6MQ0wCwYDVQQDDARzajI2
-  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
-  NzA3MzEwNTQ3MDVaFw0xODA3MzEwNTQ3MDVaMDoxDTALBgNVBAMMBHNqMjYxFDAS
-  BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
-  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
-  xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
-  1xzcNRvFsn0aQoQ00k+sj+G83j3T5OOV5OZIlu8xAChMkQmiPd1NXc6uFv+Iacz7
-  kj+CMsI9YUFdNoU09QY0b+u+Rb6wDYdpyvN60YC30h0h1MeYbvYZJx/iZK4XY5zu
-  4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
-  KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
-  NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wDQYJKoZIhvcNAQEFBQADggEBADGiXpvK754s0zTFx3y31ZRDdvAI
-  lA209JIjUlDyr9ptCRadihyfF2l9/hb+hLemiPEYppzG6vEK1TIyzbAR36yOJ8CX
-  4vPkCXLuwHhs6UIRbwN+IEy41nsIlBxmjLYei8h3t/G2Vm2oOaLdbjDXS+Srl9U8
-  shsE8ft81PxSQfzEL7Mr9cC9XvWbHW+SyTpfGm8rAtaqZkNeke4U8a0di4oz2EfA
-  P4lSfmXxsd1C71ckIp0cyXkPhyTtpyS/5hq9HhuUNzEHkSDe36/Rd1xYKV5JxMC2
-  YAttWFUs06lor2q1wwncPaMtUtbWwW35+1IV6xhs2rFY6DD/I6ZkK3GnHdY=
-  -----END CERTIFICATE-----
-date: 2018-05-30 00:00:00.000000000 Z
+cert_chain: []
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -49,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,10 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
-- hello@jessicastokes.net
-- sj26@sj26.com
+- support@buildkite.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -102,13 +80,14 @@ files:
 - lib/simplecov-buildkite.rb
 - lib/simplecov/buildkite.rb
 - lib/simplecov/buildkite/annotation_formatter.rb
+- lib/simplecov/buildkite/profiles.rb
 - lib/simplecov/buildkite/version.rb
 homepage: https://github.com/ticky/simplecov-buildkite
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/ticky/simplecov-buildkite/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Generate SimpleCov reports for your parallel Buildkite builds
 test_files: []

checksums.yaml.gz.sig

@@ -1,2 +0,0 @@
-et�b���TB�=��Ø[�+x��;X�*C��^6�'J3����X��������x���$g��06q-��}^�e8 �@W&"�0�q��ϰ9��N| �Fk��*qN��q��Q������M��axؤ#���wG�J��jf�q��9��/�ؕ����0��6v�(�w!,�A���M�Z,�	V)
-rn�j������TG?���/v��GJ�E6�8�X/"F~c\S����P�S��&�

metadata.gz.sig

@@ -1,2 +0,0 @@
-b'��2�+V��U j��\�S��l�-�M_SxfF�-�/8�?�0��e�i!��4���i|�t&K-s�;F���������rg'�B>|<�
-���ʰ��C%K�07��z��G�B��)<~<�y���.cND��6`SM���?j��s��?�h7�r�r�k�
�),�˓���x�v(��i�V���<(@k����ݹ�̣��>.��жl���nc_b�>�EJ�D�{m#