Initial commit

Author: toolmantim

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Buildkite
+
+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.
+

README.md

@@ -0,0 +1,31 @@
+# JUnit Annotate Buildkite Plugin
+
+A [Buildkite](https://buildkite.com/) plugin for annotating your builds with the test failures.
+
+## Example
+
+The following pipeline will run 50 `test.sh` jobs in parallel, and then process all the resulting JUnit XML files to create a summary build annotation.
+
+```yml
+steps:
+  - command: test.sh
+    parallelism: 50
+    artifact_paths: tmp/junit-*.xml
+  - wait: ~
+    continue_on_failure: true
+  - plugins:
+      junit-annotate#v0.0.1:
+        artifacts: tmp/junit-*.xml
+```
+
+## Configuration
+
+### `artifacts` (required)
+
+The artifact glob path to find the JUnit XML files.
+
+Example: `tmp/junit-*.xml`
+
+## License
+
+MIT (see [LICENSE](LICENSE))

docker-compose.yml

@@ -0,0 +1,6 @@
+version: '2'
+services:
+  tests:
+    image: buildkite/plugin-tester
+    volumes:
+      - ".:/plugin"

hooks/command

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -euo pipefail
+
+junits_dir=$(mktemp -d -p "$(pwd)" "junits-tmp.XXXXXXXXXX")
+
+function cleanup {
+  rm -rf "${junits_dir}"
+}
+
+trap cleanup EXIT
+
+echo "--- :junit: Download the junits"
+
+buildkite-agent artifact download "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_ARTIFACTS}" junits_dir
+
+echo "--- :junit: Processing the junits"
+
+docker run \
+  --rm \
+  -v "$(pwd)/src:/usr/src/app" \
+  -v "${junits_dir}:/junits" \
+  ruby:2.4 /usr/src/app/run.sh > "${junits_dir}/annotation.md"
+
+cat "${junits_dir}/annotation.md"
+
+echo "--- :buildkite: Creating annotation"
+
+buildkite-agent annotate --context junit --style error < "${junits_dir}/annotation.md"

plugin.json

@@ -0,0 +1,7 @@
+{
+  "name": "junit-annotate",
+  "description": "Annotates your build using JUnit XML reports",
+  "author": "@buildkite",
+  "public": true,
+  "requirements": ["docker"]
+}

src/junit.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+# Reads a list of junit files and returns a nice annotation on STDOUT
+#
+# Usage: junit.rb junit-1.xml junit-2.xml junit-3.xml
+
+require 'nokogiri'
+require 'tempfile'
+
+class Failure < Struct.new(:name, :classname, :body, :job); end
+
+rspec_files = ARGV
+all_failures = []
+
+rspec_files.each do |file|
+  STDERR.puts "--- :junit: Parsing #{file}"
+  job = file[/rspec-(.*).xml$/, 1]
+  xml = File.read(file)
+  doc = Nokogiri::XML(xml)
+
+  doc.search('//testcase').each do |testcase|
+    name = testcase['name']
+    classname = testcase['classname']
+    failures = testcase.search("failure")
+
+    if failures.any?
+      failures.each do |failure|
+        all_failures << Failure.new(name, classname, failure.text.chomp.strip, job)
+      end
+    end
+  end
+end
+
+STDERR.puts "--- ❓ Checking failures"
+
+if all_failures.empty?
+  STDERR.puts "No failures, all good!"
+  exit 0
+else
+  STDERR.puts "There are #{all_failures.length} errors... (boo)"
+end
+
+STDERR.puts "--- ✍️ Preparing annotation"
+
+buffer = "There were #{all_failures.length} failures:\n\n"
+all_failures.each do |failure|
+  buffer << "<details>\n"
+  buffer << "<summary><code>#{failure.name} in #{failure.classname}</code></summary>\n\n"
+  buffer << "<code><pre>#{failure.body}</pre></code>\n\n"
+  buffer << %{in <a href="##{failure.job}">Job ##{failure.job}</a>\n}
+  buffer << "</details>"
+  buffer << "\n\n\n"
+end
+
+puts buffer
+
+STDERR.puts "--- :buildkite: Creating annotation"
+
+file = File.new("junit-annotation.md")
+file.write(buffer)
+file.close

src/run.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -euo pipefail
+
+gem install nokogiri --quiet --silent
+
+ruby junit.rb /junits/*

tests/command.bats

@@ -0,0 +1,10 @@
+#!/usr/bin/env bats
+
+load "$BATS_PATH/load.bash"
+
+@test "calls git log" {
+  stub git "log : echo some-log"
+  git log
+  assert_success
+  unstub git
+}