Skip to content

Commit

Permalink
Fix FNs with inner classes when looking for exposed mutable fields fr…
Browse files Browse the repository at this point in the history 
…om Java 11 (#3174)

* Extend detector `FindReturnRef` to detect exposition of references and buffers in nested and inner classes

Tihs patch fixes issue #2042

* switch back the guard clause

* Rewrite the tests to the newer type

* Rename parameter

* Fix merge

* Remove unnecessary imports from tests

* Rename field to not match a restricted identifier

* Spotless apply

* fix changelog merge

* fix changelog after merge

* spelling fix

* small refactor

* revert changes to FindReturnRef detector

* fix EI_EXPOSE_REP2 FNs

* fix FNs and tests

* add testcase with multilevel nested classes

* move FindReturnRef code examples to exposemutable package

* fix issue

* rename FindReturnRef example classes

* fix unconnected issues in FindReturnRef examples + spotlessApply

---------

Co-authored-by: Ádám Balogh <[email protected]>
Co-authored-by: Balogh, Ádám <[email protected]>
  • Loading branch information
@JuditKnoll @baloghadamsoftware
3 people authored Oct 31, 2024
1 parent ba73fa1 commit d37c057
Show file tree
Hide file tree
Showing 9 changed files with 824 additions and 65 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Currently the versioning policy of this project follows [Semantic Versioning v2.
- Fixed some CWE mappings ([#3124](https://github.com/spotbugs/spotbugs/pull/3124))
- Recognize some classes as immutable, fixing EI_EXPOSE and MS_EXPOSE FPs ([#3137](https://github.com/spotbugs/spotbugs/pull/3137))
- Do not report UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR for fields initialized in method annotated with TestNG's @BeforeClass. ([#3152](https://github.com/spotbugs/spotbugs/issues/3152))
- Fixed detector `FindReturnRef` not finding references exposed from nested and inner classes ([#2042](https://github.com/spotbugs/spotbugs/issues/2042))

### Cleanup
- Cleanup thread issue and regex issue in test-harness ([#3130](https://github.com/spotbugs/spotbugs/issues/3130))
Expand Down
176 changes: 173 additions & 3 deletions spotbugs-tests/src/test/java/edu/umd/cs/findbugs/detect/FindReturnRefTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
class FindReturnRefTest extends AbstractIntegrationTest {
@Test
void testFindReturnRefTestNegativeChecks() {
performAnalysis("FindReturnRefNegativeTest.class",
"FindReturnRefNegativeTest$Inner.class");
performAnalysis("exposemutable/FindReturnRefNegativeTest.class",
"exposemutable/FindReturnRefNegativeTest$Inner.class");

assertNoExposeBug();
}

@Test
void testFindReturnRefTestChecks() {
performAnalysis("FindReturnRefTest.class");
performAnalysis("exposemutable/FindReturnRefTest.class");

assertBugTypeCount("EI_EXPOSE_BUF", 2);
assertBugTypeCount("EI_EXPOSE_BUF2", 2);
Expand Down Expand Up @@ -69,6 +69,176 @@ void testFindReturnRefTestChecks() {
assertBugInMethodAtField("MS_EXPOSE_REP", "FindReturnRefTest", "getStaticDateArray2", "sDateArray");
}

@Test
void testExposeMutableFromInner() {
performAnalysis("exposemutable/ExposeMutableFromInner.class",
"exposemutable/ExposeMutableFromInner$Nested.class",
"exposemutable/ExposeMutableFromInner$Inner.class");

assertBugTypeCount("EI_EXPOSE_BUF", 2);
assertBugTypeCount("EI_EXPOSE_BUF2", 2);
assertBugTypeCount("EI_EXPOSE_REP", 6);
assertBugTypeCount("EI_EXPOSE_REP2", 6);
assertBugTypeCount("EI_EXPOSE_STATIC_BUF2", 2);
assertBugTypeCount("EI_EXPOSE_STATIC_REP2", 6);
assertBugTypeCount("MS_EXPOSE_BUF", 2);
assertBugTypeCount("MS_EXPOSE_REP", 6);

assertBugInMethodAtField("EI_EXPOSE_BUF", "ExposeMutableFromInner$Inner", "getBufferWrap", "charArray");
assertBugInMethodAtField("EI_EXPOSE_BUF", "ExposeMutableFromInner$Inner", "getBufferDuplicate", "charBuf");

assertBugInMethodAtField("EI_EXPOSE_BUF2", "ExposeMutableFromInner$Inner", "setBufferDuplicate", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_BUF2", "ExposeMutableFromInner$Inner", "setBufferWrap", "charBuf");

assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromInner$Inner", "getBuffer", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromInner$Inner", "getDate", "date");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromInner$Inner", "getDate2", "date");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromInner$Inner", "getDateArray", "dateArray");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromInner$Inner", "getValues", "hm");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromInner$Inner", "getDateArray2", "dateArray");

assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromInner$Inner", "setBuffer", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromInner$Inner", "setDate", "date");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromInner$Inner", "setDate2", "date");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromInner$Inner", "setDateArray", "dateArray");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromInner$Inner", "setValues", "hm");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromInner$Inner", "setDateArray2", "dateArray");

assertBugInMethodAtField("EI_EXPOSE_STATIC_BUF2", "ExposeMutableFromInner$Nested", "setStaticBufferDuplicate", "sCharBuf");
assertBugInMethodAtField("EI_EXPOSE_STATIC_BUF2", "ExposeMutableFromInner$Nested", "setStaticBufferWrap", "sCharBuf");

assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromInner$Nested", "setStaticBuffer", "sCharBuf");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromInner$Nested", "setStaticDate", "sDate");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromInner$Nested", "setStaticDate2", "sDate");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromInner$Nested", "setStaticDateArray", "sDateArray");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromInner$Nested", "setStaticValues", "shm");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromInner$Nested", "setStaticDateArray2", "sDateArray");

assertBugInMethodAtField("MS_EXPOSE_BUF", "ExposeMutableFromInner$Nested", "getStaticBufferWrap", "sCharArray");
assertBugInMethodAtField("MS_EXPOSE_BUF", "ExposeMutableFromInner$Nested", "getStaticBufferDuplicate", "sCharBuf");

assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromInner$Nested", "getStaticBuffer", "sCharBuf");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromInner$Nested", "getStaticDate", "sDate");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromInner$Nested", "getStaticDate2", "sDate");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromInner$Nested", "getStaticDateArray", "sDateArray");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromInner$Nested", "getStaticValues", "shm");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromInner$Nested", "getStaticDateArray2", "sDateArray");
}

@Test
void testExposeInnerMutableChecks() {
performAnalysis("exposemutable/ExposeInnerMutable.class",
"exposemutable/ExposeInnerMutable$Nested.class");

assertBugTypeCount("EI_EXPOSE_BUF", 2);
assertBugTypeCount("EI_EXPOSE_BUF2", 2);
assertBugTypeCount("EI_EXPOSE_REP", 6);
assertBugTypeCount("EI_EXPOSE_REP2", 6);
assertBugTypeCount("EI_EXPOSE_STATIC_BUF2", 2);
assertBugTypeCount("EI_EXPOSE_STATIC_REP2", 6);
assertBugTypeCount("MS_EXPOSE_BUF", 2);
assertBugTypeCount("MS_EXPOSE_REP", 6);

assertBugInMethodAtField("EI_EXPOSE_BUF", "ExposeInnerMutable$Nested", "getBufferWrap", "charArray");
assertBugInMethodAtField("EI_EXPOSE_BUF", "ExposeInnerMutable$Nested", "getBufferDuplicate", "charBuf");

assertBugInMethodAtField("EI_EXPOSE_BUF2", "ExposeInnerMutable$Nested", "setBufferDuplicate", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_BUF2", "ExposeInnerMutable$Nested", "setBufferWrap", "charBuf");

assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeInnerMutable$Nested", "getBuffer", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeInnerMutable$Nested", "getDate", "date");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeInnerMutable$Nested", "getDate2", "date");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeInnerMutable$Nested", "getDateArray", "dateArray");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeInnerMutable$Nested", "getValues", "hm");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeInnerMutable$Nested", "getDateArray2", "dateArray");

assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeInnerMutable$Nested", "setBuffer", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeInnerMutable$Nested", "setDate", "date");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeInnerMutable$Nested", "setDate2", "date");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeInnerMutable$Nested", "setDateArray", "dateArray");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeInnerMutable$Nested", "setValues", "hm");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeInnerMutable$Nested", "setDateArray2", "dateArray");

assertBugInMethodAtField("EI_EXPOSE_STATIC_BUF2", "ExposeInnerMutable$Nested", "setStaticBufferDuplicate", "sCharBuf");
assertBugInMethodAtField("EI_EXPOSE_STATIC_BUF2", "ExposeInnerMutable$Nested", "setStaticBufferWrap", "sCharBuf");

assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeInnerMutable$Nested", "setStaticBuffer", "sCharBuf");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeInnerMutable$Nested", "setStaticDate", "sDate");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeInnerMutable$Nested", "setStaticDate2", "sDate");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeInnerMutable$Nested", "setStaticDateArray", "sDateArray");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeInnerMutable$Nested", "setStaticValues", "shm");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeInnerMutable$Nested", "setStaticDateArray2", "sDateArray");

assertBugInMethodAtField("MS_EXPOSE_BUF", "ExposeInnerMutable$Nested", "getStaticBufferWrap", "sCharArray");
assertBugInMethodAtField("MS_EXPOSE_BUF", "ExposeInnerMutable$Nested", "getStaticBufferDuplicate", "sCharBuf");

assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeInnerMutable$Nested", "getStaticBuffer", "sCharBuf");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeInnerMutable$Nested", "getStaticDate", "sDate");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeInnerMutable$Nested", "getStaticDate2", "sDate");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeInnerMutable$Nested", "getStaticDateArray", "sDateArray");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeInnerMutable$Nested", "getStaticValues", "shm");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeInnerMutable$Nested", "getStaticDateArray2", "sDateArray");
}

@Test
void testExposeMutableFromMutilevelInnerChecks() {
performAnalysis("exposemutable/ExposeMutableFromMutilevelInner.class",
"exposemutable/ExposeMutableFromMutilevelInner$MiddleStatic.class",
"exposemutable/ExposeMutableFromMutilevelInner$Middle.class",
"exposemutable/ExposeMutableFromMutilevelInner$MiddleStatic$Nested.class",
"exposemutable/ExposeMutableFromMutilevelInner$Middle$Inner.class");

assertBugTypeCount("EI_EXPOSE_BUF", 2);
assertBugTypeCount("EI_EXPOSE_BUF2", 2);
assertBugTypeCount("EI_EXPOSE_REP", 6);
assertBugTypeCount("EI_EXPOSE_REP2", 6);
assertBugTypeCount("EI_EXPOSE_STATIC_BUF2", 2);
assertBugTypeCount("EI_EXPOSE_STATIC_REP2", 6);
assertBugTypeCount("MS_EXPOSE_BUF", 2);
assertBugTypeCount("MS_EXPOSE_REP", 6);

assertBugInMethodAtField("EI_EXPOSE_BUF", "ExposeMutableFromMutilevelInner$Middle$Inner", "getBufferWrap", "charArray");
assertBugInMethodAtField("EI_EXPOSE_BUF", "ExposeMutableFromMutilevelInner$Middle$Inner", "getBufferDuplicate", "charBuf");

assertBugInMethodAtField("EI_EXPOSE_BUF2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setBufferDuplicate", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_BUF2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setBufferWrap", "charBuf");

assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromMutilevelInner$Middle$Inner", "getBuffer", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromMutilevelInner$Middle$Inner", "getDate", "date");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromMutilevelInner$Middle$Inner", "getDate2", "date");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromMutilevelInner$Middle$Inner", "getDateArray", "dateArray");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromMutilevelInner$Middle$Inner", "getValues", "hm");
assertBugInMethodAtField("EI_EXPOSE_REP", "ExposeMutableFromMutilevelInner$Middle$Inner", "getDateArray2", "dateArray");

assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setBuffer", "charBuf");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setDate", "date");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setDate2", "date");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setDateArray", "dateArray");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setValues", "hm");
assertBugInMethodAtField("EI_EXPOSE_REP2", "ExposeMutableFromMutilevelInner$Middle$Inner", "setDateArray2", "dateArray");

assertBugInMethodAtField("EI_EXPOSE_STATIC_BUF2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticBufferDuplicate",
"sCharBuf");
assertBugInMethodAtField("EI_EXPOSE_STATIC_BUF2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticBufferWrap", "sCharBuf");

assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticBuffer", "sCharBuf");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticDate", "sDate");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticDate2", "sDate");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticDateArray", "sDateArray");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticValues", "shm");
assertBugInMethodAtField("EI_EXPOSE_STATIC_REP2", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "setStaticDateArray2", "sDateArray");

assertBugInMethodAtField("MS_EXPOSE_BUF", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticBufferWrap", "sCharArray");
assertBugInMethodAtField("MS_EXPOSE_BUF", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticBufferDuplicate", "sCharBuf");

assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticBuffer", "sCharBuf");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticDate", "sDate");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticDate2", "sDate");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticDateArray", "sDateArray");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticValues", "shm");
assertBugInMethodAtField("MS_EXPOSE_REP", "ExposeMutableFromMutilevelInner$MiddleStatic$Nested", "getStaticDateArray2", "sDateArray");
}

@Test
@DisabledOnJre({ JRE.JAVA_8, JRE.JAVA_11 })
void testUnmodifiableClass() {
Expand Down
Loading

0 comments on commit d37c057

Please sign in to comment.