fix: collection of fixes and resolution for shellcheck warnings

README.md

@@ -5,14 +5,14 @@
 
 **Quickly create and run optimised Windows, macOS and Linux virtual machines:**
 
-<img src=".github/screenshot.png" alt="Quickemu Screenshot" />
-
 **Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/>**
-
-We have a Discord for this project:
-
-[![Discord](https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)](https://discord.gg/sNmz3uw)
 </div>
+<p align="center">
+  &nbsp;<a href="https://wimpysworld.io/discord" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/712850672223125565?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&labelColor=%234253e8&color=%23e4e2e2"></a>&nbsp;
+  &nbsp;<a href="https://fosstodon.org/@wimpy" target="_blank"><img alt="Mastodon" src="https://img.shields.io/badge/Mastodon-6468fa?style=for-the-badge&logo=mastodon&logoColor=%23ffffff"></a>&nbsp;
+  &nbsp;<a href="https://twitter.com/m_wimpress" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-303030?style=for-the-badge&logo=x&logoColor=%23ffffff"></a>&nbsp;
+  &nbsp;<a href="https://linkedin.com/in/martinwimpress" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a>&nbsp;
+</p>
 
 # Introduction
 
@@ -85,6 +85,10 @@ quickemu --vm nixos-unstable.conf
 -   Execute `quickget` (with no arguments) to see a list of all the
     supported operating systems.
 
+## Demo
+
+<div align="center"><a href="https://asciinema.org/a/658148?autoplay=1" target="_blank"><img src="https://asciinema.org/a/658148.svg" /></a></div>
+
 # Documentation
 
 The wiki describes how to get up and running with Quickemu and also
@@ -129,6 +133,7 @@ We welcome contributions to Quickemu.
 -   Submit [Quickemu Pull
     requests](https://github.com/quickemu-project/quickemu/pulls) to fix
     bugs 🐞 or add new features ✨
+    -   Follow our [guide to adding a new OS to quickget](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features#adding-a-new-os-to-quickget)
     -   Commit messages must [conform to the Conventional Commits
-    specification](https://www.conventionalcommits.org/).
+    specification](https://www.conventionalcommits.org/)
 -   [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖

quickemu

@@ -237,6 +237,7 @@ function vm_boot() {
     local OSK=""
     local SOUND=""
     local SMM="${SMM:-off}"
+    local TEMP_PORT=""
     local USB_HOST_PASSTHROUGH_CONTROLLER="qemu-xhci"
     local VGA=""
     local VIDEO=""
@@ -400,6 +401,7 @@ function vm_boot() {
         if [ -n "${EFI_CODE}" ] || [ ! -e "${EFI_CODE}" ]; then
             case ${secureboot} in
             on)
+                # shellcheck disable=SC2054,SC2140
                 ovmfs=("/usr/share/OVMF/OVMF_CODE_4M.secboot.fd","/usr/share/OVMF/OVMF_VARS_4M.fd" \
                     "/usr/share/edk2/ovmf/OVMF_CODE.secboot.fd","/usr/share/edk2/ovmf/OVMF_VARS.fd" \
                     "/usr/share/OVMF/x64/OVMF_CODE.secboot.fd","/usr/share/OVMF/x64/OVMF_VARS.fd" \
@@ -410,6 +412,7 @@ function vm_boot() {
                 )
                 ;;
             *)
+                # shellcheck disable=SC2054,SC2140
                 ovmfs=("/usr/share/OVMF/OVMF_CODE_4M.fd","/usr/share/OVMF/OVMF_VARS_4M.fd" \
                     "/usr/share/edk2/ovmf/OVMF_CODE.fd","/usr/share/edk2/ovmf/OVMF_VARS.fd" \
                     "/usr/share/OVMF/OVMF_CODE.fd","/usr/share/OVMF/OVMF_VARS.fd" \
@@ -443,7 +446,7 @@ function vm_boot() {
             echo "       Please install OVMF firmware."
             exit 1
         fi
-        if [ ! -z "${EFI_EXTRA_VARS}" ]; then
+        if [ -n "${EFI_EXTRA_VARS}" ]; then
             if [ ! -e "${EFI_EXTRA_VARS}" ]; then
                 echo " - EFI:      ERROR! EFI_EXTRA_VARS file ${EFI_EXTRA_VARS} does not exist."
                 exit 1
@@ -992,7 +995,8 @@ function vm_boot() {
 
     # Only enable SPICE is using SPICE display
     if [ "${OUTPUT}" == "none" ] || [ "${OUTPUT}" == "spice" ] || [ "${OUTPUT}" == "spice-app" ]; then
-        args+=(-spice ${SPICE}
+        # shellcheck disable=SC2054
+        args+=(-spice "${SPICE}"
             -device virtio-serial-pci
             -chardev socket,id=agent0,path="${VMDIR}/${VMNAME}-agent.sock",server=on,wait=off
             -device virtserialport,chardev=agent0,name=org.qemu.guest_agent.0
@@ -1002,9 +1006,10 @@ function vm_boot() {
             -device virtserialport,chardev=webdav0,name=org.spice-space.webdav.0)
     fi
 
+    # shellcheck disable=SC2054
     args+=(-device virtio-rng-pci,rng=rng0
         -object rng-random,id=rng0,filename=/dev/urandom
-        -device ${USB_HOST_PASSTHROUGH_CONTROLLER},id=spicepass
+        -device "${USB_HOST_PASSTHROUGH_CONTROLLER}",id=spicepass
         -chardev spicevmc,id=usbredirchardev1,name=usbredir
         -device usb-redir,chardev=usbredirchardev1,id=usbredirdev1
         -chardev spicevmc,id=usbredirchardev2,name=usbredir
@@ -1016,6 +1021,7 @@ function vm_boot() {
     )
 
     if "${QEMU}" -chardev spicevmc,id=ccid,name= 2>&1 | grep -q smartcard; then
+        # shellcheck disable=SC2054
         args+=(-chardev spicevmc,id=ccid,name=smartcard
                -device ccid-card-passthru,chardev=ccid)
     else
@@ -1025,8 +1031,10 @@ function vm_boot() {
     # setup usb-controller
     [ -z "${USB_CONTROLLER}" ] && USB_CONTROLLER="$usb_controller"
     if [ "${USB_CONTROLLER}" == "ehci" ]; then
+        # shellcheck disable=SC2054
         args+=(-device usb-ehci,id=input)
     elif [ "${USB_CONTROLLER}" == "xhci" ]; then
+        # shellcheck disable=SC2054
         args+=(-device qemu-xhci,id=input)
     elif [ -z "${USB_CONTROLLER}" ] || [ "${USB_CONTROLLER}" == "none" ]; then
         # add nothing
@@ -1039,8 +1047,10 @@ function vm_boot() {
     # @INFO: must be set after usb-controller
     [ -z "${KEYBOARD}" ] && KEYBOARD="$keyboard"
     if [ "${KEYBOARD}" == "usb" ]; then
+        # shellcheck disable=SC2054
         args+=(-device usb-kbd,bus=input.0)
     elif [ "${KEYBOARD}" == "virtio" ]; then
+        # shellcheck disable=SC2054
         args+=(-device virtio-keyboard)
     elif [ "${KEYBOARD}" == "ps2" ] || [ -z "${KEYBOARD}" ]; then
         # add nothing, default is ps/2 keyboard
@@ -1053,7 +1063,7 @@ function vm_boot() {
     # @INFO: When using the VNC display, you must use the -k parameter to set the keyboard layout if you are not using en-us.
     [ -z "${KEYBOARD_LAYOUT}" ] && KEYBOARD_LAYOUT="$keyboard_layout"
     if [ -n "${KEYBOARD_LAYOUT}" ]; then
-        args+=(-k ${KEYBOARD_LAYOUT})
+        args+=(-k "${KEYBOARD_LAYOUT}")
     fi
 
     # FIXME: Check for device availability. qemu will fail to start otherwise
@@ -1067,10 +1077,13 @@ function vm_boot() {
     # @INFO: must be set after usb-controller
     [ -z "${MOUSE}" ] && MOUSE="$mouse"
     if [ "${MOUSE}" == "usb" ]; then
+        # shellcheck disable=SC2054
         args+=(-device usb-mouse,bus=input.0)
     elif [ "${MOUSE}" == "tablet" ]; then
+        # shellcheck disable=SC2054
         args+=(-device usb-tablet,bus=input.0)
     elif [ "${MOUSE}" == "virtio" ]; then
+        # shellcheck disable=SC2054
         args+=(-device virtio-mouse)
     elif [ "${MOUSE}" == "ps2" ] || [ -z "${MOUSE}" ]; then
         # add nothing, default is ps/2 mouse
@@ -1189,6 +1202,7 @@ function vm_boot() {
         args+=(-drive if=ide,index=0,media=disk,file="${disk_img}")
 
     elif [ "${guest_os}" == "windows-server" ]; then
+        # shellcheck disable=SC2054,SC2206
         args+=(-device ide-hd,drive=SystemDisk
             -drive id=SystemDisk,if=none,format=qcow2,file="${disk_img}" ${STATUS_QUO})
 
@@ -1239,16 +1253,18 @@ function vm_boot() {
         echo " - Monitor:  (off)"
     elif [ "${MONITOR}" == "telnet" ]; then
         # Find a free port to expose monitor-telnet to the guest
-        local temp_port="$(get_port ${MONITOR_TELNET_PORT} 9)"
-        if [ -z "${temp_port}" ]; then
+        TEMP_PORT="$(get_port ${MONITOR_TELNET_PORT} 9)"
+        if [ -z "${TEMP_PORT}" ]; then
             echo " - Monitor:  All Monitor-Telnet ports have been exhausted."
         else
-            MONITOR_TELNET_PORT="${temp_port}"
-            args+=(-monitor telnet:${MONITOR_TELNET_HOST}:${MONITOR_TELNET_PORT},server,nowait)
+            MONITOR_TELNET_PORT="${TEMP_PORT}"
+            # shellcheck disable=SC2054
+            args+=(-monitor telnet:"${MONITOR_TELNET_HOST}:${MONITOR_TELNET_PORT}",server,nowait)
             echo " - Monitor:  On host:  telnet ${MONITOR_TELNET_HOST} ${MONITOR_TELNET_PORT}"
             echo "monitor-telnet,${MONITOR_TELNET_PORT},${MONITOR_TELNET_HOST}" >> "${VMDIR}/${VMNAME}.ports"
         fi
     elif [ "${MONITOR}" == "socket" ]; then
+        # shellcheck disable=SC2054,SC2206
         args+=(-monitor unix:${VM_MONITOR_SOCKETPATH},server,nowait)
         echo " - Monitor:  On host:  nc -U \"${VM_MONITOR_SOCKETPATH}\""
         echo "             or     :  socat -,echo=0,icanon=0 unix-connect:${VM_MONITOR_SOCKETPATH}"
@@ -1276,16 +1292,18 @@ function vm_boot() {
         args+=(-serial none)
     elif [ "${SERIAL}" == "telnet" ]; then
         # Find a free port to expose serial-telnet to the guest
-        local temp_port="$(get_port ${SERIAL_TELNET_PORT} 9)"
-        if [ -z "${temp_port}" ]; then
+        TEMP_PORT="$(get_port ${SERIAL_TELNET_PORT} 9)"
+        if [ -z "${TEMP_PORT}" ]; then
             echo " - Serial:   All Serial-Telnet ports have been exhausted."
         else
-            SERIAL_TELNET_PORT="${temp_port}"
+            SERIAL_TELNET_PORT="${TEMP_PORT}"
+            # shellcheck disable=SC2054,SC2206
             args+=(-serial telnet:${SERIAL_TELNET_HOST}:${SERIAL_TELNET_PORT},server,nowait)
             echo " - Serial:   On host:  telnet ${SERIAL_TELNET_HOST} ${SERIAL_TELNET_PORT}"
             echo "serial-telnet,${SERIAL_TELNET_PORT},${SERIAL_TELNET_HOST}" >> "${VMDIR}/${VMNAME}.ports"
         fi
     elif [ "${SERIAL}" == "socket" ]; then
+        # shellcheck disable=SC2054,SC2206
         args+=(-serial unix:${VM_SERIAL_SOCKETPATH},server,nowait)
         echo " - Serial:   On host:  nc -U \"${VM_SERIAL_SOCKETPATH}\""
         echo "             or     :  socat -,echo=0,icanon=0 unix-connect:${VM_SERIAL_SOCKETPATH}"
@@ -1298,6 +1316,7 @@ function vm_boot() {
         EXTRA_ARGS="${extra_args}"
     fi
     if [ -n "${EXTRA_ARGS}" ]; then
+        # shellcheck disable=SC2206
         args+=(${EXTRA_ARGS})
     fi
 
@@ -1468,9 +1487,12 @@ function parse_ports_from_file {
     local FILE="${VMDIR}/${VMNAME}.ports"
 
     # parse ports
-    local port_name=( $(cat "$FILE" | cut -d, -f1) )
-    local port_number=( $(cat "$FILE" | cut -d, -f2) )
-    local host_name=( $(cat "$FILE" | gawk 'FS="," {print $3,"."}') )
+    # shellcheck disable=SC2207
+    local port_name=( $(cat "${FILE}" | cut -d',' -f 1) )
+    # shellcheck disable=SC2207
+    local port_number=( $(cat "${FILE}" | cut -d',' -f 2) )
+    # shellcheck disable=SC2207
+    local host_name=( $(cat "${FILE}" | gawk 'FS="," {print $3,"."}') )
 
     for ((i=0; i<${#port_name[@]}; i++)); do
         if [ "${port_name[$i]}" == "ssh" ]; then
@@ -1562,7 +1584,6 @@ public_dir=""
 monitor="socket"
 monitor_telnet_port="4440"
 monitor_telnet_host="localhost"
-monitor_cmd=""
 serial="socket"
 serial_telnet_port="6660"
 serial_telnet_host="localhost"
@@ -1675,7 +1696,7 @@ else
             shift
             shift;;
         -screenpct|--screenpct)
-            if [ ! -z "${2##*[!0-9]*}" ] ; then
+            if [ -n "${2##*[!0-9]*}" ] ; then
                 if [[ ${2} -ge 25 && ${2} -lt 100 ]] ; then
                     SCREENPCT=${2}
                 else
@@ -1924,7 +1945,7 @@ if [ -n "${VM}" ] && [ -e "${VM}" ]; then
     VM_UP=0
     if [ -r "${VMDIR}/${VMNAME}.pid" ]; then
         VM_PID=$(head -c50 "${VMDIR}/${VMNAME}.pid")
-        kill -0 ${VM_PID} 2>&1 >/dev/null
+        kill -0 ${VM_PID} > /dev/null 2>&1
         if [ $? -eq 0 ]; then
             echo "VM already started!"
             VM_UP=1