WinAppDriver 연동 기능은 넥사크로플랫폼 17에서 제공하는 UIAutomation 인터페이스를 사용해 NRE에서 실행하는 앱의 속성을 읽거나 쓰고 파라미터를 지정해 메소드를 실행하는 것을 지원합니다. 셀레니움 같은 UI 자동화 테스트 도구를 사용해 단위 테스트를 작성하고 테스트할 수 있습니다.

이번 장에서는 WinAppDriver를 설치하고 비주얼 스튜디오와 이클립스에서 기본적인 C#, Java 프로젝트를 생성해 넥사크로플랫폼 앱에 연결하는 단계를 살펴봅니다.

WinAppDriver 연동 환경 설정하기

WinAppDriver 설치하기

개발 도구 설치하기

C# 또는 Java 언어를 사용해 단위테스트 프로젝트를 만들 수 있습니다.

비주얼 스튜디오 설치하기

C# 언어를 사용하고 비주얼 스튜디오를 설치하지 않은 경우 무료로 제공되는 개발 도구를 설치할 수 있습니다.

이클립스 설치하기

Java 언어를 사용하고 이클립스를 설치하지 않은 경우 무료로 제공되는 개발 도구를 설치할 수 있습니다.

단위테스트 만들고 실행하기

넥사크로플랫폼 앱 만들고 배포하기

간단한 넥사크로플랫폼 앱을 만들고 배포합니다.

Button 컴포넌트와 Edit 컴포넌트만 화면에 배치합니다.

Button 컴포넌트 onclick 이벤트가 발생하면 Edit 컴포넌트에 value 속성값을 변경합니다.

this.Button00_onclick = function(obj:nexacro.Button,e:nexacro.ClickEventInfo)
{
	this.Edit00.set_value("BUTTON CLICK");
};

서버 연결 없이 실행할 수 있도록 Update Type은 "Local"로 지정합니다.

단위테스트 프로젝트 만들기

비주얼 스튜디오에서 단위테스트 프로젝트 만들기

메뉴 [Project > Manage NuGet Package]를 선택하고 검색창에서 "Appium"을 입력해서 검색 결과에서 Appium WebDriver 라이브러리를 확인합니다. [Install] 버튼을 클릭하면 라이브러리를 설치합니다.

아래 코드에서 넥사크로플랫폼 앱 관련 설정을 수정합니다. 앱이 설치된 경로, nexacro.exe 실행 파일 경로, nexacro.exe 실행 옵션을 실제 설치 경로에 맞게 수정합니다.

http://127.0.0.1:4723/

C:\\Program Files\\nexacro\\17\\app0201

C:\\Program Files\\nexacro\\17\\app0201\\nexacro.exe

-k 'UnitTest' -s 'C:\\Program Files\\nexacro\\17\\app0201\\app0201\\start.json'

using System;
using System.Threading;
using System.Diagnostics;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using OpenQA.Selenium.Appium.Windows;
using OpenQA.Selenium.Remote;

namespace UnitTestProject1
{
	[TestClass]
	public class NexaTestSession
	{
		// winappdriver url
		protected const string WindowsApplicationDriverUrl = "http://127.0.0.1:4723/";
		// app path
		private const string NexacroAppDr = "C:\\Program Files\\nexacro\\17\\app0201";
		// nexacro.exe path
		private const string NexacroAppId = "C:\\Program Files\\nexacro\\17\\app0201\\nexacro.exe";
		// nexacro.exe argument
		private const string NexacroAppAg = "-k 'UnitTest' -s 'C:\\Program Files\\nexacro\\17\\app0201\\app0201\\start.json'";
		// search root
		private const string FindNexacro = "Root";
		// OS/Device
		private const string TestOs = "Windows";
		private const string TestDevice = "WindowsPC";

		// Session Object : WindowsDriver 
		protected static WindowsDriver<WindowsElement> session;

		// WinAppDriver Session Create
		[ClassInitialize]
		public static void Setup(TestContext context)
		{
			// Launch a new instance of nexacro application or find nexacro application
		}

