Skip to content

Fix matching against one of multiple env-variables pointing to one JDK #148

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

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

Fix matching against one of multiple env-variables pointing to one JDK #148

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
30 changes: 30 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,34 @@ under the License.
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>run-its</id>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.6.1</version>
<executions>
<execution>
<id>sanitize-java-home</id>
<goals>
<goal>regex-property</goal>
</goals>
<!-- Prevent it-test failures on Windows due to interpretation of back-slashes in paths.-->
Copy link
Copy Markdown
Member

@slawekjaranowski slawekjaranowski Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks strange ... how it will be in real environments ... users on Windows will have such values

Copy link
Copy Markdown
Author

@HannesWell HannesWell Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no clue. But if you can tell me how to do it properly, I'm happy to change/remove that.

<configuration>
<name>java.home.sanitized</name>
<value>${java.home}</value>
<regex>\\</regex>
<replacement>/</replacement>
<failIfNoMatch>false</failIfNoMatch>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>
20 changes: 20 additions & 0 deletions src/it/select-jdk-env-multi/invoker.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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.

invoker.goals = compile
invoker.environmentVariables.JAVA_X_HOME = ${java.home.sanitized}
invoker.environmentVariables.JAVA_Y_HOME = ${java.home.sanitized}
54 changes: 54 additions & 0 deletions src/it/select-jdk-env-multi/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.apache.maven.plugins.toolchains.its</groupId>
<artifactId>select-jdk-toolchain-range</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>

<name>maven-toolchains-plugin IT: select jdk toolchain test with environment variable</name>
<description>Check that jdk toolchain can be selected when multiple environment variables are used</description>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-toolchains-plugin</artifactId>
<version>@project.version@</version>
<configuration>
<env>JAVA_X_HOME</env>
</configuration>
<executions>
<execution>
<goals>
<goal>select-jdk-toolchain</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
2 changes: 1 addition & 1 deletion src/main/java/org/apache/maven/plugins/toolchain/jdk/SelectJdkToolchainMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ private boolean matches(String key, String reqVal, String tcVal) {
case VERSION:
return RequirementMatcherFactory.createVersionMatcher(tcVal).matches(reqVal);
case ENV:
return reqVal.matches("(.*,|^)\\Q" + tcVal + "\\E(,.*|$)");
return tcVal.matches("(.*,|^)\\Q" + reqVal + "\\E(,.*|$)");
Copy link
Copy Markdown
Member

@slawekjaranowski slawekjaranowski Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a unit test will be appreciated for such code

Copy link
Copy Markdown
Author

@HannesWell HannesWell Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I already wanted to add one.
But I found only one very basic test for this at all and setting up a complete new test infrastructure for this was a bit too much work for me at the moment. :/

Copy link
Copy Markdown
Author

@HannesWell HannesWell Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a second look and maybe it's simpler than assumed. And I oversaw the IT tests.
But I assume a unit test would be possible relatively easy.
I'm looking into it.

Copy link
Copy Markdown
Member

@slawekjaranowski slawekjaranowski Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unit test will be enough, I'm fine to make method package protected and simply test it,
eg. we can provide many examples by parameterized test

Copy link
Copy Markdown
Author

@HannesWell HannesWell Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've now figured out how to setup an integration test (and handle the trickery of Windows path with back-slashes).

Setting up a unit test would probably also be possible with the adjustments you mentioned, but since the most relevant part of the logic is in the Mojo, would again need more non trivial test setup.

default:
return RequirementMatcherFactory.createExactMatcher(tcVal).matches(reqVal);
}
Expand Down
Loading