chore: auto-format shell (#6780)

Make `tox` -e do_format` and `tox -e check_format` enforce formatting of json and shell scripts.

Remove unmaintained shell scripts.

Update GH Actions.

Author: holmanb

.github/workflows/21-pr-check-format.yml

@@ -13,11 +13,11 @@ defaults:
     shell: sh -ex {0}
 
 jobs:
-  check_format:
+  check_linters:
     strategy:
       fail-fast: false
       matrix:
-        env: [ruff, mypy, pylint, black, isort]
+        env: [check_format]
     name: Check ${{ matrix.env }}
     runs-on: ubuntu-latest
     env:
@@ -30,6 +30,7 @@ jobs:
         run: |
           sudo DEBIAN_FRONTEND=noninteractive apt-get -qy update
           sudo DEBIAN_FRONTEND=noninteractive apt-get -qy install tox
+          sudo snap install shfmt
 
       - name: Print version
         run: python3 --version
@@ -39,20 +40,12 @@ jobs:
           # matrix env: not to be confused w/environment variables or testenv
           TOXENV: ${{ matrix.env }}
         run: tox
-  schema-format:
-    strategy:
-      fail-fast: false
-    name: Check json format
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
 
-      - name: Test format
+      - name: Formatting check failed
+        if: failure()
         run: |
-          tools/check_json_format.sh cloudinit/config/schemas/schema-cloud-config-v1.json
-          tools/check_json_format.sh cloudinit/config/schemas/schema-network-config-v1.json
-          tools/check_json_format.sh cloudinit/config/schemas/versions.schema.cloud-config.json
+          echo "[31mResolve formatting errors with `tox -e do_format` (requires shfmt to format shell).\e[0m"
+          echo "[31mFor mypy and pylint failures see the warnings above.\e[0m"
 
   doc:
     strategy:

Makefile

@@ -9,40 +9,18 @@ distro ?= redhat
 
 GENERATOR_F=./systemd/cloud-init-generator
 DS_IDENTIFY=./tools/ds-identify
-BENCHMARK=./tools/benchmark.sh
 
 
 all: check
 
 check: test
 
-style-check: lint
-
-lint:
-	@$(CWD)/tools/run-lint
-
 unittest: clean_pyc
 	$(PYTHON) -m pytest -v tests/unittests cloudinit
 
 render-template:
 	$(PYTHON) ./tools/render-template --variant=$(VARIANT) $(FILE) $(subst .tmpl,,$(FILE))
 
-# from systemd-generator(7) regarding generators:
-# "We do recommend C code however, since generators are executed
-# synchronously and hence delay the entire boot if they are slow."
-#
-# Our generator is a shell script. Make it easy to measure the
-# generator. This should be monitored for performance regressions
-benchmark-generator: FILE=$(GENERATOR_F).tmpl
-benchmark-generator: VARIANT="benchmark"
-benchmark-generator: export ITER=$(NUM_ITER)
-benchmark-generator: render-template
-	$(BENCHMARK) $(GENERATOR_F)
-
-benchmark-ds-identify: export ITER=$(NUM_ITER)
-benchmark-ds-identify:
-	$(BENCHMARK) $(DS_IDENTIFY)
-
 ci-deps-ubuntu:
 	@$(PYTHON) $(CWD)/tools/read-dependencies --distro ubuntu --test-distro
 
@@ -103,13 +81,6 @@ deb-src:
 doc:
 	tox -e doc
 
-fmt:
-	tox -e do_format && tox -e check_format
-
-fmt-tip:
-	tox -e do_format_tip && tox -e check_format_tip
-
-
-.PHONY: all check test lint clean rpm srpm deb deb-src clean_pyc
-.PHONY: unittest style-check render-template benchmark-generator
+.PHONY: all check test clean rpm srpm deb deb-src clean_pyc
+.PHONY: unittest render-template
 .PHONY: clean_pytest clean_packaging clean_release doc

tools/Z99-cloud-locale-test.sh

@@ -6,12 +6,12 @@
 # (c) 2012, Canonical Group, Ltd.
 #
 # This file is part of cloud-init. See LICENSE file for license information.
- 
+
 # Purpose: Detect invalid locale settings and inform the user
 #  of how to fix them.
 
 locale_warn() {
-    command -v local >/dev/null && local _local="local" ||
+    command -v local > /dev/null && local _local="local" ||
         typeset _local="typeset"
 
     $_local bad_names="" bad_lcs="" key="" val="" var="" vars="" bad_kv=""
@@ -27,13 +27,14 @@ locale_warn() {
     # locale: Cannot set LC_SOMETHING to default locale
     while read -r w1 w2 w3 w4 remain; do
         case "$w1" in
-            locale:) bad_names="${bad_names} ${w4}";;
+            locale:) bad_names="${bad_names} ${w4}" ;;
             *)
                 key=${w1%%=*}
                 val=${w1#*=}
                 val=${val#\"}
                 val=${val%\"}
-                vars="${vars} $key=$val";;
+                vars="${vars} $key=$val"
+                ;;
         esac
     done
     for bad in $bad_names; do
@@ -93,7 +94,7 @@ locale_warn() {
     printf "_____________________________________________________________________\n\n"
 
     # only show the message once
-    : > ~/.cloud-locale-test.skip 2>/dev/null || :
+    : > ~/.cloud-locale-test.skip 2> /dev/null || :
 }
 
 [ -f ~/.cloud-locale-test.skip -o -f /var/lib/cloud/instance/locale-check.skip ] ||

tools/Z99-cloudinit-warnings.sh

@@ -4,7 +4,7 @@
 # Purpose: show user warnings on login.
 
 cloud_init_warnings() {
-    command -v local >/dev/null && local _local="local" ||
+    command -v local > /dev/null && local _local="local" ||
         typeset _local="typeset"
     $_local warning="" idir="/var/lib/cloud/instance" n=0
     $_local warndir="$idir/warnings"
@@ -16,7 +16,7 @@ cloud_init_warnings() {
     for warning in "$warndir"/*; do
         [ -f "$warning" ] || continue
         cat "$warning"
-        n=$((n+1))
+        n=$((n + 1))
     done
     [ $n -eq 0 ] && return 0
     echo ""

tools/benchmark.sh

@@ -8,7 +8,10 @@
 
 set -eux
 
-fail() { echo "FAILED:" "$@" 1>&2; exit 1; }
+fail() {
+    echo "FAILED:" "$@" 1>&2
+    exit 1
+}
 
 PYTHON="${PYTHON:-python3}"
 if [ ! $(which ${PYTHON}) ]; then

tools/build-on-freebsd

@@ -1,6 +1,9 @@
 #!/bin/sh
 
-fail() { echo "FAILED:" "$@" 1>&2; exit 1; }
+fail() {
+    echo "FAILED:" "$@" 1>&2
+    exit 1
+}
 
 PYTHON="${PYTHON:-python3}"
 if [ ! $(which ${PYTHON}) ]; then

tools/build-on-netbsd

@@ -1,9 +1,12 @@
 #!/bin/sh
 
-fail() { echo "FAILED:" "$@" 1>&2; exit 1; }
+fail() {
+    echo "FAILED:" "$@" 1>&2
+    exit 1
+}
 
 PYTHON=${PYTHON:-python3}
-if ! command -v ${PYTHON} >/dev/null 2>&1; then
+if ! command -v ${PYTHON} > /dev/null 2>&1; then
     echo "Please install python first."
     exit 1
 fi
@@ -27,10 +30,10 @@ pkgs="
    wget
 "
 
-[ -f $depschecked ] || echo "Installing the following packages: $pkgs"; output=$(pkg_add -zI $pkgs 2>&1)
-
+[ -f $depschecked ] || echo "Installing the following packages: $pkgs"
+output=$(pkg_add -zI $pkgs 2>&1)
 
-if  echo "$output" | grep -q -e "Can't find" -e "Ambiguous"; then
+if echo "$output" | grep -q -e "Can't find" -e "Ambiguous"; then
     echo "Failed to find or install one or more packages"
     echo "Failed Package(s):"
     echo "$output"

tools/build-on-openbsd

@@ -14,9 +14,9 @@ PIPE="/run/cloud-init/share/hook-hotplug-cmd"
 [ -p $PIPE ] || mkfifo -m700 $PIPE
 
 while true; do
-  # shellcheck disable=SC2162
-  if read args < $PIPE; then
-    # shellcheck disable=SC2086
-    /usr/bin/cloud-init devel hotplug-hook $args
-  fi
+    # shellcheck disable=SC2162
+    if read args < $PIPE; then
+        # shellcheck disable=SC2086
+        /usr/bin/cloud-init devel hotplug-hook $args
+    fi
 done