Add pipeline for testing (#18)

* Add pipeline for testing

* fix shellcheck files hash

* fix indentation

* specify agent queue

* correct linter id

* remove default specifier for add_prefix as arg isn't included if not specified

* covert docker-compose docs

Author: Sam Giffney

.buildkite/pipeline.yml

@@ -0,0 +1,22 @@
+steps:
+  - label: ":shell: shellcheck"
+    plugins:
+      - shellcheck#v1.3.0:
+          files:
+            - hooks/*
+    agents:
+      queue: docker-light
+
+  - label: ":sparkles: lint"
+    plugins:
+      - plugin-linter#v3.0.0:
+          id: jobready/codeclimate-test-reporter
+    agents:
+      queue: docker-light
+
+  - label: ":docker: :hammer:"
+    plugins:
+      docker-compose#v4.9.0:
+        run: tests
+    agents:
+      queue: docker-light

README.md

@@ -1,5 +1,7 @@
 # codeclimate-test-reporter-buildkite-plugin
 
+[![Build status](https://badge.buildkite.com/f02ebd0ee8076077620275a2d77190da07c192522aaaeeb940.svg)](https://buildkite.com/jobready/codeclimate-test-reporter-buildkite-plugin)
+
 A BuildKite plugin
 
 https://buildkite.com/docs/agent/plugins
@@ -203,7 +205,7 @@ Example: `false`
 
 Controls the name outputs files formatted by the codeclimate test reporter. Required to stop artifact names clashing when processing multiple test suites.
 
-### `add_prefix` (optional, default `<empty_string>`)
+### `add_prefix` (optional)
 
 Controls the prefix to add to file paths in coverage payloads, to make them match the project's directory structure.
 
@@ -218,20 +220,28 @@ The `CC_TEST_REPORTER_ID` environment variable must be configured.
 
 ## Development
 
+### shellcheck
+
+To run the [shellcheck](https://github.com/koalaman/shellcheck), run
+
+```sh
+docker compose run --rm shellcheck hooks/*
+```
+
 ### Linting
 
 To run the [Buildkite Plugin Linter](https://github.com/buildkite-plugins/buildkite-plugin-linter), run
 
 ```sh
-docker-compose run --rm lint --name jobready/codeclimate-test-reporter
+docker compose run --rm lint
 ```
 
 ### Testing
 
-To run the [Buildkite Plugin Linter](https://github.com/buildkite-plugins/buildkite-plugin-linter), run
+To run the [Buildkite Plugin Tester](https://github.com/buildkite-plugins/buildkite-plugin-tester), run
 
 ```sh
-docker run -it --rm -v "$PWD:/plugin:ro" buildkite/plugin-tester
+docker compose run --rm tests
 ```
 
 ## Contributing

docker-compose.yml

@@ -1,11 +1,17 @@
-version: '2'
+version: '3.7'
 services:
   tests:
-    image: buildkite/plugin-tester
+    image: buildkite/plugin-tester:v4.0.0
     volumes:
       - ".:/plugin:ro"
+
   lint:
     image: buildkite/plugin-linter
-    command: ['--id', 'jobready/codeclimate-test-reporter-buildkite-plugin']
+    command: ['--id', 'jobready/codeclimate-test-reporter']
     volumes:
       - ".:/plugin:ro"
+
+  shellcheck:
+    image: koalaman/shellcheck:v0.9.0
+    volumes:
+      - ".:/mnt:ro"

hooks/command

@@ -13,8 +13,9 @@ install_reporter() {
     "https://codeclimate.com/downloads/test-reporter/test-reporter-${version}-linux-amd64" && \
   chmod +x ./cc-test-reporter
   # add current working directory to path so cc-test-reporter is accessible
-  export PATH=${PATH}:$(pwd)
-  printf -- "cc-test-reporter --version\\n$(cc-test-reporter -v)\\n"
+  PATH=${PATH}:$(pwd)
+  export PATH
+  printf -- "cc-test-reporter --version\\n%s\\n" "$(cc-test-reporter -v)"
 }
 
 download_artifacts() {
@@ -28,7 +29,8 @@ download_artifacts() {
 }
 
 format_file() {
-  output_file="coverage/$formatted_file_prefix.$(basename $1)"
+  existing_file=$(basename "$1")
+  output_file="coverage/$formatted_file_prefix.$existing_file"
   [[ $output_file == *.json ]] || output_file+=.json
 
   args=()
@@ -59,7 +61,6 @@ format_files() {
 
   printf -- "--- :codeclimate: Formatting coverage\\n"
 
-  count=1
   for f in ${BUILDKITE_PLUGIN_CODECLIMATE_TEST_REPORTER_ARTIFACT}; do
     format_file "$f" &
   done
@@ -81,6 +82,7 @@ report_coverage() {
     args+=( "--parts" )
     args+=( "${BUILDKITE_PLUGIN_CODECLIMATE_TEST_REPORTER_PARTS}" )
   fi
+  # shellcheck disable=SC2206
   args+=( coverage/${formatted_file_prefix}.*.json )
   echo cc-test-reporter "${args[@]}"
   cc-test-reporter "${args[@]}"