Skip to content

Commit

Permalink
Resolves #790: Correct update scope determination
Browse files Browse the repository at this point in the history
  • Loading branch information
@jarmoniuk @slawekjaranowski
jarmoniuk authored and slawekjaranowski committed Oct 26, 2022
1 parent cdd2446 commit 6ad99f8
Show file tree
Hide file tree
Showing 2 changed files with 177 additions and 7 deletions.
11 changes: 6 additions & 5 deletions src/main/java/org/codehaus/mojo/versions/DisplayDependencyUpdatesMojo.java
View file
Expand Up @@ -226,7 +226,7 @@ public class DisplayDependencyUpdatesMojo
* @since 2.5
*/
@Parameter( property = "allowMajorUpdates", defaultValue = "true" )
private boolean allowMajorUpdates;
private boolean allowMajorUpdates = true;

/**
* <p>Whether to allow the minor version number to be changed.</p>
Expand All @@ -237,7 +237,7 @@ public class DisplayDependencyUpdatesMojo
* @since 2.5
*/
@Parameter( property = "allowMinorUpdates", defaultValue = "true" )
private boolean allowMinorUpdates;
private boolean allowMinorUpdates = true;

/**
* <p>Whether to allow the incremental version number to be changed.</p>
Expand All @@ -249,7 +249,7 @@ public class DisplayDependencyUpdatesMojo
* @since 2.5
*/
@Parameter( property = "allowIncrementalUpdates", defaultValue = "true" )
private boolean allowIncrementalUpdates;
private boolean allowIncrementalUpdates = true;

/**
* Whether to allow any version change to be allowed. This keeps
Expand All @@ -263,7 +263,7 @@ public class DisplayDependencyUpdatesMojo
*/
@Deprecated
@Parameter( property = "allowAnyUpdates", defaultValue = "true" )
private boolean allowAnyUpdates;
private boolean allowAnyUpdates = true;

