-
Notifications
You must be signed in to change notification settings - Fork 33
Fix potential NPE in getJdkHome() with null guards #185
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.
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
elharo
wants to merge
1
commit into
apache:master
Choose a base branch
from
elharo:fix-npe-getJdkHome
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+119
−3
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
src/test/java/org/apache/maven/plugins/toolchain/jdk/SelectJdkToolchainMojoTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
| package org.apache.maven.plugins.toolchain.jdk; | ||
|
|
||
| import java.lang.reflect.Method; | ||
| import java.util.Map; | ||
|
|
||
| import org.apache.maven.toolchain.ToolchainPrivate; | ||
| import org.apache.maven.toolchain.model.ToolchainModel; | ||
| import org.codehaus.plexus.util.xml.Xpp3Dom; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertNull; | ||
|
|
||
| class SelectJdkToolchainMojoTest { | ||
|
|
||
| @Test | ||
| void testGetJdkHomeWithNonXpp3DomConfiguration() throws Exception { | ||
| ToolchainModel model = new ToolchainModel(); | ||
| model.setConfiguration("string-config"); | ||
| ToolchainPrivate toolchain = createStub(model); | ||
| assertNull(invokeGetJdkHome(toolchain)); | ||
| } | ||
|
|
||
| @Test | ||
| void testGetJdkHomeWithNullModel() throws Exception { | ||
| ToolchainPrivate toolchain = createStub(null); | ||
| assertNull(invokeGetJdkHome(toolchain)); | ||
| } | ||
|
|
||
| @Test | ||
| void testGetJdkHomeWithNullConfiguration() throws Exception { | ||
| ToolchainModel model = new ToolchainModel(); | ||
| model.setConfiguration(null); | ||
| ToolchainPrivate toolchain = createStub(model); | ||
| assertNull(invokeGetJdkHome(toolchain)); | ||
| } | ||
|
|
||
| @Test | ||
| void testGetJdkHomeWithMissingJdkHomeChild() throws Exception { | ||
| Xpp3Dom config = new Xpp3Dom("configuration"); | ||
| ToolchainModel model = new ToolchainModel(); | ||
| model.setConfiguration(config); | ||
| ToolchainPrivate toolchain = createStub(model); | ||
| assertNull(invokeGetJdkHome(toolchain)); | ||
| } | ||
|
|
||
| @Test | ||
| void testGetJdkHomeWithValidJdkHome() throws Exception { | ||
| Xpp3Dom config = new Xpp3Dom("configuration"); | ||
| Xpp3Dom jdkHome = new Xpp3Dom("jdkHome"); | ||
| jdkHome.setValue("/path/to/jdk"); | ||
| config.addChild(jdkHome); | ||
| ToolchainModel model = new ToolchainModel(); | ||
| model.setConfiguration(config); | ||
| ToolchainPrivate toolchain = createStub(model); | ||
| assertEquals("/path/to/jdk", invokeGetJdkHome(toolchain)); | ||
| } | ||
|
|
||
| private String invokeGetJdkHome(ToolchainPrivate toolchain) throws Exception { | ||
| SelectJdkToolchainMojo mojo = new SelectJdkToolchainMojo(); | ||
| Method method = SelectJdkToolchainMojo.class.getDeclaredMethod("getJdkHome", ToolchainPrivate.class); | ||
| method.setAccessible(true); | ||
| return (String) method.invoke(mojo, toolchain); | ||
| } | ||
|
|
||
| private ToolchainPrivate createStub(ToolchainModel model) { | ||
| return new ToolchainPrivate() { | ||
| @Override | ||
| public ToolchainModel getModel() { | ||
| return model; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean matchesRequirements(Map<String, String> requirements) { | ||
| return false; | ||
| } | ||
|
|
||
| @Override | ||
| public String getType() { | ||
| return "jdk"; | ||
| } | ||
|
|
||
| @Override | ||
| public String findTool(String toolName) { | ||
| return null; | ||
| } | ||
| }; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does the calling code react when this method returns null? Have we just moved the NullPointerException up a method in the stack?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Objects.equals(null, null) returns true, and Objects.equals(null, "value") returns false. So if we cannot determine the JDK home of the selected toolchain (null), it will not match the current JDK home (unless that is also null), and the IfSame block is simply skipped the toolchain is used as-is. No NPE is moved upstream; the null is handled safely by Objects.equals.