How to test Hot Key in Robot?

RobotFramework

現在的Web應用程式，做得越來越像Desktop應用程式。像ExtJS Framework中，也有一個是完全以桌面為主的範例，中華電信的客服系統也是透過這個範例去延伸的。言歸正傳，因為越來越像Desktop應用程式，也有了HotKey的功能。那我們該如何測它?RobotFramework有提供Selenium的Library讓你去測Web相關的應用程式，像Press Key與Call Selenium Api都可以讓你去產生key event。但是，小弟我偏偏就遇到怎麼送這些event也不會被trigger的應用程式，那該怎麼辦?

那我們就送給它從系統中所發出的event吧!出張嘴是最容易不過的，對於我這種小毛頭所擁有的技術也是有限。還好從小爸爸媽媽就告訴我要努力用功~~打魔獸~~念書，經過Google後，得知Java Awt Framework中的Robot Package，可以讓你模擬出鍵盤與滑鼠事件。但接踵而來的問題是:這些事件的發送對象該怎麼選擇阿?Windows容易些，透過WinAPI即可達到，Linux該怎麼辦?KDE、GNome是不同的，我沒有那種美國時間去implement底層的code來達到我的目的。後來某一天在我看~~色情網站~~社群網戰的時候，我頓悟了：透過Linux的HotKey+RobotFramework不就解決了?
接下來我要告訴你的，首先是如何使用Awt Robot，接著是在Windows與Linux上poptop待測程式的方法，最後是RobotFramework範例。

我簡單的實做了一個HotKeyUtil類別，提供pressLeftMouse、sendKeysCombo、releaseKey、pressKey的功能。所接受的參數可以參考KeyEvent內以VK_開頭宣告成員，如VK_CONTROL為Ctrl，VK_A為A。Ctrl+A可以透過sendKeysCombo方法送出。而pressLeftMouse方法為送出滑鼠右鍵的Event，接受輸入要點擊的xy軸。

Java Code

package org.tonylin.HotKeySender;
import java.lang.reflect.*;
import java.awt.Robot;
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
 
public class HotKeyUtil {	
	public static void pressLeftMouse(int aX, int aY) throws Exception {
		Robot robot = new Robot();
		robot.mouseMove(aX, aY);
		robot.mousePress(InputEvent.BUTTON1_MASK);
		robot.delay(500);
		robot.mouseRelease(InputEvent.BUTTON1_MASK);
	}
 
	public static void pressKey(String keys[]) throws Exception {
		Robot robot = new Robot();
 
        Class<?> cl = KeyEvent.class;
 
        int [] intKeys = new int [keys.length];
 
        for (int i = 0; i < keys.length; i++) {
            Field field = cl.getDeclaredField(keys[i]);
            intKeys[i] = field.getInt(field);
            robot.keyPress(intKeys[i]);
        }
   }
 
	public static void releaseKey(String keys[]) throws Exception {
		Robot robot = new Robot();
 
        Class<?> cl = KeyEvent.class;
 
        int [] intKeys = new int [keys.length];
 
        for (int i = keys.length - 1; i >= 0; i--) {
        	Field field = cl.getDeclaredField(keys[i]);
            intKeys[i] = field.getInt(field);
            robot.keyRelease(intKeys[i]);
        }
   }
 
	public static void sendKeysCombo(String keys[]) throws Exception {
		Robot robot = new Robot();
 
        Class<?> cl = KeyEvent.class;
 
        int [] intKeys = new int [keys.length];
 
        for (int i = 0; i < keys.length; i++) {
            Field field = cl.getDeclaredField(keys[i]);
            intKeys[i] = field.getInt(field);
            robot.keyPress(intKeys[i]);
        }
 
        for (int i = keys.length - 1; i >= 0; i--)
            robot.keyRelease(intKeys[i]);
   }
 
 
}

Bash

我將這一個類別包成jar檔後，透過batch/shellscript去呼叫它。在這裡我有另外寫一個HotKeySender的main程式，去接收參數決定要呼叫的method。這裡就看個人喜好，是要把所有的動作用一個script完成呢，還是各別動作用各別script。
Linux Ctrl+A shell script:

