[3.8.x][MNG-7407] Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable #674

laeubi · 2022-02-02T09:08:26Z

Currently the handling for https://maven.apache.org/maven-ci-friendly.html is hard wired into maven.

For Tycho we like to replace/extend the default handling for this to supply the user with some automatic derived values for some of the variables.

This PR extracts the parts of that handling in a new ModelVersionProcessor that has the current behavior as a default implemented. This not only makes it more clear how this is handled (no cross references between DefaultModelValidator and AbstractStringBasedModelInterpolator required) but also allows to override the handling by a core extension.

FYI @mickaelistria @akurtakov

Following this checklist to help us incorporate your
contribution quickly and easily:

Make sure there is a JIRA issue filed
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
Each commit in the pull request should have a meaningful subject line and body.
Format the pull request title like [MNG-XXX] SUMMARY, where you replace MNG-XXX
and SUMMARY with the appropriate JIRA issue. Best practice is to use the JIRA issue
title in the pull request title and in the first line of the commit message.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Run mvn clean verify to make sure basic checks pass. A more thorough check will
be performed on your pull request automatically.
You have run the Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.

michael-o · 2022-02-06T14:49:26Z

...builder/src/main/java/org/apache/maven/model/interpolation/DefaultModelVersionProcessor.java

+        }
+        if ( request.getSystemProperties().containsKey( SHA1_PROPERTY ) )
+        {
+            modelProperties.put( SHA1_PROPERTY, request.getSystemProperties().get( SHA1_PROPERTY ) );


@rfscholte I believe that this is a bug in our code since those are are supposed to be user properties and not system properties or we need to support both. @laeubi Not a regression from you, but an observation.

As far as I understand the idea ias that system properties given on the command line take precedence over everything else.

True, but those are not system properties, those are user properties. A common misconception and badly coined in the Maven core codebase. See:

maven/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java

Lines 1743 to 1753 in 4476026

private static void setCliProperty( String name, String value, Properties properties )

{

properties.setProperty( name, value );

// ----------------------------------------------------------------------

// I'm leaving the setting of system properties here as not to break

// the SystemPropertyProfileActivator. This won't harm embedding. jvz.

// ----------------------------------------------------------------------

System.setProperty( name, value );

}

Okay I have changed the PR accordingly.

@rfscholte I believe that this is a bug in our code since those are are supposed to be user properties and not system properties or we need to support both.

It should be at least user properties. That's probably enough, as I expect that's the way CI servers can provide a value.

michael-o

Looks sane to me, needs testing though. Open questions:

Why for Maven 3.8.x only? No master?
The title is misleading. What you actually did is to move a default implementation to a replace component. @cstamas Did this also in resolver. May be can better rewording this to something like: Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable
Can this be covered by a test somehow?

laeubi · 2022-02-06T16:14:56Z

* Why for Maven 3.8.x only? No master?

I can open a PR for master also.

* The title is misleading. What you actually did is to move a default implementation to a replace component. @cstamas Did this also in resolver. May be can better rewording this to something like: Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable

Sure do you simply want to rename the PR or should I do so?

* Can this be covered by a test somehow?

There are already some tests for this functionality that also run fine with this changes.

michael-o · 2022-02-06T16:28:43Z

* Why for Maven 3.8.x only? No master?
I can open a PR for master also.

Yes, please.

* The title is misleading. What you actually did is to move a default implementation to a replace component. @cstamas Did this also in resolver. May be can better rewording this to something like: Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable

Sure do you simply want to rename the PR or should I do so?

Yes, please. PR and JIRA issue.

* Can this be covered by a test somehow?
There are already some tests for this functionality that also run fine with this changes.

Please point me to them.

laeubi · 2022-02-06T17:19:56Z

Please point me to them.

I think this is where it is tested

maven/maven-model-builder/src/test/java/org/apache/maven/model/validation/DefaultModelValidatorTest.java

Lines 804 to 860 in 6ca13af

    
           public void testCiFriendlySha1() 
        
               throws Exception 
        
           { 
        
               SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-sha1.xml" ); 
        
               assertViolations( result, 0, 0, 0 ); 
        
           } 
        
           @Test 
        
           public void testCiFriendlyRevision() 
        
               throws Exception 
        
           { 
        
               SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-revision.xml" ); 
        
               assertViolations( result, 0, 0, 0 ); 
        
           } 
        
           @Test 
        
           public void testCiFriendlyChangeList() 
        
               throws Exception 
        
           { 
        
               SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-changelist.xml" ); 
        
               assertViolations( result, 0, 0, 0 ); 
        
           } 
        
           @Test 
        
           public void testCiFriendlyAllExpressions() 
        
               throws Exception 
        
           { 
        
               SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-all-expressions.xml" ); 
        
               assertViolations( result, 0, 0, 0 ); 
        
           } 
        
           @Test 
        
           public void testCiFriendlyBad() 
        
               throws Exception 
        
           { 
        
               SimpleProblemCollector result = validateRaw( "raw-model/bad-ci-friendly.xml" ); 
        
               assertViolations( result, 0, 0, 1 ); 
        
               assertEquals( "'version' contains an expression but should be a constant.", result.getWarnings().get( 0 ) ); 
        
           } 
        
           @Test 
        
           public void testCiFriendlyBadSha1Plus() 
        
               throws Exception 
        
           { 
        
               SimpleProblemCollector result = validateRaw( "raw-model/bad-ci-friendly-sha1plus.xml" ); 
        
               assertViolations( result, 0, 0, 1 ); 
        
               assertEquals( "'version' contains an expression but should be a constant.", result.getWarnings().get( 0 ) ); 
        
           } 
        
           @Test 
        
           public void testCiFriendlyBadSha1Plus2() 
        
               throws Exception 
        
           { 
        
               SimpleProblemCollector result = validateRaw( "raw-model/bad-ci-friendly-sha1plus2.xml" ); 
        
               assertViolations( result, 0, 0, 1 ); 
        
               assertEquals( "'version' contains an expression but should be a constant.", result.getWarnings().get( 0 ) ); 
        
           }

laeubi · 2022-02-06T17:24:08Z

Title updated as you suggested.

michael-o · 2022-02-06T17:33:30Z

Please point me to them.

I think this is where it is tested

maven/maven-model-builder/src/test/java/org/apache/maven/model/validation/DefaultModelValidatorTest.java

Lines 804 to 860 in 6ca13af

public void testCiFriendlySha1()

throws Exception

{

SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-sha1.xml" );

assertViolations( result, 0, 0, 0 );

}

@Test

public void testCiFriendlyRevision()

throws Exception

{

SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-revision.xml" );

assertViolations( result, 0, 0, 0 );

}

@Test

public void testCiFriendlyChangeList()

throws Exception

{

SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-changelist.xml" );

assertViolations( result, 0, 0, 0 );

}

@Test

public void testCiFriendlyAllExpressions()

throws Exception

{

SimpleProblemCollector result = validateRaw( "raw-model/ok-ci-friendly-all-expressions.xml" );

assertViolations( result, 0, 0, 0 );

}

@Test

public void testCiFriendlyBad()

throws Exception

{

SimpleProblemCollector result = validateRaw( "raw-model/bad-ci-friendly.xml" );

assertViolations( result, 0, 0, 1 );

assertEquals( "'version' contains an expression but should be a constant.", result.getWarnings().get( 0 ) );

}

@Test

public void testCiFriendlyBadSha1Plus()

throws Exception

{

SimpleProblemCollector result = validateRaw( "raw-model/bad-ci-friendly-sha1plus.xml" );

assertViolations( result, 0, 0, 1 );

assertEquals( "'version' contains an expression but should be a constant.", result.getWarnings().get( 0 ) );

}

@Test

public void testCiFriendlyBadSha1Plus2()

throws Exception

{

SimpleProblemCollector result = validateRaw( "raw-model/bad-ci-friendly-sha1plus2.xml" );

assertViolations( result, 0, 0, 1 );

assertEquals( "'version' contains an expression but should be a constant.", result.getWarnings().get( 0 ) );

}

Indeed, this should be enough for the default implementation.

laeubi · 2022-02-06T18:24:49Z

I can open a PR for master also.

Yes, please.

Done: #675

michael-o · 2022-02-13T10:47:59Z

Please rebase

Versions pluggable

laeubi · 2022-02-13T14:54:39Z

Please rebase

Done.

…endly Versions pluggable This closes #674

michael-o · 2022-02-19T17:08:34Z

Merged.

This was referenced Feb 2, 2022

Support setting CI-Friendly-Versions in tycho-build-extension eclipse-tycho/tycho#611

Closed

Allow some kind of "releaseBuildVersion" eclipse-tycho/tycho#603

Closed

michael-o reviewed Feb 6, 2022

View reviewed changes

laeubi changed the title ~~MNG-7407 Allow core-extension to override default CI-Firendly-Versions handling~~ [3.8.x][MNG-7407] Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable Feb 6, 2022

laeubi force-pushed the MNG-7407-3.8.x branch from 0ec6ebf to ac42c96 Compare February 6, 2022 17:23

MNG-7407 Introduce a ModelVersionProcessor component to make CI Friends

5f9cfa1

Versions pluggable

laeubi force-pushed the MNG-7407-3.8.x branch from ac42c96 to 5f9cfa1 Compare February 13, 2022 14:54

asfgit pushed a commit that referenced this pull request Feb 19, 2022

[MNG-7407] Introduce a ModelVersionProcessor component to make CI Fri…

3777126

…endly Versions pluggable This closes #674

asfgit pushed a commit that referenced this pull request Feb 19, 2022

[MNG-7407] Introduce a ModelVersionProcessor component to make CI Fri…

2bb1228

…endly Versions pluggable This closes #674

michael-o closed this Feb 19, 2022

michael-o mentioned this pull request Feb 20, 2022

[MNG-7417] Several classes do not set properties properly for building requests #306

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[3.8.x][MNG-7407] Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable #674

[3.8.x][MNG-7407] Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable #674

laeubi commented Feb 2, 2022 •

edited

Loading

michael-o Feb 6, 2022

laeubi Feb 6, 2022

michael-o Feb 6, 2022

laeubi Feb 6, 2022

rfscholte Feb 7, 2022

michael-o left a comment •

edited

Loading

laeubi commented Feb 6, 2022

michael-o commented Feb 6, 2022 •

edited

Loading

laeubi commented Feb 6, 2022

laeubi commented Feb 6, 2022

michael-o commented Feb 6, 2022

laeubi commented Feb 6, 2022

michael-o commented Feb 13, 2022

laeubi commented Feb 13, 2022

michael-o commented Feb 19, 2022

	private static void setCliProperty( String name, String value, Properties properties )
	{
	properties.setProperty( name, value );

	// ----------------------------------------------------------------------
	// I'm leaving the setting of system properties here as not to break
	// the SystemPropertyProfileActivator. This won't harm embedding. jvz.
	// ----------------------------------------------------------------------

	System.setProperty( name, value );
	}

[3.8.x][MNG-7407] Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable #674

[3.8.x][MNG-7407] Introduce a ModelVersionProcessor component to make CI Friends Versions pluggable #674

Conversation

laeubi commented Feb 2, 2022 • edited Loading

michael-o Feb 6, 2022

Choose a reason for hiding this comment

laeubi Feb 6, 2022

Choose a reason for hiding this comment

michael-o Feb 6, 2022

Choose a reason for hiding this comment

laeubi Feb 6, 2022

Choose a reason for hiding this comment

rfscholte Feb 7, 2022

Choose a reason for hiding this comment

michael-o left a comment • edited Loading

Choose a reason for hiding this comment

laeubi commented Feb 6, 2022

michael-o commented Feb 6, 2022 • edited Loading

laeubi commented Feb 6, 2022

laeubi commented Feb 6, 2022

michael-o commented Feb 6, 2022

laeubi commented Feb 6, 2022

michael-o commented Feb 13, 2022

laeubi commented Feb 13, 2022

michael-o commented Feb 19, 2022

laeubi commented Feb 2, 2022 •

edited

Loading

michael-o left a comment •

edited

Loading

michael-o commented Feb 6, 2022 •

edited

Loading