hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

add a test for display name in the cache

Browse Source
This commit is contained in:
Clément Fournier 2023-02-26 16:06:01 +01:00
parent 9e43640834
commit 22871ad03c
No known key found for this signature in database
GPG Key ID: 4D8D42402E4F47E2
1 changed files with 52 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
pmd-core/src/test/java/net/sourceforge/pmd/cache/FileAnalysisCacheTest.java vendored
View File

@ -43,6 +43,7 @@ import net.sourceforge.pmd.lang.document.TextDocument;
import net.sourceforge.pmd.lang.document.TextFile;
import net.sourceforge.pmd.lang.document.TextFileContent;
import net.sourceforge.pmd.lang.document.TextRange2d;
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.reporting.FileAnalysisListener;
class FileAnalysisCacheTest {
@ -142,6 +143,57 @@ class FileAnalysisCacheTest {
assertEquals(textLocation.getEndColumn(), cachedViolation.getEndColumn());
}
@Test
void testDisplayNameIsRespected() throws Exception {
// This checks that the display name of the file is respected even if
// the file is assigned a different display name across runs. The path
// id is saved into the cache file, and the cache implementation updates the
// display name of the violations to match their current display name.
final net.sourceforge.pmd.Rule rule = mock(net.sourceforge.pmd.Rule.class, Mockito.RETURNS_SMART_NULLS);
when(rule.getLanguage()).thenReturn(mock(Language.class));
final TextRange2d textLocation = TextRange2d.range2d(1, 2, 3, 4);
TextFile mockFile = mock(TextFile.class);
when(mockFile.getDisplayName()).thenReturn("display0");
when(mockFile.getPathId()).thenReturn("pathId");
when(mockFile.getLanguageVersion()).thenReturn(dummyVersion);
when(mockFile.readContents()).thenReturn(TextFileContent.fromCharSeq("abc"));
final FileAnalysisCache cache = new FileAnalysisCache(newCacheFile);
cache.checkValidity(mock(RuleSets.class), mock(ClassLoader.class));
try (TextDocument doc0 = TextDocument.create(mockFile)) {
cache.isUpToDate(doc0);
try (FileAnalysisListener listener = cache.startFileAnalysis(doc0)) {
listener.onRuleViolation(new ParametricRuleViolation(rule, FileLocation.range(doc0.getDisplayName(), textLocation), "message"));
}
} finally {
cache.persist();
}
reloadWithOneViolation(mockFile);
// now try with another display name
when(mockFile.getDisplayName()).thenReturn("display2");
reloadWithOneViolation(mockFile);
}
private void reloadWithOneViolation(TextFile mockFile) throws IOException {
final FileAnalysisCache reloadedCache = new FileAnalysisCache(newCacheFile);
reloadedCache.checkValidity(mock(RuleSets.class), mock(ClassLoader.class));
try (TextDocument doc1 = TextDocument.create(mockFile)) {
assertTrue(reloadedCache.isUpToDate(doc1),
"Cache believes unmodified file with violations is not up to date");
List<RuleViolation> cachedViolations = reloadedCache.getCachedViolations(doc1);
assertEquals(1, cachedViolations.size(), "Cached rule violations count mismatch");
final RuleViolation cachedViolation = cachedViolations.get(0);
assertEquals(mockFile.getDisplayName(), cachedViolation.getFilename());
}
}
@Test
void testCacheValidityWithNoChanges() throws IOException {
final RuleSets rs = mock(RuleSets.class);