Setup and Configuration

## 4 Setup and Configuration

Note | The Jakarta EE Specification process provides for any number of compatible implementations. As additional implementations become available, refer to project or product documentation from those vendors for specific TCK setup and operational guidance.

This chapter describes how to set up the Tag Library 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 Tag Library TCK.

### 4.1 Configuring Your Environment to Run the TCK Against the Compatible 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 11 or 17 is installed

   2. `TS_HOME` to the directory in which the Tag Library TCK 3.0 software is installed

   3. `JAVAEE_HOME` to the directory in which the Tag Library 3.0 CI has been installed

   4. `PATH` to include the following directories: `JAVA_HOME/bin`, `JAVAEE_HOME/bin`, and `ANT_HOME/bin`

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

   1. Set the `webServerHost` property to the name of the host on which CI (for example, Eclipse GlassFish 7.0), is running.
      The default setting is `localhost`.

   2. Set the `webServerPort` property to the port number of the host on whichCI (for example Eclipse GlassFish 7.0) is running.
      The default setting is `8080`.

   3. `impl.vi` to the Vendor implementation.

   4. `impl.vi.deploy.dir` to the Vendor implementation deployment directory.
      The Tag Library TCK includes the following handlers:

      - `none`: No deployment; default setting

      - `glassfish`: Deploy to the Eclipse GlassFish 7.0 server

      - `tomcat`: Deploy to the a Tomcat server
        See Section 4.4, "Custom Deployment Handlers," for information about creating your own deployment handler and setting the `impl.vi.deploy.dir` property to use that handler.

   5. `jsf.classes` to the Standard Tag Library for Jakarta Server Pages API and implementation classes that are under test

   6. `jspservlet.classes` to the path to the Servlet and Jakarta Server Pages API classes.
      The `ts.jte` file includes examples that show how to set the classes properties for Eclipse GlassFish 7.0 servers.

   7. `report.dir` to the default directory in which JavaTest creates a test report for the most recent test run.
      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"`.

   8. `work.dir` to the default directory in which JavaTest writes temporary files that are created during test execution.
      This property is required for the TCK Ant targets.

3. Provide your own implementation of the porting package interface provided with the Tag Library TCK.
   The porting package interface, `TSURLInterface.java`, obtains URL strings for web resources in an implementation-specific manner. API documentation for the `TSURLInterface.java` porting package interface is available in the Tag Library TCK documentation bundle.

#### 4.1.1 Initializing Database and Packaging the War Files for Deployment

The Ant target `init.<dbname>` configures the database for running the test. The target can be run from `<TS_HOME>/bin`.

For example, change to the `<TS_HOME>/bin` directory, then enter

`ant init.javadb`

This adds the database users and run db statements that are necessary for the tests to run successfully.

In addition to database configuration `init.<dbname>` builds all the test classes and packages the war files to `<TS_HOME>/dist/*` which is deployed later.

#### 4.1.2 Preparing the WAR Files for Deployment

Complete this step only if you intend to package a Tag Library implementation in the WAR files, thereby overriding the default Tag Library implementation for the application server under test. This procedure adds to and rebuilds the Tag Library TCK WAR files.

1. Copy the JAR file or files required by the Tag Library implementation that will replace the application server’s default Tag Library implementation to the `<TS_HOME>/weblib` directory.
   This JAR file (or files) must contain all of the TLDs (located in the `META-INF` directory of the archive) for the tag libraries, as defined by the Tag Library specification and any additional support JAR files upon which the Tag Library implementation is dependent.

2. Change to the `<TS_HOME>/src/com/sun/ts/tests` directory and run `ant build` to package the web archives.
   This adds the JAR file or files from the `<TS_HOME>/weblib` directory to each of the WAR files.

### 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.

#### Before You Begin

Decide against which Tag Library implementation the tests will be run and determine to which Servlet–compliant Web server the Tag Library TCK applications will be published.

Adapt the instructions above for the vendor implementation.

### 4.3 Deploying the Tag Library TCK Tests

To deploy the Tag Library TCK tests to the Jakarta EE 10 platform, perform the following steps.

1. Make sure that the Web server to which you will deploy the Tag Library TCK tests is running.

   1. Start the database.

   2. Start the web server domain.
      For example, with Eclipse GlassFish 7.0 we can use the `asadmin` to start/stop database and domain.
      `./asadmin start-database`
      `./asadmin start-domain`

   3. In addition, with Java SE 11 or 17 security changes, it is necessary to set the following JVM properties on the domain in order to ensure all tests pass.
      `-Djavax.xml.accessExternalStylesheet=all`
      `-Djavax.xml.accessExternalSchema=all`
      `-Djavax.xml.accessExternalDTD=file,http`
      These properties need to exist and be set within the appserver domain if security manager is enabled. For example, we can use `asadmin` to set/unset jvm options followed by domain restart.
      `./asadmin create-jvm-options -Djavax.xml.accessExternalStylesheet=all`
      `./asadmin create-jvm-options -Djavax.xml.accessExternalSchema=all`
      `./asadmin create-jvm-options -Djavax.xml.accessExternalDTD=file,http`
      `./asadmin restart-domain`

2. Change to the `<TS_HOME>/bin` directory.

3. Execute the `ant deploy.all` command.
   All of the WAR files containing the Tag Library TCK tests have been deployed. Follow the instructions in Section 5.1, "Using the GUI for TCK Test Execution," or Section 5.2, "Using the Command Line for TCK Test Execution," to run the tests you just deployed.

### 4.4 Custom Configuration Handlers

Configuration handlers are used to configure and unconfigure a Tag Library 3.0 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, you may wish to view `<TS_HOME>/bin/xml/impl/glassfish/config.vi.xml`, the configuration file for Jakarta EE 10 Compatible Implementation, Eclipse GlassFish.

### 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 Tag Library TCK provides these deployment handlers:

- `<TS_HOME>/bin/xml/impl/none/deploy.xml`

- `<TS_HOME>/bin/xml/impl/glassfish/deploy.xml`

- `<TS_HOME>/bin/xml/impl/tomcat/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 Eclipse 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 Tag Library implementation, you must create a custom handler.

1. Create a new directory in the `<TS_HOME>/bin/xml/impl` directory tree. For example, create the `<TS_HOME>/bin/xml/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".

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

3. 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 Eclipse Glassfish directories for guidance as you create the same targets for the Web container in which you will run your implementation of Tag Library.

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 Tag Library TCK test suite using the JavaTest harness software:

- Through the JavaTest GUI; if using this method, please continue on to Section 4.7, "Using the JavaTest Harness Configuration GUI."

- In JavaTest batch mode, from the command line in your shell environment; if using this method, please proceed directly to Chapter 5, "Executing Tests."

### 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 Tag Library TCK test environment. This section covers the following topics:

- Configuration GUI Overview

- Starting the Configuration GUI

- To Configure the JavaTest Harness to Run the Tag Library TCK Tests

- Modifying the Default Test Configuration

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 11 or 17 installed on your system.

The Tag Library 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 Tag Library 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.

Copyright © 2017, 2021 Oracle and/or its affiliates. All rights reserved.