branch develop updated (3e93d17 -> 92e789d)
This is an automated email from the git hooks/post-receive script. New change to branch develop in repository maven-helper-plugin. See http://git.nuiton.org/maven-helper-plugin.git from 3e93d17 fixes #3702: Use maven 3 API fixes #3703: Split mojo Api in two modules (one with Api and one with test Api) Merge branch 'feature/3702' into develop new 92e789d fix documentation and javadoc (refs #3703) The 1 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "adds" were already present in the repository and have only been added to this reference. Detailed log of new commits: commit 92e789d4e82a3fb1e9ce29d38e01f3b6db4dd6a1 Author: Tony CHEMIT <chemit@codelutin.com> Date: Mon May 25 16:25:07 2015 +0200 fix documentation and javadoc (refs #3703) Summary of changes: helper-maven-plugin-api/pom.xml | 17 ++---- helper-maven-plugin-api/src/site/apt/index.apt | 13 +---- .../java/org/nuiton/plugin/PluginHelperTest.java | 2 - helper-maven-plugin-test-api/pom.xml | 61 ++-------------------- .../src/site/apt/index.apt | 2 +- .../src/site/apt/mojo-testFramework.apt | 43 +++++++-------- helper-maven-plugin/pom.xml | 11 ---- pom.xml | 9 ++-- src/site/apt/index.apt | 18 ++++++- 9 files changed, 50 insertions(+), 126 deletions(-) -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository maven-helper-plugin. See http://git.nuiton.org/maven-helper-plugin.git commit 92e789d4e82a3fb1e9ce29d38e01f3b6db4dd6a1 Author: Tony CHEMIT <chemit@codelutin.com> Date: Mon May 25 16:25:07 2015 +0200 fix documentation and javadoc (refs #3703) --- helper-maven-plugin-api/pom.xml | 17 ++---- helper-maven-plugin-api/src/site/apt/index.apt | 13 +---- .../java/org/nuiton/plugin/PluginHelperTest.java | 2 - helper-maven-plugin-test-api/pom.xml | 61 ++-------------------- .../src/site/apt/index.apt | 2 +- .../src/site/apt/mojo-testFramework.apt | 43 +++++++-------- helper-maven-plugin/pom.xml | 11 ---- pom.xml | 9 ++-- src/site/apt/index.apt | 18 ++++++- 9 files changed, 50 insertions(+), 126 deletions(-) diff --git a/helper-maven-plugin-api/pom.xml b/helper-maven-plugin-api/pom.xml index e6544b6..2896558 100644 --- a/helper-maven-plugin-api/pom.xml +++ b/helper-maven-plugin-api/pom.xml @@ -31,13 +31,11 @@ </parent> <artifactId>helper-maven-plugin-api</artifactId> - <name>Helper Maven Plugin :: API</name> + <name>Helper Maven Plugin :: Api</name> <description>Simple maven mojo api for our projects</description> <properties> - <plexusMailSenderVersion>1.0-alpha-2</plexusMailSenderVersion> - <!-- extra files to include in release --> <redmine.releaseFiles>${redmine.libReleaseFiles}</redmine.releaseFiles> @@ -69,11 +67,6 @@ <!-- provided dependencies --> - <!--dependency> - <groupId>org.codehaus.plexus</groupId> - <artifactId>plexus-container-default</artifactId> - </dependency--> - <dependency> <groupId>org.apache.maven</groupId> <artifactId>maven-core</artifactId> @@ -104,6 +97,8 @@ <scope>provided</scope> </dependency> + <!-- tests dependencies --> + <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> @@ -149,12 +144,6 @@ <plugins> <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>cobertura-maven-plugin</artifactId> - <version>${coberturaPluginVersion}</version> - </plugin> - - <plugin> <artifactId>maven-javadoc-plugin</artifactId> <version>${javadocPluginVersion}</version> <configuration> diff --git a/helper-maven-plugin-api/src/site/apt/index.apt b/helper-maven-plugin-api/src/site/apt/index.apt index 340fdb4..cfa75d3 100644 --- a/helper-maven-plugin-api/src/site/apt/index.apt +++ b/helper-maven-plugin-api/src/site/apt/index.apt @@ -31,21 +31,10 @@ Maven helper Plugin API This project helps to build maven projects. - This modules offers two things: - - * The plugin api : a very small framework to create new plugins (see {Plugin toolkit overview}) - - * The test toolkit : usefull classes to make new tests (see {Test toolkit overview}) + This module offers a plugin api : a very small framework to create new plugins (see {Plugin toolkit overview}) Plugin toolkit overview see the {{{./mojo-framework.html}Mojo framework}} page. see {{{./apidocs/index.html}javadoc}}. - - -Test toolkit overview - - see the {{{./mojo-testFramework.html}Mojo test framework}} page. - - see {{{./testapidocs/index.html}test-javadoc}}. diff --git a/helper-maven-plugin-api/src/test/java/org/nuiton/plugin/PluginHelperTest.java b/helper-maven-plugin-api/src/test/java/org/nuiton/plugin/PluginHelperTest.java index b746d83..5c89381 100644 --- a/helper-maven-plugin-api/src/test/java/org/nuiton/plugin/PluginHelperTest.java +++ b/helper-maven-plugin-api/src/test/java/org/nuiton/plugin/PluginHelperTest.java @@ -32,8 +32,6 @@ import java.net.URISyntaxException; import java.net.URL; /** - * Tests the {@link PluginHelper} class. - * * @author tchemit - chemit@codelutin.com * @since 1.2.3 */ diff --git a/helper-maven-plugin-test-api/pom.xml b/helper-maven-plugin-test-api/pom.xml index e6228e2..2112d71 100644 --- a/helper-maven-plugin-test-api/pom.xml +++ b/helper-maven-plugin-test-api/pom.xml @@ -36,8 +36,6 @@ <properties> - <plexusMailSenderVersion>1.0-alpha-2</plexusMailSenderVersion> - <!-- extra files to include in release --> <redmine.releaseFiles>${redmine.libReleaseFiles}</redmine.releaseFiles> @@ -60,10 +58,10 @@ <!-- provided dependencies --> - <dependency> - <groupId>org.codehaus.plexus</groupId> - <artifactId>plexus-container-default</artifactId> - </dependency> + <!--<dependency>--> + <!--<groupId>org.codehaus.plexus</groupId>--> + <!--<artifactId>plexus-container-default</artifactId>--> + <!--</dependency>--> <dependency> <groupId>org.apache.maven</groupId> @@ -107,8 +105,6 @@ <scope>provided</scope> </dependency> - <!-- tests dependencies --> - <dependency> <groupId>org.apache.maven.plugin-testing</groupId> <artifactId>maven-plugin-testing-harness</artifactId> @@ -156,55 +152,6 @@ </build> <profiles> - <!-- reporting at release time --> - <profile> - <id>reporting</id> - <activation> - <property> - <name>performRelease</name> - <value>true</value> - </property> - </activation> - - <reporting> - <plugins> - - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>cobertura-maven-plugin</artifactId> - <version>${coberturaPluginVersion}</version> - </plugin> - - <plugin> - <artifactId>maven-javadoc-plugin</artifactId> - <version>${javadocPluginVersion}</version> - <configuration> - <quiet>true</quiet> - <tagletArtifacts> - <tagletArtifact> - <groupId>org.apache.maven.plugin-tools</groupId> - <artifactId>maven-plugin-tools-javadoc</artifactId> - <version>${pluginPluginVersion}</version> - </tagletArtifact> - <tagletArtifact> - <groupId>org.codehaus.plexus</groupId> - <artifactId>plexus-component-javadoc</artifactId> - <version>1.5.5</version> - </tagletArtifact> - </tagletArtifacts> - </configuration> - <reportSets> - <reportSet> - <reports> - <report>javadoc</report> - <report>test-javadoc</report> - </reports> - </reportSet> - </reportSets> - </plugin> - </plugins> - </reporting> - </profile> <!-- prepare the assembly at release time --> <profile> diff --git a/helper-maven-plugin-test-api/src/site/apt/index.apt b/helper-maven-plugin-test-api/src/site/apt/index.apt index cdb688d..8131a59 100644 --- a/helper-maven-plugin-test-api/src/site/apt/index.apt +++ b/helper-maven-plugin-test-api/src/site/apt/index.apt @@ -14,4 +14,4 @@ Test toolkit overview see the {{{./mojo-testFramework.html}Mojo test framework}} page. - see {{{./testapidocs/index.html}test-javadoc}}. + see {{{./apidocs/index.html}javadoc}}. diff --git a/helper-maven-plugin-test-api/src/site/apt/mojo-testFramework.apt b/helper-maven-plugin-test-api/src/site/apt/mojo-testFramework.apt index 32757d7..0a36d83 100644 --- a/helper-maven-plugin-test-api/src/site/apt/mojo-testFramework.apt +++ b/helper-maven-plugin-test-api/src/site/apt/mojo-testFramework.apt @@ -12,23 +12,21 @@ Introduction The <mojo test framework> aims to simplify the writing of tests on a mojo. - To use this framework, your mojo classes <<MUST>> implements the contract - <<org.nuiton.plugin.Plugin>>. + To use this framework, your mojo classes <<MUST>> implements the contract <<org.nuiton.plugin.Plugin>>. The framework use these technologies : - * <<java 6>> + * <<java 7>> - * <<maven 2.2.1>> + * <<maven 3.3.3>> - * <<junit 4.7>> + * <<junit 4.12>> - * <<maven-plugin-testing-harness 1.2>>. + * <<maven-plugin-testing-harness 3.3.02>>. How to use it - For each mojo you want to test, implements the <<org.nuiton.plugin.AbstractMojoTest>> - class. + For each mojo you want to test, place the <<org.nuiton.plugin.MojoTestRule>> as a Rule on your test class. For each mojo's invocation you want to test : @@ -61,17 +59,15 @@ import static org.junit.Assert.*; import org.junit.Test; import org.nuiton.plugin.AbstractMojoTest; -public class MyMojoTest extends AbstractMojoTest<MyMojo> { +public class MyMojoTest { - @Override - protected String getGoalName(String methodName) { - return "my-goal"; - } + @Rule + public MojoTestRule<MyMojo> rule = MojoTestRule.newRule(MyMojoTest.class, "my-goal"); @Test public void firstTest() throws Exception { - MyMojo mojo = getMojo(); + MyMojo mojo = rule.getMojo(); mojo.execute(); @@ -81,7 +77,7 @@ public class MyMojoTest extends AbstractMojoTest<MyMojo> { @Test public void seconTest() throws Exception { - MyMojo mojo = getMojo(); + MyMojo mojo = rule.getMojo(); mojo.execute(); @@ -126,16 +122,15 @@ maven-test-plugin `-- secondTest.xml -------------------------------------------------------------------------------- -Go deeper in AbstractMojoTest +Go deeper... - Often, we could want to do some extra initialization on the mojo before - executing it. + Often, we could want to do some extra initialization on the mojo before executing it. <Note:> There is some limitations of the <maven-plugin-testing-harness> and this is not a real maven execution environement, for example you can not defined in the pom file some properties... - You can then override the <<setupMojo>> method, like in the next example : + You can then override the <<setupMojo>> method of the rule, like in the next example : -------------------------------------------------------------------------------- @@ -165,14 +160,14 @@ Go deeper in AbstractMojoTest } @Override - protected File getPomFile(File testDir, String methodName, String goalName) { - return super.getPomFile(testDir, methodName, goalName); + protected File getPomFile(File testDir, String methodName) { + return super.getPomFile(testDir, methodName); } @Override - protected File getTestDir(String methodName, String goalName) { - return super.getTestDir(methodName, goalName); + protected File getTestDir(String methodName) { + return super.getTestDir(methodName); } -------------------------------------------------------------------------------- - For more explanations, see the {{{./testapidocs/index.html}test-javadoc}}. + For more explanations, see the {{{./apidocs/index.html}javadoc}}. diff --git a/helper-maven-plugin/pom.xml b/helper-maven-plugin/pom.xml index 011c93c..4e7f0dd 100644 --- a/helper-maven-plugin/pom.xml +++ b/helper-maven-plugin/pom.xml @@ -72,11 +72,6 @@ <artifactId>plexus-sec-dispatcher</artifactId> </dependency> - <!--dependency> - <groupId>org.codehaus.plexus</groupId> - <artifactId>plexus-container-default</artifactId> - </dependency--> - <dependency> <groupId>plexus</groupId> <artifactId>plexus-mail-sender-api</artifactId> @@ -254,12 +249,6 @@ </plugin> <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>cobertura-maven-plugin</artifactId> - <version>${coberturaPluginVersion}</version> - </plugin> - - <plugin> <artifactId>maven-javadoc-plugin</artifactId> <version>${javadocPluginVersion}</version> <configuration> diff --git a/pom.xml b/pom.xml index bd10b94..5abc135 100644 --- a/pom.xml +++ b/pom.xml @@ -146,7 +146,8 @@ <dependency> <groupId>org.codehaus.plexus</groupId> <artifactId>plexus-container-default</artifactId> - <version>1.0-alpha-9-stable-1</version> + <!--<version>1.0-alpha-9-stable-1</version>--> + <version>1.6</version> <scope>provided</scope> </dependency> @@ -223,7 +224,7 @@ <dependency> <groupId>org.eclipse.sisu</groupId> <artifactId>org.eclipse.sisu.plexus</artifactId> - <version>0.3.0</version> + <version>0.3.1</version> </dependency> <!-- dependencies to mojo annotations --> @@ -237,13 +238,13 @@ <dependency> <groupId>javax.mail</groupId> <artifactId>mail</artifactId> - <version>1.4.7</version> + <version>1.5.0-b01</version> </dependency> <dependency> <groupId>org.apache.maven.wagon</groupId> <artifactId>wagon-provider-api</artifactId> - <version>2.4</version> + <version>2.9</version> <scope>provided</scope> </dependency> diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt index 9f4de97..e4888f9 100644 --- a/src/site/apt/index.apt +++ b/src/site/apt/index.apt @@ -33,7 +33,23 @@ Maven helper Plugin * Some nice goals: (See {{{./helper-maven-plugin/index.html}Plugin Module}}) - * A simple and efficient plugin api: (See {{{./helper-maven-plugin-api/index.html}API Module}}) + * A simple and efficient plugin api: (See {{{./helper-maven-plugin-api/index.html}Api Module}}) + + * And his test Api: (See {{{./helper-maven-plugin-test--api/index.html}Test Api Module}}) + +What's new in version 2.1 + +* Move to maven 3 + + * Maven 3.3.3 requirements + + * Jdk 7 requirements + +* Split Api module in two modules + + * The Api module <helper-maven-plugin-api> + + * The Test Api module <helper-maven-plugin-test-api> What's new in version 2.0 -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
participants (1)
-
nuiton.org scm