provide an alternative to Janino based conditional configuration processing - Part 4

ceki · ceki · commit 0b4432a31921 · 2025-10-18T22:20:59.000+02:00
Signed-off-by: ceki &lt;ceki@qos.ch&gt;
diff --git a/logback-core-blackbox/src/test/blackboxInput/joran/conditional/if0_NoJoran.xml b/logback-core-blackbox/src/test/blackboxInput/joran/conditional/if0_NoJoran.xml
@@ -14,7 +14,7 @@
 
 <x>
     <stack name="BEGIN"/>
-    <condition class="ch.qos.logback.core.boolex.PropertyEqualsValue">
+    <condition class="ch.qos.logback.core.boolex.PropertyEqualityCondition">
             <key>ki1</key>
             <value>val1</value>
     </condition>
diff --git a/logback-core-blackbox/src/test/blackboxInput/joran/conditional/ifSystem_NoJoran.xml b/logback-core-blackbox/src/test/blackboxInput/joran/conditional/ifSystem_NoJoran.xml
@@ -17,7 +17,7 @@
 <x>
     <stack name="BEGIN"/>
 
-    <condition class="ch.qos.logback.core.blackbox.boolex.IsPropertyNullCondition">
+    <condition class="ch.qos.logback.core.boolex.IsPropertyNullCondition">
         <key>sysKey</key>
     </condition>
     <if>
diff --git a/logback-core-blackbox/src/test/blackboxInput/joran/conditional/ifWithoutElse_NoJoran.xml b/logback-core-blackbox/src/test/blackboxInput/joran/conditional/ifWithoutElse_NoJoran.xml
@@ -14,7 +14,7 @@
 
 <x>
     <stack name="BEGIN"/>
-    <condition class="ch.qos.logback.core.boolex.PropertyEqualsValue">
+    <condition class="ch.qos.logback.core.boolex.PropertyEqualityCondition">
         <key>ki1</key>
         <value>val1</value>
     </condition>
diff --git a/logback-core-blackbox/src/test/blackboxInput/joran/conditional/if_localProperty_NoJoran.xml b/logback-core-blackbox/src/test/blackboxInput/joran/conditional/if_localProperty_NoJoran.xml
@@ -15,7 +15,7 @@
 <x>
     <stack name="BEGIN"/>
     <property name="Ki1" value="Val1"/>
-    <condition class="ch.qos.logback.core.boolex.PropertyEqualsValue">
+    <condition class="ch.qos.logback.core.boolex.PropertyEqualityCondition">
         <key>Ki1</key>
         <value>Val1</value>
     </condition>
diff --git a/logback-core-blackbox/src/test/java/ch/qos/logback/core/blackbox/boolex/AlwaysFalseCondition.java b/logback-core-blackbox/src/test/java/ch/qos/logback/core/blackbox/boolex/AlwaysFalseCondition.java
@@ -14,9 +14,9 @@
 
 package ch.qos.logback.core.blackbox.boolex;
 
-import ch.qos.logback.core.boolex.PropertyEvaluatorBase;
+import ch.qos.logback.core.boolex.PropertyConditionBase;
 
