You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2017/08/20 19:00:40 UTC

svn commit: r1805578 - in /maven/shared/trunk/maven-artifact-transfer/src: main/java/org/apache/maven/shared/artifact/deploy/ main/java/org/apache/maven/shared/artifact/deploy/internal/ test/java/org/apache/maven/shared/artifact/deploy/ test/java/org/a...

Author: khmarbaise
Date: Sun Aug 20 19:00:40 2017
New Revision: 1805578

URL: http://svn.apache.org/viewvc?rev=1805578&view=rev
Log:
[MSHARED-658] ArtifactDeployer check for integrity of parameters null, empty collection, being a directory
 o Added unit tests to check parameters etc.

Added:
    maven/shared/trunk/maven-artifact-transfer/src/test/java/org/apache/maven/shared/artifact/deploy/
    maven/shared/trunk/maven-artifact-transfer/src/test/java/org/apache/maven/shared/artifact/deploy/internal/
    maven/shared/trunk/maven-artifact-transfer/src/test/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployerTest.java
Modified:
    maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/ArtifactDeployer.java
    maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployer.java

Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/ArtifactDeployer.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/ArtifactDeployer.java?rev=1805578&r1=1805577&r2=1805578&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/ArtifactDeployer.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/ArtifactDeployer.java Sun Aug 20 19:00:40 2017
@@ -35,6 +35,9 @@ public interface ArtifactDeployer
      * @param request {@link ProjectBuildingRequest}
      * @param mavenArtifacts {@link Artifact}
      * @throws ArtifactDeployerException in case of an error.
+     * @throws IllegalArgumentException in case of parameter <code>request</code> is <code>null</code> or parameter
+     *             <code>mavenArtifacts</code> is <code>null</code> or <code>mavenArtifacts.isEmpty()</code> is
+     *             <code>true</code>.
      */
     void deploy( ProjectBuildingRequest request, Collection<Artifact> mavenArtifacts )
         throws ArtifactDeployerException;
@@ -45,9 +48,12 @@ public interface ArtifactDeployer
      *            used.
      * @param mavenArtifacts the artifacts to deploy
      * @throws ArtifactDeployerException in case of an error.
+     * @throws IllegalArgumentException in case of parameter <code>request</code> is <code>null</code> or parameter
+     *             <code>mavenArtifacts</code> is <code>null</code> or <code>mavenArtifacts.isEmpty()</code> is
+     *             <code>true</code>.
      */
     void deploy( ProjectBuildingRequest request, ArtifactRepository remoteRepository,
                  Collection<Artifact> mavenArtifacts )
