Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MASSEMBLY-832] Consider dependency optional attribute when gather de… #49

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[MASSEMBLY-832] Consider dependency optional attribute when gather de… #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/main/java/org/apache/maven/plugins/assembly/archive/task/AddDependencySetsTask.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,19 @@ Set<Artifact> resolveDependencyArtifacts( final DependencySet dependencySet )
final ScopeFilter scopeFilter = FilterUtils.newScopeFilter( dependencySet.getScope() );

final ArtifactFilter filter = new ArtifactIncludeFilterTransformer().transform( scopeFilter );

final ArtifactFilter optionalFilter = new ArtifactFilter()
{
@Override
public boolean include( Artifact artifact )
{
return artifact.isOptional() ? dependencySet.isUseOptionalDependencies() : true;
}
};

FilterUtils.filterArtifacts( dependencyArtifacts, dependencySet.getIncludes(), dependencySet.getExcludes(),
dependencySet.isUseStrictFiltering(), dependencySet.isUseTransitiveFiltering(),
logger, filter );
logger, filter, optionalFilter );

return dependencyArtifacts;
}
Expand Down
9 changes: 9 additions & 0 deletions src/main/mdo/assembly-component.mdo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,15 @@
build should be included in this dependency set. Default value is false. (Since 2.2)
]]></description>
</field>
<field>
<name>useOptionalDependencies</name>
<version>2.1.0+</version>
<type>boolean</type>
<defaultValue>false</defaultValue>
<description>
Determines whether optional dependencies should be included in this dependency set.
</description>
</field>
<field>
<name>useTransitiveDependencies</name>
<version>1.1.0+</version>
Expand Down
9 changes: 9 additions & 0 deletions src/main/mdo/assembly.mdo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,15 @@
build should be included in this dependency set. (Since 2.2-beta-1)
]]></description>
</field>
<field>
<name>useOptionalDependencies</name>
<version>2.1.0+</version>
<type>boolean</type>
<defaultValue>false</defaultValue>
<description>
Determines whether optional dependencies should be included in this dependency set.
</description>
</field>
<field>
<name>useTransitiveDependencies</name>
<version>1.1.0+</version>
Expand Down
101 changes: 78 additions & 23 deletions src/test/java/org/apache/maven/plugins/assembly/archive/task/AddDependencySetsTaskTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,7 @@
* under the License.
*/

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isNull;
import static org.mockito.Mockito.atLeastOnce;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;

import com.google.common.collect.ImmutableSet;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.handler.ArtifactHandler;
import org.apache.maven.execution.MavenSession;
Expand Down Expand Up @@ -71,6 +49,29 @@
import org.mockito.ArgumentCaptor;
import org.mockito.junit.MockitoJUnitRunner;

import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isNull;
import static org.mockito.Mockito.atLeastOnce;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

@RunWith( MockitoJUnitRunner.class )
public class AddDependencySetsTaskTest
{
Expand Down Expand Up @@ -425,6 +426,60 @@ public void testGetDependencyArtifacts_ShouldFilterOneDependencyArtifactViaInclu
assertSame( am1, result.iterator().next() );
}

@Test
public void testGetDependencyArtifacts_ShouldFilterOptionalArtifactsByDefault() throws Exception
{
Artifact am1 = mockArtifact(1);
when(am1.isOptional()).thenReturn(true);
Artifact am2 = mockArtifact(2);
Set<Artifact> resolvedArtifacts = resolveDependencyArtifacts(new DependencySet(), ImmutableSet.of(am1, am2));
assertEquals(1, resolvedArtifacts.size());
assertSame(am2, resolvedArtifacts.iterator().next());
}

@Test
public void testGetDependencyArtifacts_ShouldFilterOptionalArtifactsExplicitly() throws Exception
{
Artifact am1 = mockArtifact(1);
when(am1.isOptional()).thenReturn(true);
Artifact am2 = mockArtifact(2);
DependencySet dependencySet = new DependencySet();
dependencySet.setUseOptionalDependencies(false);

Set<Artifact> resolvedArtifacts = resolveDependencyArtifacts(dependencySet, ImmutableSet.of(am1, am2));
assertEquals(1, resolvedArtifacts.size());
assertSame(am2, resolvedArtifacts.iterator().next());
}

@Test
public void testGetDependencyArtifacts_ShouldNotFilterOptionalArtifactsExplicitly() throws Exception
{
Artifact am1 = mockArtifact(1);
when(am1.isOptional()).thenReturn(true);
Artifact am2 = mockArtifact(2);
DependencySet dependencySet = new DependencySet();
dependencySet.setUseOptionalDependencies(true);

Set<Artifact> resolvedArtifacts = resolveDependencyArtifacts(dependencySet, ImmutableSet.of(am1, am2));
assertEquals(2, resolvedArtifacts.size());
}

private static Artifact mockArtifact( int id )
{
Artifact a = mock(Artifact.class);
when(a.getId()).thenReturn("group:artifact" + id + ":1.0:jar");
return a;
}

private Set<Artifact> resolveDependencyArtifacts( DependencySet dependencySet, Set<Artifact> artifacts ) throws Exception
{
MavenProject project = new MavenProject(new Model());
Logger logger = new ConsoleLogger(Logger.LEVEL_DEBUG, "test");
AddDependencySetsTask task =
new AddDependencySetsTask(Collections.singletonList(dependencySet), artifacts, project, null, logger);
return task.resolveDependencyArtifacts(dependencySet);
}

@Test
public void testGetDependencyArtifacts_ShouldIgnoreTransitivePathFilteringWhenIncludeNotTransitive()
throws Exception
Expand Down