[bugfix] Avoid reflection for setting private LOG field

Author: adamretter

extensions/indexes/range/pom.xml

@@ -188,6 +188,7 @@
                                 <include>src/test/resources/log4j2.xml</include>
                                 <include>src/test/xquery/range/conditions.xql</include>
                                 <include>src/main/java/org/exist/indexing/range/RangeIndexAnalyzer.java</include>
+                                <include>src/main/java/org/exist/indexing/range/RangeIndexConfig.java</include>
                                 <include>src/main/java/org/exist/indexing/range/RangeIndexConfigAttributeCondition.java</include>
                                 <include>src/main/java/org/exist/indexing/range/RangeIndexConfigElement.java</include>
                                 <include>src/main/java/org/exist/indexing/range/RangeIndexConfigField.java</include>
@@ -206,6 +207,7 @@
                                 <exclude>src/test/resources/log4j2.xml</exclude>
                                 <exclude>src/test/xquery/range/conditions.xql</exclude>
                                 <exclude>src/main/java/org/exist/indexing/range/RangeIndexAnalyzer.java</exclude>
+                                <exclude>src/main/java/org/exist/indexing/range/RangeIndexConfig.java</exclude>
                                 <exclude>src/main/java/org/exist/indexing/range/RangeIndexConfigAttributeCondition.java</exclude>
                                 <exclude>src/main/java/org/exist/indexing/range/RangeIndexConfigElement.java</exclude>
                                 <exclude>src/main/java/org/exist/indexing/range/RangeIndexConfigField.java</exclude>

extensions/indexes/range/src/main/java/org/exist/indexing/range/RangeIndexConfig.java

@@ -1,4 +1,28 @@
 /*
+ * Elemental
+ * Copyright (C) 2024, Evolved Binary Ltd
+ *
+ * admin@evolvedbinary.com
+ * https://www.evolvedbinary.com | https://www.elemental.xyz
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; version 2.1.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
+ *       The original license header is included below.
+ *
+ * =====================================================================
+ *
  * eXist-db Open Source Native XML Database
  * Copyright (C) 2001 The eXist-db Authors
  *
@@ -135,9 +159,9 @@ private void parseChildren(NodeList configNodes, Map<String, String> namespaces)
                     }
 
                     if(uri != null) {
-                        LOG.error("Invalid range index configuration (" + uri + "): " + e.getMessage());
+                        getLogger().error("Invalid range index configuration (" + uri + "): " + e.getMessage());
                     } else {
-                        LOG.error("Invalid range index configuration: " + e.getMessage());
+                        getLogger().error("Invalid range index configuration: " + e.getMessage());
                     }
                 }
             }
@@ -266,4 +290,13 @@ public void remove() {
         }
 
     }
-}
+
+    /**
+     * Designed to be overridable so that we can observe logging in tests.
+     *
+     * @return the logger.
+     */
+    Logger getLogger() {
+        return LOG;
+    }
+}

extensions/indexes/range/src/test/java/org/exist/indexing/range/RangeIndexConfigTest.java

@@ -106,7 +106,6 @@ public void errorsHaveSourceContext() throws NoSuchFieldException, IllegalAccess
         expect(mockCreateDocument.getDocumentURI()).andReturn(mockCollectionXConfUri);
 
         final Capture<String> errorMsgCapture = newCapture();
-
         mockLogger.error(capture(errorMsgCapture));
 
         replay(mockConfigNodes, mockConfigNode, mockCreates, mockCreateDocument, mockCreate, mockEmptyNodeList, mockLogger);
@@ -116,26 +115,17 @@ public void errorsHaveSourceContext() throws NoSuchFieldException, IllegalAccess
         final Map<String, String> namespaces = new HashMap<>();
         namespaces.put("tei", "http://www.tei-c.org/ns/1.0");
 
-        overrideLogger(RangeIndexConfig.class, mockLogger);
-        final RangeIndexConfig config = new RangeIndexConfig(mockConfigNodes, namespaces);
+        final RangeIndexConfig config = new RangeIndexConfig(mockConfigNodes, namespaces) {
+            @Override
+            Logger getLogger() {
+                return mockLogger;
+            }
+        };
 
         assertTrue(errorMsgCapture.getValue().contains("Illegal QName: '" + badCreateQName + "'.. QName is invalid: INVALID_LOCAL_PART"));
         assertTrue(errorMsgCapture.getValue().contains("(" + mockCollectionXConfUri + ")"));
 
-        verify(mockConfigNodes, mockConfigNode, mockCreates, mockCreateDocument, mockCreate, mockEmptyNodeList, mockLogger);
+        verify(mockConfigNodes, mockConfigNode, mockCreates, mockCreateDocument, mockCreate, mockEmptyNodeList);
     }
 
-    private void overrideLogger(final Class clazz, final Logger logger) throws NoSuchFieldException, IllegalAccessException {
-        final Field loggerField = clazz.getDeclaredField("LOG");
-
-        // allow access to private field
-        loggerField.setAccessible(true);
-
-        // remove final modifier
-        final Field modifiersField = JDKCompatibility.getModifiersField();
-        modifiersField.setAccessible(true);
-        modifiersField.setInt(loggerField, loggerField.getModifiers() & ~Modifier.FINAL);
-
-        loggerField.set(null, logger);
-    }
 }