-                     throws ArtifactDeployerException;
+        throws ArtifactDeployerException;
 
 }

Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployer.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployer.java?rev=1805578&r1=1805577&r2=1805578&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployer.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployer.java Sun Aug 20 19:00:40 2017
@@ -43,11 +43,13 @@ public class DefaultArtifactDeployer
 {
 
     private PlexusContainer container;
-    
+
     @Override
     public void deploy( ProjectBuildingRequest request, Collection<Artifact> mavenArtifacts )
         throws ArtifactDeployerException
     {
+        validateParameters( request, mavenArtifacts );
+
         try
         {
             String hint = isMaven31() ? "maven31" : "maven3";
@@ -65,8 +67,9 @@ public class DefaultArtifactDeployer
     @Override
     public void deploy( ProjectBuildingRequest request, ArtifactRepository remoteRepository,
                         Collection<Artifact> mavenArtifacts )
-                            throws ArtifactDeployerException
+        throws ArtifactDeployerException
     {
+        validateParameters( request, mavenArtifacts );
         try
         {
             String hint = isMaven31() ? "maven31" : "maven3";
@@ -80,6 +83,23 @@ public class DefaultArtifactDeployer
             throw new ArtifactDeployerException( e.getMessage(), e );
         }
     }
+
+    private void validateParameters( ProjectBuildingRequest request, Collection<Artifact> mavenArtifacts )
+    {
+        if ( request == null )
+        {
+            throw new IllegalArgumentException( "The parameter request is not allowed to be null." );
+        }
+        if ( mavenArtifacts == null )
+        {
+            throw new IllegalArgumentException( "The parameter mavenArtifacts is not allowed to be null." );
+        }
+        if ( mavenArtifacts.isEmpty() )
+        {
+            throw new IllegalArgumentException( "The collection mavenArtifacts is not allowed to be empty." );
+        }
+    }
+
     /**
      * @return true if the current Maven version is Maven 3.1.
      */
@@ -105,7 +125,7 @@ public class DefaultArtifactDeployer
     /**
      * Injects the Plexus content.
      *
-     * @param context   Plexus context to inject.
+     * @param context Plexus context to inject.
      * @throws ContextException if the PlexusContainer could not be located.
      */
     public void contextualize( Context context )

Added: maven/shared/trunk/maven-artifact-transfer/src/test/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployerTest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/test/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployerTest.java?rev=1805578&view=auto
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/test/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployerTest.java (added)
+++ maven/shared/trunk/maven-artifact-transfer/src/test/java/org/apache/maven/shared/artifact/deploy/internal/DefaultArtifactDeployerTest.java Sun Aug 20 19:00:40 2017
@@ -0,0 +1,115 @@
+package org.apache.maven.shared.artifact.deploy.internal;
+
+/*
+ * 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.mockito.Mockito.mock;
+
+import java.util.Collections;
+
+import org.apache.maven.artifact.Artifact;
+import org.apache.maven.project.ProjectBuildingRequest;
+import org.apache.maven.shared.artifact.deploy.ArtifactDeployerException;
+import org.apache.maven.shared.artifact.deploy.internal.DefaultArtifactDeployer;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+/**
+ * Check the parameter contracts which have been made based on the interface {@link ArtifactDeployer}.
+ * 
+ * @author Karl Heinz Marbaise <a href="mailto:khmarbaise@apache.org">khmabaise@apache.org</a>
+ */
+public class DefaultArtifactDeployerTest
+{
+    @Rule
+    public ExpectedException thrown = ExpectedException.none();
+
+    @Test
+    public void deployShouldReturnIllegalArgumentExceptionForFirstParameterWithNull()
+        throws ArtifactDeployerException
+    {
+        DefaultArtifactDeployer dap = new DefaultArtifactDeployer();
+
+        thrown.expect( IllegalArgumentException.class );
+        thrown.expectMessage( "The parameter request is not allowed to be null." );
+        dap.deploy( null, Collections.<Artifact>emptyList() );
+    }
+
+    @Test
+    public void deployShouldReturnIllegalArgumentExceptionForSecondParameterWithNull()
+        throws ArtifactDeployerException
+    {
+        DefaultArtifactDeployer dap = new DefaultArtifactDeployer();
+
+        thrown.expect( IllegalArgumentException.class );
+        thrown.expectMessage( "The parameter mavenArtifacts is not allowed to be null." );
+        ProjectBuildingRequest pbr = mock( ProjectBuildingRequest.class );
+        dap.deploy( pbr, null );
+    }
+
+    @Test
+    public void deployShouldReturnIllegalArgumentExceptionForSecondParameterWithEmpty()
+        throws ArtifactDeployerException
+    {
+        DefaultArtifactDeployer dap = new DefaultArtifactDeployer();
+
+        thrown.expect( IllegalArgumentException.class );
+        thrown.expectMessage( "The collection mavenArtifacts is not allowed to be empty." );
+        ProjectBuildingRequest pbr = mock( ProjectBuildingRequest.class );
+        dap.deploy( pbr, Collections.<Artifact>emptyList() );
+    }
+
+
+    @Test
+    public void deploy3ParametersShouldReturnIllegalArgumentExceptionForFirstParameterWithNull()
+        throws ArtifactDeployerException
+    {
+        DefaultArtifactDeployer dap = new DefaultArtifactDeployer();
+
+        thrown.expect( IllegalArgumentException.class );
+        thrown.expectMessage( "The parameter request is not allowed to be null." );
+        dap.deploy( null, null, Collections.<Artifact>emptyList() );
+    }
+
+    @Test
+    public void deploy3ParametersShouldReturnIllegalArgumentExceptionForSecondParameterWithNull()
+        throws ArtifactDeployerException
+    {
+        DefaultArtifactDeployer dap = new DefaultArtifactDeployer();
+
+        thrown.expect( IllegalArgumentException.class );
+        thrown.expectMessage( "The parameter mavenArtifacts is not allowed to be null." );
+        ProjectBuildingRequest pbr = mock( ProjectBuildingRequest.class );
+        dap.deploy( pbr, null, null );
+    }
+
+    @Test
+    public void deploy3ParametersShouldReturnIllegalArgumentExceptionForSecondParameterWithEmpty()
+        throws ArtifactDeployerException
+    {
+        DefaultArtifactDeployer dap = new DefaultArtifactDeployer();
+
+        thrown.expect( IllegalArgumentException.class );
+        thrown.expectMessage( "The collection mavenArtifacts is not allowed to be empty." );
+        ProjectBuildingRequest pbr = mock( ProjectBuildingRequest.class );
+        dap.deploy( pbr, null, Collections.<Artifact>emptyList() );
+    }
+
+}