Skip to content

Commit

Permalink
Swap full > platform
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleAure committed May 23, 2024
1 parent 28debff commit c0d5b15
Show file tree
Hide file tree
Showing 13 changed files with 28 additions and 28 deletions.
6 changes: 3 additions & 3 deletions tck-dist/src/main/asciidoc/sections/01preface.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ When running in EE mode the {APILongName} TCK acts as a `Test Client` that will
The Platform Server will act as a `Test Server` and run tests based on incoming requests from the `Test Client`.
Assertions will occur both on the client and server sides.

=== Terminology - "Core Profile" vs "Web Profile" vs "Full Profile"
=== Terminology - "Core Profile" vs "Web Profile" vs "Platform"

The Jakarta EE platform defines sets of specifications that create the core, web, and full profiles.
The Jakarta EE working group defines sets of specifications that create the core profile, web profile, and platform.
// TODO update this if Jakarta Data ends up being in something other than core profile
The {APILongName} TCK can run against each of these profiles since {APILongName} is a Core Profile specification.

References:

* Core profile: https://jakarta.ee/specifications/coreprofile/
* Web profile: https://jakarta.ee/specifications/webprofile/
* Full profile: https://jakarta.ee/specifications/platform/
* Platform: https://jakarta.ee/specifications/platform/

=== Before You Read This Guide

Expand Down
2 changes: 1 addition & 1 deletion tck-dist/src/main/asciidoc/sections/05inventory.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The {APILongName} TCK is a test library that includes four types of packages:
- `ee.jakarta.tck.data.standalone.\*` these are basic API tests, or SPI tests that can run in SE Mode or EE mode.
- `ee.jakarta.tck.data.core.\*` these are more complex integration tests that must run against at least Core Profile.
- `ee.jakarta.tck.data.web.\*` these are more complex integration tests that must run against at least Web Profile.
- `ee.jakarta.tck.data.full.\*` these are more complex integration tests that must run against at least Full Profile.
- `ee.jakarta.tck.data.platform.\*` these are more complex integration tests that must run against at least Platform.
- `ee.jakarta.tck.data.framework.\*` these are utility packages that help support the development and execution of the TCK.

Tests that exist at a lower level will run on any level above, for example, all core profile tests will run against web profile.
Expand Down
2 changes: 1 addition & 1 deletion tck-dist/src/main/asciidoc/sections/07.1se-mode.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ include::{starterLoc}/se-pom.xml[tags=configJunit5;!logging;!signature;!entity]
All test classes that support running in standalone mode are annotated with the `@Standalone` annotation.

When running in standalone mode, include the group `<groups>standalone<groups>`.
This will ensure that none of the core/web/full profile tests are run.
This will ensure that none of the core/web/platform profile tests are run.

When running in standalone mode, include the system property `<jakarta.tck.skip.deployment>true</jakarta.tck.skip.deployment>`.
This will ensure that no Arquillian deployments are created and that all tests are run on the client JVM.
Expand Down
2 changes: 1 addition & 1 deletion tck-dist/src/main/asciidoc/sections/07.2ee-mode.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ include::{starterLoc}/ee-pom.xml[tags=configJunit5;!arquillian;!logging;!entity]

==== Profile Mode

All test classes that require running on a Jakarta profile are annotated with the `@Core`, `@Web`, or `@Full` annotation.
All test classes that require running on a Jakarta profile are annotated with the `@Core`, `@Web`, or `@Platform` annotation.

When running against a Jakarta profile, include the group that matches your supported profile. For example: `<groups>core<groups>`.

Expand Down
2 changes: 1 addition & 1 deletion tck-dist/src/main/asciidoc/sections/09running.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ $ mvn clean test

=== Expected Output

Here is example output when successfully running (full profile + persistence entity) the starter project:
Here is example output when successfully running (platform + persistence entity) the starter project:

