この記事は「Robot Framework Advent Calendar 2017 - Qiita」の4日目の記事です。
Robot Frameworkはドキュメントが充実しています。そのため、たいていのことはドキュメントを読めば解決します。
例えば、Robot Frameworkの標準ライブラリで使えるキーワードは、以下のドキュメントにて解説されています。
- 公式ドキュメント http://robotframework.org/robotframework/#standard-libraries
- 日本語訳 http://robotframework-ja.readthedocs.io/ja/latest/userguide/CreatingTestData/UsingTestLibraries.html#id7
また、ライブラリのドキュメントは、決まったフォーマットで作成されています。これは Libdoc (Library documentation tool) にて生成されたものです。
robotframework/Libdoc.rst at master · robotframework/robotframework
ただ、最初はLibdocドキュメントの読み方が分からなかったため、その時のメモを残します。
今回は例として、Builtinライブラリのキーワード Should Be Equal を使います。
キーワードのドキュメントが表形式で作成されており、左から順に
- Keyword
- Arguments
- Documentation
となります。
Keyword
Robot Frameworkのテストコードに記載するキーワードです。
例では Should Be Equal になります。
Arguments
キーワードの引数です。
引数名引数名=デフォルト値
のどちらかになります。前者であれば必須の引数、後者は任意の引数となります。
例では、
- first
- second
は必須です。一方、
- msg=None
- values=True
- ignore_case=False
は任意です。
Documentation
キーワードの説明や使い方、サンプルなどが記載されています。
サンプルはスペース・パイプ区切り方式で書かれています。そのため、スペース区切り形式を使っている場合は、列の区切り(|)を2つのスペースへと脳内変換します。
例えば、
|Should Be Equal|${x}|expected|
をスペース区切り形式で使う場合、
Should Be Equal ${x} expected
と書きます。
Libdocのフォーマットは決まっているため、ライブラリのドキュメントの読み方も慣れやすいです。
