🥇ব্যাশ স্ক্রিপ্ট সেরা অনুশীলন: নির্ভরযোগ্য, পারফরম্যান্স ব্যাশ স্ক্রিপ্টের জন্য একটি দ্রুত নির্দেশিকা

মনাপি দ্বারা শেল ওয়ালপেপার

ব্যাশ স্ক্রিপ্টগুলি ডিবাগ করা একটি খড়ের গাদায় সুই খোঁজার মতো, বিশেষত যখন কাঠামো, লগিং এবং নির্ভরযোগ্যতার বিষয়গুলি সময়মত বিবেচনা না করেই বিদ্যমান কোডবেসে নতুন সংযোজন প্রদর্শিত হয়। আপনার নিজের ভুলের কারণে বা স্ক্রিপ্টের জটিল স্তূপ পরিচালনা করার সময় আপনি এই ধরনের পরিস্থিতিতে নিজেকে খুঁজে পেতে পারেন।

টীম Mail.ru ক্লাউড সলিউশন সুপারিশ সহ একটি নিবন্ধ অনুবাদ করুন যা আপনাকে লিখতে, ডিবাগ করতে এবং আপনার স্ক্রিপ্টগুলিকে আরও ভালভাবে বজায় রাখতে সহায়তা করবে৷ বিশ্বাস করুন বা না করুন, পরিষ্কার, ব্যবহারের জন্য প্রস্তুত ব্যাশ কোড লেখার সন্তুষ্টিকে হারাতে পারে না যা প্রতিবার কাজ করে।

নিবন্ধে, লেখক গত কয়েক বছরে তিনি যা শিখেছেন তা শেয়ার করেছেন, সেইসাথে কিছু সাধারণ ভুল যা তাকে রক্ষা করেছে। এটি গুরুত্বপূর্ণ কারণ প্রতিটি সফ্টওয়্যার বিকাশকারী, তাদের কর্মজীবনের কোন না কোন সময়ে, রুটিন কাজের কাজগুলি স্বয়ংক্রিয় করতে স্ক্রিপ্টগুলির সাথে কাজ করে।

ফাঁদ হ্যান্ডলার

স্ক্রিপ্ট এক্সিকিউশনের সময় অপ্রত্যাশিত কিছু ঘটলে আমি যে বেশিরভাগ ব্যাশ স্ক্রিপ্টের সম্মুখীন হয়েছি সেগুলি কখনই কার্যকর ক্লিনআপ মেকানিজম ব্যবহার করে না।

বাইরে থেকে বিস্ময় জাগতে পারে, যেমন কোর থেকে সংকেত পাওয়া। স্ক্রিপ্টগুলি প্রোডাকশন সিস্টেমে চালানোর জন্য যথেষ্ট নির্ভরযোগ্য তা নিশ্চিত করার জন্য এই জাতীয় কেসগুলি পরিচালনা করা অত্যন্ত গুরুত্বপূর্ণ। আমি প্রায়ই এই ধরনের পরিস্থিতিতে প্রতিক্রিয়া জানাতে প্রস্থান হ্যান্ডলার ব্যবহার করি:

function handle_exit() {
  // Add cleanup code here
  // for eg. rm -f "/tmp/${lock_file}.lock"
  // exit with an appropriate status code
}
  
// trap <HANDLER_FXN> <LIST OF SIGNALS TO TRAP>
trap handle_exit 0 SIGHUP SIGINT SIGQUIT SIGABRT SIGTERM

trap একটি শেল বিল্ট-ইন কমান্ড যা আপনাকে একটি ক্লিনআপ ফাংশন নিবন্ধন করতে সাহায্য করে যা কোনো সংকেতের ক্ষেত্রে বলা হয়। যাইহোক, যেমন হ্যান্ডলার সঙ্গে বিশেষ যত্ন নেওয়া উচিত SIGINT, যা স্ক্রিপ্টটি বাতিল করে দেয়।

উপরন্তু, অধিকাংশ ক্ষেত্রে আপনি শুধুমাত্র ধরা উচিত EXIT, কিন্তু ধারণা হল আপনি আসলে প্রতিটি পৃথক সংকেতের জন্য স্ক্রিপ্টের আচরণ কাস্টমাইজ করতে পারেন।

অন্তর্নির্মিত সেট ফাংশন - ত্রুটি দ্রুত সমাপ্তি