		// WinAppDriver Session Delete
		public static void TearDown()
		{
            // Close the application and delete the session
            if (session != null)
            {
                // Close Session – Close Application
                session.Close();
                // Quit Session
                session.Quit();
                // Delete Session
                session = null;
            }
		}

		[TestMethod]
		public void Test_Session()
		{
            Debug.WriteLine("session:" + session);
            Debug.WriteLine("session.SessionId:" + session.SessionId);
		}
	}
}

위의 코드에서 Setup 메소드를 아래와 같이 수정합니다.

// WinAppDriver Session Create
[ClassInitialize]
public static void Setup(TestContext context)
{
	// Launch a new instance of nexacro application or find nexacro application
	if (session == null)
	{
		// Create a new session to launch nexacro application
		DesiredCapabilities appCapabilities = new DesiredCapabilities();
		TimeSpan time = new TimeSpan(0, 0, 10);

		// Launch Nexacro
		appCapabilities.SetCapability("app", NexacroAppId);
		appCapabilities.SetCapability("appArguments", NexacroAppAg);
		appCapabilities.SetCapability("appWorkingDir", NexacroAppDr);
		appCapabilities.SetCapability("platformName", TestOs);
		appCapabilities.SetCapability("deviceName", TestDevice);

		// Request Remote WinAppDriver Service
	session = new WindowsDriver<WindowsElement>(new Uri(WindowsApplicationDriverUrl), appCapabilities, time);

		// Set implicit timeout to 1.5 seconds to make element search to retry every 500 ms for at most three times
		session.Manage().Timeouts().ImplicitlyWait(TimeSpan.FromSeconds(0.5));
		Thread.Sleep(TimeSpan.FromSeconds(1.0));
	}
}

WinAppDriver을 실행한 콘솔 화면에서 접속 정보와 세션이 생성된 것을 확인할 수 있습니다.

이클립스에서 단위테스트 프로젝트 만들기

아래 코드에서 넥사크로플랫폼 앱 관련 설정을 수정합니다. 앱이 설치된 경로, nexacro.exe 실행 파일 경로, nexacro.exe 실행 옵션을 실제 설치 경로에 맞게 수정합니다.

http://127.0.0.1:4723/

C:\\Program Files (x86)\\nexacro\\17\\app0201

C:\\Program Files (x86)\\nexacro\\17\\app0201\\nexacro.exe

-k 'UnitTest' -s 'C:\\Program Files (x86)\\nexacro\\17\\app0201\\app0201\\start.json'

import org.junit.*;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebElement;
import io.appium.java_client.windows.WindowsDriver;
import java.util.concurrent.TimeUnit;
import java.net.URL;

public class UnitTest {

	// winappdriver url
	private String WindowsApplicationDriverUrl = "http://127.0.0.1:4723/";
	// app path
	private String NexacroAppDr = "C:\\Program Files (x86)\\nexacro\\17\\app0201";
	// nexacro.exe path
	private String NexacroAppId = "C:\\Program Files (x86)\\nexacro\\17\\app0201\\nexacro.exe";
	// nexacro.exe argument
	private String NexacroAppAg = "-k 'UnitTest' -s 'C:\\Program Files (x86)\\nexacro\\17\\app0201\\app0201\\start.json'";
	// search root
	// private String FindNexacro = "Root";

	// OS/Device
	private String TestOs = "Windows";
	private String TestDevice = "WindowsPC";

	// Session Object : WindowsDriver
	private static WindowsDriver<RemoteWebElement> session = null;
	

	@Before
	public void setUp() throws Exception {
		// Launch a new instance of nexacro application or find nexacro application
	}

	@After
	public void tearDown() throws Exception {
		if (session != null) {
			// Nexacro17Session.quit();
		}
	}

	@Test
    public void Test_01_Session()
    {
        System.out.println("session : " + session);
		System.out.println("session.SessionId : " + session.getSessionId());        
    }
}

위의 코드에서 Setup 메소드를 아래와 같이 수정합니다.

