CLI について

SOAtest のコマンドラインインターフェイス (soatestcli) は、自動夜間プロセスの一部として静的解析やテストを実行します。コマンドラインモードは、SOAtest の Automation Edition で使用でき、Docker のデプロイと互換性があります。

soatestcli は、結果を Parasoft Report Center に送信し、SOA プロジェクトに従事している各チームの開発者およびテスターに焦点を絞ったレポートを送信できます。レポートを複数の形式で生成できます。レポート設定 (レポートの送信先、レポートのラベル付け、使用するメールサーバーやドメインなど) や、Report Center、E-mail、ライセンスなどの詳しい設定は、設定ファイルでコントロールできます。

最適なチームコンフィギュレーションは、チームのビルドマシンに 1 つの SOAtest (Automation Edition) を、各開発者/テスト担当者のワークステーションに SOAtest (Desktop Edition) を、アーキテクトのマシンに 1 つの SOAtest (Architect Edition) を用意することです。

エンジニアは、自分のローカルマシンにインストールした SOAtest を使用してテストの開発や実行を行い、ソース管理に成果物をチェックインします。そしてチームマシンで毎晩 soatestcli を実行します。構成によっては、テストの実行、ポリシー順守のモニタリング、指定の静的解析テストも実施されることがあります。テストが完了したら、SOAtest GUI にテスト結果をインポートし、タスクの確認や対応を行います。

さらに、 SOAtest は Report Center に結果を送信し、チームメンバーごとに「そのメンバーに割り当てられたタスクだけのレポート」を送付します。そして、グループマネージャーには「全チーム/プロジェクトの品質タスクの一覧および各タスクの担当者 (チームメンバー) の一覧」をレポートします。

前提条件

コマンドラインモードを使用するには、コマンドラインインターフェイスライセンス (SOAtest Automation Edition で利用可能) が必要です。
コマンドラインからテストを実行する前に、プロジェクト、.tst ファイル、テストスイートを設定する必要があります。詳細については、「プロジェクト、.tstファイル、テストスイートの追加」を参照してください。
テストを開始する前に、「設定」で説明しているように、DTP のレポート設定や他の Parasoft 設定を行うことを強く推奨します。

CLI のセットアップ

Parasoft SOAtest には 2 種類のユーザーモードがあります。デスクトップでインタラクティブに使用する GUI モードと、コマンドラインインターフェイス (CLI) を使用するコマンドラインモードです。CLI インターフェイスは Automation Edition の標準機能です。

一般的に CLI モードを使用するのは、「定期的または継続的なコード解析を実行する場合」、および「定期的/継続的なビルドと同時にテスト実行する、または自動回帰テストインフラの一部としてテスト実行する場合」です。CLI 実行の一部として、 SOAtest は以下の 1 つ以上を実行できます。

機能テスト、セキュリティテスト、回帰テストの実行
ポリシーの推進
静的解析
SCM コードリポジトリの解析。最後の実行後にあったコード変更を特定し、更新されたコードのコードレビューセッションを実施します。
指定されたレポート設定に従った、レポートの生成、およびセントラルレポートサーバーあるいは個々の開発者やマネージャーへのレポートの配布

実行の一部として、 SOAtest は SCM クライアントを使用できます (対応している場合)。ファイルの変更情報を SCM システムから自動的に復旧し、コード解析とテストの実行結果に基づいて特定の個人のためにタスクを生成します。

SOAtest の詳細な実行オプションは、テストコンフィギュレーションと環境設定によって制御されます。

テストコンフィギュレーションは、同梱のビルトインコンフィギュレーションをそのまま使用するか、SOAtest の GUI を使って作成します。ユーザー固有のテストコンフィギュレーションを作成するためのテンプレートとして、ビルトインコンフィギュレーションを使用することを推奨します。作成したテストコンフィギュレーションは、ローカルディスクに格納されます。

設定は、SOAtest GUI で指定できます。ほとんどの設定は構成ファイルで指定することも可能です。構成ファイルは、CLI 呼び出しのパラメーターとして渡します。構成ファイルの設定項目は、設定ファイル (オプション) で参照できます。デフォルトで使用されるのは GUI で指定した設定です。構成ファイルの設定は、実行時に GUI のデフォルト設定を上書きします。そのため、すべての CLI 実行で使用する基本的な設定を GUI で指定した上で、構成ファイルを作成し、特定の実行に合わせてデフォルト設定を変更することができます。たとえば、実行ごとに異なる情報をレポートに含めたり、レポートの E-mail 配布オプション (レポート名や E-mail の見出しなど) を変更したい場合、構成ファイルを使用すると役立ちます。

ステップ 1: 環境設定

設定を確認するには、[Parasoft] メニュー > [設定] をクリックします。[Parasoft] グループの次の設定から環境設定を開始します。

ライセンス: ライセンスまたはライセンスサーバー設定を指定します。
ソース管理: この設定は、影響されたコードまたはテストの成果物を最後に変更した個人が、ツールの結果を自動マッピングさせることを可能にします。ユーザーの SCM に適したオプションを設定するには、ご使用のソース管理システムを確認し、「ソース管理リポジトリとの接続」の手順に従ってください。
スコープと作成者: ユーザーの環境に適したオプションをオンにします。詳細については、「タスクの割り当てとコード作成者の設定」を参照してください。
レポート: 次のオプションがデフォルトで有効になっています。
- 詳細な開発者レポート (タスクの内訳と詳細を含む)
- 作成者ごとのタスクの概要 (概要の表)
- コマンドラインモードでフォーマット済みのレポートを生成
- 抑制の詳細 (静的解析だけに適用される)
E-mails: レポートの E-mail 送信に使用される設定を入力します。SOAtest テストマシンから接続できるメールサーバー上の既存の E-mail アカウントである必要があります。
レポート > E-mail 通知:
- 必要に応じて、[レポートを E-mail で送信する] をオンにします。E-mail の配布には上記の [E-mail] 設定が使用されます。
- マネージャーレポートは、 SOAtest によって生成されたすべてのテストのロールアップを含みます。開発者/テスターレポートは個別の開発者やテスト担当者の結果だけを含みます。適宜、オプションを有効にして E-mail アドレスを指定します。

ステップ 2: テストコンフィギュレーションのカスタマイズ

ユーザー任意のテストコンフィギュレーションを作成します。詳細については、「テストコンフィギュレーションとルールの設定」を参照してください。SOAtest 固有のオプションの詳細については、「SOAtest テストコンフィギュレーションの設定」を参照してください。

ステップ 3: 設定ファイルの作成

設定ファイルを作成します (「設定ファイル (オプション)」で説明)。

ステップ 4: 現在実行中のビルドシステムで CLI をアクティブにする (バッチスクリプトなど)

たとえば、次のようなサンプルコマンドラインを追加できます。

soatestcli -resource <project name> -config "team://Team Configuration" -publish -settings acme_policy.settings

レポートは、各バッチの実行後に送信され、トレンドレポートにデータが投入されます。

Page tree

SOAtest CLI Overview