Setup and Configuration

Previous Next Contents

4 Setup and Configuration

This chapter describes how to set up the JPA TCK and JavaTest harness software. Before proceeding with the instructions in this chapter, be sure to install all required software, as described in Chapter 3, "Installation."

After completing the instructions in this chapter, proceed to Chapter 5, "Executing Tests," for instructions on running the JPA TCK.

4.1 Configuring Your Environment to Run the TCK Against the Reference Implementation

After configuring your environment as described in this section, continue with the instructions in Section 4.6, "Using the JavaTest Harness Software."

Note

In these instructions, variables in angle brackets need to be expanded for each platform. For example, <TS_HOME> becomes $TS_HOME on Solaris/Linux and %TS_HOME% on Windows. In addition, the forward slashes (/) used in all of the examples need to be replaced with backslashes (\) for Windows. Finally, be sure to use the appropriate separator for your operating system when specifying multiple path entries (; on Windows, : on UNIX/Linux).

On Windows, you must escape any backslashes with an extra backslash in path separators used in any of the following properties, or use forward slashes as a path separator instead.

  1. Set the following environment variables in your shell environment:

    1. JAVA_HOME to the directory in which Java SE 8 is installed

    2. TS_HOME to the directory in which the JPA TCK 2.2 software is installed

    3. PATH to include the following directories: JAVA_HOME/bin, ECLIPSELINK_HOME/bin, and <TS_HOME>/tools/ant/bin

  2. Edit your <TS_HOME>/bin/ts.jte file and set the following environment variables:

    1. Set jpa.classes to include all of the necessary JAR files that pertain to your implementation.

    2. Set jdbc.lib.classpath to the location where the JDBC drivers are installed.

    3. Set jdbc.db to the name of the database under test. Valid values include:

      derby
      mysql
      sybase
      db2
      mssqlserver
      oracle
      postgresql
    4. Set javax.persistence.provider, javax.persistence.jdbc.driver, javax.persistence.jdbc.url, javax.persistence.jdbc.user, and javax.persistence.jdbc.password to the appropriate values for the database and persistence provider under test.
      These properties are passed to the Persistence provider during the creation of the EntityManagerFactory. Any additional values, for example setting an implementation’s logging level, must be set by following the instructions in Step 2e.

    5. Set the jpa.provider.implementation.specific.properties property to include any implementation-specific settings that need to be passed to the provider when the EntityManagerFactory is created.

    6. Set sigTestClasspath to include any additional classes not specified with the jpa.classes property.

    7. Set work.dir to the default directory in which JavaTest writes temporary files that are created during test execution. The default location is <TS_HOME>/tmp/JTwork.
      This property is required for the TCK Ant targets.

    8. Set report.dir to the default directory in which JavaTest creates a test report for the most recent test run. The default location is <TS_HOME>/tmp/JTreport.
      This property is a required property for the TCK Ant targets; it must be set. To disable reporting, set the report.dir property to "none".

    9. Set db.supports.sequence to false if the database does not support the use of SEQUENCE.
      The default value is true.

    10. Set persistence.second.level.caching.supported to false if your persistence provider does not support second level caching.
      The default value is true.

  3. If you are using MySQL or MS SQL Server, do the following:

    1. If you are using MySQL, see Section 4.3.1, "Setup Considerations for MySQL," and proceed to Step 4.

    2. If you are using MS SQL Server, see Section 4.3.2, "Setup Considerations for MS SQL Server," and proceed to Step 4.

  4. Start the database under test.

  5. Initialize the database under test.
    The init.database target initializes the database tables.
    Change to the <TS_HOME>/bin directory and execute the following command:

    ant -f initdb.xml

4.2 Configuring Your Environment to Repackage and Run the TCK Against the Vendor Implementation

After configuring your environment as described in this section, continue with the instructions in Section 4.4, "Using the JavaTest Harness Software."

Note

In these instructions, variables in angle brackets need to be expanded for each platform. For example, <TS_HOME> becomes $TS_HOME on Solaris/Linux and %TS_HOME% on Windows. In addition, the forward slashes (/) used in all of the examples need to be replaced with backslashes (\) for Windows. Finally, be sure to use the appropriate separator for your operating system when specifying multiple path entries (; on Windows, : on UNIX/Linux).

On Windows, you must escape any backslashes with an extra backslash in path separators used in any of the following properties, or use forward slashes as a path separator instead.

Adapt the instructions above as appropriate for your implementation.

4.3 Setup Considerations

4.3.1 Setup Considerations for MySQL

The Java Persistence API (JPA) tests require delimited identifiers for the native query tests. If you are using delimited identifiers on MySQL, modify the sql-mode setting in the my.cnf file to set the ANSI_QUOTES option. After setting this option, reboot the MySQL server. Set the option as shown in this example:

