refactor file change scanning for clarity

Signed-off-by: ceki <ceki@qos.ch>

Author: ceki

logback-classic-blackbox/src/test/java/ch/qos/logback/classic/blackbox/joran/BlackboxJoranConfiguratorTest.java

@@ -14,30 +14,33 @@
 
 package ch.qos.logback.classic.blackbox.joran;
 
+import ch.qos.logback.classic.ClassicConstants;
 import ch.qos.logback.classic.Level;
 import ch.qos.logback.classic.Logger;
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.classic.blackbox.BlackboxClassicTestConstants;
 import ch.qos.logback.classic.joran.JoranConfigurator;
 import ch.qos.logback.classic.jul.JULHelper;
 import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.classic.util.DefaultJoranConfigurator;
 import ch.qos.logback.classic.util.LogbackMDCAdapter;
 import ch.qos.logback.core.joran.spi.JoranException;
 import ch.qos.logback.core.read.ListAppender;
 import ch.qos.logback.core.testUtil.RandomUtil;
 import ch.qos.logback.core.testUtil.StringListAppender;
+import ch.qos.logback.core.util.Loader;
 import ch.qos.logback.core.util.StatusPrinter;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.junit.jupiter.api.Assertions.assertNull;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
 
 public class BlackboxJoranConfiguratorTest {
+
  LoggerContext loggerContext = new LoggerContext();
  LogbackMDCAdapter logbackMDCAdapter = new LogbackMDCAdapter();
  Logger logger = loggerContext.getLogger(this.getClass().getName());
@@ -51,9 +54,10 @@ void configure(String file) throws JoranException {
  jc.setContext(loggerContext);
  loggerContext.putProperty("diff", "" + diff);
  jc.doConfigure(file);
-
  }
 
+
+
  @Test
  public void eval() throws JoranException {
  configure(BlackboxClassicTestConstants.JORAN_INPUT_PREFIX + "callerData.xml");
@@ -190,5 +194,21 @@ void verifyJULLevel(String loggerName, Level expectedLevel) {
  }
  }
 
+ // See https://github.com/qos-ch/logback/issues/1001
+ // See https://github.com/qos-ch/logback/issues/997
+ @Test
+ public void fileAsResource() throws JoranException, IOException, InterruptedException {
+ JoranConfigurator joranConfigurator = new JoranConfigurator();
+ joranConfigurator.setContext(loggerContext);
+ ClassLoader classLoader = Loader.getClassLoaderOfObject(joranConfigurator);
+ String logbackConfigFile = "asResource/topFile.xml";
+ URL aURL = Loader.getResource(logbackConfigFile, classLoader);
+ InputStream inputStream = aURL.openStream();
+ assertNotNull(inputStream);
+ joranConfigurator.doConfigure(inputStream);
+ StatusPrinter.print(loggerContext);
+ checker.assertIsWarningOrErrorFree();
+ fail();
+ }
 
 }

logback-classic-blackbox/src/test/java/ch/qos/logback/classic/blackbox/joran/ReconfigureOnChangeTaskTest.java

@@ -98,7 +98,6 @@ public void checkBasicLifecyle() throws JoranException, IOException, Interrupted
  configure(file);
  List<File> fileList = getConfigurationWatchList(loggerContext);
  assertThatListContainsFile(fileList, file);
- statusPrinter2.print(loggerContext);
  checkThatTaskHasRan();
  checkThatTaskCanBeStopped();
  }
@@ -203,10 +202,10 @@ public void reconfigurationIsNotPossibleInTheAbsenceOfATopFile() throws IOExcept
  configure(asBAIS(configurationStr));
 
  ConfigurationWatchList configurationWatchList = ConfigurationWatchListUtil.getConfigurationWatchList(loggerContext);
- assertNull(configurationWatchList);
+
+ assertNotNull(configurationWatchList);
  assertFalse(ConfigurationWatchListUtil.watchPredicateFulfilled(loggerContext));
  statusChecker.containsMatch(Status.WARN, ConfigurationModelHandlerFull.FAILED_WATCH_PREDICATE_MESSAGE_1);
- StatusPrinter.print(loggerContext);
 
  assertFalse(listener.changeDetectorRegisteredEventOccurred);
  assertEquals(0, loggerContext.getCopyOfScheduledFutures().size());
