跳到主要內容

Mock System.exit

Problem

一個java的console programe,免不了需要使用System.exit讓caller知道程式的執行結果。這就像是C中的exit,C還可以透過main的return value來當exit code。我們先看看下面的範例程式:
package org.tonylin.powermock;
 
public class Example {
 
	public Example(){
 
	}
 
	public void doSomething(){
 
	}
 
	public static void main(String[] args) {
		try {
			new Example().doSomething();
		} catch( Exception e ){
			System.exit(1);
		} finally {
			System.exit(0);
		}
	}
 
}
main中僅是call Example的doSometing,有問題就dump exit code為1,正常exit code為0。而然如果在Junit中直接呼叫Example.main,這測試馬上就結束了,下面的測試案例也不用繼續進行。也許你可以把main精簡到不能再精簡的地步,不去管它或是透過外部程式的方式去測它;不管怎樣,它的line coverage還是會少掉這幾行,對一個基於外部程式的系統而言,也非常的傷。我們可以透過PowerMock以下的方式,去捕捉到Exit code與避免程式離開。

How to solve?

我們先撰寫基本的skeleton:
package org.tonylin.powermock;
 
import org.easymock.EasyMock;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.powermock.api.easymock.PowerMock;
import org.powermock.core.classloader.annotations.PrepareForTest;
import org.powermock.modules.junit4.PowerMockRunner;
 
 
@RunWith(PowerMockRunner.class)
@PrepareForTest({Example.class})
public class TestExample {
	@Test
	public void testMain(){
 
	}
}
首先加入Run With annotation讓測試透過PowerMockRunner執行,接著將Example.class加到PrepareForTest中。而測試案例的實做,首先必須透過PowerMock的mockStatic去mock System.clss,接著執行System.exit(0)與PowerMock.expectLastCall().times(1)讓PowerMock知道我們想去mock的method與預期的接收參數為0。如果main所執行的是System.exit(1),就會test failed。最後是使用PowerMock.replayAll()讓所有的mock work並呼叫我們的待測method。
	@Test
	public void testMain(){
		PowerMock.mockStatic(System.class);
 
		System.exit(0);
 
		PowerMock.expectLastCall().times(1);
 
		PowerMock.replayAll();
 
		Example.main(new String[0]);
	}
以上完成後,你可能會有另外一個問題: Exception path該如何測? 我們必須先mock new Example,再讓它拋出exception,這個問題可以參考Mock Constructor。如果在執行完System.exit之後,你希望main程式能夠離開,那在PowerMock.expectLastCall()的地方要改為PowerMock.expectLastCall().andStubThrow(new RuntimeException()),而call main的地方要去catch它,這樣就可以與原本main的流程相同,否則在執行完System.exit後,程式是會繼續執行下去的! 因為這是假的System.exit阿!

留言

這個網誌中的熱門文章

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

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

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的方式...