فصل ۳۰: عیبیابی و رفع خطا
با افزایش پیچیدگی اسکریپتها، مدیریت و شناسایی خطاهای احتمالی اهمیتی دوچندان مییابد. در این فصل، به بررسی دستهبندیهای رایج خطا در اسکریپتنویسی پوسته میپردازیم و تکنیکهای کارآمدی را برای شناسایی (Debugging) و رفع این اختلالات مرور خواهیم کرد.
خطاهای نحوی (Syntax Errors) #
یکی از رایجترین دستههای خطا، «خطاهای نحوی» هستند که بر اثر اشتباه در نگارش ساختارهای دستوریِ پوسته پدید میآیند. مفسر پوسته به محض مواجهه با چنین خطاهایی، فرآیند اجرای اسکریپت را متوقف میکند. برای نمایش انواع متداول این خطاها، از اسکریپت نمونهی زیر استفاده میکنیم:
#!/bin/bash
# trouble: script to demonstrate common errors
number=1
if [ $number = 1 ]; then
echo "Number is equal to 1."
else
echo "Number is not equal to 1."
fi
این اسکریپت در وضعیت فعلی، بدون هیچگونه نقص فنی اجرا میشود:
[me@linuxbox ~]$ trouble
Number is equal to 1.
خطاهای کاراکتر کوتیشن #
اکنون اسکریپت را ویرایش کرده و کاراکتر کوتیشن پایانی را در آرگومان دستور echo اول حذف میکنیم:
#!/bin/bash
# trouble: script to demonstrate common errors
number=1
if [ $number = 1 ]; then
echo "Number is equal to 1.
else
echo "Number is not equal to 1."
fi
خروجی مفسر پس از اجرا به این صورت خواهد بود:
[me@linuxbox ~]$ trouble
/home/me/bin/trouble: line 10: unexpected EOF while looking for matching `"'
/home/me/bin/trouble: line 13: syntax error: unexpected end of file
مشاهده میکنید که دو خطا تولید شده است. نکتهی قابلتأمل اینجاست که شماره خطوط گزارششده در
پیامهای خطا، دقیقاً به محل حذف کوتیشن اشاره ندارند، بلکه نقاطی بسیار جلوتر در برنامه را نشان
میدهند. با تحلیل رفتار مفسر، علت این موضوع مشخص میشود: Bash پس از مواجهه با کوتیشنِ باز،
تمام نویسههای بعدی را به عنوان بخشی از رشته در نظر میگیرد تا زمانی که به یک کوتیشنِ بسته
برسد؛ در این مثال، مفسر اولین کوتیشنِ بسته را در دستور echo دوم مییابد. در نتیجه، ساختار دستور
if از هم میپاشد، چرا که کلمهی کلیدی fi اکنون در میان یک رشتهی متنیِ ناتمام محصور شده است.
در اسکریپتهای طولانی و پیچیده، ردیابی این قبیل خطاها میتواند بسیار دشوار باشد. استفاده از ویرایشگرهای متنی که از قابلیت برجستهسازی نحو (Syntax Highlighting) پشتیبانی میکنند، کمک شایانی به رفع این مشکل میکند؛ زیرا رشتههای متنی را با رنگی متفاوت از دستورات اصلی پوسته نمایش میدهند. چنانچه نسخهی کامل ویرایشگر vim بر روی سیستم شما نصب است، میتوانید با وارد کردن دستور زیر در محیط برنامه، این قابلیت را فعال کنید:
:syntax on
خطاهای توکنهای مفقود یا غیرمنتظره #
یکی دیگر از اشتباهات رایج در اسکریپتنویسی، عدم تکمیل صحیح دستورات مرکب (Compound Commands)
نظیر if یا while است. برای درک بهتر، پیامد حذف علامت سمیکالن
(;) را که پس از بخش شرطی در دستور if قرار میگیرد، بررسی میکنیم:
#!/bin/bash
# trouble: script to demonstrate common errors
number=1
if [ $number = 1 ] then
echo "Number is equal to 1."
else
echo "Number is not equal to 1."
fi
خروجی مفسر به شرح زیر خواهد بود:
[me@linuxbox ~]$ trouble
/home/me/bin/trouble: line 9: syntax error near unexpected token `else'
/home/me/bin/trouble: line 9: `else'
در اینجا نیز مشاهده میشود که پیام خطا به نقطهای اشاره دارد که پس از رخدادِ خطای واقعی واقع شده است.
تحلیل فرآیند مفسر در این حالت بسیار حائز اهمیت است. همانطور که میدانیم، ساختار
if فهرستی از دستورات را پذیرفته و وضعیت خروج (Exit Status) آخرین دستور را ارزیابی
میکند. در اسکریپت فوق، هدف ما این است که فهرست دستورات تنها شامل دستور ] (که
معادل و مترادف دستور test است) باشد. این دستور، پارامترهای پس از خود را به عنوان
فهرستی از آرگومانها دریافت میکند که در اینجا شامل چهار مورد است:
$number و = و 1 و ]
با حذف سمیکالن، کلمهی کلیدی then به اشتباه به عنوان یکی از آرگومانهای دستور
] در نظر گرفته میشود که از نظر نحوی فاقد اشکال است. متعاقباً دستور
echo نیز به عنوان دستور بعدی در فهرست دستوراتِ تحت ارزیابیِ if لحاظ
میگردد. چالش اصلی زمانی بروز میکند که مفسر به واژهی else میرسد؛ از آنجا که
پوسته این واژه را به عنوان یک کلمه رزرو شده (Reserved Word) و نه یک دستور معمولی میشناسد،
حضور آن در این موقعیت را غیرمجاز تشخیص داده و پیام خطا صادر میکند.
خطاهای بسط غیرمنتظره #
برخی خطاها در اسکریپتنویسی لینوکس بهصورت مقطعی رخ میدهند؛ به این معنا که اسکریپت در شرایط
عادی بهدرستی اجرا میشود، اما تحت شرایطی خاص و به دلیل نتایج حاصل از بسط (Expansion)، با شکست
مواجه میگردد. برای درک این موضوع، سمیکالن حذفشده در مثال قبل را بازگردانده و مقدار متغیر
number را تهی (خالی) فرض میکنیم:
#!/bin/bash
# trouble: script to demonstrate common errors
number=
if [ $number = 1 ]; then
echo "Number is equal to 1."
else
echo "Number is not equal to 1."
fi
اجرای اسکریپت با این تغییر، خروجی زیر را تولید میکند:
[me@linuxbox ~]$ trouble
/home/me/bin/trouble: line 7: [: =: unary operator expected
Number is not equal to 1.
این پیام خطا کمی مبهم به نظر میرسد. ریشهی مشکل در نحوهی بسط متغیر number درون
دستور test (یا همان ]) نهفته است. زمانی که عبارت زیر ارزیابی میشود:
[ $number = 1 ]
از آنجا که مقدار متغیر تهی است، پس از مرحلهی بسط، دستور عملاً به شکل زیر در میآید:
[ = 1 ]
این عبارت از نظر نحوی نامعتبر است. عملگر = یک عملگر دوگانه (Binary Operator) است
و به مقادیری در هر دو طرف خود نیاز دارد؛ اما در اینجا مقدار سمت چپ مفقود است. در چنین حالتی،
دستور test به اشتباه تصور میکند با یک عملگر یگانی (Unary) مانند -z
روبروست. از آنجا که این ارزیابی با خطا مواجه میشود، دستور if وضعیت خروج غیرصفر
دریافت کرده و مطابق با آن، بخش else را اجرا میکند.
برای رفع این اختلال، کافی است آرگومانهای دستور test را محصور در دابلکوتیشن (" ") قرار دهید:
[ "$number" = 1 ]
در این حالت، پس از بسط، عبارت به شکل زیر در میآید که تعداد آرگومانهای آن صحیح است:
[ "" = 1 ]
علاوه بر متغیرهای تهی، استفاده از کوتیشن برای متغیرهایی که ممکن است حاوی فاصله (Space) باشند (مانند نام فایلها) نیز حیاتی است.
خطاهای منطقی (Logical Errors) #
برخلاف خطاهای نحوی، خطاهای منطقی مانع از اجرای اسکریپت نمیشوند؛ برنامه با موفقیت توسط مفسر پوسته اجرا میگردد، اما به دلیل نقص در طراحیِ الگوریتم، خروجی یا نتیجهی مطلوب حاصل نمیشود. اگرچه منشأ این خطاها میتواند بسیار متنوع باشد، اما در اسکریپتنویسی پوسته معمولاً با سه دستهی رایج روبرو هستیم:
-
عبارات شرطی نادرست: در بسیاری از موارد، ساختار
if/then/else بهدرستی کدگذاری نمیشود و در نتیجه منطق برنامه منحرف میگردد. این مسئله ممکن است ناشی از معکوس شدن منطقِ شرط یا در نظر نگرفتن تمام حالات ممکن (منطق ناقص) باشد. - خطاهای «یک واحد اختلاف» (Off-by-one Errors): این خطاها اغلب در حلقههایی رخ میدهند که از شمارنده (Counter) استفاده میکنند. برای مثال، برنامهنویس ممکن است فراموش کند که شمارش باید از عدد صفر شروع شود یا در نقطهای اشتباه خاتمه یابد. این ناهماهنگی منجر به تکرارِ بیش از حد یا پایان زودهنگام حلقه و از دست رفتن آخرین تکرار میشود.
- موقعیتهای پیشبینینشده: بخش عمدهای از خطاهای منطقی زمانی بروز میکنند که برنامه با دادهها یا شرایطی مواجه میشود که توسعهدهنده از قبل برای آنها تدبیری نیندیشیده است. همانطور که پیشتر اشاره شد، بسطهای غیرمنتظره (مانند نام فایلی که حاوی کاراکتر فاصله است و به اشتباه به چندین آرگومان مجزا تبدیل میشود) نمونهای بارز از این وضعیتهای پیشبینینشده در دنیای لینوکس هستند.
برنامهنویسی تدافعی (Defensive Programming) #
در توسعهی اسکریپت، اعتبارسنجی فرضیات نقشی حیاتی ایفا میکند. این رویکرد به معنای ارزیابی دقیق وضعیت خروج (Exit Status) تمامی دستورات و برنامههای بهکاررفته است. برای درک اهمیت این موضوع، یک نمونهی واقعی را بررسی میکنیم: مدیر سیستمی برای انجام عملیات نگهداری روی یک سرور حساس، اسکریپتی شامل دو خط زیر نوشت:
cd $dir_name
rm *
در نگاه اول، این دو خط فاقد ایراد فنی هستند، اما تنها به شرطی که دایرکتوریِ تعریفشده در متغیر
dir_name واقعاً وجود داشته باشد. اگر این مسیر وجود نداشته باشد، دستور
cd با خطا مواجه شده و مفسر به خط بعد میرود؛ در نتیجه، تمام فایلهای موجود در
دایرکتوری کاری فعلی (Current Working Directory) حذف میشوند. این خطای منطقی میتواند منجر به
نابودی بخشهای حیاتی سیستم شود.
برای ارتقای امنیت و پایداری این طراحی، میتوان چندین گام برداشت. نخست، با استفاده از
دابلکوتیشن، از بسط صحیح متغیر مطمئن میشویم و اجرای دستور rm را به موفقیتِ
cd منوط میکنیم:
cd "$dir_name" && rm *
با این تغییر، اگر cd شکست بخورد، rm اجرا نخواهد شد. با این حال، اگر
متغیر dir_name تعریف نشده یا خالی باشد، دستور cd ممکن است کاربر را به
دایرکتوری خانگی (Home) هدایت کند. برای جلوگیری از این سناریو، باید ابتدا وجود دایرکتوری را
احراز کنیم:
[[ -d "$dir_name" ]] && cd "$dir_name" && rm *
در اسکریپتهای حرفهای، بهترین رویکرد این است که منطقی برای توقف برنامه و گزارش خطا در صورت بروز شرایط پیشبینینشده اضافه شود:
# Delete files in directory $dir_name
if [[ ! -d "$dir_name" ]]; then
echo "No such directory: '$dir_name'" >&2
exit 1
fi
if ! cd "$dir_name"; then
echo "Cannot cd to '$dir_name'" >&2
exit 1
fi
if ! rm *; then
echo "File deletion failed. Check results" >&2
exit 1
fi
در این ساختار، ابتدا موجودیت مسیر بررسی شده و سپس موفقیتِ تغییر دایرکتوری کنترل میگردد. در صورت بروز هرگونه اختلال، یک پیام توضیحی به خروجی خطای استاندارد (stderr) ارسال شده و اسکریپت با وضعیت خروج 1 (نشانه شکست) خاتمه مییابد.
مکانیزمهای توقف خودکار: set -e، set -u و set -o PIPEFAIL #
یکی از ویژگیهای پیشفرض در پوسته bash این است که اگر دستوری در حین اجرای اسکریپت با شکست مواجه
شود (بهجز خطاهای نحوی در خودِ اسکریپت)، مفسر بدون توقف به اجرای دستور بعدی ادامه میدهد. در
بسیاری از موارد، این رفتار نامطلوب است؛ به همین دلیل استاندارد POSIX و بهتبع آن bash
راهکارهایی را برای مدیریت این وضعیت ارائه دادهاند. پوسته bash از تنظیماتی بهره میبرد که
امکان مدیریت خودکار خطاها را فراهم میکند؛ به این معنا که با فعالسازی آنها، اسکریپت به محض
بازگشت وضعیت خروج (Exit Code) غیرصفر از هر دستور (با رعایت برخی استثنائات منطقی)، متوقف
میشود.
برای فعالسازی این قابلیت، معمولاً دستور set -e در ابتدای اسکریپت قرار میگیرد.
علاوه بر این، بسیاری از استانداردهای نوین اسکریپتنویسی بر استفاده همزمان از این ویژگی و چند
تنظیم مرتبط دیگر تأکید دارند؛ از جمله set -u که در صورت ارجاع به متغیرهای
تعریفنشده (Unset) باعث توقف اسکریپت میشود، و set -o PIPEFAIL که موجب میگردد در
صورت شکست هر یک از اجزای یک پایپلاین (Pipeline)، کل فرآیند متوقف شود (برخلاف حالت پیشفرض که
فقط وضعیت خروج آخرین دستورِ پایپ ملاک است).
با این وجود، تکیه مطلق بر این ویژگیها توصیه نمیشود. رویکرد اصولی آن است که مدیریت خطا
بهصورت آگاهانه طراحی شود و نباید از set -e بهعنوان جایگزینی برای الگوهای صحیح
برنامهنویسی استفاده کرد.
در بخش پرسشهای متداول (FAQ) شماره ۱۰۵ مستندات Bash، تحلیل زیر در این باره ارائه شده است:
http://mywiki.wooledge.org/BashFAQ/105
«قابلیت set -e تلاشی برای افزودن مکانیزم "کشف خودکار خطا" به پوسته بود. هدف اصلی
این بود که پوسته با بروز هر خطایی متوقف شود تا برنامهنویس ناچار نباشد پس از هر دستور حیاتی،
عبارت || exit 1 را بهصورت دستی اضافه کند.»
تحقق این هدف بسیار پیچیده است؛ چرا که بسیاری از دستورات بهطور عامدانه وضعیت خروج غیرصفر برمیگردانند. برای مثال در عبارت:
if [ -d /foo ]; then ...; else ...; fi
بدیهی است که نمیخواهیم در صورت عدم وجود دایرکتوری و بازگشت وضعیت خروج غیرصفر توسط دستور
[ -d /foo ]، اسکریپت متوقف شود؛ چرا که قصد داریم این وضعیت را در بلوک
else مدیریت کنیم.
به همین سبب، توسعهدهندگان ناگزیر به وضع مجموعهای از قوانین استثنایی شدند؛ قوانینی نظیر
«دستوراتی که بخشی از شرطِ if هستند، ایمن تلقی میشوند» یا «دستورات میانی در یک
پایپلاین (Pipeline)، بهجز آخرین دستور، مشمول توقف نمیشوند.»
این قوانین بسیار پیچیده هستند و حتی در پوشش برخی سناریوهای ساده نیز ناتوان میمانند. چالش بزرگتر اینجاست که این ضوابط در نسخههای مختلف Bash تغییر میکنند، زیرا این پوسته همواره در تلاش است تا تعاریف منعطف و گاه مبهم POSIX از این ویژگی را دنبال کند. این عدم قطعیت هنگام درگیر شدن زیرپوستهها (Subshells) دوچندان میشود؛ در این حالت، رفتار سیستم بسته به اینکه Bash در حالت انطباق با POSIX فراخوانی شده باشد یا خیر، متفاوت خواهد بود.
ابزار عیبیابی ShellCheck #
برنامهای کاربردی به نام ShellCheck در مخازن رسمی اکثر توزیعهای لینوکس موجود است
که وظیفهی تحلیل ایستای اسکریپتهای پوسته را بر عهده دارد. این ابزار قادر است طیف گستردهای از
خطاهای نحوی، منطقی و شیوههای نادرست اسکریپتنویسی (Anti-patterns) را شناسایی کند. بهرهگیری
از این ابزار برای تضمین کیفیت و پایداری کدهای توسعهیافته بسیار توصیه میشود.
برای بررسی اسکریپتی که دارای خط تفسير (Shebang) است، بهسادگی دستور زیر را اجرا کنید:
shellcheck my_script
ShellCheck بهطور خودکار نوع پوسته (Shell) را بر اساس محتوای shebang تشخیص میدهد. جهت تحلیل
فایلهایی که فاقد این خط هستند (مانند کتابخانههای توابع)، میتوان از پارامتر -s
برای تعیین صریح نوع پوسته استفاده کرد:
shellcheck -s bash my_library
در اینجا گزینه -s مخفف shell بوده و برای مشخص کردن مفسر مورد نظر (مانند bash، sh
یا ksh) به کار میرود. برای کسب اطلاعات بیشتر و استفاده از نسخهی آنلاین این ابزار، میتوانید
به وبسایت رسمی آن در نشانی shellcheck.net مراجعه کنید.
مخاطرات نامگذاری فایلها #
اختلال دیگری که در اسکریپتهای حذف فایل وجود دارد، کمتر به چشم میآید اما میتواند پیامدهای
بسیار خطرناکی داشته باشد. از دیدگاه بسیاری از متخصصان، سیستمهای یونیکس و شبهیونیکس دارای یک
چالش طراحی بنیادین در حوزه نامگذاری فایلها هستند. یونیکس در این زمینه بسیار منعطف عمل میکند؛
به طوری که عملاً تنها دو نویسه (Character) مجاز به حضور در نام فایل نیستند: نخست کاراکتر
/ که برای تفکیک اجزای مسیر (Path) استفاده میشود و دوم نویسهی null که برای
نشانهگذاری پایان رشتهها کاربرد دارد.
سایر نویسهها کاملاً مجاز هستند؛ از جمله فاصلهها (Spaces)، تبها (Tabs)، خطِ جدید (Newline)، خطتیره در ابتدای نام، بازگشت به ابتدای سطر (Carriage Return) و غیره.
نکتهی بحرانی، وجود خطتیره (-) در ابتدای نام فایل است. برای مثال، ایجاد فایلی با
نام -rf ~ در یونیکس کاملاً مجاز است. لحظهای تصور کنید اگر این نام فایل بهعنوان
ورودی به دستور rm ارسال شود، چه اتفاقی رخ میدهد؛ مفسر دستور، نام فایل را
بهعنوان گزینههای عملیاتی (-r برای حذف بازگشتی و -f برای اجبار) و
علامت ~ را بهعنوان دایرکتوری خانگی کاربر تفسیر میکند.
برای ایمنسازی اسکریپت در برابر این آسیبپذیری، باید دستور rm را از حالت ساده به شکل زیر تغییر دهیم:
rm ./*
افزودن پیشوند ./ باعث میشود تا نام فایلهایی که با خطتیره شروع میشوند، دیگر
بهعنوان «گزینه» (Option) توسط دستور تفسیر نشوند، چرا که اکنون مسیر با یک نقطه شروع شده است.
بهطور کلی، توصیه میشود هنگام استفاده از نویسههای جانشین یا همان Wildcardها (نظیر
* و ?)، همیشه از پیشوند ./ استفاده کنید تا از تفسیر
نادرست آنها توسط دستورات جلوگیری شود. این قاعده شامل موارد مشابهی مانند *.pdf یا
*.mp3 نیز میگردد.
نامگذاری فایلهای قابل حمل (Portable Filenames) #
برای تضمین سازگاری نام فایلها میان پلتفرمهای گوناگون (مانند توزیعهای مختلف لینوکس، یونیکس و سایر سیستمعاملها)، رعایت احتیاط در انتخاب نویسهها امری حیاتی است. استانداردی تحت عنوان POSIX Portable Filename Character Set تدوین شده است که با پیروی از آن، احتمال عملکرد صحیح نام فایل در سیستمهای مختلف به حداکثر میرسد.
این استاندارد بسیار ساده و محدود است؛ بر این اساس، تنها نویسههای مجاز برای استفاده عبارتند از:
حروف بزرگ (A-Z)، حروف کوچک (a-z)، اعداد (0-9)، نقطه (.)، خطتیره (-)
و زیرخط (_). همچنین، این استاندارد مؤکداً پیشنهاد میکند که نام فایلها هرگز با
کاراکتر خطتیره شروع نشوند تا از بروز تداخلهای نحوی در محیط پوسته جلوگیری شود.
اعتبارسنجی ورودیها #
یک اصل بنیادین در توسعه نرمافزار حرفهای حکم میکند که اگر برنامهای ورودی دریافت میکند،
باید توانایی مدیریت هر نوع دادهی ورودی را داشته باشد. این امر مستلزم بررسی و پالایش دقیق
دادهها است تا اطمینان حاصل شود که تنها مقادیر معتبر به مراحل بعدی پردازش راه مییابند. در فصل
پیشین و هنگام بررسی دستور read، نمونهای از این رویکرد را در قالب شرط زیر برای
اعتبارسنجی گزینههای منو مشاهده کردیم:
[[ $REPLY =~ ^[0-3]$ ]]
این عبارتِ شرطی بسیار دقیق عمل میکند و تنها زمانی وضعیت خروج صفر را برمیگرداند که رشتهی ورودی کاربر دقیقاً یک عدد در بازه صفر تا سه باشد؛ در غیر این صورت، هر ورودی دیگری مردود اعلام میشود. نگارش چنین شرطهای سختگیرانهای اگرچه ممکن است چالشبرانگیز باشد، اما برای تولید یک اسکریپت با کیفیت و پایدار (Robust) ضرورتی انکارناپذیر است.
طراحی اسکریپت و محدودیت زمان #
در دنیای طراحی صنعتی، اصلی وجود دارد که میگوید عمق و کیفیت طراحی یک پروژه، تابعی از زمانِ اختصاصیافته به طراح است. اگر برای طراحی ابزاری جهت «دفع حشرات» تنها پنج دقیقه فرصت داشته باشید، نتیجهی کار یک مگسکش ساده خواهد بود؛ اما با اختصاص پنج ماه زمان، ممکن است یک «سیستم لیزری هوشمند» ابداع کنید.
این منطق در دنیای برنامهنویسی و اسکریپتنویسی پوسته نیز کاملاً صادق است. گاهی یک اسکریپت موقت و ساده (Quick and Dirty) که تنها یکبار توسط خودِ برنامهنویس استفاده میشود، کفایت میکند. چنین ابزارهایی باید به سرعت و با کمترین هزینه نوشته شوند و نیازی به مستندسازی گسترده یا مکانیزمهای دفاعی پیچیده ندارند. اما اگر قرار است اسکریپتی در محیطهای عملیاتی (Production) مستقر شود و بهطور مکرر توسط کاربران متعدد مورد استفاده قرار گیرد، فرآیند توسعهی آن باید بسیار دقیق، نظاممند و با رعایت تمامی استانداردهای ایمنی انجام پذیرد.
متدولوژی آزمایش (Testing) #
آزمایش و اعتبارسنجی، گامی حیاتی در فرآیند توسعهی هر نرمافزار، از جمله اسکریپتنویسی پوسته محسوب میشود. در زیستبوم متنباز (Open Source)، شعار معروف «زود منتشر کن، زیاد منتشر کن» (Release Early, Release Often) بر همین منطق استوار است. با انتشار زودهنگام و مستمر، نرمافزار در معرض استفاده و ارزیابی گستردهتری قرار میگیرد؛ چرا که تجربه نشان داده است شناسایی و رفع باگها در مراحل اولیهی توسعه، بهمراتب سادهتر و کمهزینهتر از مراحل نهایی است.
در فصل ۲۶، آموختیم که چگونه میتوان از Stubها برای تأیید جریان اجرای برنامه استفاده کرد. این تکنیک از همان نخستین مراحل کدنویسی، ابزاری ارزشمند برای پایش پیشرفت پروژه و اطمینان از صحت منطق اسکریپت است.
بیایید چالش حذف فایل را که پیشتر بررسی کردیم، مجدداً در نظر بگیریم و روشی ایمن برای آزمایش آن طراحی کنیم. تست کردن مستقیمِ قطعهکد اصلی خطرناک است، زیرا هدف آن حذف واقعی دادههاست؛ اما میتوان با اعمال تغییراتی، فرآیند شرط را بدون ریسک انجام داد:
if [[ -d $dir_name ]]; then
if cd $dir_name; then
echo rm * # TESTING
else
echo "cannot cd to '$dir_name'" >&2
exit 1
fi
else
echo "no such directory: '$dir_name'" >&2
exit 1
fi
exit # TESTING
در این ساختار، از آنجا که بخشهای مدیریت خطا پیامهای خروجی گویایی صادر میکنند، نیازی به
افزودن پیامهای جدید نیست. تغییر کلیدی، قرار دادن دستور echo پیش از دستور
rm است. این کار باعث میشود به جای اجرای واقعیِ دستور حذف، خودِ دستور به همراه
لیست پارامترهای بسطیافتهی آن (Expansion) در خروجی نمایش داده شود. این رویکرد امکان بررسی دقیق
رفتار اسکریپت را در محیطی ایزوله فراهم میکند. همچنین در انتهای قطعهکد، دستور
exit اضافه شده است تا از اجرای ادامهی اسکریپت در طول فرآیند تست جلوگیری شود؛
هرچند ضرورت این کار به ساختار کلی اسکریپت بستگی دارد.
علاوه بر این، از کامنتهایی با محتوای # TESTING استفاده شده است. این برچسبها به
توسعهدهنده کمک میکنند تا پس از اتمام مراحل عیبیابی، بهسرعت تغییرات موقت را شناسایی و پیش از
استقرار نهایی اسکریپت، آنها را حذف کند.
طراحی سناریوهای آزمایش (Test Cases) #
برای انجام یک ارزیابی اثربخش، تدوین و اجرای موارد آزمایشی مناسب ضرورتی کلیدی دارد. این فرآیند از طریق انتخاب دقیق دادههای ورودی یا بازسازی شرایط عملیاتی خاصی صورت میپذیرد که «حالتهای مرزی» (Edge Cases) و سناریوهای استثنایی را هدف قرار میدهند. در قطعهکد مورد بحث، ما باید رفتار اسکریپت را در سه وضعیت عملیاتی مجزا تحلیل کنیم:
- متغیر
dir_nameحاوی مسیر یک دایرکتوری موجود و معتبر باشد. - متغیر
dir_nameبه مسیری اشاره کند که در سیستم وجود ندارد. - متغیر
dir_nameکاملاً تهی (Empty) باشد.
با اجرای اسکریپت در هر یک از این شرایط، «پوشش آزمایش» (Test Coverage) مناسبی ایجاد میشود که ریسک رفتارهای پیشبینینشده را به حداقل میرساند.
همانند فرآیند طراحی، آزمایش نیز تابعی از محدودیتهای زمانی است. لزومی ندارد تمامی جزئیات و عملکردهای فرعی یک اسکریپت تحت شرطهای گسترده قرار گیرند؛ بلکه هنر اصلی در «اولویتبندی» (Prioritization) است. از آنجا که نقص در عملکرد این قطعهکد خاص میتواند منجر به تخریب جبرانناپذیر دادهها شود، سرمایهگذاری زمانی برای طراحی دقیق و آزمایش وسواسگونهی آن کاملاً توجیهپذیر و ضروری است.
متدولوژی عیبیابی (Debugging) #
چنانچه نتایج حاصل از آزمایشها بیانگر وجود اختلال در عملکرد اسکریپت باشد، گام بعدی ورود به فرآیند عیبیابی است. بروز «مشکل» بدین معناست که اسکریپت برخلاف انتظارات و منطق طراحیشده توسط برنامهنویس رفتار میکند. در چنین شرایطی، باید با رویکردی تحلیلگرانه مشخص کنیم که اسکریپت در عمل چه توالی عملیاتی را طی میکند و منشأ این انحراف کجاست. شناسایی ریشهی باگها گاه مستلزم انجام تحقیقات دقیق و ایفای نقش یک کارآگاه فنی است.
یک اسکریپت با طراحی استاندارد، خود ابزاری برای تسهیل این فرآیند است. برنامهنویسی با رویکرد تدافعی باعث میشود تا اسکریپت شرایط غیرعادی را بهسرعت تشخیص داده و بازخوردهای (Feedback) ارزشمندی را به کاربر یا توسعهدهنده ارائه دهد. با این حال، در مواجهه با مشکلات پیچیده و رفتارهای غیرمنتظره، تکیه بر پیامهای خطای ساده کافی نبوده و استفاده از تکنیکهای پیشرفتهتر عیبیابی اجتنابناپذیر میگردد.
ایزولهسازی محدوده خطا #
در مواجهه با اسکریپتهای پیچیده و طولانی، جداسازی بخشی از کد که منشأ بروز رفتار غیرعادی است، راهکاری بسیار کارآمد محسوب میشود. لزوماً بخش ایزولهشده محل دقیق وقوع خطای اصلی نیست، اما این فرآیند دیدگاههای ارزشمندی دربارهی ریشهی واقعی مشکل در اختیار برنامهنویس قرار میدهد. یکی از متداولترین روشها برای این کار، تبدیل بخشهایی از کد به «توضیحات» یا همان کامنتگذاری (Commenting Out) است.
بهعنوان مثال، در قطعهکد حذف فایل، میتوان با غیرفعال کردن موقت بخشهای منطقی، تأثیر آنها بر رفتار کلی اسکریپت و خطاهای گزارششده بررسی کرد:
if [[ -d $dir_name ]]; then
if cd $dir_name; then
rm *
else
echo "cannot cd to '$dir_name'" >&2
exit 1
fi
# else
# echo "no such directory: '$dir_name'" >&2
# exit 1
fi
با قرار دادن نویسهی # در ابتدای خطوط، از اجرای آن بخش منطقی جلوگیری میشود. پس از
این تغییر، میتوان آزمون را مجدداً تکرار کرد تا مشخص شود که آیا حذفِ موقت آن بخش از کد، تأثیری
بر رفع یا تغییر ماهیت خطا داشته است یا خیر. این رویکرد به شما اجازه میدهد تا دایرهی جستجو را
برای یافتن باگهای منطقی تنگتر کنید.
تکنیک ردیابی عملیات #
بسیاری از خطاها ناشی از انحراف در جریان منطقی اسکریپت هستند؛ به این معنا که بخشهایی از کد یا هرگز فراخوانی نمیشوند، یا با ترتیب و زمانبندی نادرست به اجرا درمیآیند. برای درک دقیق توالیِ واقعیِ اجرای دستورات، از تکنیکی تحت عنوان ردیابی (Tracing) استفاده میکنیم.
یکی از متداولترین روشهای ردیابی، درج پیامهای اطلاعرسان در نقاط کلیدی اسکریپت است تا موقعیت لحظهایِ اجرای کد مشخص شود. برای نمونه، میتوانیم پیامهایی را به قطعهکد خود اضافه کنیم:
echo "preparing to delete files" >&2
if [[ -d $dir_name ]]; then
if cd $dir_name; then
echo "deleting files" >&2
rm *
else
echo "cannot cd to '$dir_name'" >&2
exit 1
fi
else
echo "no such directory: '$dir_name'" >&2
exit 1
fi
echo "file deletion complete" >&2
در این رویکرد، پیامهای ردیابی به خروجی خطای استاندارد (stderr) ارسال میشوند تا با خروجی معمول اسکریپت (stdout) تداخل پیدا نکنند. همچنین، برای سهولت در شناسایی و حذفِ این خطوط پس از اتمام فرآیند عیبیابی، آنها را بدون تورفتگی و در ابتدای سطر درج میکنیم تا از بدنهی اصلی کد متمایز باشند.
با اجرای اسکریپت در حالت ردیابی، اکنون میتوان توالی دقیق عملیات را مشاهده کرد:
[me@linuxbox ~]$ deletion-script
preparing to delete files
deleting files
file deletion complete
[me@linuxbox ~]$
پوسته bash علاوه بر روشهای دستی، مکانیزم ردیابی داخلی قدرتمندی دارد که از طریق گزینه
-x (چه در خط فرمان و چه با دستور set) فعال میشود. برای فعالسازی
ردیابی در کل یک اسکریپت، کافی است گزینه -x را به خط شِبنگ (Shebang) اضافه کنید. به
نمونه زیر توجه کنید:
#!/bin/bash -x
# trouble: script to demonstrate common errors
number=1
if [ $number = 1 ]; then
echo "Number is equal to 1."
else
echo "Number is not equal to 1."
fi
پس از اجرا، خروجی به صورت زیر نمایش داده میشود:
[me@linuxbox ~]$ trouble
+ number=1
+ '[' 1 = 1 ']'
+ echo 'Number is equal to 1.'
Number is equal to 1.
در این حالت، تمامی دستورات پس از انجام عملیات بسط (Expansion) نمایش داده میشوند. نویسهی
+ در ابتدای خطوط، خروجیِ ردیابی را از خروجی استاندارد برنامه متمایز میکند. این
کاراکتر، مقدار پیشفرض متغیر سیستمی PS4 (Prompt String 4) است. شما میتوانید برای
افزایش کارایی فرآیند عیبیابی، محتوای این متغیر را شخصیسازی کنید؛ برای مثال، آن را طوری تنظیم
کنید که «شماره خط» اسکریپت را در کنار هر دستور نمایش دهد.
توجه داشته باشید که برای جلوگیری از بسط زودهنگام (Early Expansion) متغیر، حتماً باید از تککوتیشن (Single Quote) استفاده کنید:
[me@linuxbox ~]$ export PS4='$LINENO + '
[me@linuxbox ~]$ trouble
5 + number=1
7 + '[' 1 = 1 ']'
8 + echo 'Number is equal to 1.'
Number is equal to 1.
جهت اجرای عملیات ردیابی (Tracing) بر روی یک قطعهکد خاص به جای کل اسکریپت، میتوان از دستور
داخلی set همراه با گزینه -x استفاده کرد. این رویکرد به شما اجازه
میدهد تا فرآیند عیبیابی را دقیقاً بر روی ناحیه مشکوک متمرکز کنید:
#!/bin/bash
# trouble: script to demonstrate common errors
number=1
set -x # Turn on tracing
if [ $number = 1 ]; then
echo "Number is equal to 1."
else
echo "Number is not equal to 1."
fi
set +x # Turn off tracing
در این متدولوژی، از set -x برای شروع ردیابی و از set +x برای خاتمه
دادن به آن استفاده میشود. بهرهگیری از این تکنیک برای تحلیل بخشهای مجزای یک اسکریپت معیوب،
سرعت شناسایی خطاهای منطقی را بهشدت افزایش میدهد.
پایش متغیرها در زمان اجرا #
در کنار فرآیند ردیابی، نمایش محتوای متغیرها ابزاری بسیار کارآمد برای تحلیل مکانیسمهای داخلی
اسکریپت در حین اجراست. با درج هوشمندانهی دستورهای echo در نقاط حساس، میتوان
وضعیت لحظهای دادهها را مشاهده کرد.
#!/bin/bash
# trouble: script to demonstrate common errors
number=1
echo "number=$number" # DEBUG
set -x # Turn on tracing
if [ $number = 1 ]; then
echo "Number is equal to 1."
else
echo "Number is not equal to 1."
fi
set +x # Turn off tracing
در این نمونهی ساده، مقدار متغیر number را در خروجی چاپ کرده و سطر افزوده شده را
با کامنت # DEBUG نشانهگذاری کردهایم تا در مراحل نهایی پاکسازی، بهراحتی قابل
شناسایی و حذف باشد. این تکنیک بهویژه هنگام تحلیل رفتار حلقهها (Loops) و بررسی صحت عملیات
محاسباتی در اسکریپتهای پیچیده، نقشی کلیدی در شناسایی انحرافات منطقی ایفا میکند.
جمعبندی #
در این فصل، تنها بخشی از چالشهایی را که ممکن است در طول توسعهی اسکریپت رخ دهند، بررسی کردیم. بیتردید موانع پیش روی یک توسعهدهنده بسیار فراتر از این موارد است؛ اما متدولوژیهای ارائهشده، بستر لازم برای شناسایی و رفع اکثر خطاهای رایج را فراهم میسازند. عیبیابی (Debugging) هنری ظریف است که با ممارست و تجربه صیقل مییابد؛ این مهارت هم شامل پیشگیری از بروز خطا (از طریق آزمایشهای مستمر در حین توسعه) و هم توانمندی در ردیابی و ریشهیابی اختلالات (با بهرهگیری مؤثر از تکنیکهای Tracing) میگردد.
منابع مطالعه تکمیلی #
ویکیپدیا مقالات کوتاهی درباره خطاهای نحوی (syntactic errors) و خطاهای منطقی (logical errors) دارد:
منابع آنلاین متعددی برای بررسی جنبههای فنی برنامهنویسی Bash وجود دارد:
- Bash Pitfalls — Wooledge
- Gotchas — Advanced Bash-Scripting Guide
- Reserved Word Index — GNU Bash Manual
دیوید ویلر (David Wheeler) بحث بسیار مفیدی درباره چالش نامگذاری فایلها در یونیکس و نحوه کدنویسی اسکریپتهای پوسته (shell scripts) برای مدیریت آنها ارائه کرده است:
برای اشکالزدایی (debugging) در سطوح پیشرفته، میتوانید از ابزار اشکالزدای مفسر Bash (Bash Debugger) استفاده کنید: