Test Design Guidelines for Reusability

Last Updated: JAN.10.2008

From: http://safsdev.sourceforge.net/sqabasic2000/TestDesignGuidelines.htm

Purpose
App Map and Test Table UTF-8 File Encodings
App Map Chaining
App Map Resolving Embedded Variables
Designing Tests for NLS
A Complete Dynamic Text Example Support NLS

Purpose

This document provides a set of guidelines that enable a tester to plan the development of test designs and related assets to maximize reuse. The intended context for this reuse is to maximize the potential for effective system\application configuration testing and localization testing, also known as NLS testing. Throughout this document we will refer primarily to NLS testing, but the concepts apply equally well to configuration testing and other forms of testing requiring reconfigurable text values.

The App Map features referenced here as App Map Chaining and App Map Resolving Embedded Variables are only available in versions of SAFS dated on or after Aug, 2006.

It is important to recognize that the single most important notion for making test designs reusable for NLS and configuration testing is that no localizable or configuration-specific text must exist in the test designs or test actions--the test tables. All such text must be managed in separate text resource files, which in the SAFS world means separate App Maps. The test designs and test actions will reference the text via variable references which will be retrieved from the App Maps opened for the target language or configuration.

App Map and Test Table UTF-8 File Encodings

(Need to respecify the following statement based on most recent experiences with Rational Robot and Rational Functional Tester evaluations.)

In order to properly represent mixed character data (some single-byte and some multi-byte) the UTF-8 character encoding format is supported by RRAFS and SAFS. All App Maps and Test Tables intended to be used for NLS testing should be encoded in the proper format required by the tools in use.

App Map Chaining

Note: App Map Chaining by default is not enabled in order to maintain backwards compatibility with existing tests. You must use the 'AppMapChaining' Driver Command to enable this feature.

C, AppMapChaining, ON

App Map Chaining is the process by which multiple App Maps can be opened and searched for referenced values. App Maps opened with chaining enabled are searched in Last-In-First-Out (LIFO) order. This allows the opening of scenario-specific maps--language or configuration, etc.--to be opened in addition to generic and shared maps. Maps opened later can have values that override or supercede maps opened earlier. In addition, shared maps can contain embedded variables (see below) that can be satisfied by the scenario-specific maps. For example, a shared map may reference an embedded variable containing localizable text that will be found in another open App Map--the one specific to the language being tested.

Example:

C, SetApplicationMap, FMStudio_NLS

C, SetApplicationMap, FMStudio_MAP

This design snippet shows two maps being opened. The first opened map (FMStudio_NLS) would contain the localized text specific to the language being tested. All entries in this map would be in the default [ApplicationConstants] section so that they could be retrieved as variables. The second map (FMStudio_MAP) would be the shared map used in all testing no matter what the language or configuration. The entries in this shared map would contain embedded variables whose values would be found in the localized map. Since the maps are read in LIFO order due to App Map Chaining, values will first be sought in the FMStudio_MAP. Embedded variables or other values not satisfied by that map will then be sought in the FMStudio_NLS map.

App Map Resolving Embedded Variables

Note: Resolving embedded variables in App Maps is not enabled by default in order to maintain backwards compatibility with existing tests. You must use the 'AppMapResolve' Driver Command to enable this feature.

C, AppMapResolve, ON

An App Map entry can contain references to variables whose values will be resolved to complete the entry. See Resolving DDVariables for Dynamic Recognition for more information on this capability. Essentially, the idea to keep in mind is that the shared maps will contain largely static text that does not need to be localized or changed for subsequent testing. Where some portion of an App Map entry does need to contain localized text that portion will be represented as an embedded variable and the ultimate value of that variable will be retrieved from a locale-specific App Map that is opened in addition to the shared App Map.

Example:



FMStudio_NLS_en (known as FMStudio_NLS):

----------------------------------------

[ApplicationConstants]

nlsHello="Hello!"



FMStudio_NLS_es (known as FMStudio_NLS):

----------------------------------------

[ApplicationConstants]

nlsHello="¡Hola!"



FMStudio_MAP:

-------------

HelloLink="Type=HTMLLink;HTMLText={^nlsHello}"

Now, let us assume that the test is run first in English and then later in Spanish. The first time the test is run the FMStudio_NLS_en (English) map is loaded along with the FMStudio_MAP. When the test goes to retrieve the value for the HelloLink component it will find the embedded ^nlsHello variable reference which must be retrieved. The ^nlsHello variable does not exist in the shared map so App Map Chaining will go look for the value in the English map. The value retrieved for ^nlsHello is "Hello!" and the resulting HelloLink value will be:

HelloLink="Type=HTMLLink;HTMLText=Hello!"

The second time the test is run the FMStudio_NLS_es Spanish map is loaded along with the FMStudio_MAP. This time the value retrieved for ^nlsHello is "¡Hola!" and the resulting HelloLink value will be:

HelloLink="Type=HTMLLink;HTMLText=¡Hola!"

As you can see, App Map Chaining with Embedded Variables is a powerful combination that enables us to deliver tests that can readily be migrated for NLS testing. However, to accomplish that it requires the Test Designers to design the tests and these assets with the goal of NLS reuse in mind.