include::generated/expected-output.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -300,11 +300,11 @@ private static void writeTestCounts(List<TestMetaData> testMetaData, File output
String output =
"""
|===
|entity type |standalone |core |web |full |skipped
|entity type |standalone |core |web |platform |skipped
|persistence |%d |%d |%d |%d |%d
|persistence |%d |%d |%d |%d |%d
|nosql |%d |%d |%d |%d |%d
|nosql |%d |%d |%d |%d |%d
|===""".formatted(getTestCounts(testMetaData));
try (BufferedWriter writer = new BufferedWriter(new FileWriter(outputLocation))) {
Expand All @@ -318,22 +318,22 @@ private static Object[] getTestCounts(List<TestMetaData> testMetaData) {
List<TestMetaData> standalone = runnableTestMetaData.stream().filter(TestMetaData::isStandalone).collect(Collectors.toList());
List<TestMetaData> core = runnableTestMetaData.stream().filter(TestMetaData::isCore).collect(Collectors.toList());
List<TestMetaData> web = runnableTestMetaData.stream().filter(TestMetaData::isWeb).collect(Collectors.toList());
List<TestMetaData> full = runnableTestMetaData.stream().filter(TestMetaData::isFull).collect(Collectors.toList());
List<TestMetaData> platform = runnableTestMetaData.stream().filter(TestMetaData::isPlatform).collect(Collectors.toList());

List<Object> results = new ArrayList<>();

//Persistence
results.add(standalone.stream().filter(TestMetaData::isPersistence).count());
results.add(core.stream().filter(TestMetaData::isPersistence).count());
results.add(web.stream().filter(TestMetaData::isPersistence).count());
results.add(full.stream().filter(TestMetaData::isPersistence).count());
results.add(platform.stream().filter(TestMetaData::isPersistence).count());
results.add(testMetaData.stream().filter(Predicate.not(TestMetaData::isRunnable)).filter(TestMetaData::isPersistence).count());

//NoSQL
results.add(standalone.stream().filter(TestMetaData::isNoSQL).count());
results.add(core.stream().filter(TestMetaData::isNoSQL).count());
results.add(web.stream().filter(TestMetaData::isNoSQL).count());
results.add(full.stream().filter(TestMetaData::isNoSQL).count());
results.add(platform.stream().filter(TestMetaData::isNoSQL).count());
results.add(testMetaData.stream().filter(Predicate.not(TestMetaData::isRunnable)).filter(TestMetaData::isNoSQL).count());

return results.toArray();
Expand Down Expand Up @@ -503,8 +503,8 @@ boolean isWeb() {
return tags.contains("web");
}

boolean isFull() {
return tags.contains("full");
boolean isPlatform() {
return tags.contains("platform");
}

boolean isPersistence() {
Expand Down
2 changes: 1 addition & 1 deletion tck-dist/src/main/starter/ee-pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@
</systemPropertyVariables>
<!-- end::systemProperties[] -->
<!-- Supported tags
Profiles:[core|web|full]
Profiles:[core|web|platform]
Entities:[nosql|persistence]
Other: [signature] -->
<groups>[TODO]</groups>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.jboss.shrinkwrap.api.container.ResourceContainer;
import org.jboss.shrinkwrap.resolver.api.maven.Maven;

import ee.jakarta.tck.data.framework.junit.anno.Full;
import ee.jakarta.tck.data.framework.junit.anno.Platform;
import ee.jakarta.tck.data.framework.junit.anno.Signature;
import ee.jakarta.tck.data.framework.junit.anno.Web;
import ee.jakarta.tck.data.framework.junit.anno.ReadOnlyTest;
Expand All @@ -42,7 +42,7 @@
*
* <p>The read-only tests require the ee.jakarta.tck.data.framework.read.only package in the container.</p>
*
* <p>The web/full profile tests require the ee.jakarta.tck.data.framework.servlet package in the container.</p>
* <p>The web/platform profile tests require the ee.jakarta.tck.data.framework.servlet package in the container.</p>
*
* <p>The signature tests require the ee.jakarta.tck.data.framework.signature package in the container.</p>
*/
Expand All @@ -67,8 +67,8 @@ public void process(Archive<?> applicationArchive, TestClass testClass) {
((ClassContainer<?>) applicationArchive).addPackage(readOnlyPackage);
}

// Add servlet packages to web/full profile tests
if(testClass.isAnnotationPresent(Web.class) || testClass.isAnnotationPresent(Full.class)) {
// Add servlet packages to web/platform profile tests
if(testClass.isAnnotationPresent(Web.class) || testClass.isAnnotationPresent(Platform.class)) {
log.info("Application Archive [" + applicationName + "] is being appended with packages [" + servletPackage +"]");
((ClassContainer<?>) applicationArchive).addPackage(servletPackage);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
@Retention(RetentionPolicy.RUNTIME)
@Tag("core")
@Tag("web")
@Tag("full")
@Tag("platform")
@ExtendWith({ ArquillianExtension.class, AssertionExtension.class })
public @interface Core {
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import ee.jakarta.tck.data.framework.junit.extensions.AssertionExtension;

/**
* <p>These are test classes that REQUIRE full profile to be executed. For these
* <p>These are test classes that REQUIRE platform profile to be executed. For these
* tests to run they must deploy an application to a Jakarta EE server using the
* Arquillian {@code @Deployment} annotation.</p>
*
Expand All @@ -36,7 +36,7 @@
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Tag("full")
@Tag("platform")
@ExtendWith({ ArquillianExtension.class, AssertionExtension.class })
public @interface Full {
public @interface Platform {
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
/**
* <p>These are test classes that DO NOT depend on any Jakarta EE profile technologies.</p>
*
* <p>However, when running the TCK against a core/web/full profile container these
* <p>However, when running the TCK against a core/web/platform profile container these
* tests will be deployed and run on the container.</p>
*
* <p>The dynamic method in which we achieve the ability to run these tests either
Expand All @@ -45,7 +45,7 @@
@Tag("standalone")
@Tag("core")
@Tag("web")
@Tag("full")
@Tag("platform")
@ExtendWith({ StandaloneExtension.class, AssertionExtension.class })
public @interface Standalone {
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Tag("web")
@Tag("full")
@Tag("platform")
@ExtendWith({ ArquillianExtension.class, AssertionExtension.class })
public @interface Web {
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* <p>This is a Junit5 extension class that extends ArquillianExtension</p>
*
* <p>This extension will passthrough to the ArquillianExtension class when running
* against a Jakarta EE core/web/full profiles, but will skip Arquillian
* against a Jakarta EE core/web/platform profiles, but will skip Arquillian
* processing when running against a standalone implementation.</p>
*
* @see org.jboss.arquillian.junit5.ArquillianExtension
Expand Down

0 comments on commit c0d5b15

Please sign in to comment.