Merge pull request #2 from DanLinX2004X/feature/ci-pipeline

DanLinX2004X · web-flow · commit b846d2fad2d0 · 2025-11-05T22:12:00.000+03:00
Fix system-monitor.sh warnings &amp; add CI
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,46 @@
+name: Bash CI
+
+on:
+  push:
+    branches: [main, feature/ci-pipeline]
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
+
+jobs:
+  bash-checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Syntax check
+        run: bash -n system-monitor.sh
+
+      - name: Run Shellcheck
+        uses: ludeeus/action-shellcheck@master
+        continue-on-error: true
+
+      - name: Verify dependencies
+        run: |
+          for cmd in awk grep free df ps bc ip; do
+            if ! command -v $cmd &>/dev/null; then
+              echo "Missing dependency: $cmd"
+              exit 1
+            fi
+          done
+
+      - name: Help/version flags test
+        run: |
+          chmod +x system-monitor.sh
+          ./system-monitor.sh --help | grep "Usage"
+          ./system-monitor.sh --version | grep "version"
+
+      - name: Smoke test
+        run: |
+          ./system-monitor.sh --brief | grep "cpu_load"
diff --git a/README.md b/README.md
@@ -227,7 +227,7 @@ Add a line for hourly monitoring (runs at the beginning of each hour):**
     
 - Cron runs with a minimal environment - test thoroughly
 
-### 🐳 **Docker Container Monitoring**
+### 🐳 Docker Container Monitoring
 
 You can use this script to monitor resources inside Docker containers.
 
@@ -283,7 +283,7 @@ docker exec postgres-container /tmp/system-monitor.sh --brief
 - Some **system metrics** may not be available in containers
     
 
-### 🔄 **Alternative: Run from host system**
+### 🔄 *lternative: Run from host system
 
 You can also monitor containers from the host system:
 
@@ -297,18 +297,33 @@ docker exec container_name cat /proc/loadavg
 docker exec container_name free -h
 ```
 
+## ⚙️ CI Integration & ShellCheck Fixes
+
+- Continuous Integration (CI): Added GitHub Actions workflow to automatically check the script on every push and pull request.
+	- Syntax check (bash -n)
+	- ShellCheck validation
+	- Dependency verification (awk, grep, free, df, ps, bc, ip)
+	- Smoke tests & basic flag tests (--help, --version, --brief)
+- ShellCheck Warnings: Fixed all warnings in system-monitor.sh to ensure clean, maintainable code.
+	- Quotes around variables
+	- Separate declaration and assignment for local variables
+	- Word splitting issues resolved
+
+> ✅ CI ensures that every future change maintains script correctness and readability.
+
+
 ## 🤝 Contributing
 
 If you'd like to suggest improvements or report issues:
 
-### 📝 **Easiest Way (Recommended):**
+### 📝 Easiest Way (Recommended):
 
 1. **Create an Issue** on GitHub - describe your idea or problem
     
 2. **I'll implement the changes** myself and credit you in the commits
     
 
-### 💻 **For Advanced Users (if familiar with Git):**
+### 💻 For Advanced Users (if familiar with Git):
 
 1. **Fork the repository** (click "Fork" in the top-right corner)
     
@@ -317,7 +332,7 @@ If you'd like to suggest improvements or report issues:
 3. **Create a Pull Request** - I'll review and merge your changes
     
 
-### 🐛 **Reporting Bugs:**
+### 🐛 Reporting Bugs:
 
 In your Issue, please include:
 
@@ -330,7 +345,7 @@ In your Issue, please include:
 - What you expected to see
     
 
-### 💡 **Improvement Ideas:**
+### 💡 Improvement Ideas:
 
 - Add CPU temperature monitoring
     
diff --git a/README.ru.md b/README.ru.md
@@ -277,7 +277,7 @@ docker exec postgres-container /tmp/system-monitor.sh --brief
     
 - Некоторые **системные метрики** могут быть недоступны в контейнерах
 
-### 🔄 **Альтернатива: Запуск с хостовой системы**
+### 🔄 Альтернатива: Запуск с хостовой системы
 
 Вы также можете мониторить контейнеры с хостовой системы:
 
@@ -290,18 +290,33 @@ docker exec имя_контейнера cat /proc/loadavg
 docker exec имя_контейнера free -h
 ```
 
+## ⚙️ Интеграция CI и исправления ShellCheck
+
+- Непрерывная интеграция (CI): Добавлен workflow GitHub Actions для автоматической проверки скрипта при каждом push и pull request:
+	- Проверка синтаксиса (bash -n)
+	- Валидация через ShellCheck
+	- Проверка зависимостей (awk, grep, free, df, ps, bc, ip)
+	- Smoke-тесты и базовая проверка флагов (--help, --version, --brief)
+- Предупреждения ShellCheck: Исправлены все предупреждения в system-monitor.sh для чистого и поддерживаемого кода:
+	- Кавычки вокруг переменных
+	- Раздельное объявление и присвоение локальных переменных
+	- Решены проблемы с разбиением слов
+
+> ✅ CI гарантирует, что будущие изменения будут поддерживать корректность и читаемость скрипта.
+
+
 ## 🤝 Участие в разработке
 
 Если вы хотите предложить улучшение или сообщить об ошибке:
 
-### 📝 **Самый простой способ (рекомендуется):**
+### 📝 Самый простой способ (рекомендуется):
 
 1. **Напишите Issue** на GitHub - опишите идею или проблему
     
 2. **Я сам внесу изменения** и упомяну вас в коммитах
     
 
-### 💻 **Для продвинутых (если знакомы с Git):**
+### 💻 Для продвинутых (если знакомы с Git):
 
 1. **Сделайте Fork** репозитория (кнопка "Fork" в правом верхнем углу)
     
@@ -310,7 +325,7 @@ docker exec имя_контейнера free -h
 3. **Создайте Pull Request** - я проверю и добавлю ваши изменения
     
 
-### 🐛 **Сообщение об ошибках:**
+### 🐛 Сообщение об ошибках:
 
 В Issue укажите:
 
@@ -323,7 +338,7 @@ docker exec имя_контейнера free -h
 - Что вы ожидали увидеть
     
 
-### 💡 **Идеи для улучшений:**
+### 💡 Идеи для улучшений:
 
 - Добавление мониторинга температуры CPU
     
