Home > Articles > Programming

This chapter is from the book

Waiting for Test Objects to Come into Existence

When GUI objects aren’t rendered in a timely manner, you simply want your script to wait until they appear. Chapter 1 discussed the pros and cons of using global delay settings (for example, using Rational Functional Tester’s playback settings). You also just learned about using the sleep() method in the previous section. This is helpful because the delay is specific to a script, releasing your dependencies on the global tool settings. However, it is a static delay. It waits until a specified number of seconds elapse, regardless of whether the GUI object appears sooner or not. This section discusses a happy medium between the global delay settings and the sleep() method.

The Rational Functional Java API provides a useful waitForExistence() method or WaitForExistence() function if you’re using VB.NET. In either case, it comes in two variants. One is dependent upon global playback settings. The other is script-specific.

To use this method, you need to call it from a test object. Simply put, you need to tell your script which object to wait for. You can either type the name of the object, followed by opening and closing parentheses, directly into your code and hit the period key, or you can simply place your cursor in the script where you wish the command to go, right-click the test object in the Test Objects folder (within the Script Explorer view), and click Insert at Cursor from the displayed menu. Either of these two options displays an IntelliSense drop-down window (some people refer to this as “code complete”). This window provides you with a list of methods and functions that you can call. Typing the word wait shows you the methods and functions that begin with wait. The waitForExistence() method is among them. Figures 3.3 and 3.4 show how to call the waitForExistence() method, using the Eclipse and .NET Studio environments, respectively.

If you use the Java language, you need to append a semicolon at the end of the line. If you use the VB.NET language, you are set and there is nothing further to do. Listing 3.2 shows you how the command looks in the same Rational Functional Tester script, using Java and VB.NET, respectively.

Listing 3.2. Using waitForExistence() / WaitForExistence() in a script

Java
public void testMain(Object[] args)
{
            startApp("ClassicsJavaA");

      // USE waitForExistence() ON MAIN WINDOW TO MAKE
      // SURE IT IS THERE BEFORE PERFORMING VERIFICATION
      classicsJava().waitForExistence();

      // Frame: ClassicsCD
      tree2().performTest(VerifyComposerListVP());
      classicsJava(ANY,MAY_EXIT).close();
}
VB.NET
Public Function TestMain(ByVal args() As Object) As Object
      StartApp("ClassicsJavaA")

      ' USE WaitForExistence() ON MAIN WINDOW TO MAKE
      ' SURE IT IS THERE BEFORE PERFORMING VERIFICATION
      ClassicsJava().WaitForExistence()

      ' Frame: ClassicsCD
      Tree2().PerformTest(VerifyComposerListVP())
      ClassicsJava(ANY,MAY_EXIT).Close()
      Return Nothing
End Function

In Listing 3.2, ClassicsJava() is a test object, representing the main window of the application. You call this test object’s waitForExistence() method to tell your script that it needs to wait until this object appears, prior to executing the next line. The value of this method is that it immediately continues execution of the script after the test object renders on the screen (versus waiting a static period of time). However, this particular variant of the method is dependent upon global delay settings accessed from Rational Functional Tester’s primary playback settings. Figures 3.5 and 3.6 show these options for Java and VB.NET.

The last two settings are specific to the waitForExistence()/WaitForExistence() method. If you want to change how long it waits or how often it checks for a test object’s existence, you simply override the defaults and supply your own values. You should note that using this variant of the method keeps you dependent upon Rational Functional Tester’s global settings.

To become script-specific, you would use the second variant of this method—waitForExistence(double arg0, double arg1). This enables you to provide the maximum amount of time script playback waits for the object to render (that is arg0). You also enter the amount of time it waits between attempts to find the test object (that is arg1). You specify these two values using seconds. Using this version of the method keeps your scripts independent from the values in the global delay settings for the waitForExistence() method. Listing 3.3 shows how this would look in both Java and VB.NET.

Listing 3.3. Using the script-specific version of waitForExistence()/WaitForExistence() in a script

Java
public void testMain(Object[] args)
{
      startApp("ClassicsJavaA");

      // USE waitForExistence() ON MAIN WINDOW TO MAKE
      // SURE IT IS THERE BEFORE PERFORMING VERIFICATION
      // WAIT A MAXIMUM OF 180 SECONDS/3 MINUTES
      // CHECK FOR THE MAIN WINDOW EVERY 2 SECONDS
      classicsJava().waitForExistence(180.0, 2.0);

      // Frame: ClassicsCD
      tree2().performTest(VerifyComposerListVP());
      classicsJava(ANY,MAY_EXIT).close();
}
VB.NET
Public Function TestMain(ByVal args() As Object) As Object
      StartApp("ClassicsJavaA")

      ' USE WaitForExistence() ON MAIN WINDOW TO MAKE
      ' SURE IT IS THERE BEFORE PERFORMING VERIFICATION
      ' WAIT A MAXIMUM OF 180 SECONDS/3 MINUTES
      ' CHECK FOR THE MAIN WINDOW EVERY 2 SECONDS
      ClassicsJava().WaitForExistence(180.0, 2.0)

      ' Frame: ClassicsCD
      Tree2().PerformTest(VerifyComposerListVP())
      ClassicsJava(ANY,MAY_EXIT).Close()
      Return Nothing
End Function

You can see that your script now waits for the main window (for example, classicsJava) of the application for a maximum of 180 seconds, searching for it every two seconds.

Of the three synchronization topics that you have seen thus far, this is the most desirable. It provides you with the ability to have your scripts wait until a test object appears versus waiting for a static amount of time to elapse. Further, it enables you to become script-specific, allowing any tester on your team to run it without having to adjust global playback delay settings.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020