Merge pull request #832 from ebocher/master_log

Fix logger
orbisgis · Sep 13, 2023 · 247dd2f · 247dd2f
2 parents fdbcafc + 337e0e3
commit 247dd2f
Show file tree

Hide file tree

Showing 17 changed files with 53 additions and 68 deletions.
diff --git a/bdtopo/src/main/groovy/org/orbisgis/geoclimate/bdtopo/BDTopoUtils.groovy b/bdtopo/src/main/groovy/org/orbisgis/geoclimate/bdtopo/BDTopoUtils.groovy
@@ -24,16 +24,14 @@ import org.locationtech.jts.geom.Envelope
 import org.locationtech.jts.geom.Geometry
 import org.orbisgis.geoclimate.utils.AbstractScript
 import org.orbisgis.geoclimate.utils.LoggerUtils
-import org.slf4j.LoggerFactory
 
 /**
  * BDTopo utils
  */
 abstract class BDTopoUtils extends AbstractScript {
 
     BDTopoUtils() {
-        super(LoggerFactory.getLogger(BDTopoUtils.class))
-        LoggerUtils.setLoggerLevel("INFO")
+        super(BDTopoUtils.class)
     }
 
     /**

diff --git a/common-utils/src/main/groovy/org/orbisgis/geoclimate/utils/AbstractScript.groovy b/common-utils/src/main/groovy/org/orbisgis/geoclimate/utils/AbstractScript.groovy
@@ -1,13 +1,16 @@
 package org.orbisgis.geoclimate.utils
 
 import ch.qos.logback.classic.Logger
+import ch.qos.logback.classic.LoggerContext
 
 abstract class AbstractScript extends Script {
 
     public Logger logger
 
-    AbstractScript(Logger logger) {
-        this.logger = logger
+    AbstractScript(Class aClass) {
+        LoggerContext context = new LoggerContext()
+        this.logger = context.getLogger(aClass)
+        LoggerUtils.setLoggerLevel("INFO")
     }
 
     static String uuid() { UUID.randomUUID().toString().replaceAll("-", "_") }

diff --git a/common-utils/src/main/groovy/org/orbisgis/geoclimate/utils/LoggerUtils.groovy b/common-utils/src/main/groovy/org/orbisgis/geoclimate/utils/LoggerUtils.groovy
@@ -1,12 +1,14 @@
 package org.orbisgis.geoclimate.utils
 
 import ch.qos.logback.classic.Level
+import ch.qos.logback.classic.Logger
 import ch.qos.logback.classic.LoggerContext
 import org.slf4j.LoggerFactory
 
 class LoggerUtils {
 
 
+
     /**
      * Utility class to change log level for all loggers
      *
@@ -29,4 +31,15 @@ class LoggerUtils {
             context.getLoggerList().each { it -> it.setLevel(level) }
         }
     }
+
+
+    /**
+     * Create a logback logger
+     * @param aClass
+     * @return
+     */
+    static Logger createLogger(Class aClass){
+        LoggerContext context = new LoggerContext()
+        return context.getLogger(aClass)
+    }
 }
diff --git a/geoclimate/src/main/groovy/org/orbisgis/geoclimate/Geoclimate.groovy b/geoclimate/src/main/groovy/org/orbisgis/geoclimate/Geoclimate.groovy
@@ -20,6 +20,7 @@
 package org.orbisgis.geoclimate
 
 import org.orbisgis.geoclimate.bdtopo.BDTopo
+import org.orbisgis.geoclimate.utils.LoggerUtils
 import picocli.CommandLine
 
 import java.util.concurrent.Callable
