2019年8月13日 / 最終更新日時 : 2021年6月29日 user Ranorex機能

Ranorex（v6 対応）レポートをPDFに変換する #1

今回は、ReportToPDFツールを使用してRanorexレポートをPDFに変換する方法を説明します。プラットフォームに依存しないファイル形式を使用すると、Ranorexをインストールしていないユーザーにも、レポートを簡単に配布できます。

  • 既存のレポートの変換
  • テスト実行中に変換を行う
  • カスタムスタイルシート
  • 生成されたPDFの参照
  • ReportToPDFツールの入手方法
  • まとめ

既存のレポートの変換

ReportToPDFツール（入手方法は本Blogで後述します）は、コマンドラインツールであり、既存のRanorexレポートをPDFに変換できます。レポートは、圧縮形式 “rxzlog”でツールに渡す必要があります。rxzlogはレポートおよびすべての関連ファイルを含む単一のアーカイブファイル(拡張子.rxzlog)です。レポートの形式に関するより詳しい情報は、Ranorexユーザーガイドの「レポート設定」に記載されています。

次の呼び出しを使用して、コマンド ラインからReportToPDF を実行できます。

ReportToPDF.exe <input file> <output file> /<argument>

<input file>および<output file>は必須パラメータです。 <argument>はオプションです。

<input file>
変換するファイル(*.rxzlog)を指定します。

<output file>
PDFファイルの名前を設定します。

使用可能な引数:

  • style：カスタムスタイルシートを設定します。
  • detail：生成されるPDFに含める情報を指定します。
    • none：モジュールアクションは表示されません 。
    • failed：失敗したモジュールのアクションだけが表示されます。
    • all：すべてのアクションが表示されます(デフォルト値)。

例

注意: コマンド ラインから ReportToPDF を実行するとき、戻り値 ‘0’は実行が成功したことを示し、戻り値 ‘-1’ は失敗したことを示します。

テスト実行中に変換を行う

ReportToPDF ツールは、コマンドラインツールとしてだけでなく、DLL(Dynamic Link Library)としても提供されています。Ranorex.PDF.dll を使用すると、テスト実行終了時にその場で Ranorex レポートを PDF ファイルに変換できます。ツールを簡単に使用できるよう、(DLLを参照する)Ranorex コードモジュールが提供されており、数クリックの操作でレポートを変換できます。

注意：Ranorex 7.2以降は、Ranorex Automation HelpersにてPDF変換機能に直接アクセスできます。詳しい利用方法については、ユーザーガイドの”Ranorex Automation Helpers”、もしくは、Blog記事（Ranorex（v7以降 対応）レポートをPDFに変換する #2）をご参照ください。

手順:

（この記事は、開発元 Ranorex 社 Blog 「Convert your Ranorex Report to PDF」2015年7月10日の翻訳記事です。）

①　 Ranorex プロジェクトから Ranorex.PDF.dll を参照します。それには、[参照の追加] ダイアログを開き([参照]->[参照の追加])、DLLを追加します。

これで、プロジェクトビューの参照リストに、追加した DLL が表示されるようになったはずです。

②　Ranorex プロジェクトのターゲットフレームワークとして .NET Framework 4.0 以上を指定します。それには、プロジェクトプロパティの[コンパイル]タブを開きます([プロジェクト]->[プロパティ])。

③　NET Framework を設定したら、定義済みのコードモジュール ReportToPDF.cs をプロジェクトに追加できます。[追加]->[既存のアイテム]ダイアログを開き、上記のコードモジュールを追加します。

④　最後に、ユーザーコードモジュールを Ranorex テストスイートのTEARDOWNセクションなどにドラッグ&ドロップします。

ReportToPDF コードモジュールは、その時点のレポートに対する変換処理をトリガーします。変換が終了すると、PDFファイルへのリンクを含むメッセージがレポートに記録されます。

注意: 生成される PDF のデフォルトのファイルは Ranorex レポートのファイル名と同じですが、拡張子が異なります(*.pdf)。

注意: プロジェクト名に小文字の”pdf”を含めないでください。”pdf”の文字列が含まれるとと、レポートログのリンクからPDFファイルへとジャンプできなくなります。

カスタムスタイルシート

PDFレポートのルック&フィールを変更したい場合があるかもしれません。カスタムスタイルシートを使うだけで、さまざまな設定を変更できます。

