Revise module declarations of "org.junit.platform" group

Issue #2063
junit-team · Dec 20, 2019 · f805ed8 · f805ed8
1 parent e3b2dc1
commit f805ed8
Show file tree

Hide file tree

Showing 12 changed files with 73 additions and 13 deletions.
diff --git a/junit-platform-commons/src/module/org.junit.platform.commons/module-info.java b/junit-platform-commons/src/module/org.junit.platform.commons/module-info.java
@@ -8,6 +8,12 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+/**
+ * Common APIs and support utilities for the JUnit Platform.
+ *
+ * @moduleGraph
+ * @since 1.0.0
+ */
 module org.junit.platform.commons {
 	requires java.logging;
 	requires java.management; // needed by RuntimeUtils to determine input arguments

diff --git a/junit-platform-console/src/module/org.junit.platform.console/module-info.java b/junit-platform-console/src/module/org.junit.platform.console/module-info.java
@@ -8,9 +8,18 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+/**
+ * Support for launching the JUnit Platform from the console.
+ *
+ * @moduleGraph
+ * @since 1.0.0
+ */
 module org.junit.platform.console {
-	requires transitive org.apiguardian.api;
-	requires transitive org.junit.platform.reporting;
+	requires org.apiguardian.api;
+	requires org.junit.platform.commons;
+	requires org.junit.platform.engine;
+	requires org.junit.platform.launcher;
+	requires org.junit.platform.reporting;
 
 	provides java.util.spi.ToolProvider with org.junit.platform.console.ConsoleLauncherToolProvider;
 }
diff --git a/junit-platform-engine/src/module/org.junit.platform.engine/module-info.java b/junit-platform-engine/src/module/org.junit.platform.engine/module-info.java
@@ -8,6 +8,15 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+/**
+ * Public API for test engines.
+ *
+ * <p>Provides the {@linkplain org.junit.platform.engine.TestEngine} interface, test discovery
+ * and execution reporting support.
+ *
+ * @moduleGraph
+ * @since 1.0.0
+ */
 module org.junit.platform.engine {
 	requires transitive org.apiguardian.api;
 	requires transitive org.junit.platform.commons;
@@ -20,5 +29,6 @@
 	exports org.junit.platform.engine.support.config;
 	exports org.junit.platform.engine.support.descriptor;
 	exports org.junit.platform.engine.support.discovery;
+	exports org.junit.platform.engine.support.filter;
 	exports org.junit.platform.engine.support.hierarchical;
 }
diff --git a/junit-platform-launcher/src/module/org.junit.platform.launcher/module-info.java b/junit-platform-launcher/src/module/org.junit.platform.launcher/module-info.java
@@ -8,9 +8,18 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+/**
+ * Public API for configuring and launching test plans.
+ *
+ * <p>This API is typically used by IDEs and build tools.
+ *
+ * @moduleGraph
+ * @since 1.0.0
+ */
 module org.junit.platform.launcher {
-	requires java.logging;
+	requires transitive java.logging;
 	requires transitive org.apiguardian.api;
+	requires transitive org.junit.platform.commons;
 	requires transitive org.junit.platform.engine;
 
 	exports org.junit.platform.launcher;

diff --git a/junit-platform-reporting/src/module/org.junit.platform.reporting/module-info.java b/junit-platform-reporting/src/module/org.junit.platform.reporting/module-info.java
@@ -8,9 +8,17 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+/**
+ * Defines the JUnit Platform Reporting API.
+ *
+ * @moduleGraph
+ * @since 1.4.0
+ */
 module org.junit.platform.reporting {
 	requires java.xml;
 	requires transitive org.apiguardian.api;
+	requires org.junit.platform.commons;
+	requires transitive org.junit.platform.engine;
 	requires transitive org.junit.platform.launcher;
 
 	// exports org.junit.platform.reporting; empty package

diff --git a/junit-platform-suite-api/src/module/org.junit.platform.suite.api/module-info.java b/junit-platform-suite-api/src/module/org.junit.platform.suite.api/module-info.java
@@ -8,6 +8,12 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+/**
+ * Annotations for configuring a test suite on the JUnit Platform.
+ *
+ * @moduleGraph
+ * @since 1.0.0
+ */
 module org.junit.platform.suite.api {
 	requires transitive org.apiguardian.api;
 

diff --git a/junit-platform-testkit/src/module/org.junit.platform.testkit/module-info.java b/junit-platform-testkit/src/module/org.junit.platform.testkit/module-info.java
@@ -9,14 +9,18 @@
  * https://www.eclipse.org/legal/epl-v20.html
  */
 
+/**
+ * Defines the Test Kit API for the JUnit Platform.
+ *
+ * @moduleGraph
+ * @since 1.4.0
+ */
 module org.junit.platform.testkit {
-	// missing "requires java.instrument" in "org.assertj.core" module
-	// https://github.com/joel-costigliola/assertj-core/issues/1504
-	requires java.instrument;
-
 	requires transitive org.apiguardian.api;
 	requires transitive org.assertj.core;
-	requires transitive org.junit.platform.launcher;
+	requires org.junit.platform.commons;
+	requires transitive org.junit.platform.engine;
+	requires org.junit.platform.launcher;
 	requires transitive org.opentest4j;
 
 	// exports org.junit.platform.testkit; empty package

diff --git a/...rm-tooling-support-tests/projects/jar-describe-module/junit-platform-console.expected.txt b/...rm-tooling-support-tests/projects/jar-describe-module/junit-platform-console.expected.txt
@@ -1,7 +1,10 @@
 org.junit.platform.console@${platformVersion} jar:file:.+junit-platform-console/build/libs/junit-platform-console-${platformVersion}.jar/!module-info.class
 requires java.base mandated
-requires org.apiguardian.api transitive
-requires org.junit.platform.reporting transitive
+requires org.apiguardian.api
+requires org.junit.platform.commons
+requires org.junit.platform.engine
+requires org.junit.platform.launcher
+requires org.junit.platform.reporting
 provides java.util.spi.ToolProvider with org.junit.platform.console.ConsoleLauncherToolProvider
 contains org.junit.platform.console
 contains org.junit.platform.console.options

diff --git a/...orm-tooling-support-tests/projects/jar-describe-module/junit-platform-engine.expected.txt b/...orm-tooling-support-tests/projects/jar-describe-module/junit-platform-engine.expected.txt
@@ -5,6 +5,7 @@ exports org.junit.platform.engine.reporting
 exports org.junit.platform.engine.support.config
 exports org.junit.platform.engine.support.descriptor
 exports org.junit.platform.engine.support.discovery
+exports org.junit.platform.engine.support.filter
 exports org.junit.platform.engine.support.hierarchical
 requires java.base mandated
 requires org.apiguardian.api transitive

diff --git a/...m-tooling-support-tests/projects/jar-describe-module/junit-platform-launcher.expected.txt b/...m-tooling-support-tests/projects/jar-describe-module/junit-platform-launcher.expected.txt
@@ -4,8 +4,9 @@ exports org.junit.platform.launcher.core
 exports org.junit.platform.launcher.listeners
 exports org.junit.platform.launcher.listeners.discovery
 requires java.base mandated
-requires java.logging
+requires java.logging transitive
 requires org.apiguardian.api transitive
+requires org.junit.platform.commons transitive
 requires org.junit.platform.engine transitive
 uses org.junit.platform.engine.TestEngine
 uses org.junit.platform.launcher.TestExecutionListener
diff --git a/...-tooling-support-tests/projects/jar-describe-module/junit-platform-reporting.expected.txt b/...-tooling-support-tests/projects/jar-describe-module/junit-platform-reporting.expected.txt
@@ -3,4 +3,6 @@ exports org.junit.platform.reporting.legacy.xml
 requires java.base mandated
 requires java.xml
 requires org.apiguardian.api transitive
+requires org.junit.platform.commons
+requires org.junit.platform.engine transitive
 requires org.junit.platform.launcher transitive
diff --git a/...rm-tooling-support-tests/projects/jar-describe-module/junit-platform-testkit.expected.txt b/...rm-tooling-support-tests/projects/jar-describe-module/junit-platform-testkit.expected.txt
@@ -1,9 +1,10 @@
 org.junit.platform.testkit@${platformVersion} jar:file:.+junit-platform-testkit/build/libs/junit-platform-testkit-${platformVersion}.jar/!module-info.class
 exports org.junit.platform.testkit.engine
 requires java.base mandated
-requires java.instrument
 requires org.apiguardian.api transitive
 requires org.assertj.core transitive
-requires org.junit.platform.launcher transitive
+requires org.junit.platform.commons
+requires org.junit.platform.engine transitive
+requires org.junit.platform.launcher
 requires org.opentest4j transitive
 uses org.junit.platform.engine.TestEngine