TestRail را می توان از طریق کانتینرهای Docker نصب کرد و راه اندازی و اجرا با TestRail را بسیار آسان تر می کند. این شامل تمام وابستگی ها و فایل های مورد نیاز برای TestRail می شود تا زمان نصب را به حداقل برسانید.

الزامات #

• Docker را نصب کنید + Docker-compose (در لینوکس، با استفاده از pip توصیه می شود)
• برخی درک اولیه از داکر (مثلاً دانستن اینکه کانتینرها، تصاویر، حالت جدا شده و … چیست) → به رسمی مراجعه کنید مستندات Docker “شروع به کار”.
• اختیاری: اگر از quickstart.sh اسکریپت، همچنین نصب کنید sudo و ip (معمولاً در اکثر سیستم ها از قبل نصب شده است)

شروع سریع با اسکریپت #

این مراحل را دنبال کنید:

1. اجرا کنید quickstart.sh
2. دو رمز عبور را وارد کنید – یکی برای کاربر پایگاه داده “عادی” و دیگری برای root
3. چند لحظه صبر کنید – TestRail دانلود و راه اندازی می شود

TestRail باید از طریق URL زیر قابل دسترسی باشد: http://localhost:۸۰۰۰

نصب را از طریق رابط کاربری وب به پایان برسانید (از مقادیر چاپ شده توسط نصب کننده در پایان استفاده کنید).

cqlsh <host> -u <user> -p <password>

شما باید خروجی زیر را دریافت کنید:

Connected to Test Cluster at 127.0.0.1:9042.
[cqlsh 5.0.1 | Cassandra 3.11.9 | CQL spec 3.4.4 | Native protocol v4]
 Use HELP for help.
 cqlsh>

با اجرای پرس و جو CQL زیر، فضای کلید را ایجاد کنید:

CREATE KEYSPACE IF NOT EXISTS tr_keyspace WITH REPLICATION={'class': 'SimpleStrategy', 'replication_factor': 1};

اجرای TestRail با استفاده از docker-compose #

فایل نوشتن از طریق متغیرهای محیطی پیکربندی می شود – پیشنهاد می شود از یک فایل env. استفاده کنید. اطلاعات بیشتر در مورد یک فایل env در دسترس است مستندات فایل های Docker env. 

1. ابتدا یک فایل .env با حداقل متغیرهای اجباری برای:
   • DB_USER
   • DB_NAME
   • DB_PWD
   • DB_ROOT_PWD
2. بعد، اجرا کنید docker-compose up (در اولین بار چند دقیقه طول می کشد).
3. TestRail باید بالا باشد! دسترسی به آن از طریق: http://localhost:۸۰۰۰
4. هنگامی که نصب کننده TestRail تنظیمات پایگاه داده را می خواهد، مقادیری را که در فایل .env مشخص کرده اید، دوباره وارد کنید.
5. برای حذف نمونه، فشار دهید Ctrl+C و سپس اجرا کنید docker-compose down.

متغیرهای محیطی #

پیشنهاد می شود یک فایل .env محلی ایجاد کنید تا متغیرهای خاص کاربر یا ماشین را مشخص کنید (برای اطلاعات بیشتر، به مستندات فایل های Docker env). نحو ساده است: به عنوان مثال. “HTTP_PORT=۸۰۰۰”

متغیرهای محیطی را نیز می توان مستقیماً در پوسته با همان نحو تنظیم کرد و سپس از آن استفاده کرد docker-compose.

