FileLibrary | Ranorex
Help CenterUser GuideRanorex Studio expert

FileLibrary

テストの実行中に、ファイルに対してチェックをおこなったり、データを書き込んだりする必要がある場合があります。このライブラリには、そういった機能を提供するユーザーコード メソッドが含まれます。

⇢ ユーザーコード ライブラリの活用 の手順に従って、任意のレコーディング モジュールに配置し、このセクションで説明する方法に従って設定してください。

AppendStringToExistingFile

任意のファイルを開き、その末尾に文字列を追加します。ファイルが存在しない場合には、新しく生成します。

利用可能な引数は以下です。

String text

  • ファイルに追加する文字列です。
  • 変数を使用できます。

String path

  • 文字列を追加するファイルへのパスです。絶対パスおよび相対パスを指定できます。ファイル名と拡張子が含まれている必要があります。基底パスは、ソリューションの出力フォルダーです。
  • ファイル名と拡張子のみを指定した場合、つまり、パスを指定しない場合、ソリューションの出力フォルダーを検索します。
  • 指定したファイルが存在しない場合、ファイルを新しく生成し、文字列を追加します。

Boolean addNewLine

  • true = ファイルの末尾の新しい行に、文字列を追加します。
  • false = ファイルの末尾の最後の行に、文字列を追加します。

レポートにも表示されます。

CheckFilesExist

ひとつ以上のファイルが存在しているかをチェックします。Validation アクションのように動作し、success または failure を返します。

利用可能な引数は以下です。

String path

  • 存在をチェックしたいファイルが含まれるフォルダーへのパスです。絶対パスおよび相対パスを指定できます。基底パスは、ソリューションの出力フォルダーです。
  • 相対パス “./” は、出力フォルダーを検索します。

String pattern

  • 特定のファイル名および拡張子、または、検索パターンを指定できます。例えば、”DemoApp.*” は、名前が DemoApp. で始まるすべてのファイルを検索します。

Int32 expectedCount

  • 対象のフォルダーに存在すべきファイルの数を指定します。
  • このメソッドは、検索パターンで見つかった実際のファイル数と、この引数で指定したファイル数を比較します。
  • ファイル数が一致した場合 success を、一致しなかった場合には failure を返します。

結果はレポートに表示されます。

DeleteFiles

ひとつ以上のファイルを削除します。

利用可能な引数は以下です。

String path

  • 削除したいファイルが含まれるフォルダーへのパスです。絶対パスおよび相対パスを指定できます。基底パスは、ソリューションの出力フォルダーです。相対パス “./” は、出力フォルダーを検索します。

String pattern

  • 特定のファイル名および拡張子、または、検索パターンを指定できます。例えば、”DemoApp.*” は、名前が DemoApp. で始まるすべてのファイルを検索します。

削除したいファイルが見つからなかった場合、failure を返さず、Warning を表示します。

出力フォルダーにある myLogFile.txt の削除に成功
出力フォルダーに myLo.txt が見つからなかったことを示す警告

ValidateFileContainsText

ファイルが任意の文字列を含むかどうかをチェックします。引数 fileEncoding の指定はオプションです。Validation アクションのように動作し、success または failure を返します。

利用可能な引数は以下です。

String filePath

  • チェックしたいファイルへのパスです。絶対パスおよび相対パスを指定できます。基底パスは、ソリューションの出力フォルダーです。
  • ファイル名と拡張子のみを指定した場合、つまり、パスを指定しない場合、ソリューションの出力フォルダーを検索します。
  • パスに誤りがある、あるいは、ファイルが見つからなかった場合、このメソッドを配置しているモジュールは fail にはなりませんが、レポートにはエラーが表示されます。

String text

  • 検索する文字列です。
  • 変数を使用できます。

String fileEncoding

  • ファイルのエンコーディングです。
  • 指定しない場合、UTF-8 として処理します。

ValidateFilesBinaryEqual

2 つのバリナリ ファイルが同じかどうかを比較します。Validation アクションのように動作し、success または failure を返します。

String filePath1 and filePath2

  • 比較したい2つのファイルへのパスです。絶対パスおよび相対パスを指定できます。ファイル名と拡張子が含まれている必要があります。基底パスは、ソリューションの出力フォルダーです。
  • ファイル名と拡張子のみを指定した場合、つまり、パスを指定しない場合、ソリューションの出力フォルダーを検索します。
  • パスに誤りがある、あるいは、ファイルが見つからなかった場合、このメソッドを配置しているモジュールは fail にはなりませんが、レポートにはエラーが表示されます。

結果はレポートに表示されます。

2 つのファイルが一致
2 つのファイルが一致しない

ValidateFilesTextEqual

2 つのテキスト ファイルが同じかどうかを比較します。引数 normalizeLineEndings の指定はオプションです。Validation アクションのように動作し、success または failure を返します。

String filePath1 and filePath2

  • 比較したい 2 つのファイルへのパスです。絶対パスおよび相対パスを指定できます。ファイル名と拡張子が含まれている必要があります。基底パスは、ソリューションの出力フォルダーです。
  • ファイル名と拡張子のみを指定した場合、つまり、パスを指定しない場合、ソリューションの出力フォルダーを検索します。
  • パスに誤りがある、あるいは、ファイルが見つからなかった場合、このメソッドを配置しているモジュールは fail にはなりませんが、レポートにはエラーが表示されます。

Boolean normalizeLineEndings

  • true = 2 つのファイルの改行コードを統一して処理します。オリジナルのファイルには変更を加えません。

結果はレポートに表示されます。

2 つのファイルが一致
2 つのファイルが一致しない

WaitForFile

テスト実行を、指定した時間の間、一時停止します。一時停止の間、1 つ以上のファイルの存在をチェックします。つまり、1 つ以上のファイルが存在するようになるのを待機します。ファイルが存在するようになるか、引数 duration で指定した時間を経過するかによって、success または fail を返します。

String path

  • 存在をチェックしたいファイルが含まれるフォルダーへのパスです。絶対パスおよび相対パスを指定できます。基底パスは、ソリューションの出力フォルダーです。
  • 相対パス “./” は、出力フォルダーを検索します。

String pattern

  • 特定のファイル名および拡張子、または、検索パターンを指定できます。例えば、”DemoApp.*” は、名前が DemoApp. で始まるすべてのファイルを検索します。

Int32 duration

  • 待機時間を ms で指定します。
  • ファイルが存在するようになるまで、テスト実行を一時停止する待機時間です。

結果はレポートに表示されます。

成功
失敗: 指定した待機時間以内にファイルが存在しなかった

WriteToFile

新しくファイルを生成し、文字列を書き込みます。AppendStringToExistingFile は、既に存在しているファイルに文字列を書き込みますが、このメソッドは、新しく生成するファイルに書き込みます。

String text

  • ファイルに書き込む文字列です。
  • 変数を使用できます。

String filenamePrefix

  • 文字列を書き込むファイルへのパスです。絶対パスおよび相対パスを指定できます。ファイル名と拡張子が含まれている必要があります。基底パスは、ソリューションの出力フォルダーです。
  • 新しく生成するファイル名に使用するプレフィックスです。
  • 指定しない場合、ファイル名はタイムスタンプのみで構成されます。(<filename>_YYYYMMDD_HHmmSS)

String fileExtension

  • 新しく生成するファイルの拡張子です。
  • 指定しない場合、拡張子は付きません。
Note icon

メモ

このメソッドが単位秒あたり複数回呼び出された場合、最後の呼び出しによって、それ以前の呼び出しがすべて上書きされます。