Bash การดีบักสคริปต์



สคริปต์พังแล้วไม่รู้ว่าพังตรงไหน — Bash มีเครื่องมือดีบักในตัวที่ทรงพลัง และ ShellCheck ที่จับบั๊กได้ก่อนรันด้วยซ้ำ บทนี้รวมทั้งหมด

bash -x — ดูทุกคำสั่งที่รัน

bash -x ./script.sh arg1 arg2

พิมพ์แต่ละคำสั่ง หลังจาก expansion เสร็จ ก่อนรัน — เห็นค่าจริงของตัวแปร

+ src=/home/somchai/data
+ dst=/backup
+ [[ -d /home/somchai/data ]]
+ mkdir -p /backup
+ cp -a /home/somchai/data /backup

+ นำหน้าคือบรรทัด trace (ระดับความลึกของ + = ระดับ nesting)

เปิด/ปิดเฉพาะช่วงในสคริปต์

set -x                           # เปิด trace
problematic_section
set +x                           # ปิด

# หรือรันฟังก์ชันเดียวแบบ verbose
( set -x; suspicious_function )

PS4 — ทำให้ trace อ่านออก

ค่าปริยายของ PS4 คือ + — เพิ่มข้อมูลได้เยอะ

export PS4='+ ${BASH_SOURCE##*/}:${LINENO}:${FUNCNAME[0]:-main}: '
bash -x ./script.sh
+ script.sh:12:main: src=/home/somchai/data
+ script.sh:18:backup_files: tar -czf /backup/data.tar.gz .

เห็นไฟล์ บรรทัด และฟังก์ชัน — หาต้นตอได้เร็วขึ้นมาก ใส่ไว้ใน ~/.bashrc เลยก็ได้

เพิ่มเวลา (หา bottleneck)

export PS4='+ $(date "+%H:%M:%S.%3N") ${LINENO}: '

set -v — แสดง source ก่อน expansion

set -v          # พิมพ์บรรทัดตามที่เขียน (ยังไม่แทนตัวแปร)
set -x          # พิมพ์บรรทัดหลังแทนตัวแปร

set -xv         # ทั้งคู่ — เห็นทั้ง "เขียนอะไร" และ "กลายเป็นอะไร"

-v มีประโยชน์เวลาอยากรู้ว่าบรรทัดไหนกำลังถูกอ่าน (เช่น heredoc, quoting ซับซ้อน)

bash -n — ตรวจ syntax ไม่รัน

bash -n ./script.sh              # เช็คว่ามี fi/done/esac ครบ, quote ปิด ฯลฯ

รันใน CI ก่อน deploy — จับ fi ที่ลืม, " ที่ไม่ปิด, do ที่ไม่มี done โดยไม่ต้องรันสคริปต์จริง (ปลอดภัย)

# pre-commit hook
for f in $(git diff --cached --name-only --diff-filter=d | grep '\.sh$'); do
    bash -n "$f" || exit 1
done

ข้อจำกัด: -n ไม่จับ error เชิงตรรกะ (ตัวแปรพิมพ์ผิด, quote ที่ถูกต้อง syntax แต่ผิดความหมาย) — นั่นคืองานของ ShellCheck

ShellCheck — ต้องมี

sudo apt install shellcheck
shellcheck ./script.sh

ShellCheck วิเคราะห์สคริปต์แบบ static (ไม่รัน) และชี้บั๊กพร้อมคำอธิบาย + ลิงก์