#!/bin/sh
BASEPATH=`dirname "$0"`
 
CLASSPATH=$BASEPATH/.:\
$BASEPATH/*
 
java -classpath "$CLASSPATH" org.tonylin.HotKeySender "ctrl-a"

Windows Ctrl+A batch file:

@echo off
set BASE=%~dp0
 
if EXIST %JAVA_HOME% set JAVA_PATH=%JAVA_HOME%\bin\java
if defined JAVA_PATH goto setClassPath
 
:setAlternativeJavaPAath
set JAVA_PATH=%BASE%..\..\..\..\jre\bin\java
 
:setClassPath
set CLASSPATH=%BASE%;^
%BASE%*;
 
"%JAVA_PATH%" -classpath "%CLASSPATH%" org.tonylin.HotKeySender "ctrl-a"

Windows

在Windows上要去找尋一個視窗，可以透過FindWindow；而要將它給poptop可以透過SetForegroundWindow。在範例程式中，argv[1]為你想要poptop的視窗title。

#include <cstdlib>
#include <iostream>
#include <windows.h>
 
using namespace std;
 
int main(int argc, char *argv[])
{
    int ret = EXIT_FAILURE;
    HWND window = FindWindow(0, argv[1]);
    if( window == 0 ){
        cout << "Can't find the window!" << endl;        
    } else {
        BOOL result = SetForegroundWindow(window); 
        if( result ) {
             cout << "Focus window success." << endl; 
        } else {
             cout << "Focus window failed." << endl; 
        }
        ret = result ? EXIT_SUCCESS : EXIT_FAILURE;
    }
    return ret;
}

Linux

到現在，我認為我的方法是偷吃步。雖然Eric捐獻了它之前研究X Window的筆記給我，但評估後認為要花比較多時間研究，才採取下面的方法。簡單來說有以下流程：
1. 透過Awt Robot送出Alt+F9縮小視窗。
2. 透過RobotFramework的Maximize Browser Window將待測程式Web放到最大。
3. 透過Awt Robot的pressLeftMouse選擇視窗。
其實也可以透過Ctrl+D去縮小所有視窗，但偏偏Ubuntu上必須要先設定才能Work。為了讓所有Linux都可以正常執行，只好採取此下策。

HotKey Keyword

這是我所撰寫送出Alt+F9去縮小視窗的Keyword，在這裡寫成for loop是為了執行多次去縮小所有視窗。GetBatchExtension是我用來根據作業系統去決定extension為sh或bat，ChmodBatch是為了讓在Linux下檔案變成可執行程式，最後透過外部程式去使用Awt Robot送出Alt+F9 Event。其它如Ctrl+A、點擊滑鼠等都大同小異，就不一一贅述。

Alt+F9 shell script:

#!/bin/sh
BASEPATH=`dirname "$0"`
 
CLASSPATH=$BASEPATH/.:\
$BASEPATH/*
 
java -classpath "$CLASSPATH" org.tonylin.HotKeySender "alt-f9"

Select Window Keyword

在Windows部分，用透過WinAPI所撰寫的FindWindows執行檔，傳入一個參數去poptop視窗。而Linux部分，會先透過Alt+F9去縮小9個視窗(這…暴力法?)，接著透過Maximize Browser Window後，再進行點擊。雖然這個方法不夠漂亮，但省了我不少時間。

在我們選擇到視窗後，看你是要Ctrl+A，還是Ctrl按著不放，都可以透過上述的方法達成。

Summary

這篇文章中，你可以學習到:
1. 如何透過Awt Robot送滑鼠與鍵盤訊息。
2. 如何在Windows上poptop一個視窗。
3. 如何在RobotFramework中，送鍵盤訊息到待測程式上。

某些符號可能會找不到，必須透過Shift+其它按鍵才能達成。舉例來說，我想輸入“_”字元，但無法直接使用VK_UNDERSCORE。最後透過VK_SHIFT+VK_MINUS就能輸入“_”，可以朝自己的鍵盤上找尋按鍵關係。