Report

3.3.2 Report

説明

Report- 実行されたスクリプトのレポート プロバイダを作成し、開始します。これは、結果、スクリーンショット、警告などのスクリプト実行データからレポートを作成するオブジェクトです。レポート プロバイダーはカスタマイズ可能なプラグインで、その機能、ライフ サイクル、出力形式は実装によって異なります。レポートのカスタマイズ方法の詳細については、プラグインAPIを参照してください。コマンドによって開始されるデフォルトのプロバイダーはレポート環境設定で設定可能で、デフォルトは「enterprise」です。

このコマンドは_REPORT_DIR変数設定を使用して、レポート・ファイルを保存するターゲット・フォルダを定義します。以下の変数を作成し、入力します：

エンタープライズ・レポート・プロバイダー

このプロバイダーは、HTML、XML、ZIP形式の両方をサポートしています。そのコードは「エンタープライズ」です。デフォルト・プロバイダの動作をそのままコピーし（スコープ・パラメータを除く）、設定パラメータもすべて再利用します。しかし違いは、テスト出力をどのように処理して結果のレポートファイルを生成するかにあります。デフォルトのプロバイダとは異なり、このプロバイダはScript, Step そして Timer テスト結果は、スクリプトの実行ログと緊密に統合されています。

出力形式がXMLに設定されている場合（コマンド引数に.xmlファイルが指定されている場合）、プロバイダはすべてのテスト出力を含む単純なXMLファイルを生成します。そのフォーマットはプロバイダのJava API ドキュメント.XMLレポートはXMLスタイルシート（XSL）でリンクされているため、ウェブブラウザで表示することができ、デフォルトのプロバイダで生成されたHTMLファイルとまったく同じレポートビューを提供します。HTMLビューへのXMLデータの解釈はウェブブラウザ側で行われるため、XML出力は高速で効率的です。XMLファイルはさらに、サードパーティ製アプリケーションへの試験結果のエクスポートにも再利用できます。

このツールは、デフォルトのXSLファイルをカスタムのものに置き換えるメカニズムをユーザー設定に提供します。これにより、ウェブブラウザがXMLデータを表示する方法をカスタマイズできます。プロバイダは、主にパフォーマンスに影響する追加設定可能なオプションを提供し、レポート生成の頻度をカスタマイズすることができます。

出力がHTMLに設定されている場合、プロバイダは実際にはまずXML出力を生成し、次にXSL変換を使用してHTMLファイルを生成すします。この操作は非効率的で、通常は非常に時間がかかります。この場合、プロバイダーはデフォルトのものと同じHTMLコンテンツを作成するので、XSLファイルにカスタム変更が適用されていない限り、代わりにデフォルトのものを使用することをお勧めします。

4.1.3以降、プロバイダは複数のレポートファイル（セミコロン区切り）を受け付けるようになった。これは、HTMLとXMLの両方のレポートを作成するために使用できます。また、レポート・フォルダの内容を含むZIPファイルを作成することもできます。

デフォルトのレポートプロバイダー

デフォルトのプロバイダは単純な HTML レポートを作成するレガシーレポートジェネレータです。これは以前のVNCRobot 1.xバージョンとT-Plan Robotバージョン2と互換性があります。プロバイダコードは "default "です。ライフサイクルは以下の通りです：

• • Reportコマンドを実行するたびに、レポート・プロバイダの新しいインスタンスが作成され、開始されます。定義済みのスクリプト変数とスクリーンショットと警告の内部リストを使用して、最初のHTMLレポートが直ちに生成されます。また、いくつかの特定の変数を報告するを実行コンテキストに追加する。

  • ステータスデーモンが作成され、起動する。あらかじめ定義された時間（通常は10秒）が経過すると定期的に起動し、リモートデスクトップのスクリーンショットを撮影する。この画像へのリンクがHTMLレポートに提供され、ユーザーはデスクトップの最近の状態を見ることができます。

  • 次にプロバイダは、出力オブジェクトの内部リストに変更通知を登録する。新しいスクリーンショットが撮影されたり、警告が作成されたりするたびに、プロバイダは起動し、新しいオブジェクトを含むようにレポートを再構築します。

  • スクリプトの実行が終了すると、ステータス・デーモンが起動し、終了状態を反映するためにステータス画像を更新する。その後、プロバイダが最後にウェイクアップし、終了コードに基づいて実行結果を反映するようにレポートを再構築します (Exit command).

デフォルトのレポートプロバイダは、スクリプト実行中に撮影されたすべての画像と警告を常に処理します。つまり、スクリプトの一番最後にReportコマンドを呼び出しても、Reportコマンドが実行される前に撮影されたものも含めて、HTMLレポートはすべてのスクリーンショットと警告を一覧表示します。現在、画像のリストは、画像のオリジンによってのみ制限することができます（以下のscopeパラメータを参照してください）。

HTMLレポートには、実行された画像比較の結果の表が含まれることもあります。この機能は、T-Planロボットの環境設定ウィンドウで設定することができ、スクリーンショットコマンドで実行された比較結果のすべて、または失敗した比較結果のみを表示することができます。
ComparetoコマンドやWaitforコマンドによる一致／不一致の画像比較は、決して一覧表示されないことに注意してください。その理由は、表の機能的なリンクを提供するためには、いずれにせよスクリーンショットを作成しなければならないからです。例については、上記のリンクにあるサンプル・レポートを参照してください。

