تست
از کجا بدانی کدت درست کار میکند، و فردا هم که عوضش کردی هنوز درست است؟ با تست و ابزارهایی که خودکار کد را وارسی میکنند. این هشت کلمه زبان همان ابزارهاست.
اسم پشت اسم
در انگلیسی میشود دو اسم را پشت هم گذاشت؛ اسم اول مثل صفت، اسم دوم را توضیح میدهد و اصل مطلب همیشه آخری است. unit test یک «تست» است (از نوع واحد)، test case یک «حالت» است (برای تست) و test coverage یک «پوشش». ترتیب در فارسی برعکس میشود: test file میشود «فایلِ تست». پس این ترکیبها را از آخر به اول ترجمه کن.
هشت کلمهی این درس
test (تِست): آزمون؛ کدی که بررسی میکند کد دیگر درست کار میکند
test یعنی «آزمون» یا «امتحان». در برنامهنویسی test تکه کدی است که کد اصلی تو را اجرا میکند و بررسی میکند جواب همانی باشد که باید. خوبیاش این است که کامپیوتر آن را در چند ثانیه و هر بار بعد از هر تغییر اجرا میکند؛ اگر چیزی را ناخواسته خراب کرده باشی، همان لحظه میفهمی. فعل هم هست: test your code.
All the tests passed, so you can merge the branch.
همهی تستها قبول شدند، پس میتوانی شاخه را مرج کنی.
unit test (یونیت تِست): تست واحد؛ تستِ یک تکهی کوچک کد بهتنهایی
unit یعنی «واحد»: یک تکهی کوچک و جدا. unit test تستی است که فقط یک واحد کوچک از برنامه، معمولا یک تابع، را جدا از بقیه امتحان میکند. این تستها کوچک و سریعاند و وقتی یکی رد شود دقیقا میدانی مشکل کجاست. تستهایی که چند بخش را با هم امتحان میکنند integration test نام دارند.
Write a unit test for every new function you add.
برای هر تابع تازهای که اضافه میکنی یک تست واحد بنویس.
test case (تِست کِیس): یک حالت مشخص که تست میشود: این ورودی، آن جواب
case یعنی «مورد» یا «حالت». test case یک حالت مشخص است که امتحانش میکنی: «اگر این ورودی را بدهم، باید این جواب را بگیرم». برای یک تابع معمولا چند test case مینویسی: یک ورودی معمولی، یک ورودی خالی، یک عدد منفی، یک ورودی خیلی بزرگ. هر چه حالتهای بیشتری را بپوشانی، باگ کمتری از دستت در میرود.
Add a test case for an empty list.
یک حالت تست برای فهرست خالی اضافه کن.
coverage (کاوِریج): پوشش؛ چه مقدار از کد را تستها اجرا میکنند
cover یعنی «پوشاندن» و coverage یعنی «میزان پوشش»، مثل پوشش آنتن موبایل. test coverage عددی است به درصد که میگوید وقتی تستها اجرا میشوند، چند درصد از خطهای کد تو واقعا اجرا شده است. پوشش ۸۰ درصد یعنی یکپنجم کد را هیچ تستی لمس نکرده. عدد بالا خوب است، ولی تضمین نمیکند باگی نباشد.
Our test coverage went up from 60 to 85 percent.
پوشش تست ما از ۶۰ به ۸۵ درصد بالا رفت.
mock (ماک): جایگزین ساختگی یک چیز واقعی برای تست
mock در انگلیسی یعنی «ساختگی» و «تقلیدی»؛ mock exam همان امتحان آزمایشی است. در تست، mock یک نسخهی قلابی از چیزی واقعی است که کد تو به آن نیاز دارد: سرور، پایگاه داده، درگاه پرداخت. به جای اینکه در هر تست واقعا به اینترنت وصل شوی، یک mock میگذاری که همیشه یک جواب آماده برمیگرداند. تست سریع میشود و به چیز بیرونی وابسته نمیماند.
We use a mock server so the tests do not need the internet.
ما از یک سرور ساختگی استفاده میکنیم تا تستها به اینترنت نیاز نداشته باشند.
lint (لینت): گشتن خودکار کد برای اشتباهها و بدنویسیها
lint در انگلیسی یعنی «پُرز»: همان گلولههای ریز نخ که روی لباس مینشیند. ابزاری به اسم linter کد تو را بدون اجرا کردن میخواند و «پرزهایش» را پیدا میکند: متغیری که ساختهای و به کار نبردهای، import اضافه، اسمی که غلط تایپ شده، سبکی که با قاعدههای تیم نمیخواند. برای پایتون ruff و pylint معروفاند و برای جاوااسکریپت ESLint.
Please lint your code before you open a pull request.
لطفا قبل از باز کردن پول ریکوئست، کدت را لینت کن.
formatter (فورمَتِر): ابزاری که ظاهر کد را خودکار مرتب میکند
format یعنی «شکل و قالب» و پسوند -er یعنی «کننده»: قالبدهنده. formatter ابزاری است که فاصلهها، تورفتگیها، جای شکستن خطها و نوع نقلقولهای کد را خودش یکدست میکند، بدون اینکه کار کد عوض شود. نتیجه: کد همهی اعضای تیم یک شکل میشود و دیگر کسی سر جای آکولاد بحث نمیکند. Prettier برای جاوااسکریپت و Black برای پایتون معروفاند.
The formatter fixes the indentation every time you save.
فرمتر هر بار که ذخیره میکنی تورفتگیها را درست میکند.
benchmark (بِنچمارک): سنجش سرعت و کارایی برای مقایسه
bench یعنی «نیمکت» یا «میز کار» و mark یعنی «نشانه»: نشانهای که نجارها روی میز کار میگذاشتند تا همهچیز را با آن اندازه بگیرند. امروز benchmark یعنی آزمونی استاندارد برای اندازه گرفتن سرعت یا کیفیت، تا بشود دو چیز را منصفانه مقایسه کرد: این تابع سریعتر است یا آن؟ این گوشی یا آن؟ مدلهای هوش مصنوعی را هم با benchmark میسنجند.
The benchmark shows that the new version is twice as fast.
بنچمارک نشان میدهد نسخهی تازه دو برابر سریعتر است.
قاعدههای تیم برای پول ریکوئست
Before you open a pull request:
- Run the formatter. It fixes spaces and quotes for you.
- Run the lint command and fix every warning.
- Write a unit test for each new function. Add a test case for empty input, too.
- Do not call the real payment server in a test. Use a mock.
- Check the coverage report. It must stay above 80 percent.
If you change slow code, run the benchmark before and after, and add both numbers to your pull request.
قبل از اینکه پول ریکوئست باز کنی:
- فرمتر را اجرا کن. فاصلهها و نقلقولها را برایت درست میکند.
- دستور lint را اجرا کن و همهی هشدارها را برطرف کن.
- برای هر تابع تازه یک تست واحد بنویس. یک حالت تست هم برای ورودی خالی اضافه کن.
- در تست، سرور واقعی پرداخت را صدا نزن. از یک جایگزین ساختگی استفاده کن.
- گزارش پوشش را نگاه کن. باید بالای ۸۰ درصد بماند.
اگر کد کُندی را عوض میکنی، بنچمارک را قبل و بعد اجرا کن و هر دو عدد را در پول ریکوئست بنویس.