#47 Refactoring of global variable map process for maven and gradle

Author: raydac

jcp-tests/jcp-test-maven/pom.xml

@@ -73,6 +73,7 @@
             </goals>
             <configuration>
               <useTestSources>true</useTestSources>
+              <unknownVarAsFalse>true</unknownVarAsFalse>
               <vars>
                 <empty.null.variable></empty.null.variable>
                 <some.test.global.test>Some Test</some.test.global.test>

jcp/src/main/java/com/igormaznitsa/jcp/gradle/JcpTask.java

@@ -113,7 +113,7 @@ public class JcpTask extends DefaultTask {
   /**
    * List of variables to be registered in preprocessor as global ones.
    */
-  private final MapProperty<String, String> vars;
+  private final MapProperty<String, Object> vars;
   /**
    * List of patterns of folder paths to be excluded from preprocessing, It uses
    * ANT path pattern format.
@@ -174,7 +174,7 @@ public JcpTask(final ObjectFactory factory) {
     this.sourceEncoding = factory.property(String.class).convention(StandardCharsets.UTF_8.name());
     this.eol = factory.property(String.class).convention(System.lineSeparator());
 
-    this.vars = factory.mapProperty(String.class, String.class);
+    this.vars = factory.mapProperty(String.class, Object.class);
 
     this.sources = factory.listProperty(File.class);
     this.configFiles = factory.listProperty(String.class);
@@ -289,7 +289,7 @@ public Property<Object> getKeepComments() {
   }
 
   @Input
-  public MapProperty<String, String> getVars() {
+  public MapProperty<String, Object> getVars() {
     return vars;
   }
 
@@ -415,10 +415,29 @@ public void warning(final String message) {
     preprocessorContext.setUnknownVariableAsFalse(this.unknownVarAsFalse.get());
     preprocessorContext.setVerbose(this.verbose.get());
 
-    this.vars.getOrElse(emptyMap()).forEach((key, value) -> {
-      logger.debug(String.format("Registering global variable: %s=%s", key, value));
-      preprocessorContext.setGlobalVariable(key, Value.recognizeRawString(value));
-    });
+    this.vars.getOrElse(emptyMap()).entrySet().stream()
+        .filter(e -> {
+          if (e.getValue() == null) {
+            if (this.unknownVarAsFalse.get()) {
+              logger.warn(String.format(
+                  "Global var '%s' ignored for null value (may be its content is empty in POM)",
+                  e.getKey()));
+              return false;
+            } else {
+              throw new IllegalStateException(String.format(
+                  "Global var '%s' has null value, to ignore it set flag unknownVarAsFalse",
+                  e.getKey()));
+            }
+          } else {
+            return true;
+          }
+        })
+        .forEach(e -> {
+          logger.debug(
+              String.format("Registering global variable: %s=%s", e.getKey(), e.getValue()));
+          preprocessorContext.setGlobalVariable(e.getKey(),
+              Value.recognizeRawString(String.valueOf(e.getValue())));
+        });
 
     final JcpPreprocessor preprocessor = new JcpPreprocessor(preprocessorContext);
 

jcp/src/main/java/com/igormaznitsa/jcp/maven/PreprocessMojo.java

@@ -49,6 +49,7 @@
 import org.apache.commons.text.StringEscapeUtils;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.AbstractMojoExecutionException;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
@@ -357,7 +358,7 @@ private void replaceSourceRootByPreprocessingDestinationFolder(final Preprocesso
   }
 
 
-  PreprocessorContext makePreprocessorContext() throws IOException {
+  PreprocessorContext makePreprocessorContext() throws AbstractMojoExecutionException {
     final PreprocessorContext context = new PreprocessorContext(this.getBaseDir());
     context.setPreprocessorLogger(this);
 
@@ -406,24 +407,35 @@ PreprocessorContext makePreprocessorContext() throws IOException {
     this.configFiles.forEach(x -> context.registerConfigFile(new File(x)));
 
     // register global vars
-    this.getVars().entrySet().stream()
-        .filter(e -> {
-          final String key = e.getKey();
-          final String value = e.getValue();
-          if (value == null) {
-            getLog().warn(String.format(
-                "Global var '%s' ignored for null value (may be its content is empty in POM)",
-                key));
-            return false;
-          } else {
-            return true;
-          }
-        })
-        .forEach(e -> {
-          getLog().debug(
-              String.format("Register global var: '%s' <- '%s'", e.getKey(), e.getValue()));
-          context.setGlobalVariable(e.getKey(), Value.recognizeRawString(e.getValue()));
-        });
+    try {
+      this.getVars().entrySet().stream()
+          .filter(e -> {
+            final String key = e.getKey();
+            final String value = e.getValue();
+            if (value == null) {
+              if (this.isUnknownVarAsFalse()) {
+                getLog().warn(String.format(
+                    "Global var '%s' ignored for null value (may be its content is empty in POM)",
+                    key));
+                return false;
+              } else {
+                throw new IllegalStateException(String.format(
+                    "Global var '%s' has null value (may be its content is empty in POM), to ignore it set unknownVarAsFalse as true",
+                    key));
+              }
+            } else {
+              return true;
+            }
+          })
+          .forEach(e -> {
+            getLog().debug(
+                String.format("Register global var: '%s' <- '%s'", e.getKey(), e.getValue()));
+            context.setGlobalVariable(e.getKey(), Value.recognizeRawString(e.getValue()));
+          });
+    } catch (final IllegalStateException ex) {
+      getLog().error(ex.getMessage());
+      throw new MojoFailureException(ex.getMessage());
+    }
     return context;
   }