@Before
public void setUp() throws Exception {
	// Launch a new instance of nexacro application or find nexacro application
	try {
		// Create a new session to launch nexacro application
		DesiredCapabilities appCapabilities = new DesiredCapabilities();

		appCapabilities.setCapability("app", NexacroAppId);
		appCapabilities.setCapability("appArguments", NexacroAppAg);
		appCapabilities.setCapability("appWorkingDir", NexacroAppDr);
		appCapabilities.setCapability("platformName", TestOs);
		appCapabilities.setCapability("deviceName", TestDevice);

		// Request Remote WinAppDriver Service
		session = new WindowsDriver<RemoteWebElement>(new URL(WindowsApplicationDriverUrl), appCapabilities);
		session.manage().timeouts().implicitlyWait(1, TimeUnit.SECONDS);

	} catch (Exception e) {
		e.printStackTrace();
	} finally {
	}
}

WinAppDriver을 실행한 콘솔 화면에서 접속 정보와 세션이 생성된 것을 확인할 수 있습니다.

단위테스트 실행하기

현재 세션에서 Button 컴포넌트를 찾고 마우스 클릭 명령을 처리합니다.

$r_title(C#)
[TestMethod]
public void Test_Button()
{
	WindowsElement element = session.FindElementByAccessibilityId("mainframe.WorkFrame.form.Button00");
	Assert.IsNotNull(element);
	Thread.Sleep(TimeSpan.FromSeconds(0.1));
	element.Click();
}

$r_title(Java)
@Test
public void Test_Button() throws Exception {
	WebElement element = session.findElementByAccessibilityId("mainframe.WorkFrame.form.Button00");
	Assert.assertNotNull(element);
	Thread.sleep(1000);
	element.click();
}

AccessibilityId 속성값 확인하기

컴포넌트나 컨트롤에 접근하기 위해서 FindElementByAccessibilityId 메소드를 사용하는데 이때 AccessibilityId 속성값을 확인해야 합니다.

컴포넌트 속성값 확인하기

Form에 배치된 컴포넌트 자체에 접근하는 방식은 아래와 같습니다.

[MainFrame id 속성값].[ChildFrame id 속성값].form.[Component id 속성값]

id 속성값이 "Button00"인 Button 컴포넌트의 엘리먼트를 얻기 위해서는 아래와 같이 코드를 작성합니다.

$r_title(C#)

WindowsElement element = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.Button00");

Div 컴포넌트 안에 배치한 컴포넌트는 아래와 같이 접근할 수 있습니다.

$r_title(C#)

WindowsElement element = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.Div00.form.CheckBox00");

컨트롤, 아이템 속성값 확인하기

예를 들어 Div 컴포넌트 안에 배치된 Combo 컴포넌트의 dropbutton은 아래와 같이 엘리먼트를 얻을 수 있습니다.

$r_title(C#)

WindowsElement element = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.Div00.form.Combo00.dropbutton");

단위 테스트를 진행하기 위해서는 Combo 컴포넌트의 드롭다운목록을 펼치고 아이템을 선택해야 합니다. 드롭다운목록을 펼치기 위해서는 Combo 컴포넌트 내 ButtonControl에 접근해야 하고 해당 컨트롤의 속성값을 확인해야 합니다.

컨트롤 속성값은 넥사크로 스튜디오에서 Help(단축키 F1)을 실행하면 컴포넌트 개요에서 확인할 수 있습니다. Combo 컴포넌트에서 드롭다운목록을 펼치기 위해 클릭하는 버튼의 id 속성값이 "dropbutton"이라는 것을 확인할 수 있습니다.

Inspect로 속성값 확인하기

하지만 드롭다운목록을 펼친 후에 Item 3에 접근하려면 어떻게 해야 하는지는 알려주지 않습니다. 이런 경우에는 "Inspect" 라는 도구를 사용합니다. "Inspect"는 윈도우 SDK가 설치되어 있다면 설치 경로에서 찾을 수 있습니다.

여러 정보가 보여지는데 그 중에서 AccessibilityId 속성값으로 사용할 항목은 "AutomationId"입니다.

드롭다운목록에서 2번째 아이템을 선택할 때는 아래와 같이 엘리먼트를 얻을 수 있습니다.

$r_title(C#)

WindowsElement element = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.Div00.form.Combo00.combolist.item_1");

아이템에 해당하는 엘리먼트는 드롭다운목록이 펼쳐진 후에 접근할 수 있습니다. 목록을 펼치기 전에 해당 아이템에 접근하려 한다면 테스트 실패로 처리됩니다.

테스트 코드에서 아래와 같이 먼저 dropbutton 엘리먼트를 찾아서 마우스 클릭 이벤트를 처리하고 드롭다운목록이 펼쳐지면 그때 원하는 아이템에 접근합니다.

$r_title(C#)

[TestMethod]
public void Test_00_FindElementItem()
{
	WindowsElement element = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.Div00.form.Combo00.dropbutton");
	Assert.IsNotNull(element);
	element.Click();
	Thread.Sleep(TimeSpan.FromSeconds(0.1));
	WindowsElement elementItem = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.Div00.form.Combo00.combolist.item_1");
	Assert.IsNotNull(elementItem);
	Debug.WriteLine("elementItem.Text:" + elementItem.Text);
}

기능별 데모 단위 테스트 실행하기

기능별 데모를 실행하기 위한 넥사크로플랫폼 앱 설치파일과 Java, C# 샘플 파일을 내려받을 수 있습니다.

https://github.com/TOBESOFT-DOCS/sample_nexacroplatform_17_winappdriver

2개의 폴더와 하나의 설치파일을 확인할 수 있습니다.

C:\Program Files (x86)\nexacro\17\app0201

지원 인터페이스

Session

세션 생성하기

winappdriver 정보로 세션을 생성하고 앱을 실행합니다.

session = new WindowsDriver(new Uri(WinAppDriverUrl), appCapabilities);

session = new WindowsDriver(new URL(WindowsApplicationDriverUrl), appCapabilities);

POST /session { …capabilities json data… }

세션 종료하기

세션을 종료하고 해당 앱을 종료합니다.

session.Quit();

session.quit();

DELETE /session/:session_id

Timeout

타임아웃 설정하기

세션 동작 시 적용할 timeout 값을 설정합니다.

session.Manage().Timeouts().ImplicitlyWait(TimeSpan.FromSeconds(0.5));

session.manage().timeouts().implicitlyWait(1, TimeUnit.SECONDS);

POST /session/:session_id/timeouts {"type":"implicit","ms":500.0}

Frame

Mainframe 정보 확인하기

MainFrame 오브젝트의 titletext 속성값을 반환합니다.

session.Title;

session.getTitle();

GET /session/:sessionId/title

Window

활성화된 윈도우 변경하기

현재 윈도우를 변경합니다. Windowhandle은 session.WindowHandles에서 얻을 수 있습니다. 최초 실행시에는 MainFrame 오브젝트가 현재 윈도우로 설정됩니다.

session.SwitchTo().Window(session.WindowHandles[0]);

Set<String> handles = session.getWindowHandles();
Set handles = session.getWindowHandles();

POST /session/:sessionId/window {"name":"0x000A12BC"}

활성화된 윈도우 종료하기

현재 윈도우를 종료합니다.

session.Close();

session.close();

DELETE /session/:sessionId/window

활성화된 윈도우 핸들 얻기

현재 윈도우 핸들 오브젝트를 반환합니다.

handle = session.CurrentWindowHandle;

Handle = session.getWindowHandle();

GET /session/:sessionId/window_handle

윈도우 핸들 배열 얻기

모든 윈도우 핸들 오브젝트를 배열 형태로 반환합니다.

handlearray = session.WindowHandles;

Set handles = session.getWindowHandles();

GET /session/:sessionId/window_handles

윈도우 크기 정보 확인하기

윈도우 크기를 Size 오브젝트 형태로 반환합니다.

session.Manage().Window.Size;

session.getWindowHandles().size()

GET /session/:sessionId/window/:windowHandle/size

윈도우 크기 변경하기

윈도우 크기를 변경합니다.

session.Manage().Window.Size = new Size(width,height);

session.manage().window().setSize(new Dimension(width, height));

POST /session/:sessionId/window/:windowHandle/size

윈도우 위치 정보 확인하기

윈도우 위치를 Point 오브젝트 형태로 반환합니다.

point = session.Manage().Window.Position;

point = session.manage().window().getPosition()

GET /session/:sessionId/window/:windowHandle/position

윈도우 위치 변경하기

윈도우 좌표를 변경합니다.

session.Manage().Window.Position = new Point(left,top);

session.manage().window().setPosition(new Point(left, top))

POST /session/:sessionId/window/:windowHandle/position

윈도우 최대화

윈도우 크기를 최대화합니다.

session.Manage().Window.Maxmize();

session.manage().window().maximize();

POST /session/:sessionId/window/:windowHandle/maximize

Element

Element는 WinAppDriver 동작의 최소단위입니다. 넥사크로플랫폼에서는 컴포넌트, 컨트롤의 구성요소인 nexacro Element를 Element로 처리합니다.

ControlElement가 컴포넌트를 둘러싸고 있고 그 안에 ContainerElement, InputElement, IconTextElement, TextElement 등의 Element가 자리잡고 있습니다. Button 컴포넌트의 경우는 아래와 같이 구성됩니다.

엘리먼트 얻기

컴포넌트, 컨트롤의 ControlElement 오브젝트를 반환합니다.

element = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.Button00");

element = session.findElementByAccessibilityId("mainframe.ChildFrame00.form.Button00");

POST /session/:sessionId/element 
{ "using":"accessibilityid", "value":"mainframe.ChildFrame00.form.Button00" }

$r_title(C#)

// parent null 지정시 : nexacro.open("openframe", url, null, ...) 
nexaButton00 = session.FindElementByAccessibilityId("openframe.form.Button00");

// parent frame 지정시 : nexacro.open("openframe", url, ownerframe, ...)
nexaButton00 = session.FindElementByAccessibilityId("mainframe.ChildFrame00.openframe.form.Button00");

엘리먼트 배열 얻기

컴포넌트, 컨트롤의 ControlElement 오브젝트 목록을 배열값으로 반환합니다.

element = session.FindElementsByAccessibilityId("mainframe.ChildFrame00.form.Button00");

element = session.findElementsByAccessibilityId("mainframe.ChildFrame00.form.Button00");

POST /session/:sessionId/elements 
{ "using":"accessibilityid", "value":"mainframe.ChildFrame00.form.Button00" }

엘리먼트 id값 확인하기

WinAppDriver Element의 id값을 반환합니다.

id = element.Id;

id = element.getTagName()

GET /session/:sessionId/element/:id/name

엘리먼트에 표시되는 텍스트 정보 확인하기

Element의 텍스트값을 반환합니다.

text = element.Text;

text = element.getText();

GET /session/:sessionId/element/:id/text

엘리먼트 마우스 클릭 이벤트 처리하기

Element의 가운데 위치에서 마우스 클릭 이벤트가 발생합니다.

element.Click();

element.click();

POST /session/:sessionId/element/:id/click

$r_title(C#)

[TestMethod]
public void Test_10_MaskEditInput()
{
	WindowsElement nexaMaskEdit00 = session.FindElementByAccessibilityId("mainframe.ChildFrame00.form.MaskEdit00");
	Assert.IsNotNull(nexaMaskEdit00);
	Thread.Sleep(TimeSpan.FromSeconds(0.1));

	nexaMaskEdit00.Clear();
	nexaMaskEdit00.Click();
	nexaMaskEdit00.SendKeys(Keys.Control + "a");
	Thread.Sleep(TimeSpan.FromSeconds(0.1));
	nexaMaskEdit00.SendKeys("abcde1234"+Keys.Enter);
	Assert.AreEqual("abcde-1234", nexaMaskEdit00.Text);
}

엘리먼트 입력값 지우기

텍스트 편집 영역을 가지고 있는 컴포넌트의 입력값을 지웁니다.

element.Clear();

element.clear();

POST /session/:sessionId/element/:id/clear

엘리먼트에 키보드 입력값 전달하기

키보드 입력값을 처리합니다.

element.SendKeys(KeyString)

element.sendKeys(KeyString)

POST /session/:sessionId/element/:id/value

엘리먼트 선택 여부 확인하기

Element의 Selected 상태값을 반환합니다.

isSelected = element.Selected;

isSelected = element.isSelected();

GET /session/:sessionId/element/:id/selected

엘리먼트 사용 가능 여부 확인하기

Element의 Enabled 상태값을 반환합니다.

isEnabled = element.Enabled;

isEnabled = element.isEnabled();

GET /session/:sessionId/element/:id/enabled

엘리먼트 화면 표시 여부 확인하기

Element의 화면 표시 여부를 반환합니다.

isDisplayed = element.Displayed;

isDisplayed = element.isDisplayed();

GET /session/:sessionId/element/:id/displayed

엘리먼트 크기 정보 확인하기

Element 크기를 Size 오브젝트 형태로 반환합니다.

size = element.Size;

size = element.getSize();

GET /session/:sessionId/element/:id/size

엘리먼트 위치 정보 확인하기 (상위 엘리먼트 기준)

Element 위치를 상위 Element 기준에서 Point 오브젝트 형태로 반환합니다.

size = element.Location;

size = element.getLocation();

GET /session/:sessionId/element/:id/location

엘리먼트 위치 정보 확인하기 (Screen 기준)

Element 위치를 Screen 기준에서 Point 오브젝트 형태로 반환합니다.

size = element.LocationOnScreenOnceScrolledIntoView;

GET /session/:sessionId/element/:id/location_in_view

활성화된 엘리먼트 얻기

현재 활성화된 Element를 반환합니다.

element = session.SwitchTo().ActiveElement();

element = session.switchTo().activeElement();

GET /session/:sessionId/element/active

2개의 엘리먼트 비교하기

Element를 비교해서 같은 Element인지 확인합니다.

isEqual = element.Equals(element2);

isEqual = element.equals(element2);

GET /session/:sessionId/element/:id/equals

엘리먼트의 UIA 인터페이스 속성값 확인하기

Element의 UIA Interface의 attribute 값을 제공합니다.

element.GetAttribute("AutomationId");

element.getAttribute("AutomationId");

GET /session/:sessionId/element/:id/attribute/:name

ScreenShot

윈도우, 엘리먼트 스크린샷 얻기

Screen 윈도우 영역 또는 Element를 Screenshot 오브젝트로 반환합니다.

Screenshot sessionshot = session.GetScreenshot();

Screenshot sessionshot = session.getScreenshotAs();

GET /session/:sessionId/screenshot 
GET /session/:sessionId/element/:id/screenshot

$r_title(Java)

FileHandler.copy(sessionshot, new File(System.getProperty("user.home")+"\\Downloads\\SessionScreenShot.png"));

관련 링크 정보

WebDriver Interface

http://www.w3.org/TR/webdriver1/
https://www.seleniumhq.org/projects/webdriver/
https://developer.mozilla.org/en-US/docs/Web/WebDriver

AppDriver Interface

https://github.com/Microsoft/WinAppDriver
https://appium.io/docs/en/drivers/windows/
https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/

UIA Interface

https://docs.microsoft.com/en-us/windows/desktop/WinAuto/entry-uiauto-win32
https://docs.microsoft.com/en-us/windows/desktop/winauto/testing-tools
https://en.wikipedia.org/wiki/Microsoft_UI_Automation

MSAA Interface

https://docs.microsoft.com/en-us/windows/desktop/WinAuto/microsoft-active-accessibility
https://docs.microsoft.com/en-us/windows/desktop/winauto/testing-tools
https://en.wikipedia.org/wiki/Microsoft_Active_Accessibility