rspec-buildkite 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa56a03a46bef42009cd2ecd773ce3d7093767832586421a43fef470bd79ffb1
-  data.tar.gz: d14a660da966c5bdd0142398c94620a7a1ac65db893c3ab851c9807914841304
+  metadata.gz: 4323487115d2dc58511e6c4acabf0007e27cfe6df9c71c9167a3c24fce9ea862
+  data.tar.gz: f6c45d22e5c68cb34145867aa175fcd7f0cf555aab9aa2dfc91e3ad065717d81
 SHA512:
-  metadata.gz: bc072e5216cd80d3b67681261e663f7b2f1ebbb33d6eab5d830db678a268fccf3e904773d9893b4553bcfec7135cbf11aa0dbecee82035c05d1608487cc6f6a4
-  data.tar.gz: 16d8112cb59fd30917579c00f2896e76294127a57fdbf9ae375f5ef7fd6e1ca591e338a35861bce3605364183426ebe03370f8ec8f3cd1704c7c0da43a5fb780
+  metadata.gz: fabcc3676a007e391243bff2e841300e362560c52c1e17c88fc3782c35316a82a4dbb1cf2ef36e21040b7002a88a33d02984eb32b50c8f474fa8fa61c28e2bba
+  data.tar.gz: f088b0c96a630a361cb7e657f2acc83f8a78e13bfe6658d46b03bad9d28cab1b30910bd5a82d895b0f3ee8ea7e62209b71fe994965e41100891e6db1151dd733

checksums.yaml.gz.sig

