Refactoring so that it works as a post-command (#1)

* Refactoring so that it works as a post-command

* shellcheck

Author: juandiegopalomino

.buildkite/pipeline.yml

@@ -0,0 +1,45 @@
+name: Checks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  ruby-test:
+    name: ruby test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: isbang/[email protected]
+        with:
+          compose-file: "./docker-compose.yml"
+          services: ruby
+  plugin-test:
+    name: plugin test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: isbang/[email protected]
+        with:
+          compose-file: "./docker-compose.yml"
+          services: plugin
+  plugin-lint:
+    name: plugin test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: isbang/[email protected]
+        with:
+          compose-file: "./docker-compose.yml"
+          services: lint
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master
+        with:
+          scandir: './hooks'

.github/workflows/ci.yaml

@@ -1 +1,2 @@
-/tests/tmp
+/tests/tmp
+.idea

.gitignore

@@ -1,5 +1,10 @@
 version: '2'
 services:
+  lint:
+    image: buildkite/plugin-linter:latest
+    command: ['--id', 'juandiegopalomino/junit-annotate-local']
+    volumes:
+      - ".:/plugin"
   plugin:
     image: buildkite/plugin-tester:latest@sha256:476a1024936901889147f53d2a3d8e71e99d76404972d583825514f5608083dc
     volumes:

docker-compose.yml

@@ -5,16 +5,18 @@ set -euo pipefail
 PLUGIN_DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)/.."
 MAX_SIZE=1024 # in KB
 
-echo "--- :junit: Download the junits"
+echo "--- :junit: Verify Directory"
+
+if [ ! -d "$BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_DIRECTORY" ]; then
+  echo "$BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_DIRECTORY does not exist."
+fi
 
-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"
 annotation_style="info"
 fail_build=0
 
 function cleanup {
-  rm -rf "${artifacts_dir}"
   rm -rf "${annotation_dir}"
 }
 
@@ -26,9 +28,7 @@ function check_size {
 
 trap cleanup EXIT
 
-buildkite-agent artifact download \
-  "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_ARTIFACTS}" \
-  "$artifacts_dir"
+xmls_dir=$(readlink -f "$BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_DIRECTORY")
 
 echo "--- :junit: Processing the junits"
 
@@ -37,17 +37,17 @@ docker \
   --log-level "error" \
   run \
     --rm \
-    --volume "$artifacts_dir:/junits" \
+    --volume "$xmls_dir:/junits" \
     --volume "$PLUGIN_DIR/ruby:/src" \
-    --env "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_JOB_UUID_FILE_PATTERN=${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_JOB_UUID_FILE_PATTERN:-}" \
-    --env "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_FAILURE_FORMAT=${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_FAILURE_FORMAT:-}" \
-    --env "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_REPORT_SLOWEST=${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_REPORT_SLOWEST:-}" \
+    --env "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_JOB_UUID_FILE_PATTERN=${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_JOB_UUID_FILE_PATTERN:-}" \
+    --env "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_FAILURE_FORMAT=${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_FAILURE_FORMAT:-}" \
+    --env "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_REPORT_SLOWEST=${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_REPORT_SLOWEST:-}" \
     ruby:2.7-alpine ruby /src/bin/annotate /junits \
       > "$annotation_path"
 
 if [[ $? -eq 64 ]]; then # special exit code to signal test failures
   annotation_style="error"
-  if [[ "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_FAIL_BUILD_ON_ERROR:-false}" =~ (true|on|1) ]]; then
+  if [[ "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_FAIL_BUILD_ON_ERROR:-false}" =~ (true|on|1) ]]; then
     fail_build=1
   fi
 fi
@@ -63,8 +63,15 @@ if grep -q "<details>" "$annotation_path"; then
     echo "$msg"
   else
     echo "--- :buildkite: Creating annotation"
+    args=(
+      --context "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_CONTEXT:-junit}"
+      --style "$annotation_style"
+    )
+    if [[ "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_APPEND:-false}" =~ (true|on|1) ]]; then
+      args+=( --append )
+    fi
     # shellcheck disable=SC2002
-    cat "$annotation_path" | buildkite-agent annotate --context "${BUILDKITE_PLUGIN_JUNIT_ANNOTATE_CONTEXT:-junit}" --style "$annotation_style"
+    cat "$annotation_path" | buildkite-agent annotate "${args[@]}"
   fi
 fi
 

hooks/command renamed to hooks/post-command

@@ -1,11 +1,11 @@
-name: Junit Annotate
-description: Annotates your build using JUnit XML reports
-author: https://github.com/buildkite
+name: Junit Annotate Local
+description: Annotates your build using JUnit XML reports from local files
+author: https://github.com/rippling
 requirements:
   - docker
 configuration:
   properties:
-    artifacts:
+    directory:
       type: string
     job-uuid-file-pattern:
       type: string
@@ -20,6 +20,8 @@ configuration:
       type: string
     report-slowest:
       type: integer
+    append:
+      type: boolean
   required:
-    - artifacts
+    - directory
   additionalProperties: false

plugin.yml

@@ -202,7 +202,7 @@
   end
 
   it "accepts custom regex filename patterns for job id" do
-    output, status = Open3.capture2e("env", "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_JOB_UUID_FILE_PATTERN=junit-(.*)-custom-pattern.xml", "#{__dir__}/../bin/annotate", "#{__dir__}/custom-job-uuid-pattern/")
+    output, status = Open3.capture2e("env", "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_JOB_UUID_FILE_PATTERN=junit-(.*)-custom-pattern.xml", "#{__dir__}/../bin/annotate", "#{__dir__}/custom-job-uuid-pattern/")
 
     assert_equal <<~OUTPUT, output
       Parsing junit-123-456-custom-pattern.xml
@@ -235,7 +235,7 @@
   end
 
   it "uses the file path instead of classname for annotation content when specified" do
-    output, status = Open3.capture2e("env", "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_FAILURE_FORMAT=file", "#{__dir__}/../bin/annotate", "#{__dir__}/test-failure-and-error/")
+    output, status = Open3.capture2e("env", "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_FAILURE_FORMAT=file", "#{__dir__}/../bin/annotate", "#{__dir__}/test-failure-and-error/")
 
     assert_equal <<~OUTPUT, output
       Parsing junit-1.xml
@@ -493,7 +493,7 @@
   end
 
   it "reports specified amount of slowest tests" do
-    output, status = Open3.capture2e("env", "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_REPORT_SLOWEST=5", "#{__dir__}/../bin/annotate", "#{__dir__}/no-test-failures/")
+    output, status = Open3.capture2e("env", "BUILDKITE_PLUGIN_JUNIT_ANNOTATE_LOCAL_REPORT_SLOWEST=5", "#{__dir__}/../bin/annotate", "#{__dir__}/no-test-failures/")
 
     assert_equal <<~OUTPUT, output
       Parsing junit-1.xml