You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2015/01/16 23:28:12 UTC
[1/2] maven git commit: Improve javadoc
Repository: maven
Updated Branches:
refs/heads/master 36d491a64 -> 99f763dec
Improve javadoc
Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/fe597d01
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/fe597d01
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/fe597d01
Branch: refs/heads/master
Commit: fe597d01f63b127c2a89098cc2c6e9489e573ab1
Parents: 36d491a
Author: Robert Scholte <rf...@codehaus.org>
Authored: Thu Jan 15 21:56:45 2015 +0100
Committer: Robert Scholte <rf...@codehaus.org>
Committed: Fri Jan 16 13:24:56 2015 +0100
----------------------------------------------------------------------
.../java/org/apache/maven/building/ProblemCollectorFactory.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/maven/blob/fe597d01/maven-builder-support/src/main/java/org/apache/maven/building/ProblemCollectorFactory.java
----------------------------------------------------------------------
diff --git a/maven-builder-support/src/main/java/org/apache/maven/building/ProblemCollectorFactory.java b/maven-builder-support/src/main/java/org/apache/maven/building/ProblemCollectorFactory.java
index 1a23ee9..fa1de3b 100644
--- a/maven-builder-support/src/main/java/org/apache/maven/building/ProblemCollectorFactory.java
+++ b/maven-builder-support/src/main/java/org/apache/maven/building/ProblemCollectorFactory.java
@@ -32,7 +32,7 @@ public class ProblemCollectorFactory
/**
* The default implementation is not visible, create it with this factory
*
- * @param problems
+ * @param problems starting set of problems, may be {@code null}
* @return a new instance of a ProblemCollector
*/
public static ProblemCollector newInstance( List<Problem> problems )
[2/2] maven git commit: Add junit tests for DefaultToolchainsBuilder
and ToolchainsBuildingException
Posted by rf...@apache.org.
Add junit tests for DefaultToolchainsBuilder and ToolchainsBuildingException
Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/99f763de
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/99f763de
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/99f763de
Branch: refs/heads/master
Commit: 99f763decd91b6c6f924d997b6b1f84d5d7c15f1
Parents: fe597d0
Author: Robert Scholte <rf...@codehaus.org>
Authored: Thu Jan 15 22:26:59 2015 +0100
Committer: Robert Scholte <rf...@codehaus.org>
Committed: Fri Jan 16 13:24:57 2015 +0100
----------------------------------------------------------------------
.../building/DefaultToolchainsBuilder.java | 2 +
.../building/ToolchainsBuildingException.java | 9 +-
.../building/DefaultToolchainsBuilderTest.java | 185 +++++++++++++++++++
.../ToolchainsBuildingExceptionTest.java | 73 ++++++++
4 files changed, 267 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/maven/blob/99f763de/maven-core/src/main/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilder.java
----------------------------------------------------------------------
diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilder.java b/maven-core/src/main/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilder.java
index 397f0ce..808e4be 100644
--- a/maven-core/src/main/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilder.java
+++ b/maven-core/src/main/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilder.java
@@ -26,6 +26,7 @@ import java.util.Map;
import javax.inject.Inject;
import javax.inject.Named;
+import javax.inject.Singleton;
import org.apache.maven.building.Problem;
import org.apache.maven.building.ProblemCollector;
@@ -43,6 +44,7 @@ import org.apache.maven.toolchain.model.TrackableBase;
* @since 3.2.6
*/
@Named
+@Singleton
public class DefaultToolchainsBuilder
implements ToolchainsBuilder
{
http://git-wip-us.apache.org/repos/asf/maven/blob/99f763de/maven-core/src/main/java/org/apache/maven/toolchain/building/ToolchainsBuildingException.java
----------------------------------------------------------------------
diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/building/ToolchainsBuildingException.java b/maven-core/src/main/java/org/apache/maven/toolchain/building/ToolchainsBuildingException.java
index b3ec9a3..cf6ff74 100644
--- a/maven-core/src/main/java/org/apache/maven/toolchain/building/ToolchainsBuildingException.java
+++ b/maven-core/src/main/java/org/apache/maven/toolchain/building/ToolchainsBuildingException.java
@@ -79,8 +79,13 @@ public class ToolchainsBuildingException
writer.print( problem.getSeverity() );
writer.print( "] " );
writer.print( problem.getMessage() );
- writer.print( " @ " );
- writer.println( problem.getLocation() );
+ String location = problem.getLocation();
+ if ( !location.isEmpty() )
+ {
+ writer.print( " @ " );
+ writer.print( location );
+ }
+ writer.println();
}
return buffer.toString();
http://git-wip-us.apache.org/repos/asf/maven/blob/99f763de/maven-core/src/test/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilderTest.java
----------------------------------------------------------------------
diff --git a/maven-core/src/test/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilderTest.java b/maven-core/src/test/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilderTest.java
new file mode 100644
index 0000000..80fca09
--- /dev/null
+++ b/maven-core/src/test/java/org/apache/maven/toolchain/building/DefaultToolchainsBuilderTest.java
@@ -0,0 +1,185 @@
+package org.apache.maven.toolchain.building;
+
+/*
+ * 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.
+ */
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.anyMap;
+import static org.mockito.Mockito.when;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.maven.building.StringSource;
+import org.apache.maven.toolchain.io.ToolchainsParseException;
+import org.apache.maven.toolchain.io.ToolchainsReader;
+import org.apache.maven.toolchain.model.PersistedToolchains;
+import org.apache.maven.toolchain.model.ToolchainModel;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class DefaultToolchainsBuilderTest
+{
+ private static final String LS = System.getProperty( "line.separator" );
+
+ @Mock
+ private ToolchainsReader toolchainsReader;
+
+ @InjectMocks
+ private DefaultToolchainsBuilder toolchainBuilder = new DefaultToolchainsBuilder();
+
+ @Before
+ public void onSetup()
+ {
+ MockitoAnnotations.initMocks( this );
+ }
+
+ @Test
+ public void testBuildEmptyRequest()
+ throws Exception
+ {
+ ToolchainsBuildingRequest request = new DefaultToolchainsBuildingRequest();
+ ToolchainsBuildingResult result = toolchainBuilder.build( request );
+ assertNotNull( result.getEffectiveToolchains() );
+ assertNotNull( result.getProblems() );
+ assertEquals( 0, result.getProblems().size() );
+ }
+
+ @Test
+ public void testBuildRequestWithUserToolchains()
+ throws Exception
+ {
+ ToolchainsBuildingRequest request = new DefaultToolchainsBuildingRequest();
+ request.setUserToolchainsSource( new StringSource( "" ) );
+
+ PersistedToolchains userResult = new PersistedToolchains();
+ ToolchainModel toolchain = new ToolchainModel();
+ toolchain.setType( "TYPE" );
+ toolchain.addProvide( "key", "user_value" );
+ userResult.addToolchain( toolchain );
+ when( toolchainsReader.read( any( InputStream.class ), anyMap() ) ).thenReturn( userResult );
+
+ ToolchainsBuildingResult result = toolchainBuilder.build( request );
+ assertNotNull( result.getEffectiveToolchains() );
+ assertEquals( 1, result.getEffectiveToolchains().getToolchains().size() );
+ assertEquals( "TYPE", result.getEffectiveToolchains().getToolchains().get(0).getType() );
+ assertEquals( "user_value", result.getEffectiveToolchains().getToolchains().get(0).getProvides().getProperty( "key" ) );
+ assertNotNull( result.getProblems() );
+ assertEquals( 0, result.getProblems().size() );
+ }
+
+ @Test
+ public void testBuildRequestWithGlobalToolchains()
+ throws Exception
+ {
+ ToolchainsBuildingRequest request = new DefaultToolchainsBuildingRequest();
+ request.setGlobalToolchainsSource( new StringSource( "" ) );
+
+ PersistedToolchains globalResult = new PersistedToolchains();
+ ToolchainModel toolchain = new ToolchainModel();
+ toolchain.setType( "TYPE" );
+ toolchain.addProvide( "key", "global_value" );
+ globalResult.addToolchain( toolchain );
+ when( toolchainsReader.read( any( InputStream.class ), anyMap() ) ).thenReturn( globalResult );
+
+ ToolchainsBuildingResult result = toolchainBuilder.build( request );
+ assertNotNull( result.getEffectiveToolchains() );
+ assertEquals( 1, result.getEffectiveToolchains().getToolchains().size() );
+ assertEquals( "TYPE", result.getEffectiveToolchains().getToolchains().get(0).getType() );
+ assertEquals( "global_value", result.getEffectiveToolchains().getToolchains().get(0).getProvides().getProperty( "key" ) );
+ assertNotNull( result.getProblems() );
+ assertEquals( 0, result.getProblems().size() );
+ }
+
+ @Test
+ public void testBuildRequestWithBothToolchains()
+ throws Exception
+ {
+ ToolchainsBuildingRequest request = new DefaultToolchainsBuildingRequest();
+ request.setGlobalToolchainsSource( new StringSource( "" ) );
+ request.setUserToolchainsSource( new StringSource( "" ) );
+
+ PersistedToolchains userResult = new PersistedToolchains();
+ ToolchainModel userToolchain = new ToolchainModel();
+ userToolchain.setType( "TYPE" );
+ userToolchain.addProvide( "key", "user_value" );
+ userResult.addToolchain( userToolchain );
+
+ PersistedToolchains globalResult = new PersistedToolchains();
+ ToolchainModel globalToolchain = new ToolchainModel();
+ globalToolchain.setType( "TYPE" );
+ globalToolchain.addProvide( "key", "global_value" );
+ globalResult.addToolchain( globalToolchain );
+ when( toolchainsReader.read( any( InputStream.class ), anyMap() ) ).thenReturn( globalResult ).thenReturn( userResult );
+
+ ToolchainsBuildingResult result = toolchainBuilder.build( request );
+ assertNotNull( result.getEffectiveToolchains() );
+ assertEquals( 2, result.getEffectiveToolchains().getToolchains().size() );
+ assertEquals( "TYPE", result.getEffectiveToolchains().getToolchains().get(0).getType() );
+ assertEquals( "user_value", result.getEffectiveToolchains().getToolchains().get(0).getProvides().getProperty( "key" ) );
+ assertEquals( "TYPE", result.getEffectiveToolchains().getToolchains().get(1).getType() );
+ assertEquals( "global_value", result.getEffectiveToolchains().getToolchains().get(1).getProvides().getProperty( "key" ) );
+ assertNotNull( result.getProblems() );
+ assertEquals( 0, result.getProblems().size() );
+ }
+
+ @Test
+ public void testStrictToolchainsParseException() throws Exception
+ {
+ ToolchainsBuildingRequest request = new DefaultToolchainsBuildingRequest();
+ request.setGlobalToolchainsSource( new StringSource( "" ) );
+ ToolchainsParseException parseException = new ToolchainsParseException( "MESSAGE", 4, 2 );
+ when( toolchainsReader.read( any( InputStream.class ), anyMap() ) ).thenThrow( parseException );
+
+ try
+ {
+ toolchainBuilder.build( request );
+ }
+ catch ( ToolchainsBuildingException e )
+ {
+ assertEquals( "1 problem was encountered while building the effective toolchains" + LS +
+ "[FATAL] Non-parseable toolchains (memory): MESSAGE @ line 4, column 2" + LS, e.getMessage() );
+ }
+ }
+
+ @Test
+ public void testIOException() throws Exception
+ {
+ ToolchainsBuildingRequest request = new DefaultToolchainsBuildingRequest();
+ request.setGlobalToolchainsSource( new StringSource( "", "LOCATION" ) );
+ IOException ioException = new IOException( "MESSAGE" );
+ when( toolchainsReader.read( any( InputStream.class ), anyMap() ) ).thenThrow( ioException );
+
+ try
+ {
+ toolchainBuilder.build( request );
+ }
+ catch ( ToolchainsBuildingException e )
+ {
+ assertEquals( "1 problem was encountered while building the effective toolchains" + LS +
+ "[FATAL] Non-readable toolchains LOCATION: MESSAGE" + LS, e.getMessage() );
+ }
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/maven/blob/99f763de/maven-core/src/test/java/org/apache/maven/toolchain/building/ToolchainsBuildingExceptionTest.java
----------------------------------------------------------------------
diff --git a/maven-core/src/test/java/org/apache/maven/toolchain/building/ToolchainsBuildingExceptionTest.java b/maven-core/src/test/java/org/apache/maven/toolchain/building/ToolchainsBuildingExceptionTest.java
new file mode 100644
index 0000000..bf745c2
--- /dev/null
+++ b/maven-core/src/test/java/org/apache/maven/toolchain/building/ToolchainsBuildingExceptionTest.java
@@ -0,0 +1,73 @@
+package org.apache.maven.toolchain.building;
+
+/*
+ * 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.
+ */
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.Collections;
+
+import org.apache.maven.building.Problem;
+import org.apache.maven.building.ProblemCollector;
+import org.apache.maven.building.ProblemCollectorFactory;
+import org.junit.Test;
+
+public class ToolchainsBuildingExceptionTest
+{
+ private static final String LS = System.getProperty( "line.separator" );
+
+ @Test
+ public void testNoProblems()
+ {
+ ToolchainsBuildingException e = new ToolchainsBuildingException( Collections.<Problem>emptyList() );
+ assertEquals( "0 problems were encountered while building the effective toolchains" + LS, e.getMessage() );
+ }
+
+ @Test
+ public void testOneProblem()
+ {
+ ProblemCollector problemCollector = ProblemCollectorFactory.newInstance( null );
+ problemCollector.add( Problem.Severity.ERROR, "MESSAGE", 3, 5, new Exception() );
+ ToolchainsBuildingException e = new ToolchainsBuildingException( problemCollector.getProblems() );
+ assertEquals( "1 problem was encountered while building the effective toolchains" + LS +
+ "[ERROR] MESSAGE @ line 3, column 5" + LS, e.getMessage() );
+ }
+
+ @Test
+ public void testUnknownPositionAndSource()
+ {
+ ProblemCollector problemCollector = ProblemCollectorFactory.newInstance( null );
+ problemCollector.add( Problem.Severity.ERROR, "MESSAGE", -1, -1, new Exception() );
+ ToolchainsBuildingException e = new ToolchainsBuildingException( problemCollector.getProblems() );
+ assertEquals( "1 problem was encountered while building the effective toolchains" + LS +
+ "[ERROR] MESSAGE" + LS, e.getMessage() );
+ }
+
+ @Test
+ public void testUnknownPosition()
+ {
+ ProblemCollector problemCollector = ProblemCollectorFactory.newInstance( null );
+ problemCollector.setSource( "SOURCE" );
+ problemCollector.add( Problem.Severity.ERROR, "MESSAGE", -1, -1, new Exception() );
+ ToolchainsBuildingException e = new ToolchainsBuildingException( problemCollector.getProblems() );
+ assertEquals( "1 problem was encountered while building the effective toolchains" + LS +
+ "[ERROR] MESSAGE @ SOURCE" + LS, e.getMessage() );
+ }
+
+}