@@ -84,9 +85,9 @@ class Geoclimate implements Callable<Integer> {
     @Override
     Integer call() {
         if (verbose) {
-            Geoindicators.WorkflowUtilities.setLoggerLevel(verbose.trim())
+            LoggerUtils.setLoggerLevel(verbose.trim())
         } else {
-            Geoindicators.WorkflowUtilities.setLoggerLevel("INFO")
+            LoggerUtils.setLoggerLevel("INFO")
         }
         if (workflow.trim().equalsIgnoreCase("OSM")) {
             println("The OSM workflow has been started.\nPlease wait...")

diff --git a/geoindicators/src/main/groovy/org/orbisgis/geoclimate/Geoindicators.groovy b/geoindicators/src/main/groovy/org/orbisgis/geoclimate/Geoindicators.groovy
@@ -20,18 +20,14 @@
 package org.orbisgis.geoclimate
 
 import ch.qos.logback.classic.Level
-import ch.qos.logback.classic.LoggerContext
 import org.orbisgis.geoclimate.geoindicators.*
 import org.orbisgis.geoclimate.utils.AbstractScript
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 abstract class Geoindicators extends AbstractScript {
-    public static def logger
 
     Geoindicators() {
-        super(LoggerFactory.getLogger(Geoindicators.class))
-        var context = (LoggerContext) LoggerFactory.getILoggerFactory()
-        context.getLogger(Geoindicators.class).setLevel(Level.INFO)
+        super(Geoindicators.class)
     }
 
     //Processes

diff --git a/geoindicators/src/main/groovy/org/orbisgis/geoclimate/geoindicators/WorkflowUtilities.groovy b/geoindicators/src/main/groovy/org/orbisgis/geoclimate/geoindicators/WorkflowUtilities.groovy
@@ -28,7 +28,6 @@ import org.orbisgis.data.H2GIS
 import org.orbisgis.data.POSTGIS
 import org.orbisgis.data.jdbc.JdbcDataSource
 import org.orbisgis.geoclimate.Geoindicators
-import org.slf4j.LoggerFactory
 
 @BaseScript Geoindicators geoindicators
 
@@ -249,27 +248,4 @@ def saveToCSV(def outputTable, def filePath, def h2gis_datasource, def deleteOut
         h2gis_datasource.save("(SELECT ID_BUILD, ID_SOURCE FROM $outputTable WHERE estimated=true)", filePath, deleteOutputData)
         info "${outputTable} has been saved in ${filePath}."
     }
-}
-
-/**
- * Utility class to change log level for all loggers
- *
- */
-static def setLoggerLevel(String loggerLevel) {
-    if (loggerLevel) {
-        Level level
-        if (loggerLevel.equalsIgnoreCase("INFO")) {
-            level = Level.INFO
-        } else if (loggerLevel.equalsIgnoreCase("DEBUG")) {
-            level = Level.DEBUG
-        } else if (loggerLevel.equalsIgnoreCase("TRACE")) {
-            level = Level.TRACE
-        } else if (loggerLevel.equalsIgnoreCase("OFF")) {
-            level = Level.OFF
-        } else {
-            throw new RuntimeException("Invalid log level. Allowed values are : INFO, DEBUG, TRACE, OFF")
-        }
-        var context = (LoggerContext) LoggerFactory.getILoggerFactory()
-        context.getLoggerList().each { it -> it.setLevel(level) }
-    }
 }
diff --git a/...rs/src/test/groovy/org/orbisgis/geoclimate/geoindicators/WorkflowGeoIndicatorsTest.groovy b/...rs/src/test/groovy/org/orbisgis/geoclimate/geoindicators/WorkflowGeoIndicatorsTest.groovy
@@ -19,14 +19,14 @@
  */
 package org.orbisgis.geoclimate.geoindicators
 
+import ch.qos.logback.classic.Logger
 import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.io.TempDir
 import org.orbisgis.data.H2GIS
 import org.orbisgis.data.dataframe.DataFrame
 import org.orbisgis.geoclimate.Geoindicators
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 import static org.junit.jupiter.api.Assertions.*
 import static org.orbisgis.data.H2GIS.open
@@ -36,7 +36,7 @@ class WorkflowGeoIndicatorsTest {
     @TempDir
     static File folder
 
-    public static Logger logger = LoggerFactory.getLogger(WorkflowGeoIndicatorsTest.class)
+    public static Logger logger = LoggerUtils.createLogger(WorkflowGeoIndicatorsTest.class)
 
     // Indicator list (at RSU scale) for each type of use
     public static listNames = [

diff --git a/osm/pom.xml b/osm/pom.xml
@@ -63,6 +63,10 @@
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.orbisgis.geoclimate</groupId>
+            <artifactId>common-utils</artifactId>
+        </dependency>
         <!-- Test dependencies -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>

diff --git a/osm/src/main/groovy/org/orbisgis/geoclimate/osm/OSM.groovy b/osm/src/main/groovy/org/orbisgis/geoclimate/osm/OSM.groovy
@@ -21,10 +21,9 @@ package org.orbisgis.geoclimate.osm
 
 import org.locationtech.jts.geom.Envelope
 import org.locationtech.jts.geom.Geometry
-import org.orbisgis.geoclimate.geoindicators.WorkflowUtilities
 import org.orbisgis.geoclimate.osmtools.utils.Utilities
 import org.orbisgis.geoclimate.utils.AbstractScript
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 /**
  * Main class to access to the OSM processes
@@ -37,8 +36,7 @@ abstract class OSM extends AbstractScript {
     public static InputDataFormatting = new InputDataFormatting()
 
     OSM() {
-        super(LoggerFactory.getLogger(OSM.class))
-        WorkflowUtilities.setLoggerLevel("INFO")
+        super(OSM.class)
     }
 
 

diff --git a/osm/src/test/groovy/org/orbisgis/geoclimate/osm/WorkflowAbstractTest.groovy b/osm/src/test/groovy/org/orbisgis/geoclimate/osm/WorkflowAbstractTest.groovy
@@ -19,15 +19,15 @@
  */
 package org.orbisgis.geoclimate.osm
 
+import ch.qos.logback.classic.Logger
 import org.orbisgis.geoclimate.Geoindicators
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 import static org.junit.jupiter.api.Assertions.*
 
 class WorkflowAbstractTest {
 
-    public static Logger logger = LoggerFactory.getLogger(WorkflowAbstractTest.class)
+    public static Logger logger = LoggerUtils.createLogger(WorkflowAbstractTest.class)
 
     /**
      * A method to compute geomorphological indicators

diff --git a/osmtools/src/main/groovy/org/orbisgis/geoclimate/osmtools/OSMTools.groovy b/osmtools/src/main/groovy/org/orbisgis/geoclimate/osmtools/OSMTools.groovy
@@ -25,7 +25,6 @@ import org.orbisgis.geoclimate.osmtools.utils.TransformUtils as TRANSFORM_UTILS
 import org.orbisgis.geoclimate.osmtools.utils.Utilities as UTILITIES
 import org.orbisgis.geoclimate.utils.AbstractScript
 import org.orbisgis.geoclimate.utils.LoggerUtils
-import org.slf4j.LoggerFactory
 
 /**
  * Main script to access to all processes used to extract, transform and save OSM data as GIS layers.
@@ -42,7 +41,6 @@ abstract class OSMTools extends AbstractScript {
     def static TransformUtils = new TRANSFORM_UTILS()
 
     OSMTools() {
-        super(LoggerFactory.getLogger(OSMTools.class))
-        LoggerUtils.setLoggerLevel("INFO")
+        super(OSMTools.class)
     }
 }
diff --git a/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/LoaderTest.groovy b/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/LoaderTest.groovy
@@ -19,15 +19,15 @@
  */
 package org.orbisgis.geoclimate.osmtools
 
+import ch.qos.logback.classic.Logger
 import org.junit.jupiter.api.*
 import org.junit.jupiter.api.io.TempDir
 import org.locationtech.jts.geom.Coordinate
 import org.locationtech.jts.geom.GeometryFactory
 import org.orbisgis.data.H2GIS
 import org.orbisgis.geoclimate.osmtools.utils.OSMElement
 import org.orbisgis.geoclimate.osmtools.utils.Utilities
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 import java.util.regex.Pattern
 
@@ -44,7 +44,7 @@ class LoaderTest extends AbstractOSMToolsTest {
     @TempDir
     static File folder
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(LoaderTest)
+    private static final Logger LOGGER = LoggerUtils.createLogger(LoaderTest)
 
     static H2GIS ds
 

diff --git a/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/TransformTest.groovy b/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/TransformTest.groovy
@@ -19,15 +19,15 @@
  */
 package org.orbisgis.geoclimate.osmtools
 
+import ch.qos.logback.classic.Logger
 import org.h2gis.utilities.GeographyUtilities
 import org.junit.jupiter.api.*
 import org.junit.jupiter.api.io.TempDir
 import org.locationtech.jts.geom.*
 import org.orbisgis.data.H2GIS
 import org.orbisgis.geoclimate.osmtools.utils.OSMElement
 import org.orbisgis.geoclimate.osmtools.utils.Utilities
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 import static org.junit.jupiter.api.Assertions.*
 
@@ -42,7 +42,7 @@ class TransformTest extends AbstractOSMToolsTest {
     @TempDir
     static File folder
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(TransformTest)
+    private static final Logger LOGGER = LoggerUtils.createLogger(TransformTest)
 
     static H2GIS ds
 

diff --git a/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/utils/TransformUtilsTest.groovy b/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/utils/TransformUtilsTest.groovy
@@ -19,6 +19,7 @@
  */
 package org.orbisgis.geoclimate.osmtools.utils
 
+import ch.qos.logback.classic.Logger
 import org.junit.jupiter.api.*
 import org.junit.jupiter.api.io.CleanupMode
 import org.junit.jupiter.api.io.TempDir
@@ -27,8 +28,7 @@ import org.locationtech.jts.geom.MultiLineString
 import org.orbisgis.data.H2GIS
 import org.orbisgis.geoclimate.osmtools.AbstractOSMToolsTest
 import org.orbisgis.geoclimate.osmtools.OSMTools
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 import static org.junit.jupiter.api.Assertions.*
 
@@ -43,7 +43,7 @@ class TransformUtilsTest extends AbstractOSMToolsTest {
     @TempDir(cleanup = CleanupMode.ON_SUCCESS)
     static File folder
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(TransformUtilsTest)
+    private static final Logger LOGGER = LoggerUtils.createLogger(TransformUtilsTest)
 
     static H2GIS h2gis
 

diff --git a/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/utils/UtilitiesTest.groovy b/osmtools/src/test/groovy/org/orbisgis/geoclimate/osmtools/utils/UtilitiesTest.groovy
@@ -19,6 +19,7 @@
  */
 package org.orbisgis.geoclimate.osmtools.utils
 
+import ch.qos.logback.classic.Logger
 import org.junit.jupiter.api.*
 import org.junit.jupiter.api.io.CleanupMode
 import org.junit.jupiter.api.io.TempDir
@@ -29,8 +30,7 @@ import org.locationtech.jts.geom.Polygon
 import org.orbisgis.data.H2GIS
 import org.orbisgis.geoclimate.osmtools.AbstractOSMToolsTest
 import org.orbisgis.geoclimate.osmtools.OSMTools
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 import java.util.regex.Pattern
 
@@ -47,7 +47,7 @@ class UtilitiesTest extends AbstractOSMToolsTest {
     @TempDir(cleanup = CleanupMode.ON_SUCCESS)
     static File folder
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(UtilitiesTest)
+    private static final Logger LOGGER = LoggerUtils.createLogger(UtilitiesTest)
 
     /** Used to store method pointer in order to replace it for the tests to avoid call to Overpass servers. */
     private static def executeOverPassQuery

diff --git a/worldpoptools/src/main/groovy/org/orbisgis/geoclimate/worldpoptools/WorldPopTools.groovy b/worldpoptools/src/main/groovy/org/orbisgis/geoclimate/worldpoptools/WorldPopTools.groovy
@@ -32,7 +32,6 @@ package org.orbisgis.geoclimate.worldpoptools
 
 import org.orbisgis.geoclimate.utils.AbstractScript
 import org.orbisgis.geoclimate.utils.LoggerUtils
-import org.slf4j.LoggerFactory
 
 /**
  * Main script to access to all WorldPop utilities
@@ -48,7 +47,6 @@ abstract class WorldPopTools extends AbstractScript {
     def static Extract = new WorldPopExtract()
 
     WorldPopTools() {
-        super(LoggerFactory.getLogger(WorldPopTools.class))
-        LoggerUtils.setLoggerLevel("INFO")
+        super(WorldPopTools.class)
     }
 }
diff --git a/...poptools/src/test/groovy/org/orbisgis/geoclimate/worldpoptools/WorldPopExtractTest.groovy b/...poptools/src/test/groovy/org/orbisgis/geoclimate/worldpoptools/WorldPopExtractTest.groovy
@@ -19,13 +19,13 @@
  */
 package org.orbisgis.geoclimate.worldpoptools
 
+import ch.qos.logback.classic.Logger
 import org.h2gis.api.EmptyProgressVisitor
 import org.h2gis.functions.io.asc.AscReaderDriver
 import org.junit.jupiter.api.*
 import org.junit.jupiter.api.io.TempDir
 import org.orbisgis.data.H2GIS
-import org.slf4j.Logger
-import org.slf4j.LoggerFactory
+import org.orbisgis.geoclimate.utils.LoggerUtils
 
 import static org.junit.jupiter.api.Assertions.*
 
@@ -34,7 +34,7 @@ class WorldPopExtractTest {
     @TempDir
     static File folder
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(WorldPopExtractTest)
+    private static final Logger LOGGER = LoggerUtils.createLogger(WorldPopExtractTest)
     private static H2GIS h2GIS
 
     @BeforeAll