sql-mode=
    "STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION,ANSI_QUOTES"

4.3.2 Setup Considerations for MS SQL Server

If your database already exists and if you use a case-sensitive collation on MS SQL Server, execute the following command to modify the database and avert errors caused by case-sensitive collation:

ALTER DATABASE ctsdb COLLATE Latin1_General_CS_AS ;

4.4 Custom Configuration Handlers

Configuration handlers are used to configure and unconfigure a JPA 2.2 implementation during the certification process. These are similar to deployment handlers but used for configuration. A configuration handler is an Ant build file that contains at least the required targets listed below: * config.vi - to configure the vendor implementation * clean.vi - to unconfigure the vendor implementation

These targets are called from the <TS_HOME>/bin/build.xml file and call down into the implementation-specific configuration handlers.

To provide your own configuration handler, create a config.vi.xml file with the necessary configuration steps for your implementation and place the file under the <TS_HOME>/bin/xml/impl/<your_impl> directory.

For more information, see <TS_HOME>/bin/xml/impl/glassfish/config.vi.xml, the configuration file for the Java EE 8 RI.

4.5 Custom Deployment Handlers

Deployment handlers are used to deploy and undeploy the WAR files that contain the tests to be run during the certification process. A deployment handler is an Ant build file that contains at least the required targets listed in the table below.

The JPA TCK provides these deployment handlers: * <TS_HOME>/bin/xml/impl/none/deploy.xml * <TS_HOME>/bin/xml/impl/glassfish/deploy.xml

The deploy.xml files in each of these directories are used to control deployment to a specific container (no deployment, deployment to the GlassFish Web container, deployment to the Tomcat Web container) denoted by the name of the directory in which each deploy.xml file resides. The primary build.xml file in the <TS_HOME>/bin directory has a target to invoke any of the required targets (-deploy, -undeploy, -deploy.all, -undeploy.all).

4.5.1 To Create a Custom Deployment Handler

To deploy tests to another JPA implementation, you must create a custom handler. 1. Create a new directory in the <TS_HOME>/bin/impl directory tree. For example, create the <TS_HOME>/bin/impl/my_deployment_handler directory. Replace my_deployment_handler with the value of the impl.vi property that you set in Step 5 of the configuration procedure described in Section 4.2, "Configuring Your Environment to Repackage and Run the TCK Against the Vendor Implementation".

  1. Copy the deploy.xml file from the <TS_HOME>/bin/xml/impl/none directory to the directory that you created.

  2. Modify the required targets in the deploy.xml file. This is what the deploy.xml file for the "none" deployment handler looks like.

    <project name="No-op Deployment" default="deploy">
        <!-- No-op deployment target -->
        <target name="-deploy">
            <echo message="No deploy target implemented for this deliverable"/>
        </target>
        <target name="-undeploy">
            <echo message="No undeploy target implemented for this deliverable"/>
        </target>
        <target name="-deploy.all">
            <echo message="No deploy target implemented for this deliverable"/>
        </target>
        <target name="-undeploy.all">
            <echo message="No undeploy target implemented for this deliverable"/>
        </target>
    </project>

    Although this example just echoes messages, it does include the four required Ant targets (-deploy, -undeploy, -deploy.all, -undeploy.all) that your custom deploy.xml file must contain. With this as your starting point, look at the required targets in the deploy.xml files in the tomcat and glassfish directories for guidance as you create the same targets for the Web container in which you will run your implementation of JPA.

The following Ant targets can be called from anywhere under the <TS_HOME>/src directory:

  • deploy

  • undeploy

  • deploy.all

  • undeploy.all

The deploy.all and undeploy.all targets can also be called from the <TS_HOME>/bin directory.

Note

The targets in the deploy.xml file are never called directly. They are called indirectly by the targets listed above.

4.6 Using the JavaTest Harness Software

There are two general ways to run the JPA TCK test suite using the JavaTest harness software:

4.7 Using the JavaTest Harness Configuration GUI

You can use the JavaTest harness GUI to modify general test settings and to quickly get started with the default JPA TCK test environment. This section covers the following topics:

Note

It is only necessary to proceed with this section if you want to run the JavaTest harness in GUI mode. If you plan to run the JavaTest harness in command-line mode, skip the remainder of this chapter, and continue with Chapter 5, "Executing Tests."

4.7.1 Configuration GUI Overview

