跳到主要內容

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

第一次寫MIB就上手

SNMP(Simple Network Management Protocol)是用來管理網路設備的一種Protocol,我對它的認識也是從工作接觸開始。雖說是管理網路設備,但是主機、電源供應器、RAID等也都可以透過它來做管理。如果你做了一個應用程式,當然所有的操作也都可以透過SNMP來完成,不過可能會很痛苦。前陣子遇到一個學弟,它告訴我說:「我可能不會想寫程式。」為什麼? 因為這是他痛苦的根源。 在這篇文章中,不是要告訴你SNMP是什麼,會看這篇文章的大哥們,應該已經對SNMP有些認識了。 是的!主題是MIB(Management information base)! 對於一個3th-party的SNMP oid,有MIB可以幫助你去了解它所提供的資訊是什麼,且可以對它做什麼操作。最近我運氣很好剛好做到關於修改MIB的工作,也讓我順便了解一下它的語法,接下來我要交給大家MIB的基礎認識。 smidump 我並非使用什麼高強的Editor去編寫MIB,我僅透過Nodepad++編輯和smidump編譯而已。smidump是Kay教我使用的一個將MIB module轉成樹狀結構或oid列表的工具,唯一的缺點是不會告訴你哪一行打錯。當然有錢直接買編輯樹狀結構的工具就可以不需要了解語法了! 安裝 在Ubuntu上可先輸入smidump確認是否安裝,如果沒安裝可透過apt-get install libsmi2ldbl安裝。(CentOS可以透過yum install libsmi) root@tonylin:~/multi-boot-server# smidump The program 'smidump' is currently not installed. You can install it by typing: apt-get install libsmi2ldbl 使用 透過下面兩行指令,就可以將mib file產生出對應的tree與oid列表的檔案。也可以透過這個結果確認MIB是不是你想要的。 smidump -f tree example1.mib > xtree.txt smidump -f identifiers example1.mib > xiden.txt 如果有參考其它檔案要加上p的參數: smidum...

升級SeleniumLibrary到4.5.0與Selenium到3.141.0

最近我們將RobotFramework升級至4.1.2,因為Jython的關係這個是目前可以使用Java執行的最後版本。 我們目前Selenium相關的Libraries版本如下: Selenium2Library - 3.0.0 (Latest, https://github.com/robotframework/Selenium2Library ) SeleniumLibrary - 3.0.0 ( https://github.com/robotframework/SeleniumLibrary/releases ) Selenium - 3.8.0 其中Selenium2Library已經沒在維護,也是最後一個版本,它所做的事情僅僅是把keyword forward給SeleniumLibrary。所以升級重點在SeleniumLibrary與Selenium。 而要升級這些Libraries,最重要的就是要知道它們彼此之間的相依,還有python版本的支援度。在我查詢套件的release note之後,因為4.1.2版本的jython只能支援到python 2.7.x,所以能升級的版本就有限制。其中SeleniumLibrary的情況如下: SeleniumLibrary 5.0.0 - 不支援Python 2 and Jython  SeleniumLibrary 4.5.0 - Python 2.7 and Selenium 3.141.0+  SeleniumLibrary 3.3.1 - Python 2.7 and Selenium 3.4+ 所以搭配了Selenium後,以下為我的第一個升級計畫: Selenium - 3.141.0 SeleniumLibrary - 3.3.。主要想確定是否會有deprecated items產生。 升級方式就是把以上原始碼丟到Lib底下,執行robot測試的時候會透過jython重新編譯。在我執行後,出現了urllib3找不到的問題: 我想可能是原本的套件中有包含urllib3,因此我到urllib3的package網站查了release note,找了可以匹配python 2.7的版本: urllib3 - 1.26.20 (https://pypi.org/project/...