@@ -1 +1,3 @@
-�Wm�fy�q��yҢ�L]42�lD�Q{�Pv���G;E%A�NP��}Vu��!��]���^@�Gkѳȶ׋䓗�!�n:�FsP�0?���p�r|N�r��<���xt|#�LNgS WX�ش��-6�b�?�w� �Xk���5�G���G��2=d�P��$~�o�x{:�se�D�-F�0�*��ʍD]a����c����^`I(l��`&}o'L]+%��o��-��n�aO�S6������"!JQ�
+oPU�t3jԥ���)��?L}e���	�&�	zM����Z'
+��[G�$Im���,�sy{��?�d����T�eȲ����բX�3r�(gP�Hf�F|B����
+x]�����3},�Օ��rO�0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Samuel Cochran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -38,6 +38,22 @@ Add it to your `.rspec` alongside your favorite formatter:
 
 Now run your specs on Buildkite!
 
+### Docker & Docker Compose
+
+If you run your RSpec builds inside Docker or Docker Compose then you'll need to make sure that buildkite-agent is available inside your container, and that some environment variables are propagated into the running containers. The buildkite-agent binary can be baked into your image, or mounted in as a volume. If you're using [the docker-compose-buildkite-plugin][dcbp] you can pass the environment using [plugin configuration][dcbp-env]. Or you can add them to the [environment section][dc-env] in your `docker-compose.yml`, or supply [env arguments][d-env] to your docker command.
+
+The following environment variables are required:
+
+- `BUILDKITE`
+- `BUILDKITE_BUILD_URL`
+- `BUILDKITE_JOB_ID`
+- `BUILDKITE_AGENT_ACCESS_TOKEN`
+
+  [dcbp]: https://github.com/buildkite-plugins/docker-compose-buildkite-plugin
+  [dcbp-env]: https://github.com/buildkite-plugins/docker-compose-buildkite-plugin#environment
+  [dc-env]: https://docs.docker.com/compose/environment-variables/
+  [d-env]: https://docs.docker.com/engine/reference/run/#env-environment-variables
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -46,7 +62,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/sj26/rspec-buildkite.
+Bug reports and pull requests are welcome on GitHub at https://github.com/buildkite/rspec-buildkite.
 
 ## License
 

data/lib/rspec/buildkite/annotation_formatter.rb

@@ -1,109 +1,76 @@
 require "thread"
 
 require "rspec/core"
+require "rspec/buildkite/recolorizer"
 
-# Create a Buildkite annotation for RSpec failures
-#
-# Help folks fix their builds as soon as possible when failures crop up by
-# calling out failures in an annotation, even while the build is still running.
-#
-# Uses a background Thread so we don't block the build.
-#
-class RSpec::Buildkite::AnnotationFormatter
-  RSpec::Core::Formatters.register self, :example_failed
+module RSpec::Buildkite
+  # Create a Buildkite annotation for RSpec failures
+  #
+  # Help folks fix their builds as soon as possible when failures crop up by
+  # calling out failures in an annotation, even while the build is still running.
+  #
+  # Uses a background Thread so we don't block the build.
+  #
+  class AnnotationFormatter
+    RSpec::Core::Formatters.register self, :example_failed
 
-  def initialize(output)
-    # We don't actually use this, but keep a reference anyway
-    @output = output
+    def initialize(output)
+      # We don't actually use this, but keep a reference anyway
+      @output = output
 
-    # Only setup if we're actually running on Buildkite
-    if ENV["BUILDKITE"]
-      @queue = Queue.new
-      @thread = Thread.new(&method(:thread))
-      at_exit { @queue.push(:close); @thread.join }
+      # Only setup if we're actually running on Buildkite
+      if ENV["BUILDKITE"]
+        @queue = Queue.new
+        @thread = Thread.new(&method(:thread))
+        at_exit { @queue.push(:close); @thread.join }
+      end
     end
-  end
 
-  def example_failed(notification)
-    @queue.push(notification) if @queue
-  end
+    def example_failed(notification)
+      @queue.push(notification) if @queue
+    end
 
-  private
+    private
 
-  def thread
-    while notification = @queue.pop
-      break if notification == :close
+    def thread
+      while notification = @queue.pop
+        break if notification == :close
 
-      if notification
-        system "buildkite-agent", "annotate",
-          "--context", "rspec",
-          "--style", "error",
-          "--append",
-          format_failure(notification),
-          out: :close # only display errors
+        if notification
+          system("buildkite-agent", "annotate",
+            "--context", "rspec",
+            "--style", "error",
+            "--append",
+            format_failure(notification),
+            out: :close # only display errors
+          ) or raise "buildkite-agent failed to run: #{$?}#{" (command not found)" if $?.exitstatus == 127}"
+        end
       end
+    rescue
+      $stderr.puts "Warning: Couldn't create Buildkite annotations:\n" <<
+        "  #{$!.to_s}\n" <<
+        "    #{$!.backtrace.join("\n    ")}"
     end
-  rescue
-    puts "Warning: Couldn't create Buildkite annotations:"
-    puts "  " << $!.to_s, "    " << $!.backtrace.join("\n    ")
-  end
 
-  def format_failure(notification)
-    build_url = ENV["BUILDKITE_BUILD_URL"].to_s
-    job_id = ENV["BUILDKITE_JOB_ID"].to_s
-    job_url = "#{build_url}##{job_id}"
-
-    "<details>\n" <<
-    "<summary>#{notification.description.encode(:xml => :text)}</summary>\n\n" <<
-    "<code><pre>#{recolorize(notification.colorized_message_lines.join("\n").encode(:xml => :text))}</pre></code>\n\n" <<
-    %{in <a href=#{job_url.encode(:xml => :attr)}>Job ##{job_id.encode(:xml => :text)}</a>\n} <<
-    "</details>" <<
-    "\n\n\n"
-  end
+    def format_failure(notification)
+      build_url = ENV["BUILDKITE_BUILD_URL"].to_s
+      job_id = ENV["BUILDKITE_JOB_ID"].to_s
+      job_url = "#{build_url}##{job_id}"
 
-  private
-
-  # Re-color an ANSI-colorized string using terminal CSS classes:
-  # https://github.com/buildkite/terminal/blob/05a77905c468b9150cac41298fdb8a0735024d42/style.go#L34
-  def recolorize(string)
-    level = 0
-    string.gsub(/\e\[(\d+(?:;\d+)*)m/) do
-      "".tap do |buffer|
-        codes = $1.split(";").map(&:to_i)
-
-        classes = []
-        while code = codes.shift
-          case code
-          when 0
-            classes.clear
-            buffer << ("</span>" * level)
-            level = 0
-          when 1..5, 9, 30..37, 90..97
-            classes << "term-fg#{code}"
-          when 40..47, 100..107
-            classes << "term-bg#{code}"
-          when 38
-            if codes[0] == 5
-              codes.shift
-              if codes[0]
-                classes << "term-fgx#{codes.shift}"
-              end
-            end
-          when 48
-            if codes[0] == 5
-              codes.shift
-              if codes[0]
-                classes << "term-bgx#{codes.shift}"
-              end
-            end
-          end
-        end
+      %{<details>\n} <<
+      %{<summary>#{notification.description.encode(:xml => :text)}</summary>\n} <<
+      %{<pre class="term">#{Recolorizer.recolorize(notification.colorized_message_lines.join("\n").encode(:xml => :text))}</pre>\n} <<
+      format_rerun(notification) <<
+      %{<p>in <a href=#{job_url.encode(:xml => :attr)}>Job ##{job_id.encode(:xml => :text)}</a></p>\n} <<
+      %{</details>} <<
+      %{\n\n\n}
+    end
 
-        if classes.any?
-          level += 1
-          buffer << %{<span class=#{classes.map { |klass| klass }.join(" ").encode(:xml => :attr)}>}
-        end
-      end
-    end << ("</span>" * level)
+    def format_rerun(notification)
+      %{<pre class="term">} <<
+      %{<span class="term-fg31">rspec #{notification.example.location_rerun_argument.encode(:xml => :text)}</span>} <<
+      %{ <span class="term-fg36"># #{notification.example.full_description.encode(:xml => :text)}</span>} <<
+      %{</pre>\n}
+    end
   end
 end

data/lib/rspec/buildkite/recolorizer.rb

@@ -0,0 +1,53 @@
+module RSpec::Buildkite
+  module Recolorizer
+    module_function
+
+    # Re-color an ANSI-colorized string using terminal CSS classes:
+    # https://github.com/buildkite/terminal/blob/05a77905c468b9150cac41298fdb8a0735024d42/style.go#L34
+    def recolorize(string)
+      level = 0
+      string.gsub(/\e\[(\d+(?:;\d+)*)m/) do
+        "".tap do |buffer|
+          codes = $1.split(";").map(&:to_i)
+
+          classes = []
+          while code = codes.shift
+            case code
+            when 0
+              classes.clear
+              buffer << ("</span>" * level)
+              level = 0
+            when 1..5, 9, 30..37
+              classes << "term-fg#{code}"
+            when 38
+              if codes[0] == 5
+                codes.shift
+                if codes[0]
+                  classes << "term-fgx#{codes.shift}"
+                end
+              end
+            when 40..47
+              classes << "term-bg#{code}"
+            when 48
+              if codes[0] == 5
+                codes.shift
+                if codes[0]
+                  classes << "term-bgx#{codes.shift}"
+                end
+              end
+            when 90..97
+              classes << "term-fgi#{code}"
+            when 100..107
+              classes << "term-bgi#{code}"
+            end
+          end
+
+          if classes.any?
+            level += 1
+            buffer << %{<span class=#{classes.map { |klass| klass }.join(" ").encode(:xml => :attr)}>}
+          end
+        end
+      end << ("</span>" * level)
+    end
+  end
+end

data/lib/rspec/buildkite/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Buildkite
-    VERSION = "0.1.0"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-buildkite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Samuel Cochran
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDKDCCAhCgAwIBAgIBBTANBgkqhkiG9w0BAQUFADA6MQ0wCwYDVQQDDARzajI2
-  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
-  NzA3MzEwNTQ3MDVaFw0xODA3MzEwNTQ3MDVaMDoxDTALBgNVBAMMBHNqMjYxFDAS
+  MIIDKDCCAhCgAwIBAgIBCDANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
+  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0y
+  MTA0MjcwMzIxMjZaFw0yMjA0MjcwMzIxMjZaMDoxDTALBgNVBAMMBHNqMjYxFDAS
   BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
   hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
   xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
@@ -21,14 +21,14 @@ cert_chain:
   4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
   KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
   NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wDQYJKoZIhvcNAQEFBQADggEBADGiXpvK754s0zTFx3y31ZRDdvAI
-  lA209JIjUlDyr9ptCRadihyfF2l9/hb+hLemiPEYppzG6vEK1TIyzbAR36yOJ8CX
-  4vPkCXLuwHhs6UIRbwN+IEy41nsIlBxmjLYei8h3t/G2Vm2oOaLdbjDXS+Srl9U8
-  shsE8ft81PxSQfzEL7Mr9cC9XvWbHW+SyTpfGm8rAtaqZkNeke4U8a0di4oz2EfA
-  P4lSfmXxsd1C71ckIp0cyXkPhyTtpyS/5hq9HhuUNzEHkSDe36/Rd1xYKV5JxMC2
-  YAttWFUs06lor2q1wwncPaMtUtbWwW35+1IV6xhs2rFY6DD/I6ZkK3GnHdY=
+  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAInkmTwBeGEJ7Xu9jjZIuFaE197m
+  YfvrzVoE6Q1DlWXpgyhhxbPIKg2acvM/Z18A7kQrF7paYl64Ti84dC64seOFIBNx
+  Qj/lxzPHMBoAYqeXYJhnYIXnvGCZ4Fkic5Bhs+VdcDP/uwYp3adqy+4bT/XDFZQg
+  tSjrAOTg3wck5aI+Tz90ONQJ83bnCRr1UPQ0T3PbWMjnNsEa9CAxUB845Sg+9yUz
+  Tvf+pbX8JT9rawFDogxPhL7eRAbjg4MH9amp5l8HTVCAsW8vqv7wM4rtMNAaXmik
+  LJghfDEf70fTtbs4Zv57pPhn1b7wBNf8fh+TZOlYAA6dFtQXoCwfE6bWgQU=
   -----END CERTIFICATE-----
-date: 2018-05-26 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -120,11 +120,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - lib/rspec/buildkite.rb
 - lib/rspec/buildkite/annotation_formatter.rb
+- lib/rspec/buildkite/recolorizer.rb
 - lib/rspec/buildkite/version.rb
-homepage: https://github.com/sj26/rspec-buildkite
+homepage: https://github.com/buildkite/rspec-buildkite
 licenses:
 - MIT
 metadata: {}
@@ -134,7 +136,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -143,8 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: RSpec formatter creating Buildkite annotations for failures