Merge pull request #4 from buildkite-plugins/prep-for-v1

v1 cleanups and fixes

Author: toolmantim

.buildkite/pipeline.yml

@@ -0,0 +1,17 @@
+steps:
+  - label: ":bash: Plugin"
+    plugins:
+      docker-compose#v2.0.0:
+        run: plugin
+  - label: ":ruby: Ruby"
+    plugins:
+      docker-compose#v2.0.0:
+        run: ruby
+  - label: "✨ Lint"
+    plugins:
+      plugin-linter#v1.0.0:
+        name: junit-annotate
+  - label: ":bash: Shellcheck"
+    plugins:
+      shellcheck#v1.0.0:
+        files: hooks/*

.gitignore

@@ -0,0 +1 @@
+/tests/tmp

LICENSE

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

README.md

@@ -14,7 +14,7 @@ steps:
   - wait: ~
     continue_on_failure: true
   - plugins:
-      junit-annotate#v0.0.1:
+      junit-annotate#v1.0.0:
         artifacts: tmp/junit-*.xml
 ```
 
@@ -26,6 +26,30 @@ The artifact glob path to find the JUnit XML files.
 
 Example: `tmp/junit-*.xml`
 
+### `job-uuid-file-pattern` (optional)
+
+The regular expression (with capture group) that matches the job UUID in the junit file names. This is used to create the job links in the annotation.
+
+To use this, configure your test reporter to embed the `$BUILDKITE_JOB_UUID` environment variable into your junit file names. For example `"junit-buildkite-job-$BUILDKITE_JOB_UUID.xml"`.
+
+Default: `-(.*).xml`
+
+## Developing
+
+To test the junit parser (in Ruby) and plugin hooks (in Bash):
+
+```bash
+docker-compose run --rm plugin &&
+docker-compose run --rm ruby
+```
+
+To test the Ruby parser locally:
+
+```bash
+cd ruby
+rake
+```
+
 ## License
 
 MIT (see [LICENSE](LICENSE))

docker-compose.yml

@@ -1,6 +1,14 @@
 version: '2'
 services:
-  tests:
+  plugin:
     image: buildkite/plugin-tester
     volumes:
       - ".:/plugin"
+    depends_on:
+      - ruby
+  ruby:
+    image: ruby:2.5-alpine
+    command: rake
+    working_dir: /src
+    volumes:
+      - "./ruby:/src"

hooks/command

@@ -2,28 +2,41 @@
 
 set -euo pipefail
 
-junits_dir=$(mktemp -d -p "$(pwd)" "junits-tmp.XXXXXXXXXX")
+PLUGIN_DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)/.."
+
+echo "--- :junit: Download the junits"
+
+artifacts_dir="$(pwd)/$(mktemp -d "junit-annotate-plugin-artifacts-tmp.XXXXXXXXXX")"
+annotation_dir="$(pwd)/$(mktemp -d "junit-annotate-plugin-annotation-tmp.XXXXXXXXXX")"
+annotation_path="${annotation_dir}/annotation.md"
 
 function cleanup {
-  rm -rf "${junits_dir}"
+  rm -rf "${artifacts_dir}"
+  rm -rf "${annotation_dir}"
 }
 
 trap cleanup EXIT
 
-echo "--- :junit: Download the junits"
-
-buildkite-agent artifact download "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_ARTIFACTS}" junits_dir
+buildkite-agent artifact download \
+  "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_ARTIFACTS}" \
+  "$artifacts_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"
+docker \
+  --log-level "error" \
+  run \
+    --rm \
+    --volume "$artifacts_dir:/junits" \
+    --volume "$PLUGIN_DIR/ruby:/src" \
+    --env "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_JOB_UUID_FILE_PATTERN=${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_JOB_UUID_FILE_PATTERN:-}" \
+    ruby:2.5-alpine /src/bin/annotate /junits \
+      > "$annotation_path"
+
+cat "$annotation_path"
+
+if grep -q "<details>" "$annotation_path"; then
+  echo "--- :buildkite: Creating annotation"
+  # shellcheck disable=SC2002
+  cat "$annotation_path" | buildkite-agent annotate --context junit --style error
+fi

plugin.json

@@ -0,0 +1,14 @@
+name: junit-annotate
+description: Annotates your build using JUnit XML reports
+author: https://github.com/buildkite
+requirements:
+  - docker
+configuration:
+  properties:
+    artifacts:
+      type: string
+    job-uuid-file-pattern:
+      type: string
+  required:
+    - artifacts
+  additionalProperties: false

plugin.yml

@@ -0,0 +1,7 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['tests/**/*_test.rb']
+end
+
+task default: :test

ruby/Rakefile

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require 'rexml/document'
+
+# Reads a list of junit files and returns a nice Buildkite build annotation on
+# STDOUT that summarizes any failures.
+
+junits_dir = ARGV[0]
+abort("Usage: annotate <junits-dir>") unless junits_dir
+abort("#{junits_dir} does not exist") unless Dir.exist?(junits_dir)
+
+job_pattern = ENV['BUILDKITE_PLUGIN_JUNIT_ANNOTATE_JOB_UUID_FILE_PATTERN']
+job_pattern = '-(.*).xml' if !job_pattern || job_pattern.empty?
+
+class Failure < Struct.new(:name, :classname, :body, :job); end
+
+junit_report_files = Dir.glob(File.join(junits_dir, "**", "*"))
+all_failures = []
+
+junit_report_files.each do |file|
+  next if File.directory?(file)
+
+  STDERR.puts "Parsing #{file.sub(junits_dir, '')}"
+  job = File.basename(file)[/#{job_pattern}/, 1]
+  xml = File.read(file)
+  doc = REXML::Document.new(xml)
+
+  doc.elements.each('*/testcase') do |testcase|
+    name = testcase.attributes['name'].to_s
+    classname = testcase.attributes['classname'].to_s
+    testcase.elements.each("failure") do |failure|
+      all_failures << Failure.new(name, classname, failure.text.chomp.strip, job)
+    end
+  end
+end
+
+STDERR.puts "--- ❓ Checking failures"
+
+if all_failures.empty?
+  STDERR.puts "There were no failures 🙌"
+  exit 0
+else
+  STDERR.puts "There are #{all_failures.length} failures 😭"
+end
+
+STDERR.puts "--- ✍️ Preparing annotation"
+
+puts "There were #{all_failures.length} failures:\n\n"
+
+all_failures.each do |failure|
+  puts "<details>"
+  puts "<summary><code>#{failure.name} in #{failure.classname}</code></summary>\n\n"
+  puts "<code><pre>#{failure.body}</pre></code>\n\n"
+  if failure.job
+    puts "in <a href=\"##{failure.job}\">Job ##{failure.job}</a>"
+  end
+  puts "</details>"
+  puts "" unless failure == all_failures.last
+end