In script.sh line 8:
rm -rf $TMPDIR/*
       ^-- SC2086: Double quote to prevent globbing and word splitting.

In script.sh line 15:
if [ $count = 5 ]; then
     ^-- SC2086 ...
        ^-- SC2050: This expression is constant...

SC code ที่เจอบ่อยที่สุด

SCปัญหาแก้
SC2086$var ไม่ครอบ quote"$var"
SC2046$(cmd) ไม่ครอบ quote"$(cmd)" หรือ mapfile
SC2164cd ไม่เช็ก errorcd x || exit
SC2155local x=$(cmd) กลบ exit statuslocal x; x=$(cmd)
SC2181เช็ก $? แทนเช็กคำสั่งตรง ๆif cmd; then
SC2115rm -rf "$x/" เสี่ยงตอน $x ว่างrm -rf "${x:?}/"
SC2006ใช้ backticks$(...)
SC2154ตัวแปรอ้างถึงแต่ไม่เคยตั้งตรวจการสะกด / source

ปิดคำเตือนเฉพาะจุด (เมื่อมั่นใจว่าตั้งใจ)

# shellcheck disable=SC2086
echo $intentional_word_split       # ตั้งใจให้แตกเป็นหลายอาร์กิวเมนต์

# ปิดทั้งไฟล์ (บนสุด หลัง shebang)
# shellcheck disable=SC2086,SC2046

# บอก ShellCheck ว่า source ไฟล์ไหน
# shellcheck source=lib/common.sh
source "$script_dir/lib/common.sh"

รันใน CI

shellcheck --severity=warning --format=gcc ./*.sh
find . -name '*.sh' -exec shellcheck {} +

integrate กับ editor (VS Code: extension “ShellCheck”, vim: ALE) — เห็น warning ขณะพิมพ์

trap DEBUG — step ทีละคำสั่ง

trap 'read -rp "[${LINENO}] $BASH_COMMAND — Enter เพื่อรันต่อ" _ </dev/tty' DEBUG

หยุดก่อนทุกคำสั่ง รอ Enter — poor man’s debugger ปิดด้วย trap - DEBUG

caller และ BASH_LINENO — stack trace

print_stack() {
    local i
    echo "Stack trace:" >&2
    for (( i = 1; i < ${#FUNCNAME[@]}; i++ )); do
        echo "  ${FUNCNAME[$i]}() ที่ ${BASH_SOURCE[$i]}:${BASH_LINENO[$i-1]}" >&2
    done
}

trap 'print_stack' ERR

bashdb — debugger เต็มรูปแบบ

sudo apt install bashdb
bashdb ./script.sh
# คำสั่ง: step, next, break, print, continue (คล้าย gdb)

ใช้น้อย — bash -x + ShellCheck ครอบคลุม 95% ของกรณี

workflow ดีบักที่แนะนำ

  1. ShellCheck ก่อนเสมอ — แก้ทุก warning หรือ disable อย่างมีเหตุผล
  2. bash -n — syntax ผ่านไหม
  3. รันด้วย bash -x + PS4 ที่มีบรรทัด — ดูว่าค่าตัวแปรตรงที่คิดไหม
  4. แคบลง — set -x/set +x ครอบเฉพาะส่วนที่สงสัย
  5. ถ้ายังงง — trap DEBUG step ทีละบรรทัด หรือใส่ echo "DEBUG: x=$x" >&2 ชั่วคราว

เรื่องที่คนมักพลาด

  • ไม่รัน ShellCheck — มันจับบั๊กที่ตามองข้ามครึ่งหนึ่ง ติดตั้งและใช้ทุกครั้ง
  • bash -x แล้วอ่าน trace ไม่ออก — ตั้ง PS4='+ ${LINENO}: ' ให้มีเลขบรรทัด
  • echo debug แล้วลืมลบ — ใช้ >&2 และ prefix DEBUG: ให้ grep ออกง่าย หรือใช้ฟังก์ชัน debug() ที่ปิดได้
  • set -x ทั้งสคริปต์ยาว — trace ท่วมจอ ครอบเฉพาะส่วนที่สงสัย
  • # shellcheck disable ทั้งไฟล์เพราะขี้เกียจ — เสียประโยชน์ แก้ทีละอันดีกว่า
  • bash -n แล้วคิดว่าปลอดภัยแล้ว — -n เช็กแค่ syntax ไม่ใช่ตรรกะ
  • debug บน production — copy ไปทดสอบที่อื่น หรือใช้ --dry-run (บทที่ 39)

สรุป

  • bash -x script.sh หรือ set -x/set +x — เห็นทุกคำสั่งหลัง expansion
  • PS4='+ ${BASH_SOURCE##*/}:${LINENO}: ' — ทำให้ trace บอกไฟล์+บรรทัด
  • bash -n — ตรวจ syntax โดยไม่รัน (ใส่ใน pre-commit / CI)
  • ShellCheck — static analysis จับบั๊กก่อนรัน (SC2086 = ครอบ quote, SC2155 = local x=$())
  • # shellcheck disable=SCxxxx ปิดเฉพาะจุดเมื่อมั่นใจ
  • trap DEBUG step ทีละคำสั่ง, FUNCNAME/BASH_LINENO ทำ stack trace
  • workflow: ShellCheck → bash -n → bash -x → แคบด้วย set -x → trap DEBUG

บทถัดไปว่าด้วยโครงสร้างสคริปต์ที่ดี — template ที่ก๊อปไปใช้ได้ พร้อม main(), usage(), constants