跳到主要內容

Robot Framework Keyword: Failure Screenshot - 生死一瞬間,捕捉錯誤畫面

Problem

在Web testing中,常會使用到等待某些事件發生的keyword。如下圖使用了Wait Until Keyword Succeeds+Element Should Not Be Visible,其中三次之中失敗兩次。

RobotFramework會在這些keyword做retry時,capture下當時的screenshot。

假如每天都有跑自動測試且有保留報表的話,這些無用的圖片將會造成硬碟的負擔。尤其現在硬碟那麼貴,應該只要捕捉我們真正需要的圖片就好了!

How to?

在匯入SeleniumLibrary時,可以指定錯誤發生後要執行的動作。預設是在錯誤發生時,執行Capture Screenshot。這樣有兩個缺點,第一個是上面所提的:浪費空間;第二個是Capture Screenshot是抓取整個螢幕的畫面,如果你今天使用遠端去執行或螢幕保護程式啟動時,都將造成抓到的圖片是全黑的。針對這兩個缺點,我們可以這樣做:

  1. 取消Selenium預設動作。
  2. 在錯誤真正發生的時後,才去capture圖片,並改用Capture Page Screenshot抓圖。須注意有瀏覽器開著才會有用,否則會Fail。

取消Selenium預設動作

有兩種做法,一個是在Test Suite設定Library時,加入run_on_failure=Nothing參數;

也可以在testcase中,透過Impory Library的keyowrd將Selenium Library加入,並依樣給予run_on_failure=Nothing參數。

SeleniumLibrary允許你傳入許多參數,因此我偏好在使用時才去匯入。為此,通常我會將它與Start Selenium Server與啟動瀏覽器等動作一同放在TestSuite中。

錯誤發生時的動作

RobotFramework提供Run Keyword If Test Failed與Run Keyword If Any Tests Failed,讓你可以對TestCase與TestSuite兩個Scope在測試失敗時,執行對應的Keyword。以下圖範例來說,我在TestSuite的TestTearDown中宣告了這個Keyword,這代表TestCase預設的Teardown將會確認如果有錯就會抓圖。而SuiteTearDown則是呼叫Suite Teardown的Keyword,去做Stop Selenium Server與有錯抓圖的動作。



這兩個Keyword除了使用在拍照外,你也可以把它做成發生錯誤就寄信通知或將軟體中的log給保留起來等動作,以方便debug。

友藏內心獨白: 這個Keyword能找到不少bug阿!

留言

這個網誌中的熱門文章

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後,安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數,以前試驗過是可以安裝完成的。因此在發生這個問題後,我檢查了它的debug console: 從console得知,eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認,有問題的是有接網路線的網卡,且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制,因此發現在Anaconda的說明文件中( link ),有提到dhcptimeout這個boot參數。看了一些人的使用範例,應該是可以直接串在isolinux.cfg中,如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串,問問Google大師,想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ,關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中;在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知,它讀取的檔案是answer file而不是boot command line。因此我接下來的測試,就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --dhcptimeo

解決RobotFramework從3.1.2升級到3.2.2之後,Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護,我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情,主要先把明確的runtime語法錯誤與deprecate item處理好,這部分內容可以參考: link 。 直到最近才發現,透過SeleniumLibrary執行Choose File去上傳檔案的動作,會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法,我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住,有些測試案例是可以執行的,但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作,因為我使用 Remote Selenium ,所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現,在3.2.2的最後一個TCP封包,比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容,還有HTTP Content-Length的計算,我都確認過沒有問題。 最後發現問題是出在socket API的使用上,就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料,但沒處理到尚未送完的資料內容,而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方,在他們出新的版本之前,我是將改完的_socket.py放在我們自己的Lib底下,好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。