شروع سریع با script #

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

1. اجرا کنید quickstart.sh
2. دو رمز عبور وارد کنید؛ یکی برای کاربر عادی database و یکی برای root.
3. چند لحظه صبر کنید تا TestRail دانلود و راه‌اندازی شود.

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

نصب را از طریق web UI کامل کنید (از مقادیری که installer در پایان نمایش می‌دهد استفاده کنید).

بعد از ورود به installation wizard،
باید مسیر زیر را برای Chrome Headless Shell وارد کنید:

• /usr/bin/chrome-headless-shell-linux64/chrome-headless-shell

پیکربندی token مربوط به Jira را به‌روزرسانی کنید (برای نسخه‌های قبل از ۱۰.۱.۴ الزامی است)
#

اگر از نسخه‌ای قدیمی‌تر از 10.1.4 ارتقا می‌دهید، باید در این فرایند فایل پیکربندی token مربوط به Jira را به‌روزرسانی کنید.

1. فایل‌های update را دانلود کنید اینجا.
2. فایل‌ها را به‌روزرسانی کنید:
   1. نام container مربوط به TestRail Server را پیدا کنید؛ برای مثال
      testrail-docker-srv
   2. دستور زیر را اجرا کنید تا فایل جدید را کپی کنید
      consts.php
      وارد container کنید.

      docker cp patches/testrail-<version>/testrail/app/config/consts.php testrail-docker-srv:/var/www/testrail/app/config

   3. مالکیت درست فایل را تنظیم کنید.

      docker exec -it testrail-docker-srv \
      chown www-data:www-data /var/www/testrail/app/config/consts.php

اجرای TestRail با docker-compose #

فایل compose از طریق environment variableها پیکربندی می‌شود؛ پیشنهاد می‌شود از یک فایل .env استفاده کنید. اطلاعات بیشتر درباره فایل .env در
مستندات Docker env files موجود است. 

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

Environment variableها #

پیشنهاد می‌شود یک فایل .env محلی بسازید تا variableهای مخصوص کاربر یا machine را در آن مشخص کنید (برای اطلاعات بیشتر، به مستندات Docker env files مراجعه کنید). syntax ساده است؛ برای مثال: HTTP_PORT=۸۰۰۰

Environment variableها را می‌توان با همین syntax مستقیماً در shell هم تنظیم کرد و سپس از docker-compose.

• DB_PORT
• HTTP_PORT
• HTTPS_PORT
• DB_URL (مثلاً http://internal.yourcompany.com/۵.۷.sql)

پایگاه‌داده‌های از پیش آماده‌شده و فایل config.php در TestRail #

با استفاده از DB_URL variable ، می‌توانید یک SQL dump هم ارائه کنید تا container آن را دانلود کند و TestRail از قبل پیکربندی شده باشد. برای عملکرد درست، config.php باید فایل مربوطه را ارائه کنید. کافی است آن را در _config کپی کنید. مطمئن شوید مقادیر موجود در config.php با تنظیمات database برای user و password که در compose file مربوط به db مشخص شده‌اند، مطابقت داشته باشد.

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

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

docker-compose up
docker-compose down

آرگومان up container را اجرا می‌کند؛ در حالی که down همه‌چیز را متوقف می‌کند. docker-compose مرجع CLI را می‌توانید اینجا ببینید.

گزینه‌های مفید دیگر: #

نام پوشه‌ای که docker-compose در آن اجرا می‌شود (در این مثال، «internal-docker») به‌عنوان project name استفاده می‌شود و به ابتدای نام همه containerهای ایجادشده اضافه می‌شود.

توصیه:  استفاده کنید از docker-compose down -v ، چون volumeهای نام‌گذاری‌شده و ناشناس را حذف می‌کند.

نکات کلی درباره فایل‌های Compose #

• همه فایل‌های Compose به volumeهای اضافه وابسته هستند:
• testrail_root شامل فایل‌های نصب است و در مسیر زیر mount می‌شود: /var/www/testrail
• testrail_opt شامل فایل‌های آپلودشده و موارد مشابه است و در مسیر زیر mount می‌شود: /opt/testrail
• testrail_db شامل database است و در مسیر زیر mount می‌شود: /var/lib/mysql.
• testrail_config حاوی فایل config.php است؛ این فایل TestRail را پیکربندی می‌کند و در مسیر مربوطه mount می‌شود /var/www/testrail/config

کانتینرها از طریق یک testrail شبکه bridged به هم متصل می‌شوند. ترتیب شروع مهم است: اول php باید اجرا شود و بعد webserver و DB.

انتقال & ارتقای TestRail #

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

لطفاً Readme موجود در GitHub repo را ببینید.

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

برای شروع یا توقف TestRail، این دو command کافی هستند. آن‌ها را در پوشه root repo اجرا کنید:

docker-compose up
docker-compose down

برای اجرای کانتینرها در detached mode، کافی است پارامتر -d را اضافه کنید: docker-compose up -d

فایل‌های docker-compose چند متغیر با مقادیر default از پیش تعیین‌شده دارند. برای تعیین مقدارهای دلخواه برای این متغیرها، یک فایل .env بسازید (همان‌طور که در
مستندات فایل‌های env در Docker توضیح داده شده است؛ .env یک فایل متنی ساده با ساختار VAR=VALUE است).

در غیر این صورت، می‌توانید env variables را از طریق command line هم تنظیم کنید؛ مثلاً با export HTTP_PORT=8008 && docker-compose up -d.

سایت
linuxhint.com راهنمای خوبی درباره استفاده از env variables در bash ارائه می‌کند.

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

استفاده از database داخل کانتینرها #

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

1. قبل از migration، privileges کاربر MySQL را بررسی کنید. اگر کاربری با ‘@localhost’ ساخته شده باشد (یعنی دسترسی فقط از localhost مجاز باشد)، باید user جدیدی با دسترسی کافی برای remote connections بسازید:
   • با دستور mysql -p به DB وصل شوید و همه userها و host آن‌ها را فهرست کنید: SELECT user, host FROM mysql.user;
   • اگر کاربر TestRail در ستون host مقدار localhost یا یک IP مشخص داشته باشد (و مقدار آن % نباشد)، باید user جدیدی ایجاد کنید: CREATE USER ‘testraildocker’@’%’ IDENTIFIED BY ‘newpassword’; >GRANT ALL ON testrail.* TO 'testraildocker'@'%';
     (% اتصال remote از هر IP را مجاز می‌کند. اگر subnet مربوط به Docker خود را می‌دانید – معمولاً ۱۷۲.۱۶.۲۵۵.۲۵۵ – برای افزایش امنیت، به جای % از همان subnet داخلی Docker استفاده کنید.)
2. کل محتوای /var/lib/mysql را به پوشه _mysql کپی کنید و فایل config.php را به _config کپی کنید.
3. اگر می‌خواهید attachments، reports، logs و audit logs را حفظ کنید، پوشه‌های 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

همچنین مسیرهای attachments و reports را در بخش TestRail > Administration > Site Settings به این موارد تغییر دهید: /opt/testrail/attachments و /opt/testrail/reports

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

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

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

3. در فایل config.php مقدارهای LOG_PATH و AUDIT_PATH را به موارد زیر تغییر دهید:

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

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

ارتقای TestRail وقتی از قبل از containers استفاده می‌کنید #

گزینه ۱: روش سریع و ساده #

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

1. کانتینر Docker مربوط به Apache را با اجرای دستور زیر پیدا کنید:
   docker ps
2. کپی کنید CONTAINER ID برای
   testrail/apacheimage
3. اجرا کنید
   docker exec -it <container_id> برای ورود به کانتینر Docker، bash را اجرا کنید
4. به مسیر زیر بروید: /var/www/testrail دایرکتوری
5. اجرا کنید php run.php update

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

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

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

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

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

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

Apache در مقایسه با nginx و MySQL در مقایسه با MariaDB #

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

تهیه backup #

همه containerها stateless هستند، بنابراین می‌توانید آن‌ها را با اطمینان حذف کنید. داده‌های مرتبط در volumeهای محلی ذخیره می‌شوند؛ به‌طور پیش‌فرض در _config ، _mysql ،
و _opt. کافی است از این پوشه‌ها backup بگیرید.

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

• 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

ساخت imageها توسط خودتان #

امکان ساخت Docker imageها توسط خودتان هم وجود دارد. همه Dockerfileها در این پوشه.
دستورالعمل‌های build در subfolderهای مربوطه قرار دارند.