T_WServAPI Regression Test Suite

This topic describes the T_WServAPI Graphics test suite and explains how to set up the test environment.

Note: Any mention to epoc32 is offset by %EPOCROOT%, which is the full path to where the epoc tree is installed.

Test approach

The purpose of the test suite is to provide regression testing of the public (PublishedAll) APIs of the Window Server classes. The testing includes negative testing to confirm that the correct errors are returned when incorrect parameters are provided. The tests are automated and do not require user intervention.

Coverage omissions

None.

Test suite details

Test script source tree location

Descriptions of the test cases can be found in the test scripts in the following locations:

  • ...\graphics\graphicsapitest\wserv\scripts\ GRAPHICS-WSERV-BackedUpWindow-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\ GRAPHICS-WSERV-BlankWindow-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\ GRAPHICS-WSERV-Events-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-Session-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WindowGc-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WindowGroup-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-Window-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WsBitmap-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WsGraphicBitmap-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WsGraphicMsgBuf-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-SoundPlugin-PublicAPI.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WsScreenDevice-PublicAPI.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-DirectScreenAccess-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-DsaSession-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WsSprite-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WsPointerCursor-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-WsGraphicBitmapAnimation-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-Frame-PublicAPI.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-AnimDll-PublicAPI.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-Anim-PublicAPI.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-AnimGeneralFunctions-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-AnimGfwe-PublicAPI.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-AnimSpriteFunctions-PublicApi.script

  • ...\graphics\graphicsapitest\wserv\scripts\GRAPHICS-WSERV-AnimWindowFunctions-PublicApi.script

Test script EPOC tree location

When the tests are built for the emulator or hardware (winscw/armv5), the scripts are exported to the following location:

%EPOCROOT%\epoc32\data\Z\graphics\

Test script build location

When the tests are built, the scripts are built in the following location:

%EPOCROOT%\epoc32\release\<winscw|armv5>\<udeb|urel>\Z\graphics

Note: When the tests are built to be executed on hardware the files are built into the z: drive of the ROM.

Test data source tree location

The test suite contains the following test data files:

  • ...\graphics\graphicsapitest\wserv\testdata\ GRAPHICS-WSERV-BackedUpWindow-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-BlankWindow-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-Events-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-Session-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WindowGc-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WindowGroup-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-Window-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WsBitmap-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WsGraphicBitmap-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WsGraphicMsgBuf-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-SoundPlugin-PublicAPI.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WsScreenDevice-PublicAPI.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-DirectScreenAccess-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-DsaSession-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WsSprite-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WsPointerCursor-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-WsGraphicBitmapAnimation-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-Frame-PublicAPI.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-AnimDll-PublicAPI.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-Anim-PublicAPI.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-AnimGeneralFunctions-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-AnimGfwe-PublicAPI.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-AnimSpriteFunctions-PublicApi.ini

  • ...\graphics\graphicsapitest\wserv\testdata\GRAPHICS-WSERV-AnimWindowFunctions-PublicApi.ini

The global environment file is located in the following location:

...\graphics\testdata\<platform>\t_graphics.ini

Where <platform> can be armv5 or winscw.

Test data files EPOC tree location

When the tests are built for the emulator or hardware (winscw or armv5), the data files are exported to the following location:

%EPOCROOT%\epoc32\data\Z\graphics\

The global environment file, t_graphics.ini is located in the following location:

%EPOCROOT%\epoc32\data\Z\graphics\<platform>\

Where <platform> can be armv5 or winscw.

Test data files emulator location

When the tests are built, the test data (.ini) files except the global environment file, t_graphics.ini are built into the following location:

%EPOCROOT%\epoc32\ release\<platform>\<udeb|urel>\Z\graphics\

The global environment file, t_graphics.ini is built in the following location:

%EPOCROOT%\epoc32\ release\<platform>\<udeb|urel>\Z\graphics\<platform>

Where <platform> can be armv5 or winscw.

Note: When the tests are built to be executed on hardware, the files are built into the z: drive of the ROM.

TestDriver file

The graphics.driver file can be found in the following location:

...\graphics\graphicsapitest\graphicssvs\testsuites\graphics\

It is used by TestDriver to construct the test suite tree structure and export all the appropriate files to the correct location in the epoc32 tree and on the device.

When the tests are built, the .driver file can be found in the following location:

%EPOCROOT%\epoc32\testdriver\testproduct

TCS files source tree location

The .tcs files can be found in the following location:

  • ...\graphics\graphicsapitest\wserv\config\t_graphics.tcs

  • ...\graphics\graphicsapitest\wserv\config\t_graphics_panic.tcs

TCS files build location

When the tests are built, the scripts are generated in the following location:

%EPOCROOT%\epoc32\release\<winscw|armv5>\<udeb|urel>\Z\graphics

Note: When the tests are built to be executed on hardware, the files are built into the z: drive of the ROM.

Test environment and execution

For information about the test environment and execution procedure, see Graphics Test Technology.

Excluding panicking test cases

Some of the negative test cases, which check for panic codes, cause positive test cases to fail. Therefore, these test cases are excluded from normal execution by specifying the test case IDs in the <test suite name>-panic.tcs files.

When using test driver to execute the test suite:

  • graphics.panicless executes the specified suite excluding the listed test cases

  • graphics.panic executes the tests that panic.

When executing the tests manually, the following testexecute command illustrates the usage of the .tcs file:

testexecute %EPOCROOT%\epoc32\release\winscw\<urel/udeb>\<test suite name>.script –[tcx|tci] %EPOCROOT%\epoc32\release\winscw\<urel/udeb>\<test suite name>.tcs

The -tcx switch is used to execute all the tests in the specified script excluding the test cases specified in the .tcs file. While the –tci switch is used to execute only the tests specified in the .tcs file from the specified script. For more information, see Graphics Test Technology.

Related concepts
Graphics Test Technology