跳到主要內容

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

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

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

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php