Skip to content
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

[MSHARED-785] Make ConstantPoolParser ignore classes in unnamed package #21

Closed
wants to merge 3 commits into from

Conversation

jhaber
Copy link
Contributor

@jhaber jhaber commented Aug 3, 2020

The ConstantPoolParser is looking for strings in the constant pool and treating them as references to a class which normally works fine, but it can create false-positives. The most common one we've run into is when there are classes in the unnamed package. For example, dnsjava has a class named update.java:
https://github.com/dnsjava/dnsjava/blob/0e56f37f320793ade4673cb2eaad159bc81d4a8a/update.java

So if you happen to have a string constant named "update", the dependency analyzer is fooled into thinking that this is a reference to update.java from dnsjava.

This PR mitigates the most common case by telling the ConstantPoolParser to ignore strings without a slash, as this should always correspond to a class in the unnamed package. This should never cause a false-negative, as according to the JLS:

types in an unnamed package cannot be imported


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. Also be sure having selected the correct component.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MSHARED-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MSHARED-XXX 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 integration tests successfully (mvn -Prun-its clean verify). ([WARNING] The requested profile "run-its" could not be activated because it does not exist.)

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.

public void testUnnamedPackageClassReference()
throws TestToolsException, ProjectDependencyAnalyzerException
{
if ( !SystemUtils.isJavaVersionAtLeast( JavaVersion.JAVA_1_8 ) )
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a use case for Assume.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍 updated, let me know if you think I should make the same change to other tests in this class

@jhaber
Copy link
Contributor Author

jhaber commented Nov 6, 2020

Gentle bump on this, let me know if there's anything I can do to help move this PR along

@slachiewicz
Copy link
Member

merged, thx @jhaber

@jhaber
Copy link
Contributor Author

jhaber commented Apr 9, 2021

🙇 thanks for integrating the change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants