Maven profiles, active profiles, and activeByDefault

[crankydillo]

We have a settings.xml file that has an activeProfile specified. We have many parent pom files that have profiles with <activeByDefault>true</active>. We primarily use this to group sets of managed dependencies. All of this builds and works fine with Maven; however, it does not with openrewrite.

My read of Maven's doc on activeByDefault is the activeByDefault=true profiles should be active in poms that do not have a profile with the same id as the active one specified in our settings.xml.

What version of OpenRewrite are you using?

• OpenRewrite v8.27.4
• Maven/Gradle plugin v5.33.0
• rewrite module

How are you running OpenRewrite?

Maven plugin + https://github.com/openrewrite/rewrite/blob/main/rewrite-maven/src/main/java/org/openrewrite/maven/ChangeDependencyGroupIdAndArtifactId.java

What is the smallest, simplest way to reproduce the problem?

TEST PR. If I've misunderstood some of your testing libs, I can give a sample project that will show the problem.

What did you expect to see?

Test to pass (maven dependency versions resolved)

What did you see instead?

Failure to resolve Maven dependency versions

Are you interested in contributing a fix to OpenRewrite?

Took a peek, but may bit a bit too extensive for how much time I have...

[crankydillo]

What do you think @timtebeek ? Does this look like a bug to you? If it's not high on your priority list, we can work on it. We just want to make sure you agree it's a bug before doing that.

[timtebeek]

Hi! I've pushed a small change to your reproducer to make that pass locally; I think the order of the pom files matters for the tests.

• Disabled test showing issues with profiles and activeByDefault=true #4270

Might there be anything else needed to replicate the issue you're seeing locally?

[crankydillo]

I will continue to work on this, but the intent is to mimic behavior when a Maven settings file has a section like this:

<activeProfiles>
       <activeProfile>foobar</activeProfile>
</activeProfiles>

When I try to perform an actual rewrite on a real project, ResolvePom#activeProfiles will be foobar and that seems to throw everything off. I will soon push a change that I think may represent this with these test-based rewrite libs, but I'm still learning how to work with those, so if you can help me represent in the test what I describe above correctly, I would appreciate it:)

Alternatively, I can push a project-based adhoc reproducer. I mean mimic what I'm really trying to do..

[timtebeek]

Perhaps seeing the implementation of this method will help you more faithfully reproduce what you're after with a unit test.

rewrite/rewrite-maven/src/main/java/org/openrewrite/maven/Assertions.java

Lines 30 to 35 in 26feaab

	static void customizeExecutionContext(ExecutionContext ctx) {
	if(MavenSettings.readFromDiskEnabled()) {
	MavenExecutionContextView mctx = MavenExecutionContextView.view(ctx);
	mctx.setMavenSettings(MavenSettings.readMavenSettingsFromDisk(mctx));
	}
	}

[crankydillo]

Perhaps seeing the implementation of this method will help you more faithfully reproduce what you're after with a unit test.

rewrite/rewrite-maven/src/main/java/org/openrewrite/maven/Assertions.java

Lines 30 to 35 in 26feaab

	static void customizeExecutionContext(ExecutionContext ctx) {
	if(MavenSettings.readFromDiskEnabled()) {
	MavenExecutionContextView mctx = MavenExecutionContextView.view(ctx);
	mctx.setMavenSettings(MavenSettings.readMavenSettingsFromDisk(mctx));
	}
	}

I have been trying some variations of that:). I did push changes that I hope does better with this commit. Let me know if there's a better way to craft the test or you need me to submit an adhoc project.

[crankydillo]

I went ahead and created an adhoc test here. Apologies for hijacking your repo. I do have a reason:)

[crankydillo]

Please ignore the 'Another adhoc' + 3 following commits above. That is a different issue I'm having. Sorry about that.

[crankydillo]

@timtebeek Sorry to pester, but I am:) Did you take a peek? I have an idea on a fix, but don't want to start that if you don't see this as an issue. Of course, we'd love it if you could fix or let us know where this lands on the priority list.

[timtebeek]

Hi @crankydillo ; Apologies for the delayed response; it's at times hard to get to everything.

I've pushed yet another change to your PR to (I think) set the active profile correctly. That again makes the test pass. With that test passing I feel I still don't fully understand the issue you're having, and how settings.xml factors in.

I can see the various pom.xml files you have, and the profiles in those, and how you set a different active profile "foobar". I'd expect that to still keep active-profile-1 and active-profile-2 active, but perhaps you have other ideas.

Any help towards solving a problem is of course appreciated, and perhaps helps explain the issue too, but for now it's a bit unclear to me still. Please note that you're always welcome in our Slack as well, if you'd prefer a more synchronous response.

[crankydillo]

Hi @crankydillo ; Apologies for the delayed response; it's at times hard to get to everything.

No need to apologize @timtebeek and thanks for reminder about slack:). Very appreciative of you looking at this!

I've pushed yet another change to your PR to (I think) set the active profile correctly. That again makes the test pass. With that test passing I feel I still don't fully understand the issue you're having, and how settings.xml factors in.

I dropped a comment on your change. One of the things that has become clear over the past few days is I don't fully understand rewriteRun, mavenProject, etc enough to use them correctly. In this case, I created this adhoc project, which is supposed to mimic our scenario and the issue I've reported here.

If you use the 'does not work' scenario, mvnDebug, and put a breakpoint ProfileActivation.isActive, you should see the issue. If the behavior of the rewrite code is correct, then I don't think a 'normal' Maven build would even work because it wouldn't be able to resolve the dependencies. However, it does.

I can see the various pom.xml files you have, and the profiles in those, and how you set a different active profile "foobar". I'd expect that to still keep active-profile-1 and active-profile-2 active, but perhaps you have other ideas.

Yes, this is our expectation as well. However, it does not appear to be the case. Might be better to work with the adhoc test I have above.

Any help towards solving a problem is of course appreciated, and perhaps helps explain the issue too, but for now it's a bit unclear to me still.

I may go ahead and work on a fix, but the root of the issue is that a profile that has <activeByDefault>true</activeByDefault> should be considered active even if a set of active profiles is specified from command-line, settings.xml, etc (e.g. user-specified active profiles), unless the particular pom that has activeByDefault profiles contains a profile from the set of user-specified active profiles. Maven doc on this.