ত্রুটিগুলি হওয়ার সাথে সাথে তাদের প্রতিক্রিয়া জানানো এবং দ্রুত কার্যকর করা বন্ধ করা খুবই গুরুত্বপূর্ণ৷ এইরকম একটি কমান্ড চালানো চালিয়ে যাওয়ার চেয়ে খারাপ আর কিছুই হতে পারে না:

rm -rf ${directory_name}/*

দয়া করে নোট করুন যে পরিবর্তনশীল directory_name নির্ধারিত না.

এই ধরনের পরিস্থিতি পরিচালনা করতে বিল্ট-ইন ফাংশন ব্যবহার করা গুরুত্বপূর্ণ set, যেমন হিসাবে set -o errexit, set -o pipefail বা set -o nounset স্ক্রিপ্টের শুরুতে। এই ফাংশনগুলি নিশ্চিত করে যে আপনার স্ক্রিপ্টটি যে কোনও নন-জিরো এক্সিট কোডের মুখোমুখি হওয়ার সাথে সাথেই প্রস্থান করবে, অনির্ধারিত ভেরিয়েবলের ব্যবহার, একটি পাইপের উপর দিয়ে যাওয়া অবৈধ কমান্ড এবং আরও অনেক কিছু:

#!/usr/bin/env bash

set -o errexit
set -o nounset
set -o pipefail

function print_var() {
  echo "${var_value}"
}

print_var

$ ./sample.sh
./sample.sh: line 8: var_value: unbound variable

দ্রষ্টব্য: অন্তর্নির্মিত ফাংশন যেমন set -o errexit, একটি "কাঁচা" রিটার্ন কোড (শূন্য ছাড়া) থাকলেই স্ক্রিপ্ট থেকে প্রস্থান করবে। তাই কাস্টম ত্রুটি হ্যান্ডলিং প্রবর্তন করা ভাল, উদাহরণস্বরূপ:

#!/bin/bash
error_exit() {
  line=$1
  shift 1
  echo "ERROR: non zero return code from line: $line -- $@"
  exit 1
}
a=0
let a++ || error_exit "$LINENO" "let operation returned non 0 code"
echo "you will never see me"
# run it, now we have useful debugging output
$ bash foo.sh
ERROR: non zero return code from line: 9 -- let operation returned non 0 code

এইভাবে স্ক্রিপ্ট লেখা আপনাকে স্ক্রিপ্টের সমস্ত কমান্ডের আচরণ সম্পর্কে আরও সতর্ক হতে বাধ্য করে এবং এটি আপনাকে অবাক করে দেওয়ার আগে একটি ত্রুটির সম্ভাবনার পূর্বাভাস দেয়।

বিকাশের সময় ত্রুটি সনাক্ত করতে ShellCheck

এটা মত কিছু একত্রিত মূল্য শেলচেক সেরা অনুশীলনের বিরুদ্ধে আপনার ব্যাশ কোড পরীক্ষা করতে আপনার বিকাশ এবং পরীক্ষার পাইপলাইনে।

আমি আমার স্থানীয় উন্নয়ন পরিবেশে সিনট্যাক্স, শব্দার্থবিদ্যা এবং কোডের কিছু ত্রুটির রিপোর্ট পেতে এটি ব্যবহার করি যা আমি বিকাশ করার সময় মিস করেছি। এটি আপনার ব্যাশ স্ক্রিপ্টগুলির জন্য একটি স্ট্যাটিক বিশ্লেষণ টুল এবং আমি এটি ব্যবহার করার জন্য অত্যন্ত সুপারিশ করছি।

আপনার নিজস্ব প্রস্থান কোড ব্যবহার করে

POSIX-এ রিটার্ন কোডগুলি শুধুমাত্র শূন্য বা এক নয়, শূন্য বা একটি অ-শূন্য মান। বিভিন্ন ত্রুটির ক্ষেত্রে কাস্টম ত্রুটি কোড (201-254 এর মধ্যে) ফেরত দিতে এই বৈশিষ্ট্যগুলি ব্যবহার করুন।

এই তথ্যটি তখন অন্যান্য স্ক্রিপ্ট দ্বারা ব্যবহার করা যেতে পারে যেগুলি ঠিক কী ধরনের ত্রুটি ঘটেছে তা বুঝতে এবং সেই অনুযায়ী প্রতিক্রিয়া জানাতে আপনার র‌্যাপ করে:

#!/usr/bin/env bash

SUCCESS=0
FILE_NOT_FOUND=240
DOWNLOAD_FAILED=241

function read_file() {
  if ${file_not_found}; then
    return ${FILE_NOT_FOUND}
  fi
}

দ্রষ্টব্য: ভুলবশত এনভায়রনমেন্ট ভেরিয়েবলকে ওভাররাইডিং এড়াতে আপনার সংজ্ঞায়িত পরিবর্তনশীল নামগুলির সাথে বিশেষভাবে সতর্ক থাকুন।

লগিং ফাংশন

আপনার স্ক্রিপ্টের ফলাফলগুলি সহজে বোঝার জন্য সুন্দর এবং কাঠামোবদ্ধ লগিং গুরুত্বপূর্ণ। অন্যান্য উচ্চ-স্তরের প্রোগ্রামিং ভাষার মতো, আমি সর্বদা আমার ব্যাশ স্ক্রিপ্টগুলিতে নেটিভ লগিং ফাংশন ব্যবহার করি, যেমন __msg_info, __msg_error ইত্যাদি।

এটি শুধুমাত্র একটি জায়গায় পরিবর্তন করে একটি প্রমিত লগিং কাঠামো প্রদান করতে সাহায্য করে:

#!/usr/bin/env bash

function __msg_error() {
    [[ "${ERROR}" == "1" ]] && echo -e "[ERROR]: $*"
}

function __msg_debug() {
    [[ "${DEBUG}" == "1" ]] && echo -e "[DEBUG]: $*"
}

function __msg_info() {
    [[ "${INFO}" == "1" ]] && echo -e "[INFO]: $*"
}

__msg_error "File could not be found. Cannot proceed"

__msg_debug "Starting script execution with 276MB of available RAM"

আমি সাধারণত আমার স্ক্রিপ্টগুলিতে কিছু ধরণের মেকানিজম রাখার চেষ্টা করি __init, যেখানে এই ধরনের লগার ভেরিয়েবল এবং অন্যান্য সিস্টেম ভেরিয়েবল শুরু করা হয় বা ডিফল্ট মানগুলিতে সেট করা হয়। এই ভেরিয়েবলগুলি স্ক্রিপ্ট আহ্বানের সময় কমান্ড লাইন বিকল্প থেকেও সেট করা যেতে পারে।

উদাহরণস্বরূপ, এরকম কিছু:

$ ./run-script.sh --debug

যখন এই ধরনের একটি স্ক্রিপ্ট কার্যকর করা হয়, এটি নিশ্চিত করে যে সিস্টেম-ব্যাপী সেটিংস প্রয়োজন হলে ডিফল্ট মানগুলিতে সেট করা হয়েছে, বা প্রয়োজনে উপযুক্ত কিছুতে অন্তত শুরু করা হয়েছে।

আমি সাধারণত ইউজার ইন্টারফেসের মধ্যে ট্রেড-অফের ক্ষেত্রে কি আরম্ভ করতে হবে এবং কি করা উচিত নয় তার পছন্দ এবং কনফিগারেশনের বিশদ বিবরণের উপর ভিত্তি করে থাকি যা ব্যবহারকারীর অনুসন্ধান করা উচিত।

পুনর্ব্যবহারের জন্য আর্কিটেকচার এবং সিস্টেমের অবস্থা পরিষ্কার

মডুলার/পুনঃব্যবহারযোগ্য কোড

├── framework
│   ├── common
│   │   ├── loggers.sh
│   │   ├── mail_reports.sh
│   │   └── slack_reports.sh
│   └── daily_database_operation.sh

আমি একটি পৃথক সংগ্রহস্থল রাখি যা আমি একটি নতুন প্রকল্প/ব্যাশ স্ক্রিপ্ট শুরু করতে ব্যবহার করতে পারি যা আমি বিকাশ করতে চাই। পুনঃব্যবহার করা যেতে পারে এমন যেকোনো কিছু একটি সংগ্রহস্থলে সংরক্ষণ করা যেতে পারে এবং সেই কার্যকারিতা ব্যবহার করতে চায় এমন অন্যান্য প্রকল্প দ্বারা পুনরুদ্ধার করা যেতে পারে। এইভাবে প্রকল্পগুলি সংগঠিত করা অন্যান্য স্ক্রিপ্টগুলির আকার উল্লেখযোগ্যভাবে হ্রাস করে এবং কোড বেসটি ছোট এবং পরীক্ষা করা সহজ তাও নিশ্চিত করে।

উপরের উদাহরণের মতো, সমস্ত লগিং ফাংশন যেমন __msg_info, __msg_error এবং অন্যান্য, যেমন স্ল্যাক রিপোর্ট, আলাদাভাবে অন্তর্ভুক্ত রয়েছে common/* এবং গতিশীলভাবে অন্যান্য পরিস্থিতিতে সংযোগ করুন daily_database_operation.sh.

একটি পরিষ্কার সিস্টেম পিছনে ছেড়ে দিন

স্ক্রিপ্টটি চলাকালীন আপনি যদি কোনও সংস্থান লোড করছেন, তবে এই ধরনের সমস্ত ডেটা একটি র্যান্ডম নামের সাথে শেয়ার করা ডিরেক্টরিতে সংরক্ষণ করার পরামর্শ দেওয়া হয়, যেমন /tmp/AlRhYbD97/*. ডিরেক্টরির নাম নির্বাচন করতে আপনি র্যান্ডম টেক্সট জেনারেটর ব্যবহার করতে পারেন:

rand_dir_name="$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 16 | head -n 1)"

কাজ শেষ হওয়ার পরে, উপরে আলোচনা করা হুক হ্যান্ডলারগুলিতে এই জাতীয় ডিরেক্টরিগুলি পরিষ্কার করা যেতে পারে। যদি অস্থায়ী ডিরেক্টরিগুলির যত্ন না নেওয়া হয়, সেগুলি জমা হয় এবং কিছু পর্যায়ে হোস্টে অপ্রত্যাশিত সমস্যা সৃষ্টি করে, যেমন একটি সম্পূর্ণ ডিস্ক।

লক ফাইল ব্যবহার করে

প্রায়শই আপনাকে নিশ্চিত করতে হবে যে কোনও নির্দিষ্ট সময়ে একটি হোস্টে স্ক্রিপ্টের শুধুমাত্র একটি উদাহরণ চলছে। এটি লক ফাইল ব্যবহার করে করা যেতে পারে।

আমি সাধারণত লক ফাইল তৈরি করি /tmp/project_name/*.lock এবং স্ক্রিপ্টের শুরুতে তাদের উপস্থিতি পরীক্ষা করুন। এটি স্ক্রিপ্টটিকে সুন্দরভাবে শেষ করতে এবং সমান্তরালভাবে চলমান অন্য স্ক্রিপ্ট দ্বারা সিস্টেমের অবস্থায় অপ্রত্যাশিত পরিবর্তন এড়াতে সহায়তা করে। প্রদত্ত হোস্টে সমান্তরালভাবে চালানোর জন্য একই স্ক্রিপ্টের প্রয়োজন হলে লক ফাইলগুলির প্রয়োজন হয় না।

পরিমাপ এবং উন্নত

আমাদের প্রায়ই এমন স্ক্রিপ্টগুলির সাথে কাজ করতে হবে যা দীর্ঘ সময় ধরে চলে, যেমন দৈনিক ডাটাবেস অপারেশন। এই ধরনের ক্রিয়াকলাপগুলি সাধারণত ধাপগুলির একটি ক্রম জড়িত: ডেটা লোড করা, অসঙ্গতিগুলি পরীক্ষা করা, ডেটা আমদানি করা, স্থিতি প্রতিবেদন পাঠানো ইত্যাদি।

এই ধরনের ক্ষেত্রে, আমি সর্বদা স্ক্রিপ্টটিকে আলাদা ছোট স্ক্রিপ্টে ভাঙার চেষ্টা করি এবং তাদের স্থিতি এবং সম্পাদনের সময়টি ব্যবহার করে রিপোর্ট করি:

time source "${filepath}" "${args}">> "${LOG_DIR}/RUN_LOG" 2>&1

পরে আমি এর সাথে মৃত্যুদন্ডের সময় দেখতে পারি:

tac "${LOG_DIR}/RUN_LOG.txt" | grep -m1 "real"

এটি আমাকে অপ্টিমাইজেশানের প্রয়োজন এমন স্ক্রিপ্টগুলিতে সমস্যা/ধীর এলাকা সনাক্ত করতে সহায়তা করে।

সৌভাগ্য কামনা করছি!

আর কি পড়তে হবে:

উত্স: www.habr.com