| type=page |
| status=published |
| title=Installation |
| next=config.html |
| prev=rules.html |
| ~~~~~~ |
| include::attributes.conf[] |
| Installation |
| ============ |
| |
| [[GBFTP]] |
| |
| |
| [[installation]] |
| 3 Installation |
| -------------- |
| |
| This chapter explains how to install the {TechnologyFullName} TCK software. |
| |
| After installing the software according to the instructions in this |
| chapter, proceed to link:config.html#GBFVV[Chapter 4, "Setup and |
| Configuration,"] for instructions on configuring your test environment. |
| |
| [NOTE] |
| ======================================================================= |
| |
| Although the {TechnologyShortName} {TechnologyVersion} TCK is not |
| depended on any particular build tool, it is convenient to install |
| Apache Maven {MavenVersion} for setup and execution of tests. |
| Any other build tools like Gradle and JUnit 5 Console Runner can also |
| be used that is Jupiter API compatible. |
| |
| ======================================================================= |
| |
| |
| [[GBFUD]][[obtaining-the-reference-implementation]] |
| |
| 3.1 Obtaining a Compatible Implementation |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| |
| Each compatible implementation (CI) will provide instructions for obtaining |
| their implementation. |
| {TechnologyRI} is a compatible implementation which may be obtained |
| from {TechnologyRIURL} |
| |
| [[GBFTS]][[installing-the-software]] |
| |
| 3.2 Installing the Software |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| |
| Before you can run the {TechnologyShortName} TCK tests, you must |
| install and set up the following software components: |
| |
| include::req-software.inc[] |
| * Java SE {SEversion} |
| * A CI for {TechnologyShortName} {TechnologyVersion}, one example is {TechnologyRI} |
| * {TechnologyShortName} TCK version {TechnologyVersion} |
| * The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) |
| * Any Jupiter API compatible test runner (eg. Apache Maven {MavenVersion}) |
| |
| Follow these steps: |
| |
| . Install the Java SE {SEversion} software, if it is not already installed. + |
| Download and install the Java SE {SEversion} software from |
| http://www.oracle.com/technetwork/java/javase/downloads/index.html. |
| Refer to the installation instructions that accompany the software for |
| additional information. |
| |
| . Install the build tool that will be used to run the TCK, if it is not already installed. + |
| It will be convenient to use Apache Maven {MavenVersion} for running the tests. The test kit |
| is not depended on Maven, any build tool compatible with Jupiter API is suffitient. |
| |
| . Install the {TechnologyShortName} TCK {TechnologyVersion} software. |
| a. Copy or download the {TechnologyShortName} TCK software to your |
| local system. + |
| You can obtain the {TechnologyShortName} TCK software from the |
| Jakarta EE site {SpecificationURL}. |
| b. Use the `unzip` command to extract the bundle in the directory of |
| your choice: + |
| +unzip {TCKPackageName}+ + |
| |
| include::install-server.inc[] |
| . Install a {TechnologyShortName} {TechnologyVersion} Compatible |
| Implementation. + |
| A Compatible Implementation is used to validate your initial |
| configuration and setup of the {TechnologyShortName} TCK |
| {TechnologyVersion} tests, which are explained further in |
| link:config.html#GBFVV[Chapter 4, "Setup and Configuration."] + |
| The Compatible Implementations for {TechnologyShortName} are listed on |
| the Jakarta EE Specifications web site: {SpecificationURL}. |
| include::install-server-vi.inc[] |
| . Install the {TechnologyShortName} VI to be tested. + |
| Follow the installation instructions for the particular VI under test. |