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拉!