diff --git a/system-monitor.sh b/system-monitor.sh
@@ -135,15 +135,17 @@ colorize() {
 
 # --- CPU Metrics Collection ---
 get_cpu_metrics() {
-    local loadavg=$(cat /proc/loadavg 2>/dev/null)
+    local loadavg
+    loadavg=$(cat /proc/loadavg 2>/dev/null)
     if [ -n "$loadavg" ]; then
         CPU_LOAD_1MIN=$(echo "$loadavg" | awk '{print $1}')
         CPU_LOAD_5MIN=$(echo "$loadavg" | awk '{print $2}')
         CPU_LOAD_15MIN=$(echo "$loadavg" | awk '{print $3}')
         CPU_CORES=$(nproc 2>/dev/null || echo "1")
 
         # Calculate load as percentage of CPU cores
-        local load_percent=$(echo "scale=0; ($CPU_LOAD_1MIN * 100) / $CPU_CORES" | bc 2>/dev/null)
+        local load_percent
+        load_percent=$(echo "scale=0; ($CPU_LOAD_1MIN * 100) / $CPU_CORES" | bc 2>/dev/null)
         CPU_LOAD_PERCENT=${load_percent:-0}
     else
         CPU_LOAD_1MIN="N/A"
@@ -156,7 +158,8 @@ get_cpu_metrics() {
 
 # --- Memory Metrics Collection ---
 get_memory_metrics() {
-    local mem_info=$(free -b 2>/dev/null | grep Mem)
+    local mem_info
+    mem_info=$(free -b 2>/dev/null | grep Mem)
     if [ -n "$mem_info" ]; then
         MEM_TOTAL=$(echo "$mem_info" | awk '{printf "%.2f", $2/1024/1024/1024}')
         MEM_USED=$(echo "$mem_info" | awk '{printf "%.2f", $3/1024/1024/1024}')
@@ -172,7 +175,8 @@ get_memory_metrics() {
 
 # --- Disk Metrics Collection ---
 get_disk_metrics() {
-    local disk_info=$(df -B1 / 2>/dev/null | awk 'NR==2')
+    local disk_info
+    disk_info=$(df -B1 / 2>/dev/null | awk 'NR==2')
     if [ -n "$disk_info" ]; then
         DISK_USED=$(echo "$disk_info" | awk '{printf "%.1f", $3/1024/1024/1024}')
         DISK_AVAILABLE=$(echo "$disk_info" | awk '{printf "%.1f", $4/1024/1024/1024}')
@@ -191,11 +195,14 @@ get_disk_metrics() {
 # --- Network Metrics Collection ---
 get_network_metrics() {
     # Get primary network interface (route to Google DNS)
-    local interface=$(ip route get 8.8.8.8 2>/dev/null | awk '{print $5}' | head -1)
+    local interface
+    interface=$(ip route get 8.8.8.8 2>/dev/null | awk '{print $5}' | head -1)
     if [ -n "$interface" ] && [ "$interface" != "dev" ]; then
         NET_INTERFACE="$interface"
-        local rx_bytes=$(cat "/sys/class/net/$interface/statistics/rx_bytes" 2>/dev/null)
-        local tx_bytes=$(cat "/sys/class/net/$interface/statistics/tx_bytes" 2>/dev/null)
+        local rx_bytes
+        rx_bytes=$(cat "/sys/class/net/$interface/statistics/rx_bytes" 2>/dev/null)
+        local tx_bytes
+        tx_bytes=$(cat "/sys/class/net/$interface/statistics/tx_bytes" 2>/dev/null)
 
         NET_RX_MB=$(echo "scale=2; ${rx_bytes:-0} / 1024 / 1024" | bc 2>/dev/null)
         NET_TX_MB=$(echo "scale=2; ${tx_bytes:-0} / 1024 / 1024" | bc 2>/dev/null)
@@ -259,14 +266,14 @@ print_detailed_stats() {
     # CPU Information
     echo -e "${BLUE}==== CPU LOAD ====${NC}"
     echo -e "CPU Cores: $CPU_CORES"
-    echo -e "Load Average: 1min: $(colorize $CPU_LOAD_1MIN 1 2) | 5min: $(colorize $CPU_LOAD_5MIN 1 2) | 15min: $(colorize $CPU_LOAD_15MIN 1 2)"
-    echo -e "System Load: $(colorize ${CPU_LOAD_PERCENT}% 70 90)"
+    echo -e "Load Average: 1min: $(colorize "$CPU_LOAD_1MIN" 1 2) | 5min: $(colorize "$CPU_LOAD_5MIN" 1 2) | 15min: $(colorize "$CPU_LOAD_15MIN" 1 2)"
+    echo -e "System Load: $(colorize "${CPU_LOAD_PERCENT}"% 70 90)"
     echo
 
     # Memory Information
     echo -e "${BLUE}==== MEMORY USAGE ====${NC}"
     echo -e "Total: ${MEM_TOTAL} GB"
-    echo -e "Used: $(colorize "${MEM_USED} GB" $(echo "scale=0; $MEM_TOTAL * 0.7" | bc 2>/dev/null) $(echo "scale=0; $MEM_TOTAL * 0.9" | bc 2>/dev/null))"
+    echo -e "Used: $(colorize "${MEM_USED} GB" "$(echo "scale=0; $MEM_TOTAL * 0.7" | bc 2>/dev/null)" "$(echo "scale=0; $MEM_TOTAL * 0.9" | bc 2>/dev/null)")"
     echo -e "Available: ${MEM_AVAILABLE} GB"
     echo -e "Usage: $(colorize "${MEM_PERCENT}%" 70 90)"
     echo
@@ -341,7 +348,7 @@ main() {
             echo
 
             # Sleep with interrupt checking
-            for ((i=0; i<INTERVAL && EXIT_SIGNAL==false; i++)); do
+            while [ "$EXIT_SIGNAL" = false ]; do
                 sleep 1
             done
         done