/**
* Whether to show additional information such as dependencies that do not need updating. Defaults to false.
Expand Down Expand Up @@ -697,7 +697,8 @@ private Optional<Segment> calculateUpdateScope()
return allowAnyUpdates
? empty()
: of( SegmentUtils.determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates,
allowIncrementalUpdates, getLog() ).map( s -> Segment.of( s.value() - 1 ) )
allowIncrementalUpdates, getLog() )
.map( s -> Segment.of( s.value() + 1 ) )
.orElse( MAJOR ) );
}

Expand Down
173 changes: 171 additions & 2 deletions src/test/java/org/codehaus/mojo/versions/DisplayDependencyUpdatesMojoTest.java
View file
Expand Up @@ -165,7 +165,8 @@ null, mockArtifactMetadataSource( new HashMap<String, String[]>()
new StubArtifactResolver( new ArtifactStubFactory(), false, false ) )
{{
setProject( createProject() );
setVariableValueToObject( this, "allowMinorUpdates", true );
setVariableValueToObject( this, "allowAnyUpdates", false );
setVariableValueToObject( this, "allowMajorUpdates", false );
setVariableValueToObject( this, "processDependencies", true );
setVariableValueToObject( this, "dependencyIncludes",
singletonList( WildcardMatcher.WILDCARD ) );
Expand All @@ -189,6 +190,132 @@ null, mockArtifactMetadataSource( new HashMap<String, String[]>()
}
}

@Test
public void testAllowMajorUpdatesFalse()
throws MojoExecutionException, MojoFailureException, IllegalAccessException, IOException
{
Path tempPath = null;
try
{
tempPath = Files.createTempFile( "display-dependency-updates", "" );
final File tempFile = tempPath.toFile();
new DisplayDependencyUpdatesMojo( mockRepositorySystem(),
null, mockArtifactMetadataSource( new HashMap<String, String[]>()
{{
put( "default-dependency", new String[] {"1.0.0", "1.1.0", "2.0.0"} );
}} ), null,
new StubArtifactResolver( new ArtifactStubFactory(), false, false ) )
{{
setProject( createProject() );
setVariableValueToObject( this, "allowAnyUpdates", false );
setVariableValueToObject( this, "allowMajorUpdates", false );
setVariableValueToObject( this, "processDependencies", true );
setVariableValueToObject( this, "dependencyIncludes",
singletonList( WildcardMatcher.WILDCARD ) );
setVariableValueToObject( this, "dependencyExcludes", emptyList() );
this.outputFile = tempFile;
setPluginContext( new HashMap<>() );
}}.execute();

String output = String.join( "", Files.readAllLines( tempPath ) );

assertThat( output, containsString( "1.1.0" ) );
assertThat( output, not( containsString( "2.0.0" ) ) );
}
finally
{
if ( tempPath != null && Files.exists( tempPath ) )
{
Files.delete( tempPath );
}
}
}

@Test
public void testAllowMinorUpdatesFalse()
throws MojoExecutionException, MojoFailureException, IllegalAccessException, IOException
{
Path tempPath = null;
try
{
tempPath = Files.createTempFile( "display-dependency-updates", "" );
final File tempFile = tempPath.toFile();
new DisplayDependencyUpdatesMojo( mockRepositorySystem(),
null, mockArtifactMetadataSource( new HashMap<String, String[]>()
{{
put( "default-dependency", new String[] {"1.0.0", "1.0.1", "1.1.0", "2.0.0"} );
}} ), null,
new StubArtifactResolver( new ArtifactStubFactory(), false, false ) )
{{
setProject( createProject() );
setVariableValueToObject( this, "allowAnyUpdates", false );
setVariableValueToObject( this, "allowMinorUpdates", false );
setVariableValueToObject( this, "processDependencies", true );
setVariableValueToObject( this, "dependencyIncludes",
singletonList( WildcardMatcher.WILDCARD ) );
setVariableValueToObject( this, "dependencyExcludes", emptyList() );
this.outputFile = tempFile;
setPluginContext( new HashMap<>() );
}}.execute();

String output = String.join( "", Files.readAllLines( tempPath ) );

assertThat( output, containsString( "1.0.1" ) );
assertThat( output, not( containsString( "1.1.0" ) ) );
assertThat( output, not( containsString( "2.0.0" ) ) );
}
finally
{
if ( tempPath != null && Files.exists( tempPath ) )
{
Files.delete( tempPath );
}
}
}

@Test
public void testAllowIncrementalUpdatesFalse()
throws MojoExecutionException, MojoFailureException, IllegalAccessException, IOException
{
Path tempPath = null;
try
{
tempPath = Files.createTempFile( "display-dependency-updates", "" );
final File tempFile = tempPath.toFile();
new DisplayDependencyUpdatesMojo( mockRepositorySystem(),
null, mockArtifactMetadataSource( new HashMap<String, String[]>()
{{
put( "default-dependency", new String[] {"1.0.0", "1.0.0-1", "1.0.1", "1.1.0", "2.0.0"} );
}} ), null,
new StubArtifactResolver( new ArtifactStubFactory(), false, false ) )
{{
setProject( createProject() );
setVariableValueToObject( this, "allowAnyUpdates", false );
setVariableValueToObject( this, "allowIncrementalUpdates", false );
setVariableValueToObject( this, "processDependencies", true );
setVariableValueToObject( this, "dependencyIncludes",
singletonList( WildcardMatcher.WILDCARD ) );
setVariableValueToObject( this, "dependencyExcludes", emptyList() );
this.outputFile = tempFile;
setPluginContext( new HashMap<>() );
}}.execute();

String output = String.join( "", Files.readAllLines( tempPath ) );

assertThat( output, containsString( "1.0.0-1" ) );
assertThat( output, not( containsString( "1.0.1" ) ) );
assertThat( output, not( containsString( "1.1.0" ) ) );
assertThat( output, not( containsString( "2.0.0" ) ) );
}
finally
{
if ( tempPath != null && Files.exists( tempPath ) )
{
Files.delete( tempPath );
}
}
}

@Test
public void testVersionsWithQualifiersNotConsideredAsIncrementalUpdates()
throws MojoExecutionException, MojoFailureException, IllegalAccessException, IOException
Expand All @@ -207,7 +334,8 @@ null, mockArtifactMetadataSource( new HashMap<String, String[]>()
new StubArtifactResolver( new ArtifactStubFactory(), false, false ) )
{{
setProject( createProject() );
setVariableValueToObject( this, "allowIncrementalUpdates", true );
setVariableValueToObject( this, "allowAnyUpdates", false );
setVariableValueToObject( this, "allowMinorUpdates", false );
setVariableValueToObject( this, "processDependencies", true );
setVariableValueToObject( this, "dependencyIncludes",
singletonList( WildcardMatcher.WILDCARD ) );
Expand All @@ -230,4 +358,45 @@ null, mockArtifactMetadataSource( new HashMap<String, String[]>()
}
}
}

@Test
public void testDetermineUpdatedSegment() throws Exception
{
File outputFile = null;
try
{
outputFile = File.createTempFile( "display-dependency-updates", "" );
assert outputFile.exists();

DisplayDependencyUpdatesMojo mojo = (DisplayDependencyUpdatesMojo) mojoRule.lookupConfiguredMojo(
new File( "target/test-classes/org/codehaus/mojo/display-dependency-updates/ruleset" ),
"display-dependency-updates" );

assertThat( mojo.ruleSet, notNullValue() );
assertThat( mojo.ruleSet.getIgnoreVersions(), notNullValue() );
assertThat( mojo.ruleSet.getIgnoreVersions(), Matchers.hasSize( 3 ) );
assertThat( mojo.ruleSet.getIgnoreVersions(), hasItem( matches(
new TestIgnoreVersions().withVersion( "1.0.1" ) ) ) );
assertThat( mojo.ruleSet.getIgnoreVersions(), containsInAnyOrder(
matches( new TestIgnoreVersions().withVersion( "1.0.1" ) ),
matches( new TestIgnoreVersions().withType( TYPE_REGEX ).withVersion( ".+-SNAPSHOT" ) ),
matches( new TestIgnoreVersions().withType( TYPE_REGEX ).withVersion( ".+-M\\d+" ) ) ) );

// This is just an example of how to create it-style tests as unit tests; the advantage is easier debugging
mojo.outputFile = outputFile;
mojo.artifactMetadataSource = mockArtifactMetadataSource( new HashMap<String, String[]>()
{{
put( "dummy-api", new String[] { "1.0.0", "1.0.1", "1.1.0-M1", "1.2.0-SNAPSHOT" } );
}} );

assertThat( mojo.ruleSet.getIgnoreVersions(), Matchers.hasSize( 3 ) );
mojo.execute();
List<String> output = Files.readAllLines( outputFile.toPath(), UTF_8 );
assertThat( output, not( hasItem( containsString( "1.1.0-M1" ) ) ) );
}
finally
{
assert outputFile == null || !outputFile.exists() || outputFile.delete();
}
}
}

0 comments on commit 6ad99f8

Please sign in to comment.