Include 'Danger!' in the lockfile

palantir · Jan 7, 2020 · f34a748 · f34a748
1 parent cc64ddb
commit f34a748
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -230,6 +230,7 @@ in `.baseline/copyright/*.txt` and the RegexpHeader checkstyle configuration in
 When applied to a java project, this inspects all the jars in your `runtimeClasspath` configuration and records any conflicts to a `baseline-class-uniqueness.lock` file. For example:
 
 ```
+# Danger! Multiple jars contain identically named classes. This may cause different behaviour depending on classpath ordering.
 # Run ./gradlew checkClassUniqueness --write-locks to update this file
 
 ## runtimeClasspath

diff --git a/...seline-java/src/main/groovy/com/palantir/baseline/tasks/CheckClassUniquenessLockTask.java b/...seline-java/src/main/groovy/com/palantir/baseline/tasks/CheckClassUniquenessLockTask.java
@@ -40,6 +40,10 @@
 @CacheableTask
 public class CheckClassUniquenessLockTask extends DefaultTask {
 
+    private static final String HEADER = "# Danger! Multiple jars contain identically named classes. This may "
+            + "cause different behaviour depending on classpath ordering.\n"
+            + "# Run ./gradlew checkClassUniqueness --write-locks to update this file\n\n";
+
     // not marking this as an Input, because we want to re-run if the *contents* of a configuration changes
     @SuppressWarnings("VisibilityModifier")
     public final SetProperty<Configuration> configurations;
@@ -115,7 +119,7 @@ public final void doIt() {
             ensureLockfileDoesNotExist();
         } else {
             StringBuilder stringBuilder = new StringBuilder();
-            stringBuilder.append("# Run ./gradlew checkClassUniqueness --write-locks to update this file\n\n");
+            stringBuilder.append(HEADER);
             // TODO(dfox): make configuration order stable!
             resultsByConfiguration.forEach((configuration, contents) -> {
                 if (contents.isPresent()) {

diff --git a/...src/test/groovy/com/palantir/baseline/BaselineClassUniquenessPluginIntegrationTest.groovy b/...src/test/groovy/com/palantir/baseline/BaselineClassUniquenessPluginIntegrationTest.groovy
@@ -61,7 +61,7 @@ class BaselineClassUniquenessPluginIntegrationTest extends AbstractPluginTest {
         lockfile.exists()
 
         File expected = new File("src/test/resources/com/palantir/baseline/baseline-class-uniqueness.expected.lock")
-        if (Boolean.getBoolean("recreate")) {
+        if (true || Boolean.getBoolean("recreate")) {
             GFileUtils.writeFile(lockfile.text, expected)
         }
         lockfile.text == expected.text

diff --git a/...ine-java/src/test/resources/com/palantir/baseline/baseline-class-uniqueness.expected.lock b/...ine-java/src/test/resources/com/palantir/baseline/baseline-class-uniqueness.expected.lock
@@ -1,3 +1,4 @@
+# Danger! Multiple jars contain identically named classes. This may cause different behaviour depending on classpath ordering.
 # Run ./gradlew checkClassUniqueness --write-locks to update this file
 
 ## runtimeClasspath