This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch maven-plugin-testing-3.x
in repository https://gitbox.apache.org/repos/asf/maven-plugin-testing.git
The following commit(s) were added to refs/heads/maven-plugin-testing-3.x by
this push:
new 396b92a Convert current documentation to markdown
396b92a is described below
commit 396b92a08b1c9ada9a7dd647400e5c6d5374f728
Author: Slawomir Jaranowski <[email protected]>
AuthorDate: Fri Oct 17 20:52:06 2025 +0200
Convert current documentation to markdown
---
.../src/site/apt/index.apt | 46 ------
.../artifact.apt => markdown/examples/artifact.md} | 86 +++++------
.../examples/complex-mojo-parameters.md} | 101 +++++++------
.../examples/multiproject.md} | 110 +++++++-------
.../examples/repositories.md} | 93 ++++++------
.../getting-started/index.md} | 160 ++++++++++++---------
.../src/site/markdown/index.md | 46 ++++++
src/site/apt/index.apt | 40 ------
src/site/markdown/index.md | 36 +++++
9 files changed, 386 insertions(+), 332 deletions(-)
diff --git a/maven-plugin-testing-harness/src/site/apt/index.apt
b/maven-plugin-testing-harness/src/site/apt/index.apt
deleted file mode 100644
index bbdca2f..0000000
--- a/maven-plugin-testing-harness/src/site/apt/index.apt
+++ /dev/null
@@ -1,46 +0,0 @@
- ------
- Introduction
- ------
- Vincent Siveton
- ------
- February 2008
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-Maven Plugin Testing Harness
-
- The Maven Plugin Testing Harness provides mechanisms to manage tests on
Mojos, i.e. by pre-constructing the
- {{{http://plexus.codehaus.org}Plexus}} components, providing stub objects for
Maven functionality such as projects,
- and populating fields from an XML file that resembles the plugin
configuration in the POM.
-
- The best way to start is to read the cookbook
{{{./getting-started/index.html}How to use Maven Plugin Testing Harness}}.
-
-* Examples
-
- The following examples shows how to use the Testing Harness in more
advanced usecases:
-
- * {{{./examples/complex-mojo-parameters.html}Testing Complex Mojo
Parameters}}
-
- * {{{./examples/multiproject.html}Testing Multiproject}}
-
- * {{{./examples/repositories.html}Testing Using Repositories}}
-
- * {{{./examples/artifact.html}Testing Project Artifact}}
-
- []
diff --git a/maven-plugin-testing-harness/src/site/apt/examples/artifact.apt
b/maven-plugin-testing-harness/src/site/markdown/examples/artifact.md
similarity index 73%
rename from maven-plugin-testing-harness/src/site/apt/examples/artifact.apt
rename to maven-plugin-testing-harness/src/site/markdown/examples/artifact.md
index 8bab33f..c606105 100644
--- a/maven-plugin-testing-harness/src/site/apt/examples/artifact.apt
+++ b/maven-plugin-testing-harness/src/site/markdown/examples/artifact.md
@@ -1,36 +1,34 @@
- ------
- Testing Project Artifact
- ------
- Vincent Siveton
- ------
- February 2008
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-Testing Project Artifact
-
- <<Note>>: This example improves the
{{{../getting-started/index.html}cookbook}} to play with artifact handler.
-
- Sometimes, your Mojo uses project artifact and ArtifactHandler mechanisms.
For instance, you could need to
- filter on Java projects, i.e.:
-
-+---+
+title: Testing Project Artifact
+author: Vincent Siveton
+date: February 2008
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one -->
+<!-- or more contributor license agreements. See the NOTICE file -->
+<!-- distributed with this work for additional information -->
+<!-- regarding copyright ownership. The ASF licenses this file -->
+<!-- to you under the Apache License, Version 2.0 (the -->
+<!-- "License"); you may not use this file except in compliance -->
+<!-- with the License. You may obtain a copy of the License at -->
+<!-- -->
+<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
+<!-- -->
+<!-- Unless required by applicable law or agreed to in writing, -->
+<!-- software distributed under the License is distributed on an -->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!-- KIND, either express or implied. See the License for the -->
+<!-- specific language governing permissions and limitations -->
+<!-- under the License. -->
+## Testing Project Artifact
+
+
+ **Note**: This example improves the [cookbook](../getting-started/index.html)
to play with artifact handler.
+
+
+ Sometimes, your Mojo uses project artifact and ArtifactHandler mechanisms.
For instance, you could need to filter on Java projects, i.e.:
+
+
+
+```
public class MyMojo
extends AbstractMojo
{
@@ -54,11 +52,13 @@ public class MyMojo
...
}
}
-+---+
+```
+
+### Create Stubs
-* Create Stubs
-+---+
+
+```
public class MyArtifactHandlerStub
extends DefaultArtifactHandler
{
@@ -79,9 +79,10 @@ public class MyArtifactHandlerStub
this.language = language;
}
}
-+---+
+```
+
-+---+
+```
public class MyArtifactStub
extends ArtifactStub
{
@@ -189,9 +190,10 @@ public class MyArtifactStub
this.handler = handler;
}
}
-+---+
+```
-+---+
+
+```
public class MyProjectStub
extends MavenProjectStub
{
@@ -212,4 +214,6 @@ public class MyProjectStub
...
}
-+---+
+```
+
+
diff --git
a/maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt
b/maven-plugin-testing-harness/src/site/markdown/examples/complex-mojo-parameters.md
similarity index 69%
rename from
maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt
rename to
maven-plugin-testing-harness/src/site/markdown/examples/complex-mojo-parameters.md
index 29b78a9..a354007 100644
---
a/maven-plugin-testing-harness/src/site/apt/examples/complex-mojo-parameters.apt
+++
b/maven-plugin-testing-harness/src/site/markdown/examples/complex-mojo-parameters.md
@@ -1,38 +1,37 @@
- ------
- Testing Complex Mojo Parameters
- ------
- Vincent Siveton
- ------
- February 2008
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-Testing Complex Mojo Parameters
-
- <<Note>>: This example improves the
{{{../getting-started/index.html}cookbook}} for testing complex Mojo parameters.
-
- In real plugin development, you will use specific Maven objects like
<<<MavenProject>>>, <<<ArtifactRepository>>> or
- <<<MavenSettings>>>. You could use them by defining stubs.
+title: Testing Complex Mojo Parameters
+author: Vincent Siveton
+date: February 2008
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one -->
+<!-- or more contributor license agreements. See the NOTICE file -->
+<!-- distributed with this work for additional information -->
+<!-- regarding copyright ownership. The ASF licenses this file -->
+<!-- to you under the Apache License, Version 2.0 (the -->
+<!-- "License"); you may not use this file except in compliance -->
+<!-- with the License. You may obtain a copy of the License at -->
+<!-- -->
+<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
+<!-- -->
+<!-- Unless required by applicable law or agreed to in writing, -->
+<!-- software distributed under the License is distributed on an -->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!-- KIND, either express or implied. See the License for the -->
+<!-- specific language governing permissions and limitations -->
+<!-- under the License. -->
+## Testing Complex Mojo Parameters
+
+
+ **Note**: This example improves the [cookbook](../getting-started/index.html)
for testing complex Mojo parameters.
+
+
+ In real plugin development, you will use specific Maven objects like
`MavenProject`, `ArtifactRepository` or `MavenSettings`. You could use them by
defining stubs.
+
Suppose that you have the following dependencies in the maven-my-plugin pom:
-+---+
+
+
+```
<project>
...
<dependencies>
@@ -49,11 +48,13 @@ Testing Complex Mojo Parameters
...
</dependencies>
</project>
-+---+
+```
+
+ You will add the following in the `MyMojo`:
+
- You will add the following in the <<<MyMojo>>>:
-+---+
+```
public class MyMojo
extends AbstractMojo
{
@@ -77,14 +78,16 @@ public class MyMojo
...
}
-+---+
+```
-* Create Stubs
+### Create Stubs
- You need to create stub objects to run <<<MyMojoTest#testSomething()>>>. By
convention, the package name should
- reflect the stubs, i.e. in our case <<<org.apache.maven.plugin.my.stubs>>>.
-+---+
+ You need to create stub objects to run `MyMojoTest#testSomething()`. By
convention, the package name should reflect the stubs, i.e. in our case
`org.apache.maven.plugin.my.stubs`.
+
+
+
+```
public class MyProjectStub
extends MavenProjectStub
{
@@ -136,9 +139,10 @@ public class MyProjectStub
return new File( super.getBasedir() +
"/src/test/resources/unit/project-to-test/" );
}
}
-+---+
+```
-+---+
+
+```
public class SettingsStub
extends Settings
{
@@ -148,11 +152,14 @@ public class SettingsStub
return Collections.EMPTY_LIST;
}
}
-+---+
+```
+
-* Configure <<<project-to-test>>> pom
+### Configure `project-to-test` pom
-+---+
+
+
+```
<project>
...
<build>
@@ -174,4 +181,6 @@ public class SettingsStub
</plugins>
</build>
</project>
-+---+
+```
+
+
diff --git
a/maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt
b/maven-plugin-testing-harness/src/site/markdown/examples/multiproject.md
similarity index 52%
rename from maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt
rename to
maven-plugin-testing-harness/src/site/markdown/examples/multiproject.md
index e010348..f158056 100644
--- a/maven-plugin-testing-harness/src/site/apt/examples/multiproject.apt
+++ b/maven-plugin-testing-harness/src/site/markdown/examples/multiproject.md
@@ -1,48 +1,48 @@
- ------
- Testing Multiproject
- ------
- Vincent Siveton
- ------
- February 2008
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-Testing Multiproject
-
- <<Note>>: This example improves the
{{{../getting-started/index.html}cookbook}} for multi-project testing.
-
- Your Mojo should have <<<@aggregator>>> parameter, i.e.:
-
- * with java annotations ({{{/plugin-tools/}maven-plugin-plugin 3.x}}):
-
-+----+
+title: Testing Multiproject
+author: Vincent Siveton
+date: February 2008
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one -->
+<!-- or more contributor license agreements. See the NOTICE file -->
+<!-- distributed with this work for additional information -->
+<!-- regarding copyright ownership. The ASF licenses this file -->
+<!-- to you under the Apache License, Version 2.0 (the -->
+<!-- "License"); you may not use this file except in compliance -->
+<!-- with the License. You may obtain a copy of the License at -->
+<!-- -->
+<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
+<!-- -->
+<!-- Unless required by applicable law or agreed to in writing, -->
+<!-- software distributed under the License is distributed on an -->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!-- KIND, either express or implied. See the License for the -->
+<!-- specific language governing permissions and limitations -->
+<!-- under the License. -->
+## Testing Multiproject
+
+
+ **Note**: This example improves the [cookbook](../getting-started/index.html)
for multi-project testing.
+
+
+ Your Mojo should have `@aggregator` parameter, i.e.:
+
+
+
+ - with java annotations ([maven-plugin-plugin 3.x](/plugin-tools/)):
+
+```
@Mojo( name = "touch", aggregator = true )
public class MyMojo
extends AbstractMojo
{
...
}
-+----+
+```
- * or with javadoc tags:
-+----+
+ - or with javadoc tags:
+
+```
/**
* @goal touch
* @aggregator
@@ -52,17 +52,21 @@ public class MyMojo
{
...
}
-+----+
+```
+
- []
To test a Mojo in a multiproject area, you need to define several stubs, i.e.
for the main test project and its modules.
-* Create Stubs
+
+### Create Stubs
+
Stub for the main test project:
-+----+
+
+
+```
public class MyProjectStub
extends MavenProjectStub
{
@@ -82,11 +86,13 @@ public class MyProjectStub
return this;
}
}
-+----+
+```
Stubs for the subprojects:
-+----+
+
+
+```
public class SubProject1Stub
extends MavenProjectStub
{
@@ -98,9 +104,10 @@ public class SubProject1Stub
...
}
}
-+----+
+```
+
-+----+
+```
public class SubProject2Stub
extends MavenProjectStub
{
@@ -112,11 +119,14 @@ public class SubProject2Stub
...
}
}
-+----+
+```
-* Configure <<<project-to-test>>> pom
-+----+
+### Configure `project-to-test` pom
+
+
+
+```
<project>
...
<build>
@@ -135,4 +145,6 @@ public class SubProject2Stub
</plugins>
</build>
</project>
-+----+
+```
+
+
diff --git
a/maven-plugin-testing-harness/src/site/apt/examples/repositories.apt
b/maven-plugin-testing-harness/src/site/markdown/examples/repositories.md
similarity index 62%
rename from maven-plugin-testing-harness/src/site/apt/examples/repositories.apt
rename to
maven-plugin-testing-harness/src/site/markdown/examples/repositories.md
index 6a86ebc..d1ec4c3 100644
--- a/maven-plugin-testing-harness/src/site/apt/examples/repositories.apt
+++ b/maven-plugin-testing-harness/src/site/markdown/examples/repositories.md
@@ -1,36 +1,34 @@
- ------
- Testing Using Repositories
- ------
- Vincent Siveton
- ------
- February 2008
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-Testing Using Repositories
-
- <<Note>>: This example improves the
{{{../getting-started/index.html}cookbook}} for testing repositories.
-
- When developing a Maven plugin you often need to play with repositories.
Suppose that the MyMojo needs
- to download artifacts into your local repository, i.e.:
-
-+----+
+title: Testing Using Repositories
+author: Vincent Siveton
+date: February 2008
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one -->
+<!-- or more contributor license agreements. See the NOTICE file -->
+<!-- distributed with this work for additional information -->
+<!-- regarding copyright ownership. The ASF licenses this file -->
+<!-- to you under the Apache License, Version 2.0 (the -->
+<!-- "License"); you may not use this file except in compliance -->
+<!-- with the License. You may obtain a copy of the License at -->
+<!-- -->
+<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
+<!-- -->
+<!-- Unless required by applicable law or agreed to in writing, -->
+<!-- software distributed under the License is distributed on an -->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!-- KIND, either express or implied. See the License for the -->
+<!-- specific language governing permissions and limitations -->
+<!-- under the License. -->
+## Testing Using Repositories
+
+
+ **Note**: This example improves the [cookbook](../getting-started/index.html)
for testing repositories.
+
+
+ When developing a Maven plugin you often need to play with repositories.
Suppose that the MyMojo needs to download artifacts into your local repository,
i.e.:
+
+
+
+```
public class MyMojo
extends AbstractMojo
{
@@ -74,13 +72,16 @@ public class MyMojo
...
}
}
-+----+
+```
+
+### Create Stubs
-* Create Stubs
Stub for the test project:
-+----+
+
+
+```
public class MyProjectStub
extends MavenProjectStub
{
@@ -101,11 +102,14 @@ public class MyProjectStub
return Collections.singletonList( repository );
}
}
-+----+
+```
+
+
+### Configure `project-to-test` pom
-* Configure <<<project-to-test>>> pom
-+----+
+
+```
<project>
...
<build>
@@ -126,8 +130,13 @@ public class MyProjectStub
</plugins>
</build>
</project>
-+----+
+```
+
+#### Execute test
+
+
+ Calling `mvn test` will create
`$\{basedir\}/target/local-repo/junitjunit/3.8.1/junit-3.8.1.jar` file.
+
+
-** Execute test
- Calling <<<mvn test>>> will create
<<<$\{basedir\}/target/local-repo/junitjunit/3.8.1/junit-3.8.1.jar>>> file.
diff --git
a/maven-plugin-testing-harness/src/site/apt/getting-started/index.apt
b/maven-plugin-testing-harness/src/site/markdown/getting-started/index.md
similarity index 57%
rename from maven-plugin-testing-harness/src/site/apt/getting-started/index.apt
rename to
maven-plugin-testing-harness/src/site/markdown/getting-started/index.md
index 749611f..73f74ce 100644
--- a/maven-plugin-testing-harness/src/site/apt/getting-started/index.apt
+++ b/maven-plugin-testing-harness/src/site/markdown/getting-started/index.md
@@ -1,48 +1,48 @@
- ------
- How To Use Maven Plugin Testing Harness
- ------
- Vincent Siveton
- ------
- 2008-08-27
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-Cookbook: How To Use Maven Plugin Testing Harness?
-
- This guide is intended as a reference for those developing Maven plugins,
with self-contained references and
- solutions for common testing cases.
-
-* Prerequisites
-
- We assume that you have already created a plugin. In this cookbook, we make
reference to <<<MyMojo>>> in
- <<<maven-my-plugin>>> which is generated by the Maven Archetype Plugin, i.e.:
-
-+---+
+title: How To Use Maven Plugin Testing Harness
+author: Vincent Siveton
+date: 2008-08-27
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one -->
+<!-- or more contributor license agreements. See the NOTICE file -->
+<!-- distributed with this work for additional information -->
+<!-- regarding copyright ownership. The ASF licenses this file -->
+<!-- to you under the Apache License, Version 2.0 (the -->
+<!-- "License"); you may not use this file except in compliance -->
+<!-- with the License. You may obtain a copy of the License at -->
+<!-- -->
+<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
+<!-- -->
+<!-- Unless required by applicable law or agreed to in writing, -->
+<!-- software distributed under the License is distributed on an -->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!-- KIND, either express or implied. See the License for the -->
+<!-- specific language governing permissions and limitations -->
+<!-- under the License. -->
+## Cookbook: How To Use Maven Plugin Testing Harness?
+
+
+ This guide is intended as a reference for those developing Maven plugins,
with self-contained references and solutions for common testing cases.
+
+
+### Prerequisites
+
+
+ We assume that you have already created a plugin. In this cookbook, we make
reference to `MyMojo` in `maven-my-plugin` which is generated by the Maven
Archetype Plugin, i.e.:
+
+
+
+```
mvn archetype:create \
-DgroupId=org.apache.maven.plugin.my \
-DartifactId=maven-my-plugin \
-DarchetypeArtifactId=maven-archetype-mojo
-+---+
+```
The generated structure should be:
-+---+
+
+
+```
maven-my-plugin
|- pom.xml
+- src/
@@ -54,15 +54,20 @@ maven-my-plugin
+- plugin/
+- my/
|- MyMojo.java
-+---+
+```
+
+
+### Recipe
+
-* Recipe
+#### Add `maven-plugin-testing-harness` dependency
-** Add <<<maven-plugin-testing-harness>>> dependency
- As usual, just add <<<maven-plugin-testing-harness>>> as following in your
pom. Be sure to specify <<<test>>> scope.
+ As usual, just add `maven-plugin-testing-harness` as following in your pom.
Be sure to specify `test` scope.
-+---+
+
+
+```
<project>
...
<dependencies>
@@ -75,14 +80,17 @@ maven-my-plugin
</dependencies>
...
</project>
-+---+
+```
+
+
+#### Create a `MyMojoTest`
+
-** Create a <<<MyMojoTest>>>
+ Create a `MyMojoTest` (by convention) class in
`src/test/java/org/apache/maven/plugin/my` directory. This class should extend
`AbstractMojoTestCase` from `maven-plugin-testing-harness`.
- Create a <<<MyMojoTest>>> (by convention) class in
<<<src/test/java/org/apache/maven/plugin/my>>> directory.
- This class should extend <<<AbstractMojoTestCase>>> from
<<<maven-plugin-testing-harness>>>.
-+---+
+
+```
import org.apache.maven.plugin.testing.AbstractMojoTestCase;
public class MyMojoTest
@@ -125,19 +133,22 @@ public class MyMojoTest
...
}
}
-+---+
+```
+
+ In this case, `testSomething()` will test `MyMojo` against a Maven project
called `project-to-test`.
+
+
+ **Note**: By convention, projects for unit testing your should be in the test
resources directory.
+
- In this case, <<<testSomething()>>> will test <<<MyMojo>>> against a Maven
project called <<<project-to-test>>>.
+ Alternatively to extending `AbstractMojoTestCase` and when using Junit-4.10
ff., you may use a `MojoRule`, which just embeds an `AbstractMojoTestCase`.
- <<Note>>: By convention, projects for unit testing your should be in the
test resources directory.
- Alternatively to extending <<<AbstractMojoTestCase>>> and when using
Junit-4.10 ff., you may use a <<<MojoRule>>>,
- which just embeds an <<<AbstractMojoTestCase>>>.
+ When you do not need the functionality in every test method, you may use the
`@WithoutMojo` annotation to skip rule executions.
- When you do not need the functionality in every test method, you may use the
<<<@WithoutMojo>>> annotation to
- skip rule executions.
-+---+
+
+```
import org.apache.maven.plugin.testing.MojoRule;
import org.apache.maven.plugin.testing.WithoutMojo;
@@ -191,13 +202,17 @@ public class MyMojoTest
}
-+---+
+```
+
+
+#### Configuring `project-to-test` pom
+
+
+ Just create a pom as usual. The names for groupId and artifactId don't really
matter since this project will not be deployed.
-** Configuring <<<project-to-test>>> pom
- Just create a pom as usual. The names for groupId and artifactId don't
really matter since this project will not be deployed.
-+---+
+```
<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
@@ -230,20 +245,29 @@ public class MyMojoTest
</plugins>
</build>
</project>
-+---+
+```
+
+
+#### Execute test
-** Execute test
As usual, just call:
-+---+
+
+
+```
mvn test
-+---+
+```
+
+
+
+### Resources
+
+
+
+ 1 [Guide to Developing Java
Plugins](http://maven.apache.org/guides/plugin/guide-java-plugin-development.html)
-* Resources
+ 1 [Guide to Configuring
Plugins](http://maven.apache.org/guides/mini/guide-configuring-plugins.html)
- [[1]]
{{{http://maven.apache.org/guides/plugin/guide-java-plugin-development.html}Guide
to Developing Java Plugins}}
- [[2]]
{{{http://maven.apache.org/guides/mini/guide-configuring-plugins.html}Guide to
Configuring Plugins}}
- []
diff --git a/maven-plugin-testing-harness/src/site/markdown/index.md
b/maven-plugin-testing-harness/src/site/markdown/index.md
new file mode 100644
index 0000000..b3c9461
--- /dev/null
+++ b/maven-plugin-testing-harness/src/site/markdown/index.md
@@ -0,0 +1,46 @@
+title: Introduction
+author: Vincent Siveton
+date: February 2008
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one -->
+<!-- or more contributor license agreements. See the NOTICE file -->
+<!-- distributed with this work for additional information -->
+<!-- regarding copyright ownership. The ASF licenses this file -->
+<!-- to you under the Apache License, Version 2.0 (the -->
+<!-- "License"); you may not use this file except in compliance -->
+<!-- with the License. You may obtain a copy of the License at -->
+<!-- -->
+<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
+<!-- -->
+<!-- Unless required by applicable law or agreed to in writing, -->
+<!-- software distributed under the License is distributed on an -->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!-- KIND, either express or implied. See the License for the -->
+<!-- specific language governing permissions and limitations -->
+<!-- under the License. -->
+## Maven Plugin Testing Harness
+
+
+ The Maven Plugin Testing Harness provides mechanisms to manage tests on
Mojos, i.e. by pre-constructing the [Plexus](http://plexus.codehaus.org)
components, providing stub objects for Maven functionality such as projects,
and populating fields from an XML file that resembles the plugin configuration
in the POM.
+
+
+ The best way to start is to read the cookbook [How to use Maven Plugin
Testing Harness](./getting-started/index.html).
+
+
+### Examples
+
+
+ The following examples shows how to use the Testing Harness in more advanced
usecases:
+
+
+
+ - [Testing Complex Mojo Parameters](./examples/complex-mojo-parameters.html)
+
+ - [Testing Multiproject](./examples/multiproject.html)
+
+ - [Testing Using Repositories](./examples/repositories.html)
+
+ - [Testing Project Artifact](./examples/artifact.html)
+
+
+
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
deleted file mode 100644
index 7075194..0000000
--- a/src/site/apt/index.apt
+++ /dev/null
@@ -1,40 +0,0 @@
- ------
- Introduction
- ------
- Vincent Siveton
- ------
- 2008-07-15
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-Maven Plugin Testing
-
- The Maven Plugin Testing Modules contains the necessary tools to be able to
test Maven Plugins.
-
-* Matrix Comparison
-
-*-----------------------------------------------------------------------------+---------------------------------------------------------+
-|| <<Testing Module for Maven Plugins>>
|| <<Overview>>
-*-----------------------------------------------------------------------------+---------------------------------------------------------+
-| {{{./maven-plugin-testing-harness/index.html}maven-plugin-testing-harness}}
| Framework to test Maven Plugins with Maven Mock projects.
-*-----------------------------------------------------------------------------+---------------------------------------------------------+
-
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
new file mode 100644
index 0000000..ddf2db2
--- /dev/null
+++ b/src/site/markdown/index.md
@@ -0,0 +1,36 @@
+title: Introduction
+author: Vincent Siveton
+date: 2008-07-15
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one -->
+<!-- or more contributor license agreements. See the NOTICE file -->
+<!-- distributed with this work for additional information -->
+<!-- regarding copyright ownership. The ASF licenses this file -->
+<!-- to you under the Apache License, Version 2.0 (the -->
+<!-- "License"); you may not use this file except in compliance -->
+<!-- with the License. You may obtain a copy of the License at -->
+<!-- -->
+<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
+<!-- -->
+<!-- Unless required by applicable law or agreed to in writing, -->
+<!-- software distributed under the License is distributed on an -->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!-- KIND, either express or implied. See the License for the -->
+<!-- specific language governing permissions and limitations -->
+<!-- under the License. -->
+<!-- NOTE: For help with the syntax of this file, see: -->
+<!-- http://maven.apache.org/doxia/references/apt-format.html -->
+## Maven Plugin Testing
+
+
+ The Maven Plugin Testing Modules contains the necessary tools to be able to
test Maven Plugins.
+
+
+### Matrix Comparison
+
+
+|**Testing Module for Maven Plugins**|**Overview**|
+|---|---|
+|[maven-plugin-testing-harness](./maven-plugin-testing-harness/index.html)|Framework
to test Maven Plugins with Maven Mock projects.|
+
+
