How to implement a test library by java? (2)

How to implement a test library by java? (2) - Develop a new library

Introduction

在先前文章中，提及到如何使用現有的Java Library當做Keyword使用。但這樣的Library本來就不是為Robot量身訂做，因而無法擁有Robot所提供的功能與特性。假如今天要完成的功能並非既有的或無法直接使用現有的API，我們可以自行實作新的Test Library。

Library APIs

RobotFrameowrk的Test Library實作機制分成三類: Static API、Dynamic API與Hybrid API，讓我簡單的告訴你實做要點。

Static API

個人最推崇的寫法，也最簡單。一言以蔽之:「Method Name即Keyword Name」。讓我們直接看範例，這兩個methods也只是將工作deligate給StringUtil。而StringUtil內的實做則是直接使用String的toLowerCase與toUpperCase。

public class StaticStringUtil {
	/**
	 * Translate the aInputString to the lower case.
	 * 
	 * @param aInputString
	 * @return
	 */
	public String translateToLowercase(String aInputString){
		return StringUtil.toLowerCase(aInputString);
	}
 
	/**
	 * Translate the aInputString to the upper case.
	 * 
	 * @param aInputString
	 * @return
	 */
	public String translateToUppercase(String aInputString){
		return StringUtil.toUpperCase(aInputString);
	}
}

在RobotFramework中，我們只需要直接使用toLowerCase與toUpperCase為keyword再帶個參數就可以取得轉換後的回傳值了。

眼尖的觀眾應該有發現，我並不是直接使用toLowerCase，而是有加上class+package name。因為我也有import java.lang.String到TestSuite中，這會造成RobotFramework不曉得該用哪一個。可以透過這個方式去解決。

Dynamic API

Dynamic API概念是:「取得Keyword list靠getKeywordNames，執行Keyword靠RunKeyword」。RobotFramework建議的Dynamic API的interface，其中還包含了getKeywordArguments與getKeywordDocumentation，透過Keyword Name取得參數與文件資訊。

public interface RobotFrameworkDynamicAPI {
	String[] getKeywordNames();
	Object runKeyword(String name, Object[] arguments);
	String[] getKeywordArguments(String name);
	String getKeywordDocumentation(String name);
}

我實做了DynamicStringUtil去implements RobotFrameworkDynamicAPI。DynamicStringUtil的member與初始值如下: 將文件與參數定為Map，key為KeywordName，value為document或arguments。會這樣定原因很簡單，就是因為取得都是透過Keyword Name。如果你有很多的TestingLibraries，不妨把它變成AbstractClass。

	final private static Map<String, String> DOCUMENTATIONS;
	final private static Map<String, String[]> ARGUMENTS;
	final private static String[] SUPPORTED_METHODS_NAME = new String[]{
		"translate_to_lowercase",
		"translate_to_uppercase"
	};
	final private static String[] SUPPORTED_METHODS_DOC = new String[]{
		"Translate the input string to the lower case.",
		"Translate the input string to the upper case."
	};	
	final private static String[][] SUPPORTED_METHODS_ARGUMENT = new String[][]{
		new String[]{"aInputString"},
		new String[]{"aInputString"}
	};	
 
 
	static {
		DOCUMENTATIONS = new HashMap<String, String>();
		ARGUMENTS = new HashMap<String, String[]>();
		for( int i = 0 ; i < SUPPORTED_METHODS_NAME.length ; i++ ){
			DOCUMENTATIONS.put(SUPPORTED_METHODS_NAME[i], 
					SUPPORTED_METHODS_DOC[i]);
			ARGUMENTS.put(SUPPORTED_METHODS_NAME[i], 
					SUPPORTED_METHODS_ARGUMENT[i]);
		}
	}

各methods的實做如下，getKeywordNames、getKeywordArguments與getKeywordDocumentation僅僅是將member的值取出來丟回去而已，而runKeyword則會根據丟入的Keyword Name去決定真正執行的method。

	@Override
	public String[] getKeywordNames() {
		return Arrays.copyOf(SUPPORTED_METHODS_NAME, 
				SUPPORTED_METHODS_NAME.length);
	}
 
	@Override
	public Object runKeyword(String name, Object[] arguments) {
		if( name.equals(SUPPORTED_METHODS_NAME[0]) ){
			return StringUtil.toLowerCase(arguments[0].toString());
		} else if( name.equals(SUPPORTED_METHODS_NAME[1])){
			return StringUtil.toUpperCase(arguments[0].toString());
		}
		throw new RuntimeException("Not support keyword: " + name);
	}
 
	@Override
	public String[] getKeywordArguments(String name) {
		if( !ARGUMENTS.containsKey(name)){
			throw new RuntimeException("Not support keyword: " + name); 
		}
		return ARGUMENTS.get(name);
	}
 
	@Override
	public String getKeywordDocumentation(String name) {
		if( !DOCUMENTATIONS.containsKey(name)){
			throw new RuntimeException("Not support keyword: " + name); 
		}
		return DOCUMENTATIONS.get(name);
	}

