跳到主要內容

Robot Framework+Sikuli(2)-Sikuli Library

Introduction

之前文章中，介紹給大家透過Sikuli Script的方式將RobotFramework與Sikuli整合在一起的方法。這篇文章要教你另外一種透過將Sikuli API寫成RobotFramework Plugin的方式。

Plugin-Based Sikuli-Robot Integration

High Level Architecture

讓我們來看看將Sikuli做成TestLibrary整合示意圖:

基本上就是我們需要去實做一個Sikuli的TestLibrary，我稱為SikuliLibrary，它會依靠Sikuli。實做方法據我所知有兩個，一個是依靠Sikuli自帶的sikuli-script.jar，另外一個是靠同樣SikuliLab的Sikuli API。由於Sikuli API已經將繁複的操作給包成API，因此我選擇它來實做TestLibrary。

Sikuli API

在Sikuli API的官方文件已經有一些Sample Code教導大家如何使用，我就不贅述只做總結。 它有幾個核心物件ScreenRegion、Target、Mouse、Keyboard與Canvas。

  • ScreenRegion: 螢幕區域，讓你可以在它的範圍內找尋Target。預設範圍為整個桌面。
  • Target: 目標，基本上就是指你要想操作的圖片。
  • Mouse: 提供滑鼠相關操作，包含Drag&Drop。
  • Keyboard: 提供鍵盤相關操作。
  • Canvas: 畫布，我把它拿來Debug用。可以針對你想要的ScreenRegion做一些畫框框或印文字的動作，讓你可以知道行為操作是否正常。

在Linux上，Sikuli API會相依於OpenCV的函式庫。我是將OpenCV 2.4版抓下來編譯後再將那些so取來用，讓TestLibrary可以portable。

Keywords

目前我想到的操作有:

  • Send Combo Keys: 送出組合鍵。輸入值為AWT KeyEvent名稱，例如Ctrl + Alt + D為VK_CONTROL + VK_ALT + VK_D。
  • Type String: 輸入字串。
  • Move Image: 移動圖片到目標位置。
  • Click Image: 點擊圖片。
  • Find All Image: 搜尋圖片出現的所有位置，這意味著圖片會顯示在多個地方。回傳結果設計為index 0代表著數量，接著都是以x與y座標為一組資料。Ex. [ 2, 100, 200, 150, 250 ]。
  • Find Image: 搜尋圖片位置。回傳結果為x與y座標，Ex. [ 150, 250 ]。
  • Image Should Exist: 確認某個圖片是否存在。
  • Disable Debug Mode: 取消偵錯模式。
  • Enable Debug Mode: 啟用偵錯模式，透過Canvas去標示出操作圖片。
  • Set Timeout: 設定搜尋圖片的Timeout。

我的類別基本宣告，物件生命週期為Test Suite。

public class SikuliLibrary {
	public static final String ROBOT_LIBRARY_VERSION = "1.0";
	public static final String ROBOT_LIBRARY_SCOPE = "TEST SUITE";
 
	private Mouse mMouse = new DesktopMouse();
	private Keyboard mKeyboard = new DesktopKeyboard();
	private ScreenRegion mDesktopSR = new DesktopScreenRegion();
	private boolean mIsDebugEnable = false;
	private int mTimout = 5000;

以Click Image為例，我會透過mDesktopSR去搜尋圖片，如果找到它會回傳圖片的ScreenRegion，如果沒找到就回拋例外SikuliLibraryException。拋例外也會造成Keyword Failed，Robot Assertion就是透過拋例外達成。這邊也有show出Canvas的使用方式，display(3)代表顯示三秒的意思。其它大同小異我就不特別說明了。

	public void clickImage(String aImagePath) throws SikuliLibraryException{
		ScreenRegion sr = getScreenRegionEx(aImagePath);
		mMouse.click(sr.getCenter());
	}
 
	private void showDebugCanvas(ScreenRegion aSR){
		if( mIsDebugEnable && aSR != null ){
			showCanvas(aSR);
		}
	}
 
	private void showCanvas(ScreenRegion aSR){
		if( aSR != null ) {
			Canvas canvas = new DesktopCanvas();
			canvas.addBox(aSR).display(3);
		}
	}
 
	private ScreenRegion getScreenRegionEx(String aImagePath) throws SikuliLibraryException{
		Target target = new ImageTarget(new File(aImagePath));
		ScreenRegion sr = mDesktopSR.wait(target, mTimout);
		if( sr == null ){
			throw new SikuliLibraryException("Image dones't exist: " + aImagePath);
		}
		showDebugCanvas(sr);
		return sr;
	}

用它吧!

在執行Robot的script中必須將這個類別jar檔加入classpath中，並且要設定java.library.path好讓sikuli api可以找的到這些so檔。

#!/bin/sh
FULLPATH=`dirname "$0"`/`basename "$0"`
SHPATH=`readlink -f "$FULLPATH"`
BASEPATH=`dirname "$SHPATH"`
 
RFPATH=$BASEPATH/robotframework.jar
NATIVE_LIB_PATH=$BASEPATH/libs/native
 
CLASSPATH=$RFPATH
java -Djava.library.path="$NATIVE_LIB_PATH" \ 
          -cp "$CLASSPATH" org.robotframework.RobotFramework -P "$BASEPATH/libs/*" "$@"

在撰寫測試案例時，必須匯入Library:

接著就是用它拉，這個範例是送Alt+F9組合鍵縮小視窗並確認某張圖片是否存在，我將圖片放在TestSuite的相對目錄中:
測試結果如下:

註: 目前已知問題在Ubuntu中Enable Debug Mode會出現Error setting window transparency或The window must use a translucency-compatible graphic的錯誤，我想應該和我在VM上執行有關係吧。

Summary

Script-Based與Plugin-Based彼此間有什麼優缺點呢?

Script-BasedPlugin-Based
程式碼活動性敗，修改維護必須透過SikuliIDE勝，直接在Robot中透過Keyword操作流程
第一次開發勝，有SikuliIDE可以做截圖提升開發速度敗，必須自行找工具截圖
大小敗，必須將整包Sikuli包到測試環境中勝，僅需jar檔與native lib

這些比較是我個人想法，要怎麼使用還是要看大家專案環境去決定。

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

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 --...
張貼留言
閱讀完整內容

解決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而產生的樣子..)
張貼留言
閱讀完整內容

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的方式...
張貼留言
閱讀完整內容