In order for the JavaTest harness to execute the test suite, it requires information about how your computing environment is configured. The JavaTest harness requires two types of configuration information:

  • Test environment: This is data used by the tests. For example, the path to the Java runtime, how to start the product being tested, network resources, and other information required by the tests in order to run. This information does not change frequently and usually stays constant from test run to test run.

  • Test parameters: This is information used by the JavaTest harness to run the tests. Test parameters are values used by the JavaTest harness that determine which tests in the test suite are run, how the tests should be run, and where the test reports are stored. This information often changes from test run to test run.

The first time you run the JavaTest harness software, you are asked to specify the test suite and work directory that you want to use. (These parameters can be changed later from within the JavaTest harness GUI.)

Once the JavaTest harness GUI is displayed, whenever you choose Start, then Run Tests to begin a test run, the JavaTest harness determines whether all of the required configuration information has been supplied:

  • If the test environment and parameters have been completely configured, the test run starts immediately.

  • If any required configuration information is missing, the configuration editor displays a series of questions asking you the necessary information. This is called the configuration interview. When you have entered the configuration data, you are asked if you wish to proceed with running the test.

4.7.2 Starting the Configuration GUI

Before you start the JavaTest harness software, you must have a valid test suite and Java SE 8 installed on your system.

The JPA TCK includes an Ant script that is used to execute the JavaTest harness from the <TS_HOME> directory. Using this Ant script to start the JavaTest harness is part of the procedure described in Section 4.7.3, "To Configure the JavaTest Harness to Run the TCK Tests."

When you execute the JavaTest harness software for the first time, the JavaTest harness displays a Welcome dialog box that guides you through the initial startup configuration.

  • If it is able to open a test suite, the JavaTest harness displays a Welcome to JavaTest dialog box that guides you through the process of either opening an existing work directory or creating a new work directory as described in the JavaTest online help.

  • If the JavaTest harness is unable to open a test suite, it displays a Welcome to JavaTest dialog box that guides you through the process of opening both a test suite and a work directory as described in the JavaTest documentation.

After you specify a work directory, you can use the Test Manager to configure and run tests as described in Section 4.7.3, "To Configure the JavaTest Harness to Run the TCK Tests."

4.7.3 To Configure the JavaTest Harness to Run the TCK Tests

The answers you give to some of the configuration interview questions are specific to your site. For example, the name of the host on which the JavaTest harness is running. Other configuration parameters can be set however you wish. For example, where you want test report files to be stored.

Note that you only need to complete all these steps the first time you start the JavaTest test harness. After you complete these steps, you can either run all of the tests by completing the steps in Section 5.1, "Starting JavaTest," or run a subset of the tests by completing the steps in Section 5.2, "Running a Subset of the Tests."

  1. Change to the <TS_HOME>/bin directory and start the JavaTest test harness:
    cd <TS_HOME>/bin
    ant gui

  2. From the File menu, click Open Quick Start Wizard.
    The Welcome screen displays.

  3. Select Start a new test run, and then click Next.
    You are prompted to create a new configuration or use a configuration template.

  4. Select Create a new configuration, and then click Next.
    You are prompted to select a test suite.

  5. Accept the default suite (<TS_HOME>/src), and then click Next.
    You are prompted to specify a work directory to use to store your test results.

  6. Type a work directory name or use the Browse button to select a work directory, and then click Next.
    You are prompted to start the configuration editor or start a test run. At this point, the JPA TCK is configured to run the default test suite.

  7. Deselect the Start the configuration editor option, and then click Finish.

  8. Click Run Tests, then click Start.
    The JavaTest harness starts running the tests.

  9. To reconfigure the JavaTest test harness, do one of the following:

    • Click Configuration, then click New Configuration.

    • Click Configuration, then click Change Configuration.

  10. Click Report, and then click Create Report.

  11. Specify the directory in which the JavaTest test harness will write the report, and then click OK.
    A report is created, and you are asked whether you want to view it.

  12. Click Yes to view the report.

4.7.4 Modifying the Default Test Configuration

The JavaTest GUI enables you to configure numerous test options. These options are divided into two general dialog box groups:

  • Group 1: Available from the JavaTest Configure/Change Configuration submenus, the following options are displayed in a tabbed dialog box:

    • Tests to Run

    • Exclude List

    • Keywords

    • Prior Status

    • Test Environment

    • Concurrency

    • Timeout Factor

  • Group 2: Available from the JavaTest Configure/Change Configuration/Other Values submenu, or by pressing Ctrl+E, the following options are displayed in a paged dialog box:

    • Environment Files

    • Test Environment

    • Specify Tests to Run

    • Specify an Exclude List

Note that there is some overlap between the functions in these two dialog boxes; for those functions use the dialog box that is most convenient for you. Please refer to the JavaTest Harness documentation or the online help for complete information about these various options.


Previous Next Contents
Eclipse Foundation Logo  Copyright © 2018, Oracle and/or its affiliates. All rights reserved.