robotframework筆記26

測試數據文檔工具(Testdoc)

Testdoc是機器人框架內置的工具生成高水平 根據測試用例文檔。 創建的文檔是在HTML中 格式和它包括名稱、文檔和其他元數據 測試套件和測試用例,以及和他們的頂級關鍵詞 參數。

一般使用

簡介

python -m robot.testdoc [options] data_sources output_file

選項

- t , ——標題 <標題>
	生成的文檔的標題。 標題中強調轉換為空間。 默認的標題是頂級套件的名稱。
- n , ——名字 <名稱>
	覆蓋頂級測試套件的名稱。
- d , ——醫生 <文件>
	覆蓋頂層的文檔測試套件。
- m , ——元數據 <名稱:值>
	釋放/覆蓋頂級測試套件的元數據。
- g , ——settag <標記>
	設置給定的標記(s)所有測試用例。
- t , ——測試 <名稱>
	包括測試的名字。
- s , ——套件 <名稱>
	包括套件的名字。
-我 , ——包括 <標記>
	包括測試的標簽。
- e , ——排除 <標記>
	排除測試的標簽。
- h ,——幫助	在控制台打印此幫助。

所有的選擇除了 ——標題 有完全相同的語義相同嗎 選擇當 執行測試用例 。

生成文檔

數據可以作為一個單獨的文件,目錄,或者是多個文件 目錄。 在所有這些情況下,最后一個參數必須的文件 寫輸出。

Testdoc與所有翻譯工作由機器人框架(支持Python, Jython和IronPython)。 它可以作為一個執行安裝模塊 python - m robot.testdoc 或作為一個腳本 python /機器人/ testdoc.py路徑 。

例子:

python -m robot.testdoc my_test.html testdoc.html
jython -m robot.testdoc --name smoke_tests --include smoke path/to/my_tests smoke.html
ipy path/to/robot/testdoc.py first_suite.txt second_suite.txt output.html

測試數據清理工具(整潔)

• 5.3.1一般使用
• 5.3.2清理測試數據
• 5.3.3改變測試數據格式

整潔是機器人框架內置的清理和變化的工具 機器人框架測試數據文件的格式。

輸出寫入標准輸出流在默認情況下,但是 一個可選的輸出文件可以從機器人2.7.5框架。 就地使用文件也可以被修改 ——原地 或 ——遞歸 選項。

一般使用

劇情簡介

python -m robot.tidy [options] inputfile
python -m robot.tidy [options] inputfile [outputfile]
python -m robot.tidy --inplace [options] inputfile [more input files]
python -m robot.tidy --recursive [options] directory

選項

-我 ,——原地	整潔的給定文件),這樣原始文件被覆蓋 (或刪除,如果格式改變)。 當這個選項 使用,它可以給多個輸入文件。 例子: python -m robot.tidy --inplace tests.html python -m robot.tidy --inplace --format txt *.html
- r , ——遞歸
	給定目錄遞歸過程。 文件的目錄 同樣當處理的地方嗎 ——原地 選擇使用。
- f , - - -格式 html <機器人| txt | | tsv >
	輸出文件格式。 如果顯式給定的輸出文件, 默認值為從其擴展。 否則 格式是沒有改變。
- p , ——用管道
	使用管道字符(|)作為細胞分離器txt格式。
- s , ——spacecount <數>
	細胞之間的空間txt格式的數量。 2.7.3新機器人框架。
- l , ——lineseparator <本機windows | | unix >
	行分隔符用於輸出。 默認值是“本地”。 本機 :使用操作系統的本機行分隔符 窗戶 :使用Windows行分隔符(CRLF) unix :使用Unix行分隔符(低頻) 新機器人2.7.6框架。
- h ,——幫助	顯示幫助。

選擇執行

雖然整潔與Python在上面的簡介中,只使用它的工作原理 也與Jython和IronPython。 在執行概要整潔 一個安裝模塊( python - m robot.tidy ),但它也可以運行 一個腳本:

python path/robot/tidy.py [options] arguments

執行一個腳本可以是有用的,如果你所做的 手動安裝 或者只有 機器人 與源代碼目錄 在您的系統。

輸出編碼

所有輸出文件編寫使用utf - 8編碼。 輸出寫入到 控制台使用當前控制台編碼。

清理測試數據

測試用例文件創建HTML編輯器或手寫可以規范化 使用整潔。 整潔總是寫標題一致,一致的訂單 設置,和一致的細胞和表之間的空白。

例子:

python -m robot.tidy messed_up_tests.html cleaned_tests.html
python -m robot.tidy --inplace tests.txt

改變測試數據格式

機器人框架支持測試數據在HTML中,TSV和TXT格式整齊 使改變之間的格式簡單。 輸入格式總是確定的 基於擴展的輸入文件。 可以設置輸出格式使用 的 - - -格式 的選項,默認值是得到了擴展 可能的輸出文件。

例子:

python -m robot.tidy tests.html tests.txt
python -m robot.tidy --format txt --inplace tests.html
python -m robot.tidy --format tsv --recursive mytests

外部工具

有很多外部工具,可以用於機器人框架。 這些工具包括測試數據編輯器 騎 ,為各種ide和擴展 文本編輯器插件,持續集成系統和構建工具, 等等。

這些工具是作為獨立項目開發獨立於機器人 框架本身。 可用工具的列表,請參閱 http://robotframework.org/工具 。

請注意

一些支持工具使用與機器人分布式框架 本身。 現在所有這些工具也可單獨購買, 他們從存儲庫中刪除和源分布 在機器人2.8.6框架。

測試數據中所有可用的設置

• 但是設置表
• 6.1.2測試用例表
• 6.1.3關鍵字表

但是設置表

設置表是用於導入測試庫,文件和資源 變量定義元數據的文件和測試套件和測試 用例。 它可以包括在測試用例文件和資源文件。 請注意 在一個資源文件,設置表只能包括設置 導入庫、資源和變量。

設置可以設置表中

的名字	描述
圖書館	用於 導入庫 。
資源	用於 考慮到資源文件使用 。
變量	用於 考慮變量文件使用 。
文檔	用於指定一個 測試套件 或 資源文件 文檔。
元數據	用於設置 免費測試套件的元數據 。
套件設置	用於指定 套件設置 。
套件拆卸	用於指定 套件拆卸 。
力的標簽	當用於指定強制值標簽 標簽的測試用例 。
默認的標簽	用於指定標簽時的默認值 標簽的測試用例 。
測試設置	用於指定一個默認的 測試設置 。
測試拆卸	用於指定一個默認的 測試拆卸 。
測試模板	用於指定一個默認的 模板的關鍵字 測試用例。
測試超時	用於指定一個默認的 測試用例超時 。

請注意

所有設置名稱可以包含一個冒號最后, 例子 文檔: 。 這可以簡化設置讀取 尤其是當使用純文本格式。

測試用例表

設置測試用例表中總是具體的測試 定義它們。 覆蓋這些設置 表中定義的默認值設置。

設置測試用例表中可用

的名字	描述
(文檔)	用於指定一個 測試用例文檔。
(標簽)	用於 標簽的測試用例 。
(設置)	用於指定一個 測試設置 。
(拆卸)	用於指定一個 測試拆卸 。
(模板)	用於指定一個 模板的關鍵字。
(超時)	用於指定一個 測試用例超時。

關鍵字表

設置關鍵字表中的特定於用戶的關鍵字 定義它們。

設置關鍵字表中可用

的名字	描述
(文檔)	用於指定一個 用戶的關鍵字的文檔。
(標簽)	用於指定 用戶關鍵詞標簽 。
(參數)	用於指定 用戶關鍵字參數 。
(返回)	用於指定 用戶關鍵字返回值 。
(拆卸)	用於指定 用戶關鍵字拆卸 。
(超時)	用於指定一個 用戶關鍵字超時 。

所有的命令行選項

這個附錄列出了所有可用的命令行選項 當 執行測試用例 當 后處理輸出 。 環境變量影響執行和后期處理 列出。

• 6.2.1測試執行的命令行選項
• 6.2.2后處理輸出的命令行選項
• 6.2.3環境變量為執行和后期處理

測試執行的命令行選項

- n , ——名字 <名稱>
	集的名字 頂級的測試套件。
- d , ——醫生 <文件>
	設置文檔 頂級的測試套件。
- m , ——元數據 <名稱:值>
	套免費的元數據 頂級測試套件。
- g , ——settag <標記>
	設置標簽(s) 執行測試用例。
- t , ——測試 <名稱>
	選擇測試用例的名字 。
- s , ——套件 <名稱>
	選擇測試套件 的名字。
- r , ——rerunfailed <文件>
	選擇失敗的測試 從較早的 輸出文件 可重復。
——runfailed <文件>
	機器人框架2.8.4以來棄用。 使用 ——rerunfailed 代替。
-我 , ——包括 <標記>
	選擇測試用例 通過標簽。
- e , ——排除 <標記>
	選擇測試用例 通過標簽。
- c , ——關鍵 <標記>
	測試有給定的標記 被認為是至關重要的 。
- n , ——被 <標記>
	測試有給定的標記 不是至關重要的 。
- v , ——變量 <名稱:值>
	集 單獨的變量 。
- v , ——variablefile <路徑:參數>
	設置變量使用 變量的文件 。
- d , ——outputdir < dir >
	定義在哪里 創建輸出文件 。
- o , ——輸出 <文件>
	集生成的路徑 輸出文件 。
- l , ——日志 <文件>
	集生成的路徑 日志文件 。
- r , ——報告 <文件>
	集生成的路徑 報告文件 。
- x , ——xunit <文件>
	集生成的路徑 xUnit兼容的結果文件 。
——xunitskipnoncritical
	馬克非關鍵測試 xUnit兼容的結果文件 跳過。
- b , ——debugfile <文件>
	一個 調試文件 這是在執行期間寫的。
- t , ——timestampoutputs
	添加一個時間戳 所有輸出文件。
——splitlog	把日志文件 成小塊,開放 瀏覽器透明。
——logtitle <標題>
	設定一個標題 對生成的測試日志。
——reporttitle <標題>
	設定一個標題 對生成的測試報告。
——reportbackground <色調>
	設置背景顏色 生成的報告。
- l , ——loglevel <上>
	設置閾值水平 為日志記錄。 (可選) 默認的 可見的日志級別 可以給 分離一個冒號(:)。
——suitestatlevel <上>
	定義了多少 水平顯示 在 統計的套件 表中輸出。
——tagstatinclude <標記>
	只包含這些標記 在 統計數據的標簽 表。
——tagstatexclude <標記>
	不包括這些標簽 從 統計數據的標簽 表。
——tagstatcombine <標簽:標題>
	創建 結合統計數據基於標簽 。
——tagdoc <模式:醫生>
	增加了 文檔指定的標簽 。
——tagstatlink <模式:鏈接:標題>
	增加了 外部鏈接 到 統計數據的標簽 表。
——removekeywords < | |通過名字:模式|標簽:模式| | wuks >
	刪除關鍵字數據 從生成的日志文件。
——flattenkeywords <為| foritem |名稱:模式|標簽:模式>
	趨於平緩的關鍵詞 在生成的日志文件。
——偵聽器 <名稱:參數>
	設置一個偵聽器 測試執行監控。
——warnonskippedfiles
	顯示一個警告,當 跳過一個無效的文件 。
——nostatusrc	設置 返回代碼 為零,不管失敗 在測試用例。 錯誤代碼返回正常。
——runemptysuite
	如果選擇的執行測試 測試套件是空的 。
——dryrun	在 排練 沒有執行模式運行測試 關鍵字源自測試庫。 有用的 驗證測試數據的語法。
——exitonfailure
	停止測試執行 如果任何關鍵的測試失敗。
——exitonerror	停止測試執行 如果任何錯誤發生在解析測試數據,導入庫,等等。
——skipteardownonexit
	跳過拆解 測試執行是過早地停止了。
——prerunmodifier <名稱:參數>
	激活 編程式的修改測試數據 。
——prerebotmodifier <名稱:參數>
	激活 編程式的修改結果 。
——隨機 < | | |套件測試都沒有>
	隨機排列 測試執行的順序。
——控制台 <詳細|虛線| |安靜沒有>
	控制台輸出類型 。
——點綴	的快捷方式 ——控制台點綴 。
——安靜	的快捷方式 ——控制台安靜 。
- w , ——consolewidth <寬度>
	設置寬度 的控制台輸出。
- c , ——consolecolors <汽車| | ansi |關閉>
	指定是顏色 在控制台上使用。
- k , ——consolemarkers <汽車| |關閉>
	顯示 標記在控制台上 當頂層 關鍵字在一個測試用例結束。
- p , ——pythonpath環境 <路徑>
	額外添加的位置 模塊搜索路徑 。
- e , ——逃避 <什么:>
	轉義字符 有問題的在控制台。
——一個 , ——argumentfile <路徑>
	一個文本文件 閱讀更多的參數 從。
- h , ——幫助	打印 使用說明 。
——版本	打印 版本信息 。

6.2.2后處理輸出的命令行選項

- r ,——合並	結合行為變化的結果 合並 。
——rerunmerge	機器人框架2.8.6以來棄用。 使用 ——合並 代替。
- n , ——名字 <名稱>
	集的名字 頂級的測試套件。
- d , ——醫生 <文件>
	設置文檔 頂級的測試套件。
- m , ——元數據 <名稱:值>
	套免費的元數據 頂級測試套件。
- g , ——settag <標記>
	設置標簽(s) 所有處理測試用例。
- t , ——測試 <名稱>
	選擇測試用例的名字 。