例:

  • カスタムロゴの指定
  • 余白およびインデントの指定
  • フォントおよび色の指定
  • その他

生成されたPDFの参照

目次の各エントリは、特定のテストケースまたはモジュールへのダイレクトリンクになっています。

テストケース/モジュールに移動したら、ヘッダーにあるリンクを使用して簡単に目次に戻ることができます(下の図を参照)。

さらに、PDFビューアーのブックマークペインを使用してPDFの任意の場所に移動できます。

ReportToPDF ツールの入手方法

注意：Ranorex 7.2以降は、Ranorex Automation HelpersにてPDF変換機能に直接アクセスできます。詳しい利用方法については、ユーザーガイドの”Ranorex Automation Helpers”をご参照ください。Ranorex Automation Helpersを使用しない場合、パッケージマネージャからRanorexToPDFのNuGetパッケージを追加できます。ReportToPDFツール は、スタンドアロンの実行モジュールおよび DLL の形で提供されています。

Ranorex v7.0 以上

Ranorex v6.2 以下

注意: RanorexがVersion 6.0.0以降の場合、テスト実行中にレポートを変換するには、”ReportToPDF_6.X.cs”のファイルを使用してください。

注意: RanorexがVersion 6.1.0以降の場合、プロジェクトの参照部分に”Ranorex.Libs.Util.dll”を追加してください。上記のDLLはRanorexプロジェクトに表示されているReferenceから[参照の追加] ダイアログを開き([追加]->[参照の追加])、[GAC]タブのDLL一覧に含まれています。

修正履歴：

Version 1.0.10 (2017年10月5日)

  • メイン機能
    • 空のレコーディングで発生する問題の修正
    • style.xml内でTOCを無効にした際に発生する例外の修正

Version 1.0.8 (2017年6月28日)

  • バグ修正
    • 条件分岐機能に対する変換機能の追加

Version 1.0.7 (2017年3月29日)

  • メイン機能
    • Ranorex v7.0 へのサポートを追加
  • マイナー機能/バグ修正
    • 空のログメッセージに発生する問題の修正
    • ソリューション名内に”PDF”が含まれた場合に発生する問題の修正
    • 新しいレポートスタイルに合わせた style.xml の更新
    • Ranorex.PDFのVersion 1.0.7へアセンブリバージョンを更新

注意：今後のバージョン（v1.0.7）では、Ranorex v7.0より前のバージョンで生成されたレポートはPDF形式に変換できません。

Version 1.0.5 (2016年9月13日)

  • HTMLのメッセージに対するサポートを追加
  • 画像比較の際、画像が見つからない問題の修正

Version 1.0.4 (2016年6月2日)

  • Report.Screenshot()アクションで重複したメッセージが出る問題の修正
  • Ranorex 6.0に対するサポートを追加
  • Ranorex Remoteを使うときに発生するバグの修正

Version 1.0.3 (2016年2月2日)

  • バグ修正
    • PDFファイル名にレポートステータスがない問題の修正
    • 失敗時に誤ったエラーが返される問題の修正

Version 1.0.2 (2015年7月31日)

  • 全般的な変更
    • ReportToPDFコードモジュールが、生成されたPDF内に表示されなくなった
    • ReportToPDFコードモジュールが、テストスイート内の位置にかかわらず、レポートの末尾に置かれるようになった
    • 変換中に発生したエラーがレポートの一部ではなくなった。エラーはコンソールに出力される
  •  バグ修正
    • 合計持続時間がない問題の修正
    • 無効化された“Collect screenshots in a subdirectory”設定の問題の修正

Version 1.0.1 (2015年7月20日)

  • メッセージコンテンツがない問題の修正
  • PDF出力パスの修正

まとめ

ReportToPDF ツールを使用すると、コマンドラインから既存の Ranorex レポートを PDF に変換したり、テスト実行終了時にその場で変換を行うことができます。どちらの場合でも、既存の継続的インテグレーション(CI)プロセスと完全に統合できます。 PDFは、簡単にメール経由で共有したり、後で使用するために保管できます。

（この記事は、開発元 Ranorex 社 Blog 「Convert your Ranorex Report to PDF」2015年7月10日の翻訳記事です。）

カテゴリー
Ranorex機能
ツール連携

前の記事

Jenkins への自動化テストの統合
2019年8月9日
Ranorex機能

次の記事

Ranorex（v7以降 対応）レポートをPDFに変換する #2
2019年8月14日