SeamFramework.orgCommunity Documentation

Preface

This guide describes how to download, install, configure, and run the Technology Compatibility Kit (TCK) used to verify the compatibility of an implementation of the JSR-299: Context and Dependency Injection for Java EE (CDI) specification.

The CDI TCK is built atop the JBoss Test Harness, a portable and configurable automated test suite for authoring unit and integration tests in a Java EE environment. The CDI TCK 1.0.2CR1 uses the JBoss Test Harness version 1.1.0CR6 to execute the test suite.

The CDI TCK is provide under the Apache Public License 2.0.

This guide is for implementors of the Context and Dependency Injection for Java EE 1.0 technology to assist in running the test suite that verifies the compatibility of their implementation.

Before reading this guide, you should familiarize yourself with the Java EE programming model, specifically the Enterprise JavaBeans (EJB) 3.0 and the Contexts and Dependency Injection for Java EE 1.0 specifications. A good resource for the Java EE programming model is the JCP web site.

The CDI TCK is based on the Context and Dependency Injection for Java EE technology specification 1.0 (JSR-299). Information about the specification, including links to the specification documents, can be found on the JSR-299 JCP page.

Before running the tests in the CDI TCK, read and become familiar with the JBoss Test Harness Reference Guide (pending), which describes how the test harness functions.

If you are running the CDI TCK for the first time, read Chapter 1, Introduction (CDI TCK) and Chapter 10, Introduction (JBoss Test Harness) completely for the necessary background information about the TCK and the JBoss Test Harness, respectively. Once you have reviewed that material, perform the steps outlined in the remaining chapters.

  • Chapter 1, Introduction (CDI TCK) gives an overview of the principles that apply generally to all Technology Compatibility Kits (TCKs), outlines the appeals process and describes the CDI TCK architecture and components. It also includes a broad overview of how the TCK is executed and lists the platforms on which the TCK has been tested and verified.

  • Chapter 2, Appeals Process explains the process to be followed by an implementor should they wish to challenge any test in the TCK.

  • Chapter 3, Installation explains where to obtain the required software for the CDI TCK and how to install it. It covers both the primary TCK components as well as tools useful for troubleshooting tests.

  • Chapter 4, Configuration details the configuration of the JBoss Test Harness, how to create a TCK runner for the TCK test suite and the mechanics of how an in-container test is conducted.

  • Chapter 5, Reporting explains the test reports that are generated by the TCK test suite and introduces the TCK audit report as a tool for measuring the completeness of the TCK in testing the JSR-299 specification and in understanding how testcases relate to the specification.

  • Chapter 7, Executing the Test Suite documents how the TCK test suite is executed. It covers both modes supported by the TCK, standalone and in-container, and shows how to dump the generated test artifacts to disk.

  • Chapter 8, Running Tests in Eclipse shows how to run individual tests in Eclipse and advises the best way to setup your Eclipse workspace for running the tests.

  • Chapter 9, Debugging Tests in Eclipse builds on Chapter 8, Running Tests in Eclipse by detailing how to debug individual tests in Eclipse.

  • Part III, “JBoss Test Harness” includes excerpts from the JBoss Test Harness Reference Guide. How to configure the JBoss Test Harness as it relates to the CDI TCK is presented in Chapter 4, Configuration. However, to aid in debugging or configuring the TCK in your environment, you may want to read in more detail how to use the JBoss Test Harness.