デフォルトのプロバイダは、HTMLレポートの最後に特定の値を挿入します。これらはHTMLコメントに埋め込まれ、ブラウザには表示されません。これらの値は、レポートの状態、実行時間、失敗した画像比較の数などに関する情報を提供します。これらの値は、レポートの状態や結果を解釈するために、サードパーティのアプリケーションで解析することができます。提供される変数のリストとサンプル値を以下に示します：

SYNOPSIS

Report <file(s)> [provider=<provider_name>] [desc=<description>] [scope=<scope_id>] [onexit=<true|false>]

• 赤色は必須パラメータです

オプション

file(s)

-レポートを保存するファイル名。T-Plan Robot Enterprise は、そのパスとファイルが作成できるかどうかをチェックし、作成できない場合はエラーを報告します。ファイルの拡張子は、プロバイダが宣言したサポートされるフォーマットのリストと照合され、不一致の場合は構文エラーが発生します。

• このコマンドは、単一サポートファイル（「results.xml」）またはセミコロン区切りのファイルリスト （「results.xml ; results.html;archive.zip」）を採用し、複数の境界を直接作成します。ZIPファイルがリストされている場合、レポートディレクトリの内容（サブフォルダを含む）をアーカイブします。パフォーマンス上の理由から、アーカイブはマクロ終了後に一度だけ作成されます。ZIP および複数の入力ファイルのサポートは 4.1.3 で導入されました。

• 「デフォルト」プロバイダーは、.htmと.htmlの拡張子をサポートしています。単一のファイルのみを受け付けます。

ファイル名は相対パス（例: report.xml）または絶対パス（例: /root/report/report.xml）で指定できます。パスが存在しない場合、通常は作成されます（一応）。ただし、この動作は任意によって異なる場合があります。相対パスを使用する場合、レポートファイルおよび関連するすべての出力は、_REPORT_DIR 変数.で定義されたディレクトリに保存される必要があります。 

provider=<プロバイダー名>

-レポートプロバイダー名（オプション）。プロバイダーには「エンタープライズ」 （現在開発中でデフォルトで選択されている）と「デフォルト」（旧式/廃止）の2種類があります。最終的には独自の名前で新しいプロバイダーを作成し、プラグインフレームワークを介してRobotにプラグインすることもできます。

desc=<説明>

-レポートの説明。これはレポートのヘッダーに表示されます。デフォルトのプロバイダを使用する場合、テキストには任意のHTMLタグを含めることができます。

scope=<scope_id>

-scopeパラメータは、スクリーンショット作成者に基づいてレポートにどの画像を含めるかを定義する方法を提供します。このパラメータはデフォルトのレポートプロバイダーによってのみサポートされており 、Enterprise パラメータでは無視されます。。

許可される値は二つあります：：

• all - この値はデフォルトです。スクリプト実行中に撮影されたすべての画像がレポートに含まれます。

• file - 現在のスクリプト内およびこのスクリプトによって呼び出されたプロシージャ内で撮影された画像のみを含めます。マスター スクリプト（つまり、このスクリプトを呼び出す上付きスクリプト）および Run 実行 は除外されます。この方法は、1つの上付き添え字を使って小さなスクリプトをいくつも実行し、大きなレポートではなく短いレポートをいくつか用意したい場合に適しています。

onexit=<true|false>

-trueを指定すると、レポートはその場で更新されず、メソッドが呼び出されたときとスクリプトが終了したときの2回だけ作成されます。このモードは、複数のレポート対象オブジェクトを作成する大規模なスクリプトで、レポートが頻繁に更新されるとパフォーマンスが低下する可能性がある場合にお勧めします。デフォルト値はfalseです。v4.1.3からサポートされています。

戻り値

Reportコマンドは、レポート・プロバイダが開始され、最初のレポートが正常に作成・保存された場合、0（ゼロ）を返します。レポート・ファイルを作成できないなど、何らかのエラーが発生した場合、コマンドは1を返します。

使用例

Report results.xml desc="これは私のXMLレポートです。"

• レポート・ジェネレータを作成し、XMLレポートの生成を開始します。相対ファイルが提供されると、レポートは_REPORT_DIR変数の値で定義されたディレクトリに保存される。提供された説明は、レポート・ヘッダーに表示されます。

Report results.xml;results.html;results.zip desc="これは私のXMLとHTMLのレポートとZIPアーカイブです。"

• レポートジェネレータを作成し、XMLおよびHTMLレポートの生成を開始します。完了したら、レポート・フォルダーのZIPファイルを作成します。

Var _REPORT_DIR=/var/apache/htdocs/robot
Report index.html scope=file
Screenshot start_state.jpg desc="{_MACHINE}デスクトップの初期状態。FILE}スクリプトの実行開始..."

• これは report コマンドの典型的な使用例です。最初のコマンドはレポートファイルとスクリーンショットの出力パスを定義します。これは、ユーザがウェブブラウザを通してオンラインでレポートを見ることができるので非常に便利です。report コマンドとスクリーンショットコマンドは出力に相対パスを使うので、 出力ディレクトリにすべてが保存されます。