Skip to content

Commit

Permalink
Refactored Annotations tck 3.0 with GF runner (#1222)
Browse files Browse the repository at this point in the history
  • Loading branch information
alwin-joseph authored Feb 11, 2024
1 parent dc05fc9 commit d5e5665
Show file tree
Hide file tree
Showing 57 changed files with 6,252 additions and 0 deletions.
73 changes: 73 additions & 0 deletions annotations/docs/CAJ2.1-ReleaseNotes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
<title>Jakarta Annotations TCK, Version 2.1 Release Notes, December 2021</title>
<!--
Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved. This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at http://www.eclipse.org/legal/epl-2.0. This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse Public License v. 2.0 are satisfied: GNU General Public License, version 2 with the GNU Classpath Exception, which is available at https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0-->
<style type="text/css">
<!--
body { background-color: #ffffdd; color: #000000}
pre { background-color: #eeeeee; color: #000099; font-size: smaller}
code { color: #000099; font-size: smaller}
h1 { color: #000099}
h2 { color: #000099}
h3 { color: #000099; text-decoration: underline}
h4 { font-style: italic; color: #000099}
.tabletitle { font-style: italic; color: #ffffcc; font-size: small; font-variant: small-caps}
.subtitle { font-style: italic; color: #ffffcc; font-variant: small-caps}
.emphasize { font-style: italic; color: #000099}
.step { font-weight: bold}
.note { background-color: #fffff0; border-bottom-width: thin; border-top-width: thin; border-top-style: inset; border-bottom-style: inset; font-size: -10%;}
th { background-color: #eeeeee; padding-left: 2pt; padding-right: 2pt;}
-->
</style></head>
<body>
<div align="center">
<h1>Jakarta Annotations Technology Compatibility Kit, Version 2.1<br>
<em class="emphasize">Release Notes, December 2021</em></h1>
</div>
<h2><a name="kit_contents">Kit Contents</a></h2>
<p>The Jakarta Annotations, Version 2.1 Technology Compatibility Kit (TCK)
includes the following items:</p>
<ul>
<li>
<p><strong>Jakarta Annotations TCK Signature Tests:</strong> Check that
all public APIs are supported and/or defined as specified in the
Jakarta Annotations specification, Version 2.1 implementation under
test.</p>
</li>
</ul>
<hr>
<h2><a name="platform">Platform Notes</a></h2>
<p>The Jakarta Annotations TCK tests have been built with JDK 11 and tested
with OpenJDK 11 and OpenJDK 17.</p>
<p>The Jakarta Annotations TCK tests have been run on the following
platforms:</p>
<ul>
<li>Debian Linux 10</li>
</ul>
<p>The Jakarta Annotations TCK tests have been run against the following
Common Annotations for Jakarta EE compatible implementations:</p>
<ul>
<li>Jakarta Annotations for Java Compatible Implementation Version 2.1</li>
</ul>
<hr>
<h2><a name="install_setup_run">Installing, Setting Up, and Running the
Jakarta Annotations TCK</a></h2>
<p>Refer to the <cite>Jakarta Annotations for Jakarta EE TCK 2.1 User's
Guide</cite> for complete instructions on installing, setting up, and
running the Jakarta Annotations TCK. The online version of the JT Harness
version 5.0 documentation is available <a href="https://wiki.openjdk.java.net/display/CodeTools/Documentation">here</a>.</p>
<hr>
<p><cite><small></small></cite></p>
<address><small> Copyright © 2013, 2021 Oracle and/or its affiliates. All
rights reserved. </small></address>
<cite>
<p></p>
</cite>
</body>
</html>
72 changes: 72 additions & 0 deletions annotations/docs/CAJ3.0-ReleaseNotes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
<title>Jakarta Annotations TCK, Version 2.1 Release Notes, December 2021</title>
<!--
Copyright (c) 2024 Oracle and/or its affiliates. All rights reserved. This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at http://www.eclipse.org/legal/epl-2.0. This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse Public License v. 2.0 are satisfied: GNU General Public License, version 2 with the GNU Classpath Exception, which is available at https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0-->
<style type="text/css">
<!--
body { background-color: #ffffdd; color: #000000}
pre { background-color: #eeeeee; color: #000099; font-size: smaller}
code { color: #000099; font-size: smaller}
h1 { color: #000099}
h2 { color: #000099}
h3 { color: #000099; text-decoration: underline}
h4 { font-style: italic; color: #000099}
.tabletitle { font-style: italic; color: #ffffcc; font-size: small; font-variant: small-caps}
.subtitle { font-style: italic; color: #ffffcc; font-variant: small-caps}
.emphasize { font-style: italic; color: #000099}
.step { font-weight: bold}
.note { background-color: #fffff0; border-bottom-width: thin; border-top-width: thin; border-top-style: inset; border-bottom-style: inset; font-size: -10%;}
th { background-color: #eeeeee; padding-left: 2pt; padding-right: 2pt;}
-->
</style></head>
<body>
<div align="center">
<h1>Jakarta Annotations Technology Compatibility Kit, Version 3.0<br>
<em class="emphasize">Release Notes, February 2024</em></h1>
</div>
<h2><a name="kit_contents">Kit Contents</a></h2>
<p>The Jakarta Annotations, Version 3.0 Technology Compatibility Kit (TCK)
includes the following items:</p>
<ul>
<li>
<p><strong>Jakarta Annotations TCK Signature Tests:</strong> Check that
all public APIs are supported and/or defined as specified in the
Jakarta Annotations specification, Version 3.0 implementation under
test.</p>
</li>
</ul>
<hr>
<h2><a name="platform">Platform Notes</a></h2>
<p>The Jakarta Annotations TCK tests have been built with JDK 17 and tested
with OpenJDK 17</p>
<p>The Jakarta Annotations TCK tests have been run on the following
platforms:</p>
<ul>
<li>Debian Linux 10</li>
</ul>
<p>The Jakarta Annotations TCK tests have been run against the following
Common Annotations for Jakarta EE compatible implementations:</p>
<ul>
<li>Jakarta Annotations for Java Compatible Implementation Version 3.0</li>
</ul>
<hr>
<h2><a name="install_setup_run">Installing, Setting Up, and Running the
Jakarta Annotations TCK</a></h2>
<p>Refer to the <cite>Jakarta Annotations for Jakarta EE TCK 3.0 User's
Guide</cite> for complete instructions on installing, setting up, and
running the Jakarta Annotations TCK.
<hr>
<p><cite><small></small></cite></p>
<address><small> Copyright (c) 2013, 2024 Oracle and/or its affiliates. All
rights reserved. </small></address>
<cite>
<p></p>
</cite>
</body>
</html>
83 changes: 83 additions & 0 deletions annotations/docs/LICENSE_EFTL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Eclipse Foundation Technology Compatibility Kit License - v 1.0

Copyright (c) 2018, Eclipse Foundation, Inc. and its licensors.

Redistribution and use in binary form is permitted provided that the
following conditions are met:

1. Use of the Technology Compatibility Kit accompanying this license
(the "TCK") and its documentation is permitted solely for the
purpose of testing compatibility of an implementation (the
"Product") of a specification (the "Specification") made available
by the Eclipse Foundation, Inc. ("Eclipse").

2. Only those modifications expressly permitted by the TCK and its
documentation are permitted. Except in these limited circumstances,
no modifications to the TCK are permitted under this license.

3. A Product will be deemed to be "compatible" with the Specification
if it fully and completely meets and satisfies all requirements of
the TCK.

4. Before any claim of compatibility (or any similar claim suggesting
compatibility) is made based on the TCK, the testing party must:

a. use the TCK to demonstrate that the Product fully and
completely meets and satisfies all requirements of the TCK;

b. make TCK test results showing full and complete satisfaction of
all requirements of the TCK publicly available on the testing
party's website and send a link to such test results to Eclipse
at [[email protected]](mailto:[email protected]); and

c. comply with any requirements stated in the Specification with
regard to subsetting, supersetting, modifying or extending the
Specification in any Product claimed to be compatible with the
Specification.

5. The test results must be continuously available and the link must
be live for at least as long as the Product is available in the
marketplace.

6. The TCK may not be used as a basis for any statements of partial
compatibility. The TCK may only be used as a basis for true,
factual statements of full compatibility of Products that fully
meet and satisfy all requirements of the TCK.

7. A determination that a Product is compatible with the TCK does not,
in itself, give rise to the right to use any name, mark, logo
associated with the TCK, Eclipse, or Eclipse's contributors or
licensors.

8. Upon the request of Eclipse, a tester will retract any statements
of compatibility (or any similar claim suggesting compatibility)
which Eclipse reasonably determines to be false or misleading or in
violation of the terms of this license.

9. Redistribution of the TCK must be under this Eclipse Foundation
Technology Compatibility Kit License and must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.

10. Neither the name, trademarks or logos of Eclipse, nor the names,
trademarks or logos of its contributors or licensors may be used to
endorse or promote products tested with this software without
specific prior written permission.

11. The source code for the TCK accompanying this license is available
from Eclipse.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, THIS SOFTWARE IS PROVIDED ON
AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER
EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR
CONDITIONS OF TITLE, NON- INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR
A PARTICULAR PURPOSE. TO THE EXTENT PERMITTED BY APPLICABLE LAW,
NEITHER THE COPYRIGHT OWNER OR ANY CONTRIBUTORS SHALL HAVE ANY
LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS),
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
19 changes: 19 additions & 0 deletions annotations/docs/TCK-Exclude-List.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#
# Copyright (c) 2024 Oracle and/or its affiliates. All rights reserved.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License v. 2.0, which is available at
# http://www.eclipse.org/legal/epl-2.0.
#
# This Source Code may also be made available under the following Secondary
# Licenses when the conditions for such availability set forth in the
# Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
# version 2 with the GNU Classpath Exception, which is available at
# https://www.gnu.org/software/classpath/license.html.
#
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
#

# This file lists the excluded tests from Jakarta Annotations TCK.
# This is intended only for documentation purpose and is not used to exclude any tests.
#
56 changes: 56 additions & 0 deletions annotations/docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
<!--
Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved. This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at http://www.eclipse.org/legal/epl-2.0. This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse Public License v. 2.0 are satisfied: GNU General Public License, version 2 with the GNU Classpath Exception, which is available at https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0-->
<title>Welcome to the Jakarta Annotations TCK, Version 2.0</title>
<style type="text/css">
<!--
pre { background-color: #eeeeee; color: #000099}
code { color: #000099}
h1 { color: #000099}
h2 { color: #000099}
h3 { color: #000099; text-decoration: underline}
h4 { font-style: italic; color: #000099}
.tabletitle { font-style: italic; color: #ffffcc; font-size: small; font-variant: small-caps}
.subtitle { font-style: italic; color: #ffffcc; font-variant: small-caps}
.emphasize { font-style: italic; color: #000099}
-->
</style> </head>
<body vlink="#840084" text="#000000" link="#0000ff" bgcolor="#ffffdd" alink="#0000ff">
<div align="Center">
<h1>Welcome to the Jakarta Annotations<br>
Technology Compatibility Kit, Version 3.0<br>
<span class="emphasize">Your Starting Point</span></h1>
</div>
<hr>
<h2>Guide to Jakarta Annotations TCK 3.0 Documentation</h2>
<p>The Jakarta Annotations Technology Compatibility Kit (TCK) 3.0
documentation includes the following:</p>
<ul>
<li> The <em><a href="CAJ3.0-ReleaseNotes.html">Jakarta Annotations 3.0
TCK Release Notes</a></em> provides the information on the test
harness, the test suite and the platforms tested.
<ul>
<li>Release Notes may be revised and distributed by the Jakarta
Annotations specification web-site: <a href="https://jakarta.ee/specifications/annotations/3.0/">https://jakarta.ee/specifications/annotations/3.0/</a></li>
</ul>
</li>
<li>The <em>Jakarta Annotations TCK Users Guide </em> provides the
information that you need to install, set up, and run the Jakarta
Annotations TCK, Version 3.0. In addition, the guide provides the rules
you must comply with to pass the Jakarta Annotations TCK. </li>
</ul>
<hr>
<p><cite><small></small></cite></p>
<address><small> Copyright (c) 2016, 2021 Oracle and/or its affiliates. All
rights reserved. </small></address>
<cite>
<p></p>
</cite>
</body>
</html>
77 changes: 77 additions & 0 deletions annotations/docs/userguide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# A JBake project template

## About JBake

JBake is a static site generator, it's inspired from jekyll and written
in java. The basic idea is to have templates for the structure of the
page, and the body generated from asciidoc content.

## Pre requisites

- Maven
- JDK8+

Deploying to Github will require password less authentication.

This is done by exporting your SSH public key into your Github account.

## Build the site locally

The site is generated under target/staging.

Open file:///PATH_TO_PROJECT_DIR/target/staging in a browser to view the site.

```
mvn generate-resources
```

Or you can invoke the JBake plugin directly.

```
mvn jbake:build
```

### Rebuild the site on changes

```
mvn jbake:watch
```

If you keep this command running, changes to the sources will be
detected and the site will be rendered incrementally.

This is convenient when writing content.

### Serve the site locally

```
mvn jbake:serve
```

If a webserver is required (e.g. absolute path are used), this command
will start a webserver (jetty) at http://localhost:8820. It will also
watch for changes and rebuild incrementally.

## Deploy the site to Github Pages

```
mvn deploy
```

## Produce a zip file for download

To produce a zip file containing the generated html files, use:

```
mvn package
```

When making a release on GitHub, this zip file should be added to the release.

## Links

- [JBake maven plugin documentation](https://github.com/Blazebit/jbake-maven-plugin)
- [JBake documentation](http://jbake.org/docs/2.5.1)
- [Freemarker documentation](http://freemarker.org/docs)
- [AsciiDoc User Guide](http://asciidoc.org/userguide.html)
- [Asciidoctor quick reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference)
Loading

0 comments on commit d5e5665

Please sign in to comment.