Designing Tests for NLS and Other Forms of Reuse

Just as special design consideration must be given during software development to make an application support Internationalization, Localization, and Globalization, so too must our test designs receive this same level of design consideration. If the tests are not designed from the very beginning with this goal in mind then the process of going back and making the tests NLS-ready can be very difficult and time consuming.

The App Map processing features mentioned above allow us to use the same common practice used by software developers when developing software. That is, we must design our tests for NLS by separating textual data and other environment-dependent resources out of the tests themselves and into separate resource files. This means we want all environment-dependent text stored in environment-specific App Maps. Other environment-dependent resources like image files should be referenced through environment-specific entries in those same App Maps. In this way, the tests themselves do not change no matter which environment is being tested. When we go to test in a new environment we just make sure we use the appropriate App Map(s) and resources targetted for that environment.

It takes vigilance and attentive awareness to design a test that is truly NLS-ready. All environment-specific text and resources must be kept out of the design and moved into the resource files (App Maps). The designs will merely contain variable references that will ultimately be satisfied by lookups into the environment-specific App Maps. This not only includes language-specific text that might appear in object recognition strings, but also any language-specific string that might be evaluated or verified--such as an object property value, displayed text, or image benchmarks whose image may contain environment-specific text, legends, or formats.

An example of this might be a Label on a dialog box that informs the user that a certain process either succeeded or failed. The recognition string for the label may not require special handling as its Name or ID may be common across all environments as shown below:

StatusLabel="Type=Label;Name=lblStatus"

However, when we wish to verify the status displayed to the user in the Label we are going to be dealing with literal text that will likely be localized and needs to be stored separately in our NLS resource files or App Maps.

Problem:

T, StatusDialog, StatusLabel, VerifyProperty, "Text", "Success!"

Solution:

T, StatusDialog, StatusLabel, VerifyProperty, "Text", ^nlsSuccess

To make sure our tests are NLS-ready we are tasked to verify a few things:

The Name of the Label does not change in other environments so it does not need to be localized.
The name of the Text property does not change in other environments so it does not need to be localized.
The displayed text in the Label will change in other environments so it does need to be localized.

Thus, our NLS-ready App Maps need to hold this localizable text so that the proper values are found at runtime:



FMStudio_NLS_en (known as FMStudio_NLS):

----------------------------------------

[ApplicationConstants]

nlsHello="Hello!"

nlsSuccess="Success!"

nlsFailed="Failed!"



FMStudio_NLS_es (known as FMStudio_NLS):

----------------------------------------

[ApplicationConstants]

nlsHello="¡Hola!"

nlsSuccess="¡Éxito!"

nlsFailed="¡Fallado!"

As you can see, it takes special attention and vigilance to carefully design our tests so that they are NLS-ready! The same level of care must be taken for all forms of displayed text, text to be input from the user that might be language-specific, and other resources containing environment-specific data like locale-specific currency, time, and date formats.

A Complete Dynamic Text Example Supporting NLS

The Scenario:

You wish to create a highly reusable step table (action) that will close any window in your application and then check the application state. We'll call this the "CloseAppWindow" table.

This can serve a number of purposes, including:

High value test assets with reduced maintenance
Supports dynamic features of the AUT
Supports growing automated coverage of the AUT
Existing automated tests are suitable for NLS testing

The Problem:For maximum reusability, CloseAppWindow must be able to recognize different windows according to their any-language Caption, so no part of CloseAppWindow, or any of the tables that call it, can contain language-specific text.

The Solution:Use App Map Chaining, App Map Embedded Variables, and Application Constants.

1. A few examples calling CloseAppWindow with the Caption parameter using Application Constants:

　　T CloseAppWindow ^Caption=^ReportsCaption T CloseAppWindow ^Caption=^HelpCaption

　　T CloseAppWindow ^Caption=^AboutCaptionThere is no localizable text calling CloseAppWindow

2. The implementation of the CloseAppWindow step table:

T   AnyWindow   AnyWindow   CloseWindow

...followed by important status and error checks

There is no localizable text in CloseAppWindow.

3. The Primary App Map using App Map Embedded Variables:

MyApp.map:

----------

...

[AnyWindow]

AnyWindow="Type=Window;Caption={^Caption}"

...

There is no localizable text in the primary App Map.

4. The NLS App Maps for App Map Chaining for Application Constants:

4a. MyApp_NLS_en (known as MyApp_NLS):

--------------------------------------

[ApplicationConstants]

ReportsCaption="Reports"

HelpCaption="Help"

AboutCaption="About"

All localizable text is confined to the NLS App Map.

4b. MyApp_NLS_es (known as MyApp_NLS):

--------------------------------------

[ApplicationConstants]

ReportsCaption="Informes"

HelpCaption="Ayuda"

AboutCaption="Sobre"

This sample design shows maximum reusability. The same test used to automatically test the English translation of the application can be used to test all other localizations. And the amount of localization necessary for each translation has been minimized to a single NLS App Map file.