diff --git a/.github/workflows/pr-automation.yml b/.github/workflows/pr-automation.yml index e9d66988..53075957 100644 --- a/.github/workflows/pr-automation.yml +++ b/.github/workflows/pr-automation.yml @@ -20,8 +20,6 @@ on: pull_request_target: types: - closed - - unlabeled - - review_requested jobs: pr-automation: diff --git a/maven-plugin-testing-harness/src/site/fml/faq.fml b/maven-plugin-testing-harness/src/site/fml/faq.fml index bcc7712f..d07aa76b 100644 --- a/maven-plugin-testing-harness/src/site/fml/faq.fml +++ b/maven-plugin-testing-harness/src/site/fml/faq.fml @@ -32,7 +32,7 @@ under the License.

This testing library is NOT designed for integration or functional testing: maven-invoker-plugin is the way to go if you need it, - which gives you a complete Maven environment at the cost of more resources and time consuptions. + which gives you a complete Maven environment at the cost of more resources and time consumption.

@@ -41,15 +41,22 @@ under the License.

-
TestCase from JUnit
+
JUnit 5 Extension - @MojoTest annotation
+
The preferred way to test Mojos is to use the JUnit 5 extension provided by the + maven-plugin-testing-harness. You can annotate your test class with @MojoTest + to have the extension set up the necessary Maven components for you. You can then inject your Mojo + and any required Maven components directly into your test class. + See javadocs for examples. +
+
TestCase from JUnit - deprecated
You could use the JUnit framework to test your plugin in the same way you'd write any other JUnit test cases, i.e. by writing a test class which extends TestCase.
-
TestCase from Plexus
-
Mojos are written to take specific advantage of the Plexus - container. If you need Plexus container services, you could write your class which extends PlexusTestCase, +
TestCase from Plexus - deprecated
+
Mojos are written to take specific advantage of the Plexus container. + If you need Plexus container services, you could write your class which extends PlexusTestCase, instead of TestCase.
-
TestCase from Testing Harness
+
TestCase from Testing Harness - deprecated
If you need to inject Maven objects into your mojo, you could use the maven-plugin-testing-harness. The maven-plugin-testing-harness is explicitly intended to test the org.apache.maven.reporting.AbstractMavenReport#execute() implementation.
@@ -57,16 +64,5 @@ under the License.

- - Is Mojo Testing Harness 2.x compatible with Maven 2.x? - -

- Mojo Testing Harness 2.0+ requires Maven 3.0. This does not necessary mean that your mojos will be - incompatible with Maven 2.x, it only means that mojo unit tests use Maven 3.x libraries to mock Maven - environment. Still, if you want to be absolutely sure your mojo is compatible with Maven 2.x, then you probably want - to use Mojo Testing Harness 1.x. -

-
-
diff --git a/maven-plugin-testing-harness/src/site/markdown/index.md b/maven-plugin-testing-harness/src/site/markdown/index.md index 00dddda0..485e7a38 100644 --- a/maven-plugin-testing-harness/src/site/markdown/index.md +++ b/maven-plugin-testing-harness/src/site/markdown/index.md @@ -33,7 +33,6 @@ date: February 2008 The following examples shows how to use the Testing Harness in more advanced use cases: - - [Testing Complex Mojo Parameters](./examples/complex-mojo-parameters.html) - [Testing Multiproject](./examples/multiproject.html) @@ -42,5 +41,6 @@ date: February 2008 - [Testing Project Artifact](./examples/artifact.html) + - [Plugins testing summary](https://maven.apache.org/plugin-developers/plugin-testing.html) diff --git a/maven-plugin-testing-harness/src/site/site.xml b/maven-plugin-testing-harness/src/site/site.xml index 30ffb27e..8c6dc15a 100644 --- a/maven-plugin-testing-harness/src/site/site.xml +++ b/maven-plugin-testing-harness/src/site/site.xml @@ -19,9 +19,8 @@ specific language governing permissions and limitations under the License. --> - - + @@ -38,4 +37,4 @@ under the License. - + diff --git a/src/site/site.xml b/src/site/site.xml index 4c9563d0..741be390 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -19,8 +19,8 @@ specific language governing permissions and limitations under the License. --> - + @@ -32,4 +32,4 @@ under the License. - +