[java] Cache invalidation - auxClasspath or classpath?

[fflatorre]

Please tag this issue as a question.

Hi,

I'm trying to gt my head around on when the cache gets invalidated.

In the official documentation, among the other reasons, it's mentioned teh cache is invalidated for a change in the auxclasspath :
https://pmd.github.io/pmd-6.0.0/pmd_release_notes_old.html#22-april-2017---560

We are not setting the "auxclasspath" as mentioned in the guide here :
https://pmd.github.io/pmd-6.2.0/pmd_userdocs_tools_ant.html

However, looking at the code :
https://github.com/pmd/pmd/blob/71df067a0dbd27ef78e4c82ca7cc58fd138f65c3/pmd-core/src/main/java/net/sourceforge/pmd/cache/FileAnalysisCache.java

it looks like that is the classpath instead that gets check-summed and then persisted/retrieved from the cache file.

Can anyone please clarify this aspect ?

Cheers,
Francesco

Affects PMD Version:
6.2.0
Rule:
NA
Description:
NA
Code Sample demonstrating the issue:

NA

Running PMD through: [Ant]

[jsotuyod]

@fflatorre over the last few releases the feature has matured a lot. Currently the cache is completely invalidated if

1. The ruleset changed
   

   pmd/pmd-core/src/main/java/net/sourceforge/pmd/cache/AbstractAnalysisCache.java

   Line 107 in 798c027

   LOG.info("Analysis cache invalidated, rulesets changed.");

2. The auxclasspath changed
   

   pmd/pmd-core/src/main/java/net/sourceforge/pmd/cache/AbstractAnalysisCache.java

   Line 120 in 798c027

   LOG.info("Analysis cache invalidated, auxclasspath changed.");

3. The execution classpath chamged
   

   pmd/pmd-core/src/main/java/net/sourceforge/pmd/cache/AbstractAnalysisCache.java

   Line 132 in 798c027

   LOG.info("Analysis cache invalidated, execution classpath changed.");

So, under current releases, both the auxclasspath AND the java classpath invalidates the cache. Moreover, the old code just checked the value of the auxclasspath (file1.jar:file2.jar), but current releases actually check both the order and the contents.

Let me know if you have any questions

[fflatorre]

Cheers @jsotuyod I got lost between releases.
So pull request #687 resolves issue #603 released on 6.1.0 which is the bit I was missing.

Great job !
Francesco