[#1959] Add ability to test loading resource bundles in annotation pr…

…ocessor Closes #1959
remkop · Feb 17, 2023 · 0ae482f · 0ae482f
1 parent 06fb221
commit 0ae482f
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 5 deletions.
diff --git a/...s/src/test/java/picocli/annotation/processing/tests/AbstractCommandSpecProcessorTest.java b/...s/src/test/java/picocli/annotation/processing/tests/AbstractCommandSpecProcessorTest.java
@@ -7,6 +7,7 @@
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
 import org.junit.Test;
+import picocli.codegen.annotation.processing.AbstractCommandSpecProcessor;
 
 import javax.tools.Diagnostic;
 import javax.tools.JavaFileObject;
@@ -19,8 +20,7 @@
 import static com.google.testing.compile.CompilationSubject.assertThat;
 import static com.google.testing.compile.Compiler.javac;
 import static org.hamcrest.CoreMatchers.containsString;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.*;
 import static picocli.annotation.processing.tests.Resources.slurp;
 import static picocli.annotation.processing.tests.Resources.slurpAll;
 import static picocli.annotation.processing.tests.YamlAssert.compareCommandYamlDump;
@@ -282,13 +282,23 @@ private void validateErrorMessages(Compilation compilation, List<String> expecte
     }
 
     @Test
-    public void testCommandWithBundle() {
+    public void testCommandWithBundleLoaded() {
+        AbstractCommandSpecProcessor.setLoadResourceBundles(true);
         Compilation compilation = compareCommandYamlDump(slurp("/picocli/examples/messages/CommandWithBundle.yaml"),
                 JavaFileObjects.forResource("picocli/examples/messages/CommandWithBundle.java"));
 
         assertOnlySourceVersionWarning(compilation);
     }
 
+    @Test
+    public void testCommandWithBundleNotLoaded() {
+        AbstractCommandSpecProcessor.setLoadResourceBundles(false);
+        Compilation compilation = compareCommandYamlDump(slurp("/picocli/examples/messages/CommandWithBundle-NotLoaded.yaml"),
+            JavaFileObjects.forResource("picocli/examples/messages/CommandWithBundle.java"));
+
+        assertOnlySourceVersionWarning(compilation);
+    }
+
     private void assertOnlySourceVersionWarning(Compilation compilation) {
         assertThat(compilation).hadWarningCount(0); // #826 version warnings are now suppressed
         // assertThat(compilation).hadWarningContaining("Supported source version 'RELEASE_6' from annotation processor 'picocli.annotation.processing.tests");

diff --git a/...egen-tests-java9plus/src/test/java/picocli/annotation/processing/tests/Issue1134Test.java b/...egen-tests-java9plus/src/test/java/picocli/annotation/processing/tests/Issue1134Test.java
@@ -3,6 +3,7 @@
 import com.google.testing.compile.Compilation;
 import com.google.testing.compile.JavaFileObjects;
 import org.junit.Test;
+import picocli.codegen.annotation.processing.AbstractCommandSpecProcessor;
 
 import javax.annotation.processing.Processor;
 
@@ -26,6 +27,7 @@ public void testIssue1134() {
 
     @Test
     public void testIssue1134Details() {
+        AbstractCommandSpecProcessor.setLoadResourceBundles(true);
 
         Compilation compilation = compareCommandYamlDump(slurp("/picocli/issue1134/Issue1134.yaml"),
                 JavaFileObjects.forResource("picocli/issue1134/Issue1134.java"));

diff --git a/...egen-tests-java9plus/src/test/java/picocli/annotation/processing/tests/Issue1137Test.java b/...egen-tests-java9plus/src/test/java/picocli/annotation/processing/tests/Issue1137Test.java
@@ -3,9 +3,9 @@
 import com.google.testing.compile.Compilation;
 import com.google.testing.compile.JavaFileObjects;
 import org.junit.Test;
+import picocli.codegen.annotation.processing.AbstractCommandSpecProcessor;
 
 import javax.annotation.processing.Processor;
-import javax.tools.StandardLocation;
 
 import static com.google.testing.compile.CompilationSubject.assertThat;
 import static com.google.testing.compile.Compiler.javac;
@@ -27,6 +27,7 @@ public void testIssue1137() {
 
     @Test
     public void testIssue1137Details() {
+        AbstractCommandSpecProcessor.setLoadResourceBundles(true);
 
         Compilation compilation = compareCommandYamlDump(slurp("/picocli/issue1137/Issue1137.yaml"),
                 JavaFileObjects.forResource("picocli/issue1137/Issue1137.java"));

diff --git a/...s-java9plus/src/test/resources/picocli/examples/messages/CommandWithBundle-NotLoaded.yaml b/...s-java9plus/src/test/resources/picocli/examples/messages/CommandWithBundle-NotLoaded.yaml
@@ -0,0 +1,50 @@
+---
+CommandSpec:
+  name: '<main class>'
+  aliases: []
+  userObject: picocli.example.messages.CommandWithBundle.CommandWithBundle
+  helpCommand: false
+  defaultValueProvider: null
+  versionProvider: null
+  version: []
+  ArgGroups: []
+  Options: []
+  PositionalParams: []
+  UnmatchedArgsBindings: []
+  Mixins: []
+  UsageMessageSpec:
+    width: 80
+    abbreviateSynopsis: false
+    hidden: false
+    showDefaultValues: false
+    sortOptions: true
+    requiredOptionMarker: ' '
+    headerHeading: ''
+    header: []
+    synopsisHeading: 'Usage: '
+    customSynopsis: []
+    descriptionHeading: ''
+    description: []
+    parameterListHeading: ''
+    optionListHeading: ''
+    commandListHeading: 'Commands:%n'
+    footerHeading: ''
+    footer: []
+  ParserSpec:
+    separator: '='
+    endOfOptionsDelimiter: '--'
+    expandAtFiles: true
+    atFileCommentChar: '#'
+    overwrittenOptionsAllowed: false
+    unmatchedArgumentsAllowed: false
+    unmatchedOptionsArePositionalParams: false
+    stopAtUnmatched: false
+    stopAtPositional: false
+    posixClusteredShortOptionsAllowed: true
+    aritySatisfiedByAttachedOptionParam: false
+    caseInsensitiveEnumValuesAllowed: false
+    collectErrors: false
+    limitSplit: false
+    toggleBooleanFlags: false
+  ResourceBundle:
+  Subcommands: []
diff --git a/...gen/src/main/java/picocli/codegen/annotation/processing/AbstractCommandSpecProcessor.java b/...gen/src/main/java/picocli/codegen/annotation/processing/AbstractCommandSpecProcessor.java
@@ -94,6 +94,7 @@
 public abstract class AbstractCommandSpecProcessor extends AbstractProcessor {
     private static final String COMMAND_DEFAULT_NAME = CommandSpec.DEFAULT_COMMAND_NAME;
     private static Logger logger = Logger.getLogger(AbstractCommandSpecProcessor.class.getName());
+    private static boolean loadBundlesDuringAnnotationProcessing;
 
     /** The ProcessingEnvironment set by the {@link #init(ProcessingEnvironment)} method. */
     protected ProcessingEnvironment processingEnv;
@@ -172,6 +173,18 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
             return false;
         }
     }
+    /**
+     * During annotation processing, resource bundles may not be available on the
+     * classpath and thereby cause failures.
+     * For that reason, by default, resource bundles are not loaded during annotation processing.
+     * This method allows for enabling loading of resource bundles during annotation processing.
+     *
+     * @since 4.8.0
+     * @param loadBundles true if bundles should be loaded, false (default) if bundles should not be loaded
+     */
+    public static final void setLoadResourceBundles(boolean loadBundles) {
+        loadBundlesDuringAnnotationProcessing = loadBundles;
+    }
 
     private static String stacktrace(Exception e) {
         StringWriter writer = new StringWriter();
@@ -180,7 +193,7 @@ private static String stacktrace(Exception e) {
     }
 
     private boolean tryProcess(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
-        Model.Messages.setLoadBundles(false);
+        Model.Messages.setLoadBundles(loadBundlesDuringAnnotationProcessing);
         new AnnotationValidator(processingEnv).validateAnnotations(roundEnv);
 
         Context context = new Context();