Create a UFT Developer testing project or module

Create a testing project or module using a built-in UFT Developer template or using your own custom framework.

Overview

The UFT Developer plugin in your IDE comes with built-in UFT Developer project or module templates. These provide a preliminary structure for your testing projects and references to the UFT Developer files you need. They also enable you to use the functionality provided with the framework for developing test code and running your tests.

Project templates are available for JUnit, TestNG, NUnit, and MSTest.

The UFT Developer plugin must be installed on your IDE. Typically, IDE plugins are installed during the UFT Developer installation process. However, you can also install them at any time. For details, see Maintaining and uninstalling UFT Developer.

Note: You can install the UFT Developer plugin on one or more Eclipse, Spring Tool Suite, or JBoss Developer Studio packages deployed on the same machine. To do this, see our blog post: How to install the LeanFT Eclipse plugin for multiple Eclipse packages deployed on the same machine.

Back to top

UFT Developer project templates for Visual Studio (Windows only)

In Visual Studio, you can create NUnit or MSTest UFT Developer test projects and test items.

You can also create a project that enables you to develop Selenium tests with extended capabilities. For details, see UFT Developer for Selenium.

Create an NUnit/MSTest project

  1. If you are creating an NUnit project, make sure that you have a supported version of the NUnit framework installed. For details on supported NUnit versions, see the Support Matrix. To download NUnit , see the NUnit download site.

    Note: In NUnit 3, the NUnit Runner and the NUnit framework are installed separately. Make sure to install the NUnit framework, preferably through the NuGet package manager.

  2. Create a new project. Select Visual C# > Test project, and then either the UFT Developer NUnit or MSTest project templates.

  3. To add a test item in the project, in the Solution Explorer, right-click the project and select Add UFT Developer.

  • Reference to the HP.LFT.SDK and related HP.LFT.* elements (project template only)

  • Reference to Microsoft.CSharp and, for UFT Developer NUnit projects, nunit.framework (project template only)

  • App.config, which enables you to customize certain test settings (project template only). For details, see Customize test settings.

  • A basic UFTDeveloperTest.cs template where you write your code (project and item templates).

    The exact structure of this template depends on whether you are using NUnit or MSTest. In both cases, they include attributes where you can define:

    Setup code Runs once at the start of the class
    Setup code Runs once at the start of each test
    Individual test units
    • The template includes a single [Test] (NUnit) / [TestMethod] (MSTest) attribute containing an empty Test() / TestMethod() method. You can rename this method to whatever you want to call your test.
    • You can add multiple [Test] / [TestMethod] attributes if you want to include several tests in your class.
    • Each [Test] / [TestMethod] attribute should declare a void test method that contains the main code for that test.
    Cleanup code Runs at the conclusion of each test
    Cleanup code Runs once at the end of the class
  • UnitTestClassBase.cs, which controls what happens during the various phases of your run, including running and closing the UFT Developer runtime engine (project template only).

Example: A new UFT Developer NUnit project in Visual Studio:

  • For details on using the MSTest framework, see the relevant MSDN documentation.
  • For details on using the NUnit framework, see the NUnit documentation.

Back to top

UFT Developer project templates for IntelliJ IDEA and Eclipse

In IntelliJ IDEA and Eclipse (including also Spring Tool Suite and JBoss Developer Studio), you can create the following projects:

JUnit and TestNG

These projects can be:

  • Maven-based: Include resources for running your tests with Maven.
  • Selenium-based: Include resources for integrating with Selenium.

Cucumber

The Cucumber template is based on the Java testing framework (JUnit) and is Maven-based. For details on creating a UFT Developer Cucumber project, see UFT Developer with Cucumber.

Prerequisites

Before you create a Java project, review the following prerequisites:

  • If you plan create a project that is based on the JUnit 5 template, make sure that you have the following installed:

    Java 8

    		  
    IntelliJ IDEA 2017.2.5 or higher If you are working with IntelliJ.
    Eclipse Oxygen 4.7.1a or higher If you are working with Eclipse.

Create a Java test project

  1. In your IDE, create a new project.

    In the New Project wizard:

    1. Create a UFT Developer > Testing project.

      IntelliJ IDEA users: Ensure that the correct Project SDK is selected.

    2. Follow the wizard, selecting the relevant options for your project:

      All projects

      Provide the project name and location.

      Eclipse users, UFT Developer 15.0.2 and later, Java 9 or later: When creating the project, clear the option Create module-info.java file. Otherwise, after the project is created, manually move the Micro Focus external .jar files in the Java Build Path, from Classpath to Modulepath. For details, see Move external .jar files from Classpath to Modulepath in the Java Build Path.
      Selenium
      1. Select Selenium.
      2. Non-Maven based project: Provide the location of your Selenium JAR files.
      Non-Maven-based project

      Provide the package name (Eclipse)/base package (IntelliJ IDEA), for example: com.microfocus.lft.
      Maven-based project

      Provide the Group ID and Artifact ID, and the Maven version.

      IntelliJ IDEA users: If you are creating a Maven-based project, a message appears prompting you to Add as Maven project. Click the link to create the Maven-based project.
      JUnit Select the JUnit version.

  2. If you are using a JUnit 5 framework, note that the JUnit 5 libraries are not distributed automatically by UFT Developer or by the IDE.

    • In Eclipse, the JUnit jars are automatically downloaded when the project is created.

    • In IntelliJ IDEA, for Non Maven-based projects: Once your project created, you will need to reconcile this issue by adding them manually:

      Expand the imports section, click the IDE suggestion, and then select Add JUnit5.0 to classpath.

      On the Download Library from Maven Repository, dialog box, click OK.

  3. Eclipse, Spring Tool Suite, and JBoss Developer Studio users: Add test cases using the New UFT Developer Test Case wizard (New > Other > UFT Developer > UFT Developer Test Case), selecting the relevant options for your test case.

  4. Maven-based project: The project is created with a pom.xml file. Open this file in a text editor and configure your organization's Maven repository details:

    <repository>
	<id>MyMVNrepo_ID</id>
	<name>MyMVNrepo_name</name>
	<url>http://MyMVNrepo_URL</url>
