跳到主要內容

Robot Framework - Test Interactive App 透過Expect測試交互式的CLI

Problem

我撰寫測試案例的應用程式,提供的CLI包含Batch與Interactive兩種模式。先前都是透過Robot本身提供的Keyword: Run、Run And Return Rc與Run And Return Rc And Output去透過Batch模式做測試。然而應用程式由於透過Java實作而成,每次執行都必須啟動JRE,導至執行測試相當緩慢。因此我企圖想改由Interactive模式去進行測試。(其實不管如何,兩種模式都應該被測試過)

How to?

交互式應用程式測試,直覺就是使用Expect。先前曾使用過Expect4J去測試軟體安裝流程,這次我打算把它寫成RobotFramework的Plugin,以Keyword的方式來撰寫測試案例。對於RobotFramework Plugin的開發,可以參考之前我所撰寫的相關文章: (1)(2),我使用的是Static API模式。

目前我設計了以下的關鍵字:

Close Spawn · Expect Should Contain · Expect String · Reset Expect Timeout · Send Command · Send Ctrl C · Send Enter · Send String · Set Expect Timeout · Spawn · Switch Spawn

成員變數/建構/解構

我參考SeleniumLibrary去設計成員變數與函式,目的是支援在同一個測試案例中,去處理兩個以上的Spawn。我們之後的所有操作,都是透過mCurrentExpectObj。如果要使用不同Spawn,就必須使用Switch Spawn並傳入ID做切換。

public static final String ROBOT_LIBRARY_VERSION = "1.0";
public static final String ROBOT_LIBRARY_SCOPE = "GLOBAL";
 
private HashMap<Long, Expect4j> mExpectObjectMap;
private Expect4j mCurrentExpectObj = null;
private Random mRandom = new Random(new Date().getTime());
 
public ExpectUtil(){
	mExpectObjectMap = new HashMap<Long, Expect4j>();
}
 
@Override
protected void finalize() throws Throwable {
	super.finalize();
	for( Expect4j expectObj : mExpectObjectMap.values()){
		expectObj.close();
	}
}

新增/關閉/切換

透過ExpectUtils的Spawn去產生Expect4j物件,接著產生隨機ID用以識別Spawn,以做切換CurrentSpawn用途。這就像是SeleniumLibrary的Open Browser與Switch Browser。關閉與切換就不贅述了。

public long spawn(String aCmd) throws Exception{
	Expect4j expectObj = ExpectUtils.spawn(aCmd); 
	mCurrentExpectObj = expectObj;
 
	long spawnId = mRandom.nextLong();
 
	mExpectObjectMap.put(spawnId, expectObj);
	return spawnId;
}
 
public void closeSpawn(){
	if( mCurrentExpectObj != null )
		mCurrentExpectObj.close();
}
 
public void switchSpawn(long aSpwanNum){
	if( !mExpectObjectMap.containsKey(aSpwanNum)){
		throw new RuntimeException("Invalid spawn number: " + aSpwanNum);
	}
 
	mCurrentExpectObj = mExpectObjectMap.get(aSpwanNum);
}

其它功能

Send相關的關鍵字,都是提供將字串送至Spawn的功能,不怎特別。其中與RobotFramework較有關連的是expectShouldContain關鍵字。我會根據傳入字串去確認Spawn中是否有出現過(即index至少要為0),去決定回傳PASS或FAIL,測試案例可以根據這個結果做Assertion。另外,並不是每個指令下完都直接有回應,因此我提供Set Expect Timeout關鍵字讓你設timeout。

public boolean expectString(String aString) throws Exception {
	return mCurrentExpectObj.expect(aString) > -1;
}
 
public String expectShouldContain(String aString) throws Exception {
	return expectString(aString) ? "PASS" : "FAIL";
}

測試案例

首先將TestLibrary的jar設定到執行的ClassPath中,做法與這篇的ShellScript相同。接著就是把它當Library給匯入就可以直接使用了。

我的測試案例就是去Spawn linux或windows的terminal,再執行echo,最後去看看是否有出現預期之結果。

當然不能忘記產生Document拉!


留言

這個網誌中的熱門文章

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 --...

解決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而產生的樣子..)

Robot Framework - Evaluate該怎麼用?

Evaluate該怎麼用? 前言 Builtin的RobotFramework Library提供了Evaluate Keyword。它所提供的功能是「執行Python描述句」。但實際上到底有什麼用途呢?原本我僅僅拿來將string轉為int的功用,經過一些查詢與試驗,我將心得整理給大家。 Builtin Builtin的function可以參考Library Doc for Evaluate。我以有使用過的function做說明。 數字轉換 Python提供了int、long、float與complex等function讓你可以將字串轉為數字,也可以透過它們做四則運算。首先以字串轉數字為例,我將8設於${num_str}中,再透過Evaluate+int轉為數字。這裡必須注意的是: 「int()中放變數必須以單引號'括起」。否則,假如你設定的數字為08,在轉換int時會出現Syntax Error。 ${num_str} | Set Variable | 8 ${num} | Evaluate | int('${num_str}') 其中int與long的第二個參數為base,這是根據你的input所決定: Comment | num = 9 ${num} | Evaluate | int('11', 8) Comment | num = 11 ${num} | Evaluate | int('11', 10) Comment | num = 17 ${num} | Evaluate | int('11', 16) 其它還有像bin、oct、hex,可以將整數轉為2、8、16進位。 運算 四則運算: 直接將運算子加上即可: ${num} | Evaluate | int('${hour}')*60 + int('${min}') 指數: 可以用pow。以下面兩個例子來說,第一個是2的3次方為8,第二個是2的3次方再mod 7為1。需注意的是: 「傳入值必須是數字不可為字串」。 ${num} | Evaluate | pow(2,3) ${num} | Evaluate | pow(2,3,7) 取最大最小值: 使用max/min,可以選擇丟一個array的方式...