Bash/debugging Bash scripts

التنقيح على مستوى البرنامج ككل

حين تحدث مشكلة في البرنامج الذي كتبته فإنك في حاجة إلى وضع يدك على مكان المشكلة بالتحديد داخل الشيفرة، وتوفر Bash مزايا تنقيح شاملة لعل أشهرها هو بدء صدفة فرعية بخيار x- الذي سيبدأ الصدفة بالكامل في طور التنقيح، وستُطبَع آثار كل أمر إضافة إلى وسائطه (arguments) إلى خَرج قياسي (standard output) بعد توسيع الأوامر لكن قبل تنفيذها.

الشيفرة التالية هي لبرنامج commented-script1.sh من مثال أساسيات كتابة برامج Bash، وقد استدعينا الصدفة في طور التنقيح (debug mode)، لاحظ أن التعليقات المضافة ليست مرئية في خرج البرنامج:

os@inspiron:~/scripts$ bash -x script1.sh
+ clear

+ echo 'The script starts now.'
The script starts now.
+ echo 'Hi, os!'
Hi, os!
+ echo

+ echo 'I will now fetch you a list of connected users:'
I will now fetch you a list of connected users:
+ echo

+ w
 13:46:40 up 24 min,  1 user,  load average: 0.54, 0.33, 0.23
USER     TTY      FROM             LOGIN@   IDLE   JCPU   PCPU WHAT
os       tty7     :0               13:22   23:56  24.22s  0.21s /usr/li
+ echo

+ echo 'I'\''m setting two variables now.'
I'm setting two variables now.
+ COLOUR=black
+ VALUE=9
+ echo 'This is a string: black'
This is a string: black
+ echo 'And this is a number: 9'
And this is a number: 9
+ echo

+ echo 'I'\''m giving you back your prompt now.'
I'm giving you back your prompt now.
+ echo

os@inspiron:~/scripts$

ويوجد الآن منقِّح للصدفة به مزايا متطورة متاح على SourceForge، وتلك المزايا موجودة في أغلب الإصدارات الحديثة في الصدفة بدءًا من إصدار 3.1 .

تنقيح أجزاء من الصدفة

لنقل أنك لا تعرف ما يفعله أمر w في مثال commented-script1.sh، فنستخدم حينها أمر set لتشغيل البرنامج في الوضع العادي للأجزاء التي نعرف أنها بدون أخطاء، وعرض معلومات تنقيح عن الأجزاء التي بها مشاكل فقط، ففي مثالنا هنا نريد أن نعرف وظيفة أمر w، فنضع إشارة بدء التنقيح قبله وإنهاء التنقيح بعده، كما يلي:

set -x			# بدء التنقيح من هنا
w
set +x			# إيقاف التنقيح من هنا

وسيكون خرج البرنامج هكذا:

os@inspiron:~/scripts$ commented-script1.sh

The script starts now.
Hi, os!

I will now fetch you a list of connected users:

+ w
 16:15:53 up  2:10,  1 user,  load average: 1.27, 1.47, 1.11
USER     TTY      FROM             LOGIN@   IDLE   JCPU   PCPU WHAT
os       tty7     :0               14:05    2:10m  1:34   0.21s /usr/li
+ set +x

I'm setting two variables now.
This is a string: black
And this is a number: 9

I'm giving you back your prompt now.

os@inspiron:~/scripts$

تستطيع إيقاف وتشغيل وضع التنقيح كما تشاء داخل نفس البرنامج بدون حد أقصى لمرات استخدامه. انظر الجدول أدناه حيث تجد بعض الخيارات المفيدة للصدفة:

نظرة عامة على خيارات أمر التنقيح set

الشكل المختصر	الشكل المفصّل	النتيجة
set -f	set -o noglob	يعطل توليد اسم الملف باستخدام المحارف الخاصة (التجميع globbing).
st -v	set -o verbose	يطبع أسطر مدخلات الصدفة كما تُقرأ.
set -x	set -o xtrace	يطبع آثار الأمر قبل تنفيذه.

تُستخدم الشَّرطة - لتفعيل خيار الصدفة وعلامة الإضافة + لإيقاف تفعيلها، انتبه كي لا تخلط بين العلامتين. انظر المثال التالي لتوضيح استخدامهما:

os@inspiron:~/scripts$ set -v

os@inspiron:~/scripts$ ls
ls
commented-scripts.sh	script1.sh

os@inspiron:~/scripts$ set +v
set +v

os@inspiron:~/scripts$ ls *
commented-script1.sh  script1.sh

os@inspiron:~/scripts$ set -f

os@inspiron:~/scripts$ ls *
ls: cannot access '*': No such file or directory

os@inspiron:~/scripts$ touch *

os@inspiron:~/scripts$ ls
*  commented-script1.sh  script1.sh

os@inspiron:~/scripts$ rm *

os@inspiron:~/scripts$ ls
commented-script1.sh  script1.sh

os@inspiron:~/scripts$

ويمكنك تحديد تلك الأوضاع داخل شيفرة البرنامج نفسه بإضافة الخيارات التي تريدها إلى تصريح الصدفة في السطر الأول -يمكنك جمع الخيارات معًا تمامًا مثل أوامر يونكس- :

#!/bin/bash -xv

وبمجرد أن تجد ذلك الجزء الذي يسبب مشكلة في شيفرتك، يمكنك حينها أن تضع أمر echo لعرض محتويات المتغيرات في مراحل مختلفة من الشيفرة كي تضع يدك على الأخطاء:

echo "Variable VARNAME is now set to $VARNAME."

ملخص

برنامج الصدفة هو سلسلة من الأوامر يعاد استخدامها بشكل متكرر، ووُضعت في ملف نصي له إذن تنفيذ كبرنامج، ويمكن استخدام أي محرر نصي لكتابة برامج لصدفة Bash.

تبدأ برامج bash بـ !# متبوعيْن بمسار الصفة التي ستنفذ الأوامر التي ستُكتب في البرنامج، وتضاف التعليقات إلى البرنامج للمرجعية فيما بعد ولتيسير فهم الشيفرة على من يقرؤها. يُفضل الإسهاب في التعليقات داخل برامج الصدفة على الإيجاز فيها.

تُنقَّح الصدفة باستخدام خيارات الصدفة، ويمكن استخدام تلك الخيارات للتنقيح الجزئي أو لتحليل الشيفرة كاملة، كما أن من الشائع إدخال أمر echo في الأماكن التي يُشتبه فيها العطل من أجل طباعة بيانات عما يحدث في تلك الأماكن.

انظر أيضًا

• أنواع المتغيرات في Bash.
• المصفوفات في Bash.
• التعابير النمطية في Bash.

مصادر

• دليل Bash للمبتدئين. فصل 2.3، تنقيح برامج Bash.

• دليل Bash للمبتدئين. فصل 2.4، ملخص.