lint: integrate shfmt and reformat (#331)

* lint: integrate shfmt and reformat

* correct version generation per suggestion

* set script dir automatically

* install via go

* drop formatter, add doc

* run help

* improve diffing

Author: ferhatelmas

docs/CONTRIBUTOR_GUIDE.md

@@ -34,6 +34,20 @@ and run:
 goimports -local sigs.k8s.io/krew -w cmd pkg integration_test
 ```
 
+Shell scripts are automatically formatted by `shfmt`, to install and to validate run:
+
+```bash
+hach/run-lint.sh
+```
+
+If format is in expected format, there will be no output.
+Otherwise, problematic scripts will be listed and a command will be
+provided to format them:
+
+```bash
+shfmt -w -i=2 hack/
+```
+
 In addition, a boilerplate license header is expected in all source files.
 
 _All new code should be covered by tests._

hack/install-gox.sh

@@ -19,25 +19,25 @@ set -euo pipefail
 
 scratch_dir="$(mktemp -d)"
 cleanup() {
-    rm -rf "${scratch_dir}"
+  rm -rf "${scratch_dir}"
 }
 trap cleanup EXIT
 
 install_gox() {
-    gobin="$(go env GOPATH)/bin"
-    cd "${scratch_dir}";
-    env GOPATH="${scratch_dir}" \
-        GO111MODULE=off \
-        GOBIN="${gobin}" \
-        go get github.com/mitchellh/gox
+  gobin="$(go env GOPATH)/bin"
+  cd "${scratch_dir}"
+  env GOPATH="${scratch_dir}" \
+    GO111MODULE=off \
+    GOBIN="${gobin}" \
+    go get github.com/mitchellh/gox
 }
 
 ensure_gox() {
-    command -v "gox" &>/dev/null
+  command -v "gox" &>/dev/null
 }
 
 install_gox
 if ! ensure_gox; then
- echo >&2 "gox not in PATH";
- exit 1
+  echo >&2 "gox not in PATH"
+  exit 1
 fi

hack/make-all.sh

@@ -16,7 +16,7 @@
 
 set -e -o pipefail
 
-SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
 "${SCRIPTDIR}/make-binaries.sh"
 "${SCRIPTDIR}/make-release-artifacts.sh"

hack/make-binaries.sh

@@ -18,15 +18,13 @@
 # combinations specified via OSARCH variable).
 
 set -e -o pipefail
-SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
 if ! command -v "gox" &>/dev/null; then
   echo >&2 "gox not installed in PATH, run hack/install-gox.sh."
   exit 1
 fi
 
-
-
 supported_platforms="darwin/amd64 windows/amd64 linux/amd64 linux/arm"
 version_pkg="sigs.k8s.io/krew/pkg/version"
 

hack/make-binary.sh

@@ -17,7 +17,7 @@
 # This script builds krew binary for the current OS/arch.
 
 set -e -o pipefail
-SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
 exec env OSARCH="$(go env GOOS)/$(go env GOARCH)" \
-    "${SCRIPTDIR}/make-binaries.sh"
+  "${SCRIPTDIR}/make-binaries.sh"

hack/make-release-artifacts.sh

@@ -16,30 +16,35 @@
 
 set -e -o pipefail
 
-SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 cd "${SCRIPTDIR}/.."
 
 bin_dir="out/bin"
 if [[ ! -d "${bin_dir}" ]]; then
-    echo >&2 "Binaries are not built (${bin_dir}), run hack/make-binaries.sh"
-    exit 1
+  echo >&2 "Binaries are not built (${bin_dir}), run hack/make-binaries.sh"
+  exit 1
 fi
 
 krew_tar_archive="krew.tar.gz"
 krew_zip_archive="krew.zip"
 
 # consistent timestamps for files in bindir to ensure consistent checksums
-while IFS= read -r -d $'\0' f
-do
+while IFS= read -r -d $'\0' f; do
   echo "modifying atime/mtime for $f"
   TZ=UTC touch -at "0001010000" "$f"
   TZ=UTC touch -mt "0001010000" "$f"
 done < <(find "${bin_dir}" -print0)
 
 echo >&2 "Creating ${krew_tar_archive} archive."
-( cd "${bin_dir}"; GZIP=-n tar czvf "${SCRIPTDIR}/../out/${krew_tar_archive}" ./*; )
+(
+  cd "${bin_dir}"
+  GZIP=-n tar czvf "${SCRIPTDIR}/../out/${krew_tar_archive}" ./*
+)
 echo >&2 "Creating ${krew_zip_archive} archive."
-( cd "${bin_dir}"; zip -X -q --verbose "${SCRIPTDIR}/../out/${krew_zip_archive}" ./*; )
+(
+  cd "${bin_dir}"
+  zip -X -q --verbose "${SCRIPTDIR}/../out/${krew_zip_archive}" ./*
+)
 
 checksum_cmd="shasum -a 256"
 if hash sha256sum 2>/dev/null; then
@@ -49,22 +54,21 @@ fi
 tar_sumfile="out/${krew_tar_archive}.sha256"
 tar_checksum="$(eval "${checksum_cmd[@]}" "out/${krew_tar_archive}" | awk '{print $1;}')"
 echo >&2 "${krew_tar_archive} checksum: ${tar_checksum}"
-echo "${tar_checksum}" > "${tar_sumfile}"
+echo "${tar_checksum}" >"${tar_sumfile}"
 echo >&2 "Written ${tar_sumfile}."
 
 zip_sumfile="out/${krew_zip_archive}.sha256"
 zip_checksum="$(eval "${checksum_cmd[@]}" "out/${krew_zip_archive}" | awk '{print $1;}')"
 echo >&2 "${krew_zip_archive} checksum: ${zip_checksum}"
-echo "${zip_checksum}" > "${zip_sumfile}"
+echo "${zip_checksum}" >"${zip_sumfile}"
 echo >&2 "Written ${zip_sumfile}."
 
-
 # Copy and process krew manifest
 git_describe="$(git describe --tags --dirty --always)"
 if [[ ! "${git_describe}" =~ v.* ]]; then
   # if tag cannot be inferred (e.g. CI/CD), still provide a valid
   # version field for krew.yaml
-  git_describe="v0.0.0-${git_describe}"
+  git_describe="v0.0.0-detached.${git_describe}"
 fi
 krew_version="${TAG_NAME:-$git_describe}"
 cp ./hack/krew.yaml ./out/krew.yaml

hack/make-release-notes.sh

@@ -20,18 +20,18 @@
 
 TAG="${TAG:?TAG environment variable must be set for this script}"
 if ! [[ "$TAG" =~ v.* ]]; then
-    echo >&2 "TAG must be in format v.*"
-    exit 1
+  echo >&2 "TAG must be in format v.*"
+  exit 1
 fi
 
 readme="https://github.com/kubernetes-sigs/krew/blob/${TAG}/README.md"
 download_base="https://storage.googleapis.com/krew"
 download_assets=(
-    krew.tar.gz
-    krew.tar.gz.sha256
-    krew.zip
-    krew.zip.sha256
-    krew.yaml
+  krew.tar.gz
+  krew.tar.gz.sha256
+  krew.zip
+  krew.zip.sha256
+  krew.yaml
 )
 
 echo "Installation"
@@ -45,12 +45,12 @@ echo "It is recommended to follow [installation instructions](${readme})"
 echo "and not using these artifacts directly."
 echo
 for f in "${download_assets[@]}"; do
-    echo "- $download_base/${TAG}/${f}"
+  echo "- $download_base/${TAG}/${f}"
 done
 echo
 echo "Thanks to our contributors for helping out with ${TAG}:"
-git log "$(git describe --tags --abbrev=0)..HEAD" --format=%an | \
-    sort | uniq -c | sort -rn | \
-    sed -E 's,^(\s+[0-9]+\s),- ,g'
+git log "$(git describe --tags --abbrev=0)..HEAD" --format=%an |
+  sort | uniq -c | sort -rn |
+  sed -E 's,^(\s+[0-9]+\s),- ,g'
 echo
 echo "(krew ${TAG} is tagged on $(date -u).)"

hack/run-in-docker.sh

@@ -18,39 +18,38 @@
 # the local filesystem.
 
 set -euo pipefail
-SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 log() { echo >&2 "$*"; }
 log_ok() { log "$(tput setaf 2)$*$(tput sgr0)"; }
 log_fail() { log "$(tput setaf 1)$*$(tput sgr0)"; }
 image="krew:sandbox"
 
 krew_bin="${SCRIPTDIR}/../out/bin/krew-linux_amd64"
 if [[ ! -f "${krew_bin}" ]]; then
-    log "Building the ${krew_bin}."
-    env OSARCH="linux/amd64" "${SCRIPTDIR}/make-binaries.sh"
+  log "Building the ${krew_bin}."
+  env OSARCH="linux/amd64" "${SCRIPTDIR}/make-binaries.sh"
 else
-    log_ok "Using existing ${krew_bin}."
+  log_ok "Using existing ${krew_bin}."
 fi
 
-
 docker build -f "${SCRIPTDIR}/sandboxed.Dockerfile" -q \
-    --tag "${image}" "${SCRIPTDIR}/.."
+  --tag "${image}" "${SCRIPTDIR}/.."
 log_ok "Sandbox image '${image}' built successfully."
 
 kubeconfig="${KUBECONFIG:-$HOME/.kube/config}"
 if [[ ! -f "${kubeconfig}" ]]; then
-    log_fail "Warning: kubeconfig not found at ${kubeconfig}, using /dev/null"
-    kubeconfig=/dev/null
+  log_fail "Warning: kubeconfig not found at ${kubeconfig}, using /dev/null"
+  kubeconfig=/dev/null
 fi
 
 log_ok "Starting docker container with volume mounts:"
-log    "    kubeconfig=${kubeconfig}"
-log    "    kubectl-krew=${krew_bin}"
+log "    kubeconfig=${kubeconfig}"
+log "    kubectl-krew=${krew_bin}"
 log_ok "You can rebuild with the following command without restarting the container:"
-log    "    env OSARCH=linux/amd64 hack/make-binaries.sh"
+log "    env OSARCH=linux/amd64 hack/make-binaries.sh"
 exec docker run --rm --tty --interactive \
-    --volume "${krew_bin}:/usr/local/bin/kubectl-krew" \
-    --volume "${kubeconfig}:/etc/kubeconfig" \
-    --env KUBECONFIG=/etc/kubeconfig \
-    --hostname krew \
-    "${image}"
+  --volume "${krew_bin}:/usr/local/bin/kubectl-krew" \
+  --volume "${kubeconfig}:/etc/kubeconfig" \
+  --env KUBECONFIG=/etc/kubeconfig \
+  --hostname krew \
+  "${image}"

hack/run-integration-tests.sh

@@ -18,13 +18,13 @@ set -euo pipefail
 
 [[ -n "${DEBUG:-}" ]] && set -x
 
-SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 BINDIR="${SCRIPTDIR}/../out/bin"
 goos="$(go env GOOS)"
 goarch="$(go env GOARCH)"
 KREW_BINARY_DEFAULT="${BINDIR}/krew-${goos}_${goarch}"
 
-if [[ "$#" -gt 0 && ( "$1" = '-h' || "$1" = '--help' ) ]]; then
+if [[ "$#" -gt 0 && ("$1" == '-h' || "$1" == '--help') ]]; then
   cat <<EOF
 Usage:
   $0 krew  # uses the given krew binary for running integration tests
@@ -33,7 +33,6 @@ EOF
   exit 0
 fi
 
-
 KREW_BINARY="${1:-$KREW_BINARY_DEFAULT}" # needed for `kubectl krew` in tests
 if [[ ! -e "${KREW_BINARY}" ]]; then
   echo >&2 "Could not find $KREW_BINARY. You need to build krew for ${goos}/${goarch} before running the integration tests."

hack/run-lint.sh

@@ -20,31 +20,53 @@ set -euo pipefail
 
 gopath="$(go env GOPATH)"
 
-if ! [[ -x "$gopath/bin/golangci-lint" ]]
-then
-   echo >&2 'Installing golangci-lint'
-   curl --silent --fail --location \
-       https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b "$gopath/bin" v1.17.1
+if ! [[ -x "$gopath/bin/golangci-lint" ]]; then
+  echo >&2 'Installing golangci-lint'
+  curl --silent --fail --location \
+    https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b "$gopath/bin" v1.17.1
 fi
 
 # configured by .golangci.yml
 GO111MODULE=on "$gopath/bin/golangci-lint" run
 
 install_impi() {
-   impi_dir="$(mktemp -d)"
-   trap 'rm -rf -- ${impi_dir}' EXIT
-   
-   GOPATH="${impi_dir}" \
-   GO111MODULE=off \
-   GOBIN="${gopath}/bin" \
-   go get github.com/pavius/impi/cmd/impi
+  impi_dir="$(mktemp -d)"
+  trap 'rm -rf -- ${impi_dir}' EXIT
+
+  GOPATH="${impi_dir}" \
+    GO111MODULE=off \
+    GOBIN="${gopath}/bin" \
+    go get github.com/pavius/impi/cmd/impi
 }
 
 # install impi that ensures import grouping is done consistently
-if ! [[ -x "${gopath}/bin/impi" ]]
-then
-   echo >&2 'Installing impi'
-   install_impi
+if ! [[ -x "${gopath}/bin/impi" ]]; then
+  echo >&2 'Installing impi'
+  install_impi
 fi
 
 "$gopath/bin/impi" --local sigs.k8s.io/krew --scheme stdThirdPartyLocal ./...
+
+install_shfmt() {
+  shfmt_dir="$(mktemp -d)"
+  trap 'rm -rf -- ${shfmt_dir}' EXIT
+
+  GOPATH="${shfmt_dir}" \
+    GO111MODULE=off \
+    GOBIN="${gopath}/bin" \
+    go get mvdan.cc/sh/cmd/shfmt
+}
+
+# install shfmt that ensures consistent format in shell scripts
+if ! [[ -x "${gopath}/bin/shfmt" ]]; then
+  echo >&2 'Installing shfmt'
+  install_shfmt
+fi
+
+SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+shfmt_out="$($gopath/bin/shfmt -l -i=2 ${SCRIPTDIR})"
+if [[ -n "${shfmt_out}" ]]; then
+  echo >&2 "The following shell scripts need to be formatted, run: 'shfmt -w -i=2 ${SCRIPTDIR}'"
+  echo >&2 "${shfmt_out}"
+  exit 1
+fi