</repository>

    Note: To run the Maven-based test using Maven, there are some additional configurations you need to apply to the pom.xml file. For details, see Run UFT Developer tests.

  • A basic UFTDeveloperTest.java template where you write your tests. The exact structure of this template depends on whether you are writing a JUnit or TestNG script. In both cases, it includes attributes where you can define:

    Attributes for defining Description
    Setup code Runs once at the start of the class
    Setup code Runs once at the start of each test
    Individual test units
    • The template includes a single @Test annotation containing an empty test() method. You can rename this method to whatever you want to call your test.
    • You can add multiple @Test annotations if you want to include several tests in your class.
    • Each @Test annotation should declare a void test method that contains the main code for that test.
    Cleanup code Runs at the conclusion of each test
    Cleanup code Runs once at the end of the class

  • UnitTestClassBase, which controls what happens during the various phases of your run, including running and closing the UFT Developer runtime engine.

  • References to the respective JUnit/TestNG jar files.

  • The resources\leanft.properties file, which enables you to customize certain test settings. For details, see Customize test settings.

  • References to the com.hp.lft.sdk, com.hp.lft.report, com.hp.lft.unittesting, com.hp.lft.verifications, and com.hp.lft.reportbuilder-standalone libraries.

  • TestNG: Includes a TestNG.xml configuration file. For more details about setting up this file, see the TestNG documentation.
  • Maven-based: Includes the pom.xml file that provides all the information that Maven needs to build the project.
  • Selenium: Includes the Selenium JARS and the UFT Developer Selenium (Java) SDK.

Example: A new UFT Developer JUnit project in Eclipse:

Example: A new UFT Developer JUnit project in IntelliJ IDEA:

UFT Developer Java files use UTF-8 encoding, so you must make sure that any Java files you use in your project are also UTF-8 or UTF-8 compatible.

Maven users: To compile your UFT Developer Java projects using Maven, you must specify the encoding either in the pom.xml or in the Maven command line.

  1. To add the encoding to the pom.xml, add the following:

    <properties>
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

  2. To specify the encoding in the command line, use:

    mvn clean install -Dproject.build.sourceEncoding=UTF-8

For details on using the JUnit framework, see the JUnit documentation.

Supported in UFT Developer versions 15.0.2 and later.

When working in Eclipse with Java 9 or later, if you created a module-info.java file when creating a new UFT Developer project, manually move the Micro Focus external .jar files in the Java Build Path from Classpath to the Modulepath:

  1. In Eclipse, in the Package Explorer, right-click your project, select Build Path > Configure Build Path.

  2. Select the Java Build Path pane and the Libraries tab.

  3. Move the .jar files shown below from the Classpath library to the Modulepath library.

Back to top

UFT Developer module template for Android Studio

For Android Studio, you can create a UFT Developer module.

The UFT Developer module template is based on JUnit, but includes enhancements to help you create mobile tests easily.

To create a UFT Developer module

  1. If you are working with a Maven repository, follow the instructions in Prerequisites for Maven-based projects.
  2. Open the project to which you want to add the UFT Developer module.
  3. In Android Studio, click File > New > New UFT Developer Module.

  4. On the Create New UFT Developer Module dialog box, enter the Module name and the Java package name, and then click Finish.

    A UFT Developer module is created with all the required resources.

  5. If you are working with a Maven repository, open the module's build.gradle file, and follow the instructions in the file.
  6. If you are working with UFT Developer from your file system and not with a Maven repository and you want to use the UFT Developer JavaDoc, you need to add it manually from the Library Properties of the UFT Developer SDK jar.

  • A UFTDeveloperTest.java template where you write your tests.

    The template includes setup code, tear-down code, and a single @Test annotation containing an empty test() method.

    Rename this method to whatever you want to call your test. You can add multiple @Test annotations if you want to include several tests in your class. Each @Test annotation should declare a void test method that contains the main code for that test.

  • The resources\leanft.properties file, which enables you to customize certain test settings. For details, see Customize test settings.

  • UnitTestClassBase, which controls what happens during the various phases of your run, including running and closing the UFT Developer runtime engine.

  • References to the com.hp.lft.sdk, com.hp.lft.verifications, and com.hp.lft.sdk.mobile libraries.

  • build.gradle scripts.

Back to top

JavaScript template for supported IDEs

You can write JavaScript tests using any of the supported IDEs.

For a starting template for JavaScript tests, see Setting up and working with the JavaScript SDK.

Back to top

Custom template

If you are using a custom framework:

  1. Ensure that your project references a number of items from the UFT Developer SDK library.

  2. Set up your project as described in Use your own frameworks with UFT Developer.

Back to top

Next steps: