Treat UI lint warnings as errors (#3885)

* Add lint warnings-as-errors

Genericize the existing unit-tests.sh script to handle other commands
and apply it for linting.

Signed-off-by: michael sorens <[email protected]>

* Update unit tests to use generic script, too

Signed-off-by: michael sorens <[email protected]>

* Forced lint error and warning

This should be reverted before merging!

Signed-off-by: michael sorens <[email protected]>

* Revert "Forced lint error and warning"

This reverts commit d5c6fb77e4198e110f08628e17fb3572cb877ff4.
That commit was provided only for exposition in the pull request.

Signed-off-by: michael sorens <[email protected]>

* Apply review feedback

A cooler bit of code!

Signed-off-by: michael sorens <[email protected]>

* Add some helpful in-code comments

Signed-off-by: michael sorens <[email protected]>

Author: msorens

components/automate-ui/package.json

@@ -15,10 +15,10 @@
     "copy-ui-lib:fonts": "cp -r ../chef-ui-library/dist/collection/assets/fonts/ src/assets/fonts",
     "build": "ng build",
     "build:prod": "npm run build -- --prod",
-    "test": "scripts/unit-tests.sh",
+    "test": "scripts/build.sh 'ng test --watch=false --code-coverage --source-map=false --configuration=no_auth' 'WARN:'",
     "test:watch": "ng test --watch=true --browsers='Chrome' --source-map=true --configuration=no_auth",
     "e2e": "ng e2e --no-webdriver-update",
-    "lint": "ng lint",
+    "lint": "scripts/build.sh 'ng lint' 'WARNING:'",
     "lint:html": "node_modules/htmlhint/bin/htmlhint --config .htmlhintrc src/app/**/*.html",
     "lint:sass": "node node_modules/sass-lint/bin/sass-lint.js -v -q"
   },

components/automate-ui/scripts/build.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+# The build machine is using sh; need to use bash to be able to use PIPESTATUS.
+
+# Purpose:
+# Treat warnings as errors for build commands that do not provide innate support to do that.
+
+CMD_STRING=$1
+# Examples:
+#    "ng lint"
+#    "ng lint | grep -v 'deprecated'"
+
+WARNING_LABEL=$2
+# Examples:
+#    "WARN:"         (as `ng test` uses)
+#    "WARNING:"      (as `ng lint` uses)
+
+# Setup an unused stream to redirect to stdout in the next command.
+exec 5>&1
+# We want to capture the target command's output to reuse it (rather than have to re-run the command),
+# so sending to an unused stream and redirecting that to stdout (stream 1) where it can be captured into the `out` variable.
+# In order to check the exit code of the target command itself, need to use PIPESTATUS
+# to grab the exit code of the first pipe component inside CMD_STRING rather than the final one.
+out=$(eval "$CMD_STRING | tee /dev/fd/5; exit \${PIPESTATUS[0]}")
+
+# If the unit test run reported non-zero--an actual unit test error--then exit with non-zero return code.
+# shellcheck disable=SC2181
+if [ $? -ne 0 ]; then
+  exit 1
+fi
+
+# If no errors, next check for any warnings.
+grep -q "$WARNING_LABEL" <<< "$out"
+
+# Return a non-zero exit code if any warnings present.
+# $? will be 0 if warnings were found, so `test` inverts that result.
+test $? -ne 0