-public class AlwaysFalseCondition extends PropertyEvaluatorBase {
+public class AlwaysFalseCondition extends PropertyConditionBase {
 
     @Override
     public boolean evaluate() {
diff --git a/logback-core-blackbox/src/test/java/ch/qos/logback/core/blackbox/boolex/AlwaysTrueCondition.java b/logback-core-blackbox/src/test/java/ch/qos/logback/core/blackbox/boolex/AlwaysTrueCondition.java
@@ -14,9 +14,9 @@
 
 package ch.qos.logback.core.blackbox.boolex;
 
-import ch.qos.logback.core.boolex.PropertyEvaluatorBase;
+import ch.qos.logback.core.boolex.PropertyConditionBase;
 
-public class AlwaysTrueCondition extends PropertyEvaluatorBase {
+public class AlwaysTrueCondition extends PropertyConditionBase {
 
     @Override
     public boolean evaluate() {
diff --git a/logback-core/src/main/java/ch/qos/logback/core/boolex/IsPropertyDefinedCondition.java b/logback-core/src/main/java/ch/qos/logback/core/boolex/IsPropertyDefinedCondition.java
@@ -0,0 +1,77 @@
+/*
+ * Logback: the reliable, generic, fast and flexible logging framework.
+ *  Copyright (C) 1999-2025, QOS.ch. All rights reserved.
+ *
+ * This program and the accompanying materials are dual-licensed under
+ * either the terms of the Eclipse Public License v1.0 as published by
+ * the Eclipse Foundation
+ *
+ *     or (per the licensee's choosing)
+ *
+ * under the terms of the GNU Lesser General Public License version 2.1
+ * as published by the Free Software Foundation.
+ */
+
+package ch.qos.logback.core.boolex;
+
+/**
+ * Checks whether a named property is defined in the
+ * context (e.g. system properties, environment, or the configured
+ * property map used by the surrounding framework).
+ *
+ * <p>This condition expects a property name to be provided via
+ * {@link #setKey(String)}. When {@link #evaluate()} is called it returns
+ * {@code true} if the named property is defined and {@code false}
+ * otherwise.
+ */
+public class IsPropertyDefinedCondition extends PropertyConditionBase {
+
+    /**
+     * The property name to check for definition. Must be set before
+     * starting this evaluator.
+     */
+    String key;
+
+    /**
+     * Start the evaluator. If the required {@link #key} is not set an
+     * error is reported and startup is aborted.
+     */
+    public void start() {
+        if (key == null) {
+            addError("In IsPropertyDefinedEvaluator 'key' parameter cannot be null");
+            return;
+        }
+        super.start();
+    }
+
+    /**
+     * Return the configured property name (key) that this evaluator will
+     * test for definition.
+     *
+     * @return the property key, or {@code null} if not set
+     */
+    public String getKey() {
+        return key;
+    }
+
+    /**
+     * Set the property name (key) to be checked by this evaluator.
+     *
+     * @param key the property name to check; must not be {@code null}
+     */
+    public void setKey(String key) {
+        this.key = key;
+    }
+
+
+    /**
+     * Evaluate whether the configured property is defined.
+     *
+     * @return {@code true} if the property named by {@link #key} is
+     *         defined, {@code false} otherwise
+     */
+    @Override
+    public boolean evaluate() {
+        return isDefined(key);
+    }
+}
diff --git a/logback-core/src/main/java/ch/qos/logback/core/boolex/IsPropertyNullCondition.java b/logback-core/src/main/java/ch/qos/logback/core/boolex/IsPropertyNullCondition.java
@@ -12,11 +12,9 @@
  * as published by the Free Software Foundation.
  */
 
-package ch.qos.logback.core.blackbox.boolex;
+package ch.qos.logback.core.boolex;
 
-import ch.qos.logback.core.boolex.PropertyEvaluatorBase;
-
-public class IsPropertyNullCondition  extends PropertyEvaluatorBase {
+public class IsPropertyNullCondition  extends PropertyConditionBase {
 
     String key;
 
diff --git a/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyCondition.java b/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyCondition.java
@@ -16,7 +16,6 @@
 
 import ch.qos.logback.core.Context;
 import ch.qos.logback.core.joran.conditional.Condition;
-import ch.qos.logback.core.joran.conditional.PropertyEvalScriptBuilder;
 import ch.qos.logback.core.spi.ContextAware;
 import ch.qos.logback.core.spi.LifeCycle;
 import ch.qos.logback.core.spi.PropertyContainer;
@@ -39,7 +38,7 @@
  * @since 1.5.20
  * @author Ceki G&uuml;lc&uuml;
  */
-public interface PropertyEvaluator extends Condition, ContextAware, LifeCycle {
+public interface PropertyCondition extends Condition, ContextAware, LifeCycle {
 
     /**
      * Returns the local {@link PropertyContainer} used for property lookups specific to the embedding configurator.
diff --git a/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyConditionBase.java b/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyConditionBase.java
@@ -14,22 +14,31 @@
 
 package ch.qos.logback.core.boolex;
 
+import ch.qos.logback.core.model.processor.ModelInterpretationContext;
 import ch.qos.logback.core.spi.ContextAwareBase;
 import ch.qos.logback.core.spi.PropertyContainer;
 import ch.qos.logback.core.util.OptionHelper;
 
 /**
- * <p>Abstract base class provides some scaffolding. it is intended to ease migration
+ * <p>Abstract base class provides some scaffolding. It is intended to ease migration
  * from <b>legacy</b> conditional processing in configuration files
- * (e.g. &lt;if>, &lt;then>, &lt;else>) using the Janino library.
- * </p>
+ * (e.g. &lt;if>, &lt;then&gt;, &lt;else>) using the Janino library. Nevertheless,
+ * it should also be useful in newly written code.</p>
  *
- * <p>Nevertheless, it should also be useful in newly written code. </p>
+ * <p>Properties are looked up in the following order:</p>
  *
+ * <ol>
+ *  <li>In the local property container, usually the {@link ModelInterpretationContext} </li>
+ *  <li>in the logger context</li>
+ *  <li>system properties</li>
+ *  <li>environment variables</li>
+ * </ol>
+ *
+ * @see OptionHelper#propertyLookup(String, PropertyContainer, PropertyContainer)
  * @since 1.5.20
  * @author Ceki G&uuml;lc&uuml;
  */
-abstract public class PropertyEvaluatorBase extends ContextAwareBase implements PropertyEvaluator {
+abstract public class PropertyConditionBase extends ContextAwareBase implements PropertyCondition {
 
     /**
      * Indicates whether this evaluator has been started.
@@ -39,33 +48,43 @@ abstract public class PropertyEvaluatorBase extends ContextAwareBase implements
      * <p>The local property container used for property lookups.</p>
      *
      * <p>Local properties correspond to the properties in the embedding
-     * configurator.</p>
+     * configurator, i.e. usually the {@link ModelInterpretationContext} instance.</p>
      */
     PropertyContainer localPropertyContainer;
 
     /**
-     * Returns the property container used by this evaluator.
+     * Returns the local property container used by this evaluator.
+     *
+     * <p>Local properties correspond to the properties in the embedding
+     * configurator, i.e. usually the {@link ModelInterpretationContext} instance.</p>
      *
-     * @return the property container
+     * @return the local property container
      */
     @Override
     public PropertyContainer getLocalPropertyContainer() {
         return localPropertyContainer;
     }
 
     /**
-     * Sets the property container for this evaluator.
+     * Sets the local property container for this evaluator.
+     *
+     * <p>Local properties correspond to the properties in the embedding
+     * configurator, i.e. usually the {@link ModelInterpretationContext} instance.</p>
      *
-     * @param aPropertyContainer the property container to set
+     * @param aLocalPropertyContainer the local property container to set
      */
     @Override
-    public void setLocalPropertyContainer(PropertyContainer aPropertyContainer) {
-        this.localPropertyContainer = aPropertyContainer;
+    public void setLocalPropertyContainer(PropertyContainer aLocalPropertyContainer) {
+        this.localPropertyContainer = aLocalPropertyContainer;
     }
 
     /**
      * Checks if the property with the given key is null.
      *
+     * <p>The property is looked up via the
+     * {@link OptionHelper#propertyLookup(String, PropertyContainer, PropertyContainer)} method.
+     * See above for the lookup order.</p>
+     *
      * @param k the property key
      * @return true if the property is null, false otherwise
      */
@@ -77,6 +96,10 @@ public boolean isNull(String k) {
     /**
      * Checks if the property with the given key is defined (not null).
      *
+     * <p>The property is looked up via the
+     * {@link OptionHelper#propertyLookup(String, PropertyContainer, PropertyContainer)} method.
+     * See above for the lookup order.</p>
+     *
      * @param k the property key
      * @return true if the property is defined, false otherwise
      */
@@ -99,6 +122,10 @@ public String p(String k) {
     /**
      * Retrieves the property value for the given key, returning an empty string if null.
      *
+     * <p>The property is looked up via the
+     * {@link OptionHelper#propertyLookup(String, PropertyContainer, PropertyContainer)} method.
+     * See above for the lookup order.</p>
+     *
      * @param k the property key
      * @return the property value or an empty string
      */
diff --git a/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyEqualityCondition.java b/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyEqualityCondition.java
@@ -0,0 +1,117 @@
+/*
+ * Logback: the reliable, generic, fast and flexible logging framework.
+ *  Copyright (C) 1999-2025, QOS.ch. All rights reserved.
+ *
+ * This program and the accompanying materials are dual-licensed under
+ * either the terms of the Eclipse Public License v1.0 as published by
+ * the Eclipse Foundation
+ *
+ *     or (per the licensee's choosing)
+ *
+ * under the terms of the GNU Lesser General Public License version 2.1
+ * as published by the Free Software Foundation.
+ */
+
+package ch.qos.logback.core.boolex;
+
+/**
+ * Condition that evaluates to {@code true} when a property
+ * equals a specified expected value.
+ *
+ * <p>The property named by {@link #key} is resolved using the
+ * inherited property lookup mechanism (see {@code PropertyConditionBase}).
+ * If the resolved property value equals {@link #value} (using
+ * {@link String#equals(Object)}), this condition evaluates to {@code true}.
+ *
+ * @since 1.5.20
+ */
+public class PropertyEqualityCondition extends PropertyConditionBase {
+
+    /**
+     * The property name (key) to look up. Must be set before starting.
+     */
+    String key;
+
+    /**
+     * The expected value to compare the resolved property against.
+     */
+    String value;
+
+    /**
+     * Start the component and validate required parameters.
+     * If either {@link #key} or {@link #value} is {@code null}, an error
+     * is reported and the component does not start.
+     */
+    public void start() {
+        if (key == null) {
+            addError("In PropertyEqualsValue 'key' parameter cannot be null");
+            return;
+        }
+        if (value == null) {
+            addError("In PropertyEqualsValue 'value' parameter cannot be null");
+            return;
+        }
+        super.start();
+    }
+
+    /**
+     * Return the configured expected value.
+     *
+     * @return the expected value, or {@code null} if not set
+     */
+    public String getValue() {
+        return value;
+    }
+
+    /**
+     * Set the expected value that the resolved property must equal for
+     * this condition to evaluate to {@code true}.
+     *
+     * @param value the expected value
+     */
+    public void setValue(String value) {
+        this.value = value;
+    }
+
+    /**
+     * Return the property key that will be looked up when evaluating the
+     * condition.
+     *
+     * @return the property key, or {@code null} if not set
+     */
+    public String getKey() {
+        return key;
+    }
+
+    /**
+     * Set the property key to resolve during evaluation.
+     *
+     * @param key the property key
+     */
+    public void setKey(String key) {
+        this.key = key;
+    }
+
+    /**
+     * Evaluate the condition: resolve the property named by {@link #key}
+     * and compare it to {@link #value}.
+     *
+     * @return {@code true} if the resolved property equals the expected
+     *         value; {@code false} otherwise
+     */
+    @Override
+    public boolean evaluate() {
+        if (key == null) {
+            addError("key cannot be null");
+            return false;
+        }
+
+        String val = p(key);
+        if (val == null)
+            return false;
+        else {
+            return val.equals(value);
+        }
+    }
+
+}
diff --git a/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyEqualsValue.java b/logback-core/src/main/java/ch/qos/logback/core/boolex/PropertyEqualsValue.java
diff --git a/logback-core/src/main/java/ch/qos/logback/core/joran/conditional/Condition.java b/logback-core/src/main/java/ch/qos/logback/core/joran/conditional/Condition.java
diff --git a/logback-core/src/main/java/ch/qos/logback/core/model/processor/conditional/ByPropertiesConditionModelHandler.java b/logback-core/src/main/java/ch/qos/logback/core/model/processor/conditional/ByPropertiesConditionModelHandler.java
diff --git a/logback-core/src/main/java/ch/qos/logback/core/util/OptionHelper.java b/logback-core/src/main/java/ch/qos/logback/core/util/OptionHelper.java