老實說，我還蠻討厭這種寫法的。我去看RobotFramework的DatabaseLibrary的程式碼，不乏Keyword Name的hardcode，個人是不太喜歡將這些東西hard code並且四散，維護上不太方便。如果像我將這些資訊都放在member中，會造成runKeyword不太好閱讀。所以: 還是用Static API的方式吧! 另外，Dynamic API在RobotFramework中的用法與Static API一樣，不同的只有前面的Package+Class名稱，要改為org.tonylin.robotframework.DynamicStringUtil。

Hybrid API

顧名思義就是Hybrid…主要特點是:「使用像dynamic API的getKeywordNames去取得有哪些Keywords，執行則是用static API的方式呼叫」。如以下範例，需要注意的是: 這裡命名的Keyword Name，不像先前可以使用translate_To_Lowercase或translate_ToLowercase，因為它是直接透過名稱去reflection取得Method的物件去執行。

public class HybridStringUtil {
	public String[] getKeywordNames() {
		return new String[] { 
				"translateToLowercase",
				"translateToUppercase" };
	}
 
	/**
	 * Translate the aInputString to the lower case.
	 * 
	 * @param aInputString
	 * @return
	 */
	public String translateToLowercase(String aInputString){
		return StringUtil.toLowerCase(aInputString);
	}
 
	/**
	 * Translate the aInputString to the upper case.
	 * 
	 * @param aInputString
	 * @return
	 */
	public String translateToUppercase(String aInputString){
		return StringUtil.toUpperCase(aInputString);
	}
}

Arguments&Return

RobotFramework允許參數與回傳值的型態除了字串外，還可以用其它的基本型態。回傳至Robot後會被轉為String，如果要使用其它的type必須要透過evaluate做轉換。在這我主要教導大家的是: 陣列、可變參數與參數預設值。

可變參數

Java可變參數的實做可以透過Array或..:

public void appendString(String[] aStrs){
}
public void appendString(String.. aStrs){
}

參數預設值

許多語言都提供參數預設值的功能，舉例來說:

void installSoftware(bool aRestart = false)

Python:

def installSoftware(restart=false):

RobotFramework本身的Keyword也支援參數預設值的功能:

如果是透過Java實做的Test Librarty，可以透過Overloading達到這個效果:

public void installSoftware(){
    installSoftware(false);
}
public void installSoftware(boolean aRestart){
    ...
}

陣列

在Java中可以使用methodName(Type[] argv1, Type[] argv2)多個Array的參數，但對Robot來說僅允許一個Array並且是最後一個位置做為參數。而回傳值使用陣列可以參考這個範例:

public String[] splitString(String aInputString, String aRegex){
    return StringUtil.splitString(aInputString, aRegex);
}
public String[] splitString(String aInputString){
    return StringUtil.splitString(aInputString, " ");
}

在Robot中，除非你很有把握的知道這Keyword有幾個參數，否則都是使用@宣告為Array變數:

生命週期

RobotFramework提供設定Test Library的Scope，即物件的生命週期，它提供TEST CASE、TEST SUITE、GLOBAL三種Scope。在程式中，我們只需要宣告一個ROBOT_LIBRARY_SCOPE的member，並且給予Scope即可。預設是使用TEST CASE，假如你不需要去保留不同Testcase或Testsuite的狀態，那最好使用TEST CASE以避免影響到測試的結果。

public class HybridStringUtil {
	public static final String ROBOT_LIBRARY_SCOPE = "TEST CASE";
...

SeleniumLibrary與DatabaseLibrary都是GLOBAL的Test Library，因為測試執行中可能一直使用同一個瀏覽器或是資料庫連線。以我的喜好而言，會將開啟SeleniumServer與關閉SeleniumServer放在各個Testsuite中，因為我希望各個Testsuite能個別執行。至於各位大大要設計的TestingLibrary，就視個人而定了!

版本資訊

如果撰寫Library給別人使用，這時版本資訊就很重要了，否則人家要回報issue怎知道是哪一版的API呢?要使用這個功能只需要在Class中宣告ROBOT_LIBRARY_VERSION的member即可:

public class HybridStringUtil {
    public static final String ROBOT_LIBRARY_VERSION = "1.0.2";
}

宣告版本資訊後，也會一併顯示在產生的Library Document中!

Summary

看完這篇文章，對於該怎麼實做Test Library應該有基本的認識了吧? 三種Library實作方式Static、Dynamic、Hybrid各有不同特色。雖然我最推崇Static的方式，但Third-party的API還是有人用Dynamic的方式。也許我還寫不夠多，無法體會到精隨。

此外，各位應該也有看到我有提到Library Document。有Document的API可以讓其它人更容易知道該如何使用，不只是Test Library，我們也可以將Robot的Resource File產生為Library Document。這部分我會再另一篇文章分享給大家，讓大家知道Document的寫法與如何產生。

阿兩的筆記本 Ryoutsu's Notebook

搜尋此網誌