- s , ——套件 <名稱>
	選擇測試套件 的名字。
-我 , ——包括 <標記>
	選擇測試用例 通過標簽。
- e , ——排除 <標記>
	選擇測試用例 通過標簽。
- c , ——關鍵 <標記>
	測試有給定的標記 被認為是至關重要的 。
- n , ——被 <標記>
	測試有給定的標記 不是至關重要的 。
- d , ——outputdir < dir >
	定義在哪里 創建輸出文件 。
- o , ——輸出 <文件>
	集生成的路徑 輸出文件 。
- l , ——日志 <文件>
	集生成的路徑 日志文件 。
- r , ——報告 <文件>
	集生成的路徑 報告文件 。
- x , ——xunit <文件>
	集生成的路徑 xUnit兼容的結果文件 。
——xunitskipnoncritical
	馬克非關鍵測試 xUnit兼容的結果文件 跳過。
- t , ——timestampoutputs
	添加一個時間戳 所有輸出文件。
——splitlog	把日志文件 成小塊,開放 瀏覽器透明。
——logtitle <標題>
	設定一個標題 對生成的測試日志。
——reporttitle <標題>
	設定一個標題 對生成的測試報告。
——reportbackground <色調>
	設置背景顏色 生成的報告。
- l , ——loglevel <上>
	設置閾值水平 選擇日志消息。 選擇默認 可見的日志級別 可以給 分離一個冒號(:)。
——suitestatlevel <上>
	定義了多少 水平顯示 在 統計的套件 表中輸出。
——tagstatinclude <標記>
	只包含這些標記 在 統計數據的標簽 表。
——tagstatexclude <標記>
	不包括這些標簽 從 統計數據的標簽 表。
——tagstatcombine <標簽:標題>
	創建 結合統計數據基於標簽 。
——tagdoc <模式:醫生>
	增加了 文檔指定的標簽 。
——tagstatlink <模式:鏈接:標題>
	增加了 外部鏈接 到 統計數據的標簽 表。
——removekeywords < | |通過名字:模式|標簽:模式| | wuks >
	刪除關鍵字數據 從生成的輸出。
——flattenkeywords <為| foritem |名稱:模式|標簽:模式>
	趨於平緩的關鍵詞 在生成的輸出。
——開始時間 <時間>
	設置 起始時間 當創建的測試執行 報告。
——endtime <時間>
	設置 結束時間 當創建的測試執行報告。
——nostatusrc	設置 返回代碼 為零,不管失敗 在測試用例。 錯誤代碼返回正常。
——processemptysuite
	即使文件包含流程的輸出文件 空的測試套件 。
——prerebotmodifier <名稱:參數>
	激活 編程式的修改結果 。
- c , ——consolecolors <汽車| | ansi |關閉>
	指定是顏色 在控制台上使用。
- p , ——pythonpath環境 <路徑>
	額外添加的位置 模塊搜索路徑 。
- e , ——逃避 <什么:>
	轉義字符 有問題的在控制台。
——一個 , ——argumentfile <路徑>
	一個文本文件 閱讀更多的參數 從。
- h ,——幫助	打印 使用說明 。
——版本	打印 版本信息 。

環境變量為執行和后期處理

ROBOT_OPTIONS  和  REBOT_OPTIONS

由空格分隔的列表默認選項  前面的任何明確的選擇  在命令行上。

ROBOT_SYSLOG_FILE

路徑  syslog  文件,機器人框架內部寫道 解析信息測試用例文件和運行 測試。

ROBOT_SYSLOG_LEVEL

日志級別使用時寫的  syslog  文件。

ROBOT_INTERNAL_TRACES

當設置為任何非空值時,機器人框架的 都包含在內部的方法  錯誤回溯  。

測試數據模板

這些模板可以使用 創建測試數據 對機器人 框架。 都有模板 測試用例 和 資源 文件 和資源模板也可以用來創建 測試套件 初始化文件 。

模板中可用 HTML格式 和 TSV格式 ,他們可以 自由定制。 沒有模板 純文本格式 因為 它需要樣板太少,模板不會是非常有用的。

testcase_template.html

測試用例文件模板的HTML格式。

testcase_template.tsv

測試用例文件模板TSV格式。

resource_template.html

資源文件模板的HTML格式。

resource_template.tsv

資源文件TSV格式的模板。

attd_template.html

在驗收測試驅動創建測試用例的模板 開發(ATDD)風格。 這些測試是由高層 關鍵字不需要參數和模板 相應的簡化。

模板是可以通過這個用戶指南,它們包含在 源分布,也可以找到 從項目頁面 。