• DB_PORT
• HTTP_PORT
• HTTPS_PORT
• DB_URL (به عنوان مثال http://internal.yourcompany.com/۵.۷.sql)

پایگاه های داده از پیش پر شده و Config.php TestRail #

از طریق DB_URL variable، همچنین امکان ارائه SQL-dump برای دانلود توسط کانتینر وجود دارد، بنابراین TestRail از قبل پیکربندی شده است. برای عملکرد مناسب، config.php فایل باید ارائه شود به سادگی آن را در قسمت کپی کنید _config پوشه اطمینان حاصل کنید که مقادیر موجود در config.php فایل مطابق با تنظیمات پایگاه داده برای کاربر و رمز عبور است که در فایل نوشتن برای db مشخص شده است.

استفاده از فایل های Compose #

استفاده عمومی #

docker-compose up
docker-compose down

استدلال up ظرف را شروع می کند. در حالی که down همه چیز را متوقف می کند این docker-compose مرجع CLI را می توان یافت اینجا.

گزینه های مفید اضافی: #

نام پوشه docker-compose در شروع شده است (در این مورد، ‘internal-docker’) به عنوان نام پروژه استفاده می شود و به همه کانتینرهای تولید شده اضافه می شود.

توصیه: استفاده کنید docker-compose down -v، همانطور که جلدهای نامگذاری شده و ناشناس را حذف می کند!

نکات کلی در مورد فایل های نوشتن #

• همه فایل های نوشتن به حجم های اضافی متکی هستند:
• testrail_root شامل نصب و نصب می شود /var/www/testrail
• testrail_opt حاوی فایل های آپلود شده و غیره است و روی آن نصب می شود /opt/testrail
• testrail_db شامل پایگاه داده و نصب می شود /var/lib/mysql.
• testrail_config حاوی فایل config.php است که TestRail را پیکربندی می کند و روی آن نصب می شود /var/www/testrail/config

کانتینرها هر چند به هم متصل هستند testrail شبکه پل شده ترتیب شروع مهم است – php باید اول باشد و سپس وب سرور و DB.

مهاجرت کردن & ارتقاء TestRail #

اجرای TestRail در کانتینرهای Docker #

لطفاً نگاهی به Readme در مخزن Github بیندازید.

از TestRail استفاده می کند docker-compose برای اجرای خدمات فردی لازم و پیوند دادن کانتینرها به یکدیگر.

برای شروع یا توقف TestRail، این دو دستور کار را انجام می دهند. آنها را در پوشه ریشه مخزن اجرا کنید:

docker-compose up
docker-compose down

برای شروع کانتینرها در حالت جدا، کافی است یک پارامتر -d اضافه کنید: docker-compose up -d

فایل‌های docker-compose حاوی تعدادی متغیر با مقادیر پیش‌فرض از پیش تعیین‌شده هستند. برای تخصیص مقادیر سفارشی برای این متغیرها، یک فایل .env ایجاد کنید (همانطور که در آن توضیح داده شده است مستندات فایل docker env – این یک فایل متنی ساده با نحو VAR=VALUE است.

در غیر این صورت، امکان ارائه متغیرهای env از طریق خط فرمان مانند صادرات نیز وجود دارد HTTP_PORT=8008 && docker-compose up -d.

سایت linuxhit.com نمای کلی خوبی از نحوه استفاده از متغیرهای env در bash ارائه می دهد.

انتقال از نصب سرور TestRail موجود به کانتینرها #

استفاده از پایگاه داده در کانتینرها #

اگر یک DB اختصاصی را فقط برای TestRail اجرا کرده اید، منطقی است که DB را در یک کانتینر نیز اجرا کنید. برای ارتقاء مراحل زیر را دنبال کنید:

1. قبل از مهاجرت، امتیازات کاربر mysql را بررسی کنید. اگر کاربری با ‘@localhost’ ایجاد شده است (محدود کردن دسترسی به “فقط از localhost”)، باید یک کاربر جدید با حق کافی برای اجازه اتصال از راه دور ایجاد کنید:

   • دسترسی به DB با mysql -p و لیست همه کاربران + میزبان: SELECT user, host FROM mysql.user; 
   • اگر کاربر TestRail دارای «localhost» یا مقداری IP در ستون «میزبان» (و نه «%») باشد، یک کاربر جدید باید ایجاد شود – CREATE USER ‘testraildocker’@’%’ IDENTIFIED by ‘new password’. – >GRANT ALL ON testrail.* TO 'testraildocker'@'%';
     (% اجازه اتصال از راه دور از هر IP را می دهد. اگر زیرشبکه docker خود را می شناسید – معمولاً ۱۷۲.۱۶.۲۵۵.۲۵۵ – از زیر شبکه docker داخلی مربوطه به جای “%” برای تقویت امنیت استفاده کنید.)
2. کل مطالب را کپی کنید /var/lib/mysql به _mysql پوشه و config.php فایل به _config.
3. اگر می‌خواهید پیوست‌ها، گزارش‌ها، گزارش‌ها و گزارش‌های حسابرسی را نگه دارید، پوشه‌ها را ایجاد کنید logs, audit, reports, attachments در _opt پوشه و محتوا را از محل قدیمی به پوشه های ایجاد شده جدید کپی کنید.

4. را ویرایش کنید config.php فایل و «DB_HOSTNAME» را به تغییر دهید db:3306. همچنین، LOG_PATH و AUDIT_PATH را به:

   define('LOG_PATH', '/opt/testrail/logs/');
   define('AUDIT_PATH', '/opt/testrail/audit/');

5. اگر می خواهید از یک پورت خاص برای دسترسی به TestRail استفاده کنید، یک فایل env. (در اینجا بیشتر) ایجاد کنید و پورت را از طریق آن مشخص کنید. HTTP_PORT=<portNumber>
6. اجرا کنید docker-compose up -d

همچنین مسیرها را برای پیوست ها و گزارش می دهد زیر TestRail > اداره > تنظیمات سایت به: /opt/testrail/attachments و /opt/testrail/reports

استفاده از پایگاه داده خارجی #

اگر از یک خارجی سرور پایگاه داده، سرور DB را همانطور که هست رها کنید و مراحل زیر را دنبال کنید:

1. را کپی کنید config.php فایل به _config.
2. اگر می‌خواهید پیوست‌ها، گزارش‌ها، گزارش‌ها و گزارش‌های حسابرسی را نگه دارید، پوشه‌ها را ایجاد کنید logs، audit، reports، و attachments در _opt folder، و محتوا را از مکان قدیمی در پوشه های ایجاد شده جدید کپی کنید.

3. LOG_PATH و AUDIT_PATH را در فایل config.php ویرایش کنید:

   define('LOG_PATH', '/opt/testrail/logs/');
   define('AUDIT_PATH', '/opt/testrail/audit/');

4. اگر می‌خواهید از یک پورت خاص برای دسترسی به TestRail استفاده کنید، یک فایل env. (در اینجا بیشتر) ایجاد کنید و پورت را از طریق HTTP_PORT= مشخص کنید.<شماره پورت>
5. اجرا کنید docker-compose up -d

اگر قبلاً از کانتینرها استفاده می کنید، TestRail را ارتقا دهید #

گزینه ۱: «n» سریع کثیف #

به سادگی از اسکریپت ارتقاء استفاده کنید: upgradeTestRail.sh
اگر پیکربندی پیش‌فرض ایجاد شده توسط اسکریپت شروع سریع باقی بماند، TestRail را ارتقا می‌دهد. سپس باید این مراحل را دنبال کنید:

1. با اجرا کردن کانتینر داکر آپاچی را پیدا کنید docker ps
2. کپی کنید CONTAINER ID برای testrail/apacheتصویر
3. اجرا کنید docker exec -it <container_id> bash برای ورود به ظرف داکر
4. حرکت به /var/www/testrail دایرکتوری
5. اجرا کنید php run.php update

اگر از مکان‌های سفارشی برای فایل‌های DB و غیره استفاده می‌کنید، از گزینه ۲ در زیر استفاده کنید.

گزینه ۲: انجام ارتقاء مرحله به مرحله #

برای ارتقا TestRail از یک نسخه قدیمی به یک نسخه جدیدتر (به عنوان مثال ۶.۰.۰ به ۶.۰.۱)، مراحل زیر را انجام دهید:

1. ظروف را ببندید: docker-compose down -v
2. (اختیاری) اگر نسخه اختصاصی TestRail را به عنوان مثال مشخص کرده اید. الف .env فایل – نسخه ای را که می خواهید به آن ارتقا دهید تنظیم کنید.
3. تصاویر را بکشید: docker-compose pull
4. توصیه می شود: ایجاد نسخه پشتیبان (به زیر مراجعه کنید)
5. TestRail را راه اندازی کنید docker-compose up -d
6. با اجرا کردن کانتینر داکر آپاچی را پیدا کنید docker ps
7. کپی کنید CONTAINER ID برای testrail/apache تصویر
8. اجرا کنید docker exec -it <container_id> bash برای ورود به ظرف داکر
9. حرکت به /var/www/testrail دایرکتوری
10. اجرا کنید php run.php update

همچنین می توانید با کپی کردن این سه پوشه در یک مکان جدید و سپس اجرا، یک ارتقای “ایمن” انجام دهید docker-compose.

موضوعات پیشرفته #

آپاچی در مقابل nginx و MySQL در مقابل MariaDB #

TestRail در حال حاضر به طور رسمی از Apache + MySQL پشتیبانی می کند. با خیال راحت nginx و mariadb را امتحان کنید – با این حال، لطفاً توجه داشته باشید که این به طور رسمی پشتیبانی نمی‌شود. اگر مشکلی در این دو سیستم پیدا کردید، لطفاً به ما اطلاع دهید تا بتوانیم در آینده به پشتیبانی بالقوه nginx/mariadb نزدیک شویم.

ایجاد پشتیبان #

همه ظروف بدون حالت هستند، بنابراین می توان آنها را با خیال راحت خارج کرد. داده های مربوطه در حجم های محلی ذخیره می شوند: به طور پیش فرض در _config، _mysql، و _opt. فقط یک نسخه پشتیبان از این پوشه ها ایجاد کنید.

متغیرهای محیطی #

• TESTRAIL_VERSION
• OPT_PATH
• CONFIG_PATH
• MYSQL_PATH
• HTTP_PORT
• DB_PORT
• DB_URL
• DB_USER
• DB_PWD
• DB_NAME
• DB_ROOT_PWD
• TR_DEFAULT_TASK_EXECUTION

خودتان تصاویر را بسازید #

همچنین امکان ساخت تصاویر Docker توسط خودتان وجود دارد. همه Dockerfiles را می توان در آن یافت این پوشه. دستورالعمل های ساخت در زیر پوشه های مربوطه می باشد.