[system-dependencies] Check for and install shellcheck and yamllint. (#…

…16285)

Also make the build go into the tools/devops directory, which will run
shellcheck on the bash files. This also required fixing a couple of issues in
one of the bash scripts.

We currently don't use yamllint, but that's coming very soon.

system-dependencies.sh

@@ -80,6 +80,16 @@ while ! test -z $1; do
 			unset IGNORE_DOTNET
 			shift
 			;;
+		--provision-shellcheck)
+			PROVISION_SHELLCHECK=1
+			unset IGNORE_SHELLCHECK
+			shift
+			;;
+		--provision-yamllint)
+			PROVISION_YAMLLINT=1
+			unset IGNORE_YAMLLINT
+			shift
+			;;
 		--provision-all)
 			PROVISION_MONO=1
 			unset IGNORE_MONO
@@ -103,6 +113,10 @@ while ! test -z $1; do
 			unset IGNORE_PYTHON3
 			PROVISION_DOTNET=1
 			unset IGNORE_DOTNET
+			PROVISION_SHELLCHECK=1
+			unset IGNORE_SHELLCHECK
+			PROVISION_YAMLLINT=1
+			unset IGNORE_YAMLLINT
 			shift
 			;;
 		--ignore-all)
@@ -118,6 +132,8 @@ while ! test -z $1; do
 			IGNORE_SIMULATORS=1
 			IGNORE_PYTHON3=1
 			IGNORE_DOTNET=1
+			IGNORE_SHELLCHECK=1
+			IGNORE_YAMLLINT=1
 			shift
 			;;
 		--ignore-osx)
@@ -174,6 +190,14 @@ while ! test -z $1; do
 			IGNORE_DOTNET=1
 			shift
 			;;
+		--ignore-shellcheck)
+			IGNORE_SHELLCHECK=1
+			shift
+			;;
+		--ignore-yamllint)
+			IGNORE_YAMLLINT=1
+			shift
+			;;
 		-v | --verbose)
 			set -x
 			shift
@@ -590,6 +614,26 @@ function install_autoconf () {
 	brew install autoconf
 }
 
+function install_shellcheck () {
+	if ! brew --version >& /dev/null; then
+		fail "Asked to install shellcheck, but brew is not installed."
+		return
+	fi
+
+	ok "Installing ${COLOR_BLUE}shellcheck${COLOR_RESET}..."
+	brew install shellcheck
+}
+
+function install_yamllint () {
+	if ! brew --version >& /dev/null; then
+		fail "Asked to install yamllint, but brew is not installed."
+		return
+	fi
+
+	ok "Installing ${COLOR_BLUE}yamllint${COLOR_RESET}..."
+	brew install yamllint
+}
+
 function install_python3 () {
 	if ! brew --version >& /dev/null; then
 		fail "Asked to install python3, but brew is not installed."
@@ -655,6 +699,40 @@ IFS='
 IFS=$IFS_tmp
 }
 
+function check_shellcheck () {
+	if ! test -z $IGNORE_SHELLCHECK; then return; fi
+
+IFStmp=$IFS
+IFS='
+'
+	if SHELLCHECK_VERSION=($(shellcheck --version 2>/dev/null)); then
+		ok "Found shellcheck ${SHELLCHECK_VERSION[1]} (no specific version is required)"
+	elif ! test -z $PROVISION_SHELLCHECK; then
+		install_shellcheck
+	else
+		fail "You must install shellcheck. The easiest way is to use homebrew, and execute ${COLOR_MAGENTA}brew install shellcheck${COLOR_RESET}."
+	fi
+
+IFS=$IFS_tmp
+}
+
+function check_yamllint () {
+	if ! test -z $IGNORE_YAMLLINT; then return; fi
+
+IFStmp=$IFS
+IFS='
+'
+	if YAMLLINT_VERSION=($(yamllint --version 2>/dev/null)); then
+		ok "Found ${YAMLLINT_VERSION[0]} (no specific version is required)"
+	elif ! test -z $PROVISION_YAMLLINT; then
+		install_yamllint
+	else
+		fail "You must install yamllint. The easiest way is to use homebrew, and execute ${COLOR_MAGENTA}brew install yamllint${COLOR_RESET}."
+	fi
+
+IFS=$IFS_tmp
+}
+
 function check_python3 () {
 	if ! test -z $IGNORE_PYTHON3; then return; fi
 
@@ -918,6 +996,8 @@ check_checkout_dir
 check_xcode
 check_homebrew
 check_autotools
+check_shellcheck
+check_yamllint
 check_python3
 check_mono
 check_cmake

tests/test-dependencies.sh

@@ -1,4 +1,4 @@
 #!/bin/bash -ex
 
 cd "$(dirname "$0")"
-./system-dependencies.sh --provision-mono --ignore-autotools --ignore-xamarin-studio --ignore-xcode --ignore-osx --ignore-cmake --ignore-dotnet
+./system-dependencies.sh --provision-mono --ignore-autotools --ignore-xamarin-studio --ignore-xcode --ignore-osx --ignore-cmake --ignore-dotnet --ignore-shellcheck --ignore-yamllint

tools/Makefile

@@ -2,6 +2,8 @@ TOP=..
 
 include $(TOP)/Make.config
 
+SUBDIRS += devops
+
 ifdef INCLUDE_MAC
 SUBDIRS+=mmp
 endif

tools/devops/add-summaries.sh

@@ -5,11 +5,11 @@ set +x
 X="#vso"
 
 FILE=$PWD/xamarin-macios/tests/TestSummary.md
-if ! test -f $FILE; then
-echo ":fire: Tests failed catastrophically (no summary found)" > $FILE
+if ! test -f "$FILE"; then
+echo ":fire: Tests failed catastrophically (no summary found)" > "$FILE"
 fi
 
-echo "#$X[task.addattachment type=Distributedtask.Core.Summary;name=Test results;]$FILE"
+echo "#${X}[task.addattachment type=Distributedtask.Core.Summary;name=Test results;]$FILE"
 
 echo "[Jenkins build]($WRENCH_URL)" > Wrench.md
-echo "#$X[task.addattachment type=Distributedtask.Core.Summary;name=Jenkins;]$PWD/Wrench.md"
+echo "#${X}[task.addattachment type=Distributedtask.Core.Summary;name=Jenkins;]$PWD/Wrench.md"

tools/devops/automation/templates/tests/build.yml

@@ -188,7 +188,7 @@ steps:
 - bash: |
     set -x
     set -e
-    $(Build.SourcesDirectory)/xamarin-macios/system-dependencies.sh --provision-simulators
+    $(Build.SourcesDirectory)/xamarin-macios/system-dependencies.sh --provision-simulators --ignore-shellcheck --ignore-yamllint
   displayName: 'Provision simulators'
 
 - template: ./run-tests.yml

tools/devops/provision-brew-packages.csx

@@ -1,4 +1,6 @@
 BrewPackages (
+    "shellcheck",
+    "yamllint",
     "cmake", 
     "autoconf",
     "automake",