このセクションの内容:
CLI について
SOAtest のコマンドライン インターフェイス (soatestcli) は、自動夜間プロセスの一部として静的解析やテストを実行します。コマンドライン モードは Automation Edition で利用できます。
soatestcli は「Parasoft Report Center への結果の送信」、「チーム マネージャーや Parasoft Team Server へのレポートの送信」、「SOA プロジェクトに従事する個々の開発者やテスト担当者に特化したレポートの送信」を実行できます。レポートを複数の形式で生成できます。レポート設定 (レポートの送信先、レポートのラベル付け、使用するメール サーバーやドメインなど) や、Team Server、Report Center、E-mail、ライセンスなどの詳しい設定は、ローカル設定ファイルでコントロールできます。
最適なチーム コンフィギュレーションは、チームのビルド マシンに 1 つの SOAtest (Automation Edition) を、各開発者/テスト担当者のワークステーションに SOAtest (Desktop Edition) を、アーキテクトのマシンに 1 つの SOAtest (Architect Edition) を、そしてチームのビルド マシンまたは別のチーム マシンに 1 つの Team Server を用意することです。
エンジニアは、自分のローカル マシンにインストールした SOAtest を使用してテストの開発や実行を行い、ソース管理に成果物をチェックインします。そしてチーム マシンで毎晩 soatestcli を実行します。構成によっては、テストの実行、ポリシー順守のモニタリング、指定の静的解析テストも実施されることがあります。テストが完了したら、SOAtest GUI にテスト結果をインポートし、タスクの確認や対応を行います。
さらに、 SOAtest は Report Center に結果を送信し、チーム メンバーごとに「そのメンバーに割り当てられたタスクだけのレポート」を送付します。そして、グループ マネージャーには「全チーム/プロジェクトの品質タスクの一覧および各タスクの担当者 (チーム メンバー) の一覧」をレポートし、Team Server にレポートと結果をアップロードします。
このプロセスを通して、テスト設定やテスト ファイルの共有と更新を Team Server が管理します。その結果、チーム間でテストが標準化され、チーム メンバーがお互いの作業を修正するのに役立ちます。標準化されたテスト設定とチーム固有のルールは、SOAtest Architect Edition を使用するチーム アーキテクトが構成および維持します。
前提条件
- コマンドライン モードを使用するには、コマンドライン インターフェイス ライセンス (SOAtest Automation Edition で利用可能) が必要です。
- コマンドラインからテストを実行する前に、プロジェクト、.tst ファイル、テスト スイートを設定する必要があります。詳細については、「プロジェクト、.tstファイル、テスト スイートの追加」 を参照してください。
- テストを開始する前に Parasoft Test の設定 (Team Server、 タスク割り当て、レポートなど) を構成することを強く推奨します。詳細については「設定」を参照してください。
CLI のセットアップ
Parasoft SOAtest には 2 種類のユーザー モードがあります。デスクトップでインタラクティブに使用する GUI モードと、コマンドライン インターフェイス (CLI) を使用するコマンドライン モードです。CLI インターフェイスは Automation Edition の標準機能です。
一般的に CLI モードを使用するのは、「定期的または継続的なコード解析を実行する場合」、および「定期的/継続的なビルドと同時にテスト実行する、または自動回帰テスト インフラの一部としてテスト実行する場合」です。CLI 実行の一部として、 SOAtest は以下の 1 つ以上を実行できます。
- 機能テスト、セキュリティ テスト、回帰テストの実行
- ポリシーの推進
- 静的解析
- SCM コード リポジトリの解析。最後の実行後にあったコード変更を特定し、更新されたコードのコード レビュー セッションを実施します。
- 指定されたレポート設定に従った、レポートの生成、およびセントラル レポート サーバーあるいは個々の開発者やマネージャーへのレポートの配布
実行の一部として、 SOAtest は SCM クライアントを使用できます (対応している場合)。ファイルの変更情報を SCM システムから自動的に復旧し、コード解析とテストの実行結果に基づいて特定の個人のためにタスクを生成します。
SOAtest の詳細な実行オプションは、テスト コンフィギュレーションと環境設定によって制御されます。
テスト コンフィギュレーションは、同梱のビルトイン コンフィギュレーションをそのまま使用するか、SOAtest の GUI を使って作成します。ユーザー固有のテスト コンフィギュレーションを作成するためのテンプレートとして、ビルトイン コンフィギュレーションを使用することを推奨します。作成したテスト コンフィギュレーションは、ローカル ディスクまたは Team Server に格納されます。
設定は、SOAtest GUI で指定できます。 ほとんどの設定は構成ファイルで指定することも可能です。構成ファイルは、CLI 呼び出しのパラメーターとして渡します。構成ファイルの設定項目は、ローカル設定ファイル (オプション) で参照できます。デフォルトで使用されるのは GUI で指定した設定です。構成ファイルの設定は、実行時に GUI のデフォルト設定を上書きします。 そのため、すべての CLI 実行で使用する基本的な設定を GUI で指定した上で、構成ファイルを作成し、特定の実行に合わせてデフォルト設定を変更することができます。たとえば、実行ごとに異なる情報をレポートに含めたり、レポートの E-mail 配布オプション (レポート名や E-mail の見出しなど) を変更したい場合、構成ファイルを使用すると役立ちます。
ステップ 1: 環境設定
設定を確認するには、[Parasoft] メニュー > [設定] をクリックします。[Parasoft] グループの次の設定から環境設定を開始します。
- ライセンス: ライセンスまたはライセンス サーバー設定を指定します。
- Team Server: [Team Server を有効にする] をオンにします。Team Server が自動認識されない場合は、 [ホスト名] に Team Server の IP アドレスを入力します。Automation Edition 製品と同じマシン上で Team Server を起動している場合は、 localhost と入力してください。Team Server インストール時に Team Server のデフォルト ポート (18888) を変更していない限り、[ポート番号] は変更しないでください。[接続のテスト] をクリックして設定が正しいかを確認します。
- ソース管理: この設定は、影響されたコードまたはテストの成果物を最後に変更した個人が、ツールの結果を自動マッピングさせることを可能にします。ユーザーの SCM に適したオプションを設定するには、ご使用のソース管理システムを確認し、「ソース管理リポジトリとの接続」の手順に従ってください。
- スコープと作成者: ユーザーの環境に適したオプションをオンにします。詳細については、「タスクの割り当てとコード作成者の設定」を参照してください。
- レポート: 次のオプションがデフォルトで有効になっています。
- 詳細な開発者レポート (タスクの内訳と詳細を含む)
- 作成者ごとのタスクの概要 (概要の表)
- コマンドライン モードでフォーマット済みのレポートを生成
- 抑制の詳細 (静的解析だけに適用される)
- E-mails: レポートの E-mail 送信に使用される設定を入力します。SOAtest テスト マシンから接続できるメール サーバー上の既存の E-mail アカウントである必要があります。
- レポート> E-mail 通知:
- 必要に応じて、[レポートを E-mail で送信する] をオンにします。この設定に関わらず、レポートは常に Parasoft Team Server にアップロードされ、後から確認できます (CLI オプションによって管理されます)。E-mail の配布には上記の [E-mail] 設定が使用されます。
- マネージャー レポートは、 SOAtest によって生成されたすべてのテストのロールアップを含みます。 開発者/テスター レポートは個別の開発者やテスト担当者の結果だけを含みます。適宜、オプションを有効にして E-mail アドレスを指定します。
ステップ 2: テスト コンフィギュレーションのカスタマイズ
ユーザー任意のテスト コンフィギュレーションを作成します。詳細については、「テスト コンフィギュレーションとルールの設定」 を参照してください。SOAtest 固有のオプションの詳細については、「SOAtest テスト コンフィギュレーションの設定」を参照してください。
ステップ 3: ローカル設定ファイルの作成
ローカル設定ファイルを作成します。詳細については、「ローカル設定ファイル (オプション)」を参照してください。
ステップ 4: 現在実行中のビルド システムで CLI をアクティブにする (バッチ スクリプトなど)
たとえば、次のようなサンプル コマンドラインを追加できます。
soatestcli -resource <project name> -config "team://Team Configuration" -publish -localsettings acme_policy.settings
レポートは、各バッチの実行後に送信され、トレンド レポートにデータが投入されます。レポートは、 [Parasoft] > [探索] > [Team Server レポート] からも参照できます。