Unix/Linux での TestRail 9.4.1 へのアップグレード

以下では、既存の TestRail を新しいバージョンにアップグレードする方法について説明します。

アップグレードの流れ

9.4.1 へのアップグレード手順は、現在ご利用の TestRail のバージョンによって異なります。

TestRail 7.x またはそれ以前のバージョンからのアップグレード

TesRail 9.4.1 へ直接アップグレードするためのスクリプトを利用する必要があります。

テクマトリックス TestRail ユーザーページから以下の2点をダウンロード、もしくはこちらまでお問い合わせください。

- TestRail 9.4.1 のインストールモジュール
- 添付ファイル移行スクリプト

アップグレードの方法は添付ファイル移行スクリプト内のドキュメントをご確認ください。

TestRail 8.0.1 からのアップグレード

TestRail 9.4.1 へアップグレードするには TestRail 8.0.4 を経由する必要があります。以下の流れでアップグレードを進めてください。

1. インストール要件の確認
  - ご利用環境が TestRail 9.4.1 のインストール要件を満たしていることを確認します。
    - PHP 8.1.29 以降(最新版を推奨) を利用する必要があります。
2. バックアップの取得
3. TestRail 8.0.4 にアップグレード
4. TestRail 9.4.1 にアップグレード
5. config.php の更新
6. Cassandra からMySQL Serverへのデータ移行

インストールモジュールはテクマトリックス TestRail ユーザーページからダウンロード、もしくはこちらまでお問い合わせください。

詳細な手順は本ページ内の次項「バックアップ」以降をご確認ください。

1.インストール要件の確認

TestRailのアップグレードを行う前に、要件および OS 固有の手順 (Windows/Linux) を確認してください。PHPやSQLなどのTestRailが依存するソフトウェアは時間とともに変更されるため、TestRailをアップグレードする前に、これらの要件を確認することをお勧めします。

2.バックアップの取得

新しいバージョンにアップグレードする前に、TestRail のファイルとデータベースのバックアップを作成することを強くお勧めします。アップグレードで問題が発生した場合、変更をロールバックして以前の (正常に動作する) バージョンに戻す唯一の方法はバックアップです。TestRail のファイルとデータベースのバックアップを定期的に作成し、新しいバージョンにアップグレードする前にも作成することをお勧めします。

3-4. アップグレード

TestRail 8.0.1 から TestRail 8.0.4 へのアップグレード、TestRail 8.0.4 から 9.4.1 へのアップグレードは次の手順を繰り返してください。

1. Apache Web サーバーおよびバックグラウンドタスクを停止します。
2. 新しいバージョン(8.0.4 または 9.4.1) のモジュールの展開前に、現行の TestRail インストールディレクトリ直下の config.php およびその他ユーザーが作成したファイル/ディレクトリ (logs、reports、audit ディレクトリなど) を退避します。
3. TestRail インストールディレクトリから古いバージョンのファイルを削除します。
4. 新しいバージョン(8.0.4 または 9.4.1) を TestRail インストールディレクトリに展開します。
5. 手順 2 で退避した config.php およびその他ユーザーが作成したファイル/ディレクトリをTestRail インストールディレクトリに戻します。
6. コマンドラインでデータベースをアップグレードします。※TestRail のインストールディレクトリは環境に合わせてください
```
cd /var/www/html/testrail
php run.php update
```
7. アップグレード完了後、Apache Web サーバーを起動します。
  - 9.4.1 へのアップグレード完了後はバックグラウンドタスクも起動します。
8. WEB ブラウザから TestRail にアクセスして [管理] > [概要] > [情報] に表示されるバージョンを確認します。
  - 初回アクセス時に必ず WEBブラウザのキャッシュをクリアしてください。

5. config.php の更新

※Chrome Headless Shell がインストールされていない場合、Chrome Headless Shell 依存関係のインストールで事前にインストールします。

Chrome Headless Shell のパスを <TestRail インストールディレクトリ>config.php に追加します。

define('TR_CHROME_PATH', '/usr/bin/chrome-headless-shell-linux64/chrome-headless-shell');

6. Cassandra からMySQL Serverへのデータ移行

添付ファイルデータの格納先を Apache Cassandra から MySQL に移行するためのスクリプトを実行します。

詳細は、Cassandra からMySQL Serverへのデータ移行（Linux 版) をご確認ください。

(参考)ブラウザーのキャッシュをクリアする

アップグレードが完了した後、すべてのエンドユーザーは jQuery のアップグレードが有効になるようにブラウザーのキャッシュをクリアする必要があります。サポート対象の各ブラウザーで、以下の手順に従ってください:

- Chrome
- Firefox
- Microsoft Edge
- Safari

(参考)Chrome Headless Shell 依存関係のインストール

任意のターミナルアプリケーションを開いて次を実行します。

sudo apt update
sudo apt install -y wget unzip libnss3 libatk1.0-0 libxcomposite1 libxdamage1 libxrandr2 libgbm1 libxkbcommon0 libasound2t64 libatk-bridge2.0-0 libxfixes3

最新の Chrome Headless Shell をダウンロードし、ターミナルで次のコマンドを実行します。

cd /tmp
LATEST_VERSION=$(wget -qO- https://googlechromelabs.github.io/chrome-for-testing/LATEST_RELEASE_STABLE)
wget https://storage.googleapis.com/chrome-for-testing-public/${LATEST_VERSION}/linux64/chrome-headless-shell-linux64.zip

バイナリを解凍して移動します。バイナリを解凍して任意の場所に移動できます。バイナリを移動する場所をメモしておきます。TestRail の設定にこのパスを追加する必要があります。
```
unzip chrome-headless-shell-linux64.zip
sudo mv chrome-headless-shell-linux64 /usr/bin/
```
パーミッションを設定します。ウェブユーザーが Chrome バイナリを実行するのに十分な権限を持っていることを確認します。
```
sudo chown www-data:www-data /usr/bin/chrome-headless-shell-linux64 -R
sudo chmod 775 /usr/bin/chrome-headless-shell-linux64 -R
```

(参考)トラブルシューティング

現在の TestRail のインストールを新しいファイルで上書きする場合、新しいバージョンのインストールファイルを展開する前に、旧バージョンの次のディレクトリを削除する必要があります:

- <TestRailインストールディレクトリ>/app/libraries/PhpSpreadsheet ディレクトリ