@@ -222,7 +221,7 @@ public void fallbackToSafe_FollowedByRecovery() throws IOException, JoranExcepti
 
  addResetResistantOnConsoleStatusListener();
  configure(topLevelFile);
-
+ //statusPrinter2.print(loggerContext);
  CountDownLatch changeDetectedLatch = registerChangeDetectedListener();
  CountDownLatch configurationDoneLatch = registerNewReconfigurationDoneSuccessfullyListener();
 
@@ -251,12 +250,13 @@ public void fallbackToSafe_FollowedByRecovery() throws IOException, JoranExcepti
  statusChecker.assertIsErrorFree();
  statusChecker.containsMatch(DETECTED_CHANGE_IN_CONFIGURATION_FILES);
  } finally {
- StatusPrinter.print(loggerContext);
+ //StatusPrinter.print(loggerContext);
  }
  }
 
  private void addResetResistantOnConsoleStatusListener() {
- if (1 == 1)
+ // enable when debugging
+ if(1==1)
  return;
  OnConsoleStatusListener ocs = new OnConsoleStatusListener();
  ocs.setContext(loggerContext);
@@ -285,7 +285,6 @@ public void fallbackToSafeWithIncludedFile_FollowedByRecovery() throws IOExcepti
 
  ReconfigureOnChangeTask roct = roctRegisteredListener.reconfigureOnChangeTask;
 
- System.out.println("===================================================");
 
  CountDownLatch changeDetectedLatch = registerChangeDetectedListener();
  CountDownLatch configurationDoneLatch = registerNewReconfigurationDoneSuccessfullyListener(roct);
@@ -299,6 +298,8 @@ public void fallbackToSafeWithIncludedFile_FollowedByRecovery() throws IOExcepti
  statusChecker.assertContainsMatch(Status.WARN, FALLING_BACK_TO_SAFE_CONFIGURATION);
  statusChecker.assertContainsMatch(Status.INFO, RE_REGISTERING_PREVIOUS_SAFE_CONFIGURATION);
 
+ //statusPrinter2.print(loggerContext);
+
  loggerContext.getStatusManager().clear();
 
  CountDownLatch secondDoneLatch = registerNewReconfigurationDoneSuccessfullyListener();

logback-classic/src/main/java/ch/qos/logback/classic/joran/ReconfigureOnChangeTask.java

@@ -67,7 +67,6 @@ public void run() {
 
  context.fireConfigurationEvent(ConfigurationEvent.newConfigurationChangeDetectedEvent(this));
  addInfo(DETECTED_CHANGE_IN_CONFIGURATION_FILES);
-
  if(changedFile != null) {
  changeInFile(changedFile, configurationWatchList);
  }
@@ -84,6 +83,7 @@ private void changeInURL(URL url) {
  }
  }
  private void changeInFile(File changedFile, ConfigurationWatchList configurationWatchList) {
+
  if(changedFile.getName().endsWith(PROPERTIES_FILE_EXTENSION)) {
  runPropertiesConfigurator(changedFile);
  return;
@@ -92,13 +92,11 @@ private void changeInFile(File changedFile, ConfigurationWatchList configuration
  // ======== fuller processing below
  addInfo(CoreConstants.RESET_MSG_PREFIX + "named [" + context.getName() + "]");
  cancelFutureInvocationsOfThisTaskInstance();
- URL mainConfigurationURL = configurationWatchList.getMainURL();
+ URL mainConfigurationURL = configurationWatchList.getTopURL();
 
  LoggerContext lc = (LoggerContext) context;
  if (mainConfigurationURL.toString().endsWith("xml")) {
  performXMLConfiguration(lc, mainConfigurationURL);
- } else if (mainConfigurationURL.toString().endsWith("groovy")) {
- addError("Groovy configuration disabled due to Java 9 compilation issues.");
  }
  }
 
@@ -127,50 +125,54 @@ private void cancelFutureInvocationsOfThisTaskInstance() {
  }
  }
 
- private void performXMLConfiguration(LoggerContext lc, URL mainConfigurationURL) {
+ private void performXMLConfiguration(LoggerContext loggerContext, URL mainConfigurationURL) {
+
  JoranConfigurator jc = new JoranConfigurator();
- jc.setContext(context);
- StatusUtil statusUtil = new StatusUtil(context);
+ jc.setContext(loggerContext);
+ StatusUtil statusUtil = new StatusUtil(loggerContext);
  Model failsafeTop = jc.recallSafeConfiguration();
- URL mainURL = ConfigurationWatchListUtil.getMainWatchURL(context);
- addInfo("Resetting loggerContext ["+lc.getName()+"]");
- lc.reset();
+ URL topURL = ConfigurationWatchListUtil.getMainWatchURL(context);
+ addInfo("Resetting loggerContext ["+loggerContext.getName()+"]");
+ loggerContext.reset();
  long threshold = System.currentTimeMillis();
  try {
  jc.doConfigure(mainConfigurationURL);
  // e.g. IncludeAction will add a status regarding XML parsing errors but no exception will reach here
  if (statusUtil.hasXMLParsingErrors(threshold)) {
- fallbackConfiguration(lc, failsafeTop, mainURL);
+ fallbackConfiguration(loggerContext, failsafeTop, topURL);
  }
  } catch (JoranException e) {
  addWarn("Exception occurred during reconfiguration", e);
- fallbackConfiguration(lc, failsafeTop, mainURL);
+ fallbackConfiguration(loggerContext, failsafeTop, topURL);
  }
  }
 
- private void fallbackConfiguration(LoggerContext lc, Model failsafeTop, URL mainURL) {
+ private void fallbackConfiguration(LoggerContext loggerContext, Model failsafeTopModel, URL topURL) {
  // failsafe events are used only in case of errors. Therefore, we must *not*
  // invoke file inclusion since the included files may be the cause of the error.
 
  // List<SaxEvent> failsafeEvents = removeIncludeEvents(eventList);
  JoranConfigurator joranConfigurator = new JoranConfigurator();
- joranConfigurator.setContext(context);
- ConfigurationWatchList oldCWL = ConfigurationWatchListUtil.getConfigurationWatchList(context);
- ConfigurationWatchList newCWL = oldCWL.buildClone();
+ joranConfigurator.setContext(loggerContext);
+ joranConfigurator.setTopURL(topURL);
+
+// ConfigurationWatchList oldCWL = ConfigurationWatchListUtil.getConfigurationWatchList(loggerContext);
+// System.out.println("--------oldCWL:"+oldCWL);
+// ConfigurationWatchList newCWL = oldCWL.buildClone();
 
- if (failsafeTop == null) {
+ if (failsafeTopModel == null) {
  addWarn("No previous configuration to fall back on.");
  return;
  } else {
  addWarn(FALLING_BACK_TO_SAFE_CONFIGURATION);
- addInfo("Safe model "+failsafeTop);
+ addInfo("Safe model "+failsafeTopModel);
  try {
- lc.reset();
- ConfigurationWatchListUtil.registerConfigurationWatchList(context, newCWL);
- ModelUtil.resetForReuse(failsafeTop);
- joranConfigurator.processModel(failsafeTop);
+ loggerContext.reset();
+// ConfigurationWatchListUtil.registerConfigurationWatchList(context, newCWL);
+ ModelUtil.resetForReuse(failsafeTopModel);
+ joranConfigurator.processModel(failsafeTopModel);
  addInfo(RE_REGISTERING_PREVIOUS_SAFE_CONFIGURATION);
- joranConfigurator.registerSafeConfiguration(failsafeTop);
+ joranConfigurator.registerSafeConfiguration(failsafeTopModel);
  context.fireConfigurationEvent(newConfigurationEndedSuccessfullyEvent(this));
  } catch (Exception e) {
  addError("Unexpected exception thrown by a configuration considered safe.", e);

logback-classic/src/main/java/ch/qos/logback/classic/model/PropertiesConfiguratorModel.java

@@ -19,4 +19,15 @@
 public class PropertiesConfiguratorModel extends ResourceModel {
 
  private static final long serialVersionUID = -2009536798661734346L;
+
+ String scanStr;
+
+ public String getScanStr() {
+ return scanStr;
+ }
+
+ public void setScanStr(String scanStr) {
+ this.scanStr = scanStr;
+ }
+
 }

logback-classic/src/main/java/ch/qos/logback/classic/model/processor/ConfigurationModelHandler.java

@@ -16,6 +16,7 @@
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.classic.model.ConfigurationModel;
 import ch.qos.logback.core.Context;
+import ch.qos.logback.core.joran.util.ConfigurationWatchListUtil;
 import ch.qos.logback.core.model.Model;
 import ch.qos.logback.core.model.processor.ModelHandlerBase;
 import ch.qos.logback.core.model.processor.ModelHandlerException;
@@ -33,7 +34,7 @@
 /**
  * In 1.3.9/1.49, ConfigurationModelHandler has been reduced in functionality and no
  * longer initiates a reconfiguration task. This change was justified by the need
- * to remove java.xml reachability. See also LOGBACK-1717.
+ * to remove java.xml reachability. See also https://jira.qos.ch/browse/LOGBACK-1717
  *
  * <p>
  * See {@link ConfigurationModelHandlerFull} subclass offering configuration
@@ -44,6 +45,8 @@ public class ConfigurationModelHandler extends ModelHandlerBase {
 
  static final Duration SCAN_PERIOD_DEFAULT = Duration.buildByMinutes(1);
 
+ protected Boolean scanning = null;
+
  public ConfigurationModelHandler(Context context) {
  super(context);
  }
@@ -75,7 +78,18 @@ public void handle(ModelInterpretationContext mic, Model model) {
  StatusListenerConfigHelper.addOnConsoleListenerInstance(context, new OnConsoleStatusListener());
  }
 
- processScanAttrib(mic, configurationModel);
+ // It is hard to gauge at this stage which URL ares watchable
+ // However, we know for sure if the user wants scanning or not
+ this.scanning = scanAttrToBoolean(configurationModel);
+
+ mic.setTopScanBoolean(scanning);
+
+ printScanMessage(scanning);
+
+ if (scanning == Boolean.TRUE) {
+ ConfigurationWatchListUtil.registerNewConfigurationWatchListWithContext(getContext());
+ ConfigurationWatchListUtil.setMainWatchURL(context, mic.getTopURL());
+ }
 
  LoggerContext lc = (LoggerContext) context;
  boolean packagingData = OptionHelper.toBoolean(mic.subst(configurationModel.getPackagingDataStr()),
@@ -88,20 +102,47 @@ public void handle(ModelInterpretationContext mic, Model model) {
 
  }
 
- protected void processScanAttrib(ModelInterpretationContext mic, ConfigurationModel configurationModel) {
- String scanStr = mic.subst(configurationModel.getScanStr());
- if (!OptionHelper.isNullOrEmptyOrAllSpaces(scanStr) && !"false".equalsIgnoreCase(scanStr)) {
- addInfo("Skipping ReconfigureOnChangeTask registration");
+ void printScanMessage(Boolean scanning) {
+ if (scanning == null) {
+ addInfo("Scan attribute not set or set to unrecognized value.");
+ return;
+ }
+ if (scanning) {
+ addInfo("Scan attribute set to true. Will scan for configuration file changes.");
+ } else {
+ addInfo("Scan attribute set to false.");
  }
  }
 
- protected void postProcessScanAttrib(ModelInterpretationContext mic, ConfigurationModel configurationModel) {
-
- }
 
  @Override
  public void postHandle(ModelInterpretationContext mic, Model model) throws ModelHandlerException {
- ConfigurationModel configurationModel = (ConfigurationModel) model;
+ //ConfigurationModel configurationModel = (ConfigurationModel) model;
+
+ }
+
+ /**
+ * Converts the scan string attribute of the given model to a Boolean value.
+ *
+ * <p>If the provided model is an instance of {@code ConfigurationModel}, the scan string is retrieved
+ * and converted to a {@code Boolean}. If the provided model is not a {@code ConfigurationModel},
+ * the method returns {@code null}.
+ * </p>
+ *
+ * @param model the model object, which may be an instance of {@code ConfigurationModel}
+ * @return a {@code Boolean} corresponding to the scan string attribute if the model is
+ * an instance of {@code ConfigurationModel}, or {@code null} otherwise
+ *
+ * @since 1.5.27
+ */
+ private Boolean scanAttrToBoolean(Model model) {
+ if(model instanceof ConfigurationModel) {
+ ConfigurationModel configurationModel = (ConfigurationModel) model;
+ String scanStr = configurationModel.getScanStr();
+ return OptionHelper.toBooleanObject(scanStr);
+ } else {
+ return null;
+ }
 
  }
 }