跳到主要內容

Expect4J

在linux中,我們可以透過expect將流程給自動化,我們也可以將它拿來做console的自動化測試工具。多虧某些好心人士,將它porting到java上,叫Expect4J。我把它拿來測試軟體的安裝流程,接下來我用範例告訴大家該如何使用。在我的範例中,主要的類別為:

  • ConsoleAutomationFixture: 負責處理Expect相關操作。
  • MyInstallerAutomationFixture: extedns ConsoleAutomationFixture去透過Expect處理Installer相關操作。

ConsoleAutomationFixture

我將重複使用到的expect操作寫成ConsoleAutomationFixture類別,讓不同的testcases可以重複使用它。包含:

  • expectString: 做某些操作後,期待待測程式所要顯示的字串。
  • sendEnter: 發送Enter給待測程式。
  • sendCtrlC: 發送Ctrl+C去強制離開程式,一般用於發生非期待事件使用。我根據installer是否有正常執行完去決定要不要送Ctrl+C。
  • sendString: 發送字串給待測程式。
  • setTimeout: 設定expectString的timeout時間。某些操作需要些時間才有會有response,可以透過設定timeout給它一個合理等待時間。
  • resetTimeout: 將timeout回復到預設值,10秒。

import static org.junit.Assert.assertTrue;
 
import org.junit.After;
 
import expect4j.Expect4j;
 
abstract public class ConsoleAutomationFixture {
	protected Expect4j mExpect = null;
	@After
	public void tearDown() throws Exception {
		if (mExpect != null) {
			mExpect.close();
			System.out.println("Exit the installer.");
		}
	}
	protected void expectString(String aString) throws Exception {
		assertTrue("Expect string dones't display: "+aString, mExpect.expect(aString) > -1);
	}
	protected void sendEnter() throws Exception {
		mExpect.send("\r\n");
	}
	protected void sendCtrlC() throws Exception {
		mExpect.send("\003");
	}
	protected void sendString(String aStr) throws Exception {
		mExpect.send(aStr);
		sendEnter();
	}
	protected void setTimeout(int aTimeout){
		mExpect.setDefaultTimeout(aTimeout*1000);
	}
	protected void resetTimeout(){
		mExpect.setDefaultTimeout(Expect4j.TIMEOUT_DEFAULT);
	}
}

MyInstallerAutomationFixture

這個類別我只展示launchInstaller method給大家看,其它都屬於機密。launchInstaller做的事情,就是透過ExpectUtils.spawn去執行installer執行檔,並將建立的Expect4J物件設置到mExpect中。即使是一個shell script也是可以透過Expect4J做測試。而在建立Expect4J物件後,我所期望installer會出現的字串是Preparing to install…,藉此就可以確認是否有正常執行。假如你要launch installer需要較長的時間,可以透過setTimeout去延長等待時間。

public class MyInstallerAutomationFixture extends ConsoleAutomationFixture {
	protected void launchInstaller(String aInstaller) throws Exception {
		File installer = new File(aInstaller);
		installer.setExecutable(true);
 
		mExpect = ExpectUtils.spawn(aInstaller);
		expectString("Preparing to install...");
	}
}

Summary

這個範例中我僅使用到Expect4J執行command的使用方式,它還支援SSH、Telnet、Socket。如果之後有機會再分享給大家,希望我所撰寫的ConsoleAutomationFixture對大家有幫助!

留言

這個網誌中的熱門文章

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了。