PlusMagi's Blog By Pitt Phunsanit Cloud Computing Shell Script: ดูการตั้งค่า GitHub Actions สำหรับรัน ShellCheck บน CI

Shell Script: ดูการตั้งค่า GitHub Actions สำหรับรัน ShellCheck บน CI

ในโลกของการพัฒนาซอฟต์แวร์ที่ต้องอาศัยระบบ Automation อย่างสูง การรักษาคุณภาพโค้ด (Code Quality) และการตรวจจับข้อผิดพลาดตั้งแต่เนิ่นๆ เป็นหัวใจสำคัญของ DevOps Pipeline เครื่องมือวิเคราะห์แบบคงที่ (Static Analysis Tools) เช่น ShellCheck ได้กลายเป็นมาตรฐานในการตรวจสอบสคริปต์ Bash เพื่อให้มั่นใจว่าทุกคำสั่งทำงานได้อย่างถูกต้อง ปลอดภัย และเป็นไปตาม Best Practices บทความนี้จะเจาะลึกวิธีการบูรณาการกระบวนการ Linting ของ ShellScript เข้ากับ GitHub Actions CI Pipeline อย่างเป็นระบบ ทำให้คุณสามารถรันการตรวจสอบเหล่านี้ได้โดยอัตโนมัติเมื่อมีการ Push หรือ Pull Request ใด ๆ

ทำไมต้องใช้ ShellCheck ใน CI/CD Pipeline

Shell scripts คือรากฐานของการทำงานอัตโนมัติบนระบบปฏิบัติการ Linux แต่เนื่องจากไวยากรณ์ของ Bash นั้นมีความยืดหยุ่นสูง (Loose Syntax) ทำให้ข้อบกพร่องเล็กน้อยเพียงจุดเดียว เช่น การจัดการตัวแปร (Variable Scope) หรือการอ้างอิงคำสั่งที่ผิดพลาด อาจทำให้ Job ล่มหรือเกิดช่องโหว่ด้านความปลอดภัยได้ ShellCheck จึงทำหน้าที่เป็นผู้รีวิวโค้ดที่มีประสบการณ์สูง มันไม่เพียงแต่แจ้งเตือนเรื่อง Syntax Error เท่านั้น แต่ยังชี้ถึง Potential Security Vulnerabilities, Best Practices, และรูปแบบโครงสร้างที่ไม่แนะนำ ซึ่งเป็นการยกระดับมาตรฐานโค้ดของเราตามหลักการ Shift-Left Testing อย่างแท้จริง

ขั้นตอนที่ 1: การตั้งค่า Workflow YAML สำหรับ GitHub Actions

ในการเริ่มใช้งาน เราจำเป็นต้องกำหนดไฟล์ workflow ย่อยในตำแหน่ง .github/workflows/ci-check.yml เพื่อให้ Git ทราบว่าควรทำงานอะไรบ้าง โครงสร้างหลักจะประกอบด้วยการกำหนด Trigger (เมื่อไหร่ที่ควรทำงาน) และ Job (ขั้นตอนการทำงาน) ซึ่งในที่นี้เราจะจำลองการรัน ShellCheck และตามด้วยการตรวจสอบความสมบูรณ์ของ Schema ฐานข้อมูล PostgreSQL เพื่อให้มั่นใจว่าทั้งโค้ดและโครงสร้างข้อมูลมีความถูกต้อง

YAML

name: Code Quality Check\n
on: [push, pull_request]\njobs:\n  shellcheck_and_db_check:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - name: Install ShellCheck\n        run: |\n          sudo apt-get install -y shellcheck\n      - name: Run ShellCheck on Scripts\n        run: shellcheck scripts/setup_env.sh\n      - name: Validate PostgreSQL Schema Integrity\n        run: |\n          psql -h localhost -U user -d dbname -c "SELECT count(*) FROM public.user_data WHERE user_id IN ('1', '2', '3');"\n

ขั้นตอนที่ 2: การตรวจสอบความสมบูรณ์ของ PostgreSQL Schema ใน CI

แม้ว่า ShellCheck จะเน้นที่ Bash Script แต่ในระบบที่ซับซ้อน โค้ดส่วนใหญ่มักจะมีการเรียกใช้ฐานข้อมูล PostgreSQL การเพิ่มขั้นตอนการตรวจสอบความสมบูรณ์ของ Schema หรือการรัน Query ที่สำคัญใน CI จะช่วยให้เรามั่นใจว่าแม้สคริปต์จะรันได้ แต่ข้อมูลที่จำเป็นก็พร้อมใช้งานเสมอ นี่คือตัวอย่างการใช้คำสั่ง psql ภายใน CI เพื่อตรวจสอบว่ามีข้อมูลสำคัญครบถ้วนหรือไม่:

สมมติว่าเราต้องการตรวจสอบว่าตาราง user_data มีข้อมูลผู้ใช้หลักครบ 3 รายการหรือไม่ เราสามารถใช้คำสั่ง SQL ต่อไปนี้:

SQL

SELECT count(DISTINCT user_id) FROM public.user_data WHERE created_at >= current_date - interval '30 days';

หาก Query นี้ส่งค่า 0 กลับมา นั่นหมายความว่าไม่มีข้อมูลใหม่ใน 30 วัน ซึ่งถือเป็น Failure ในมุมมองของ CI Pipeline ทำให้การ Deploy ถูกระงับโดยอัตโนมัติ

บทสรุป: การสร้าง Pipeline ที่แข็งแกร่ง

การบูรณาการ ShellCheck เข้ากับ GitHub Actions ไม่ได้เป็นเพียงแค่การรันเครื่องมือ แต่เป็นการสร้างเกราะป้องกันคุณภาพโค้ดตั้งแต่ต้นทาง (Shift-Left Security) การรวมการตรวจสอบ Bash Script เข้ากับการตรวจสอบความสมบูรณ์ของ Schema PostgreSQL ในขั้นตอนเดียวกัน ทำให้มั่นใจได้ว่าระบบ Automation ของคุณมีความน่าเชื่อถือสูง ทั้งในด้านไวยากรณ์ของสคริปต์ และความพร้อมของข้อมูลที่จำเป็นต่อการทำงานใน Production Environment อย่างสมบูรณ์