Merge pull request #32 from TechnologyBrewery/31-parent-update-10

#31 ⬆️ update to parent version 10 (JDK 17, default Python fo…

Author: d-ryan-ashcraft

krausening-python/pom.xml

@@ -18,6 +18,9 @@
             <plugin>
                 <groupId>org.technologybrewery.habushu</groupId>
                 <artifactId>habushu-maven-plugin</artifactId>
+                <configuration>
+                    <pythonVersion>${version.python.default}</pythonVersion>
+                </configuration>
             </plugin>
         </plugins>
     </build>

krausening-python/src/krausening/logging/log_manager.py

@@ -5,16 +5,17 @@ class LogManager:
     """
     Class for handling logging.
     """
-    DEFAULT_LOG_LEVEL = 'INFO'
+
+    DEFAULT_LOG_LEVEL = "INFO"
 
     LOG_LEVELS = {
-    'CRITICAL': logging.CRITICAL,
-    'ERROR': logging.ERROR,
-    'WARNING': logging.WARNING,
-    'INFO': logging.INFO,
-    'DEBUG': logging.DEBUG,
-    'NOTSET': logging.NOTSET,
-}
+        "CRITICAL": logging.CRITICAL,
+        "ERROR": logging.ERROR,
+        "WARNING": logging.WARNING,
+        "INFO": logging.INFO,
+        "DEBUG": logging.DEBUG,
+        "NOTSET": logging.NOTSET,
+    }
 
     __instance = None
 
@@ -39,7 +40,9 @@ def __init__(self):
     def _get_log_level(self, log_level: str) -> int:
         return self.LOG_LEVELS.get(log_level, self.LOG_LEVELS[self.DEFAULT_LOG_LEVEL])
 
-    def get_logger(self, name: str, log_level: str = DEFAULT_LOG_LEVEL) -> logging.Logger:
+    def get_logger(
+        self, name: str, log_level: str = DEFAULT_LOG_LEVEL
+    ) -> logging.Logger:
         logger = logging.getLogger(name)
         logger.addHandler(LogManager.__handler)
 

krausening-python/tests/features/steps/logging_steps.py

@@ -2,38 +2,48 @@
 from krausening.logging import LogManager
 
 LOG_LEVEL_MAPPING = {
-    50: 'CRITICAL',
-    40: 'ERROR',
-    30: 'WARNING',
-    20: 'INFO',
-    10: 'DEBUG',
-    0: 'NOTSET',
-} 
-
-@given('a name for the logger')
+    50: "CRITICAL",
+    40: "ERROR",
+    30: "WARNING",
+    20: "INFO",
+    10: "DEBUG",
+    0: "NOTSET",
+}
+
+
+@given("a name for the logger")
 def step_impl(context):
-    context.name = 'test_logger'
+    context.name = "test_logger"
 
-@given('a log level of {log_level}')
+
+@given("a log level of {log_level}")
 def step_impl(context, log_level):
     context.log_level = log_level
 
-@given('no log level specification')
+
+@given("no log level specification")
 def step_impl(context):
     context.log_level = None
 
-@given('an invalid log level specification')
+
+@given("an invalid log level specification")
 def step_impl(context):
-    context.log_level = 'WARNIG'
+    context.log_level = "WARNIG"
+
 
-@when('the get logger method is called')
+@when("the get logger method is called")
 def step_impl(context):
     if context.log_level:
-        context.logger = LogManager.get_instance().get_logger(context.name, context.log_level)
+        context.logger = LogManager.get_instance().get_logger(
+            context.name, context.log_level
+        )
     else:
         context.logger = LogManager.get_instance().get_logger(context.name)
 
-@then('a logger is returned with a log level of {log_level}')
+
+@then("a logger is returned with a log level of {log_level}")
 def step_impl(context, log_level):
     assigned_log_level = LOG_LEVEL_MAPPING[context.logger.level]
-    assert assigned_log_level == log_level, f'The specified log level ({log_level}) does not match the assigned log level ({assigned_log_level}).'
+    assert (
+        assigned_log_level == log_level
+    ), f"The specified log level ({log_level}) does not match the assigned log level ({assigned_log_level})."

krausening/pom.xml

@@ -26,12 +26,12 @@
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>
-            <version>3.14.0</version>
+            <version>3.17.0</version>
         </dependency>
         <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
-            <version>2.16.1</version>
+            <version>2.17.0</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -72,6 +72,17 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <!--
+                        While we build with Java 17, continue to release Java 11 compatible code until
+                        Maven 4 is the minimum supported version
+                        -->
+                    <release>11</release>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>

krausening/src/main/java/org/technologybrewery/krausening/Krausening.java

@@ -1,5 +1,13 @@
 package org.technologybrewery.krausening;
 
+import org.apache.commons.io.filefilter.SuffixFileFilter;
+import org.apache.commons.lang3.StringUtils;
+import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;
+import org.jasypt.iv.RandomIvGenerator;
+import org.jasypt.properties.EncryptableProperties;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.File;
 import java.io.FileReader;
 import java.io.FilenameFilter;
@@ -11,35 +19,27 @@
 import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
 
-import org.apache.commons.io.filefilter.SuffixFileFilter;
-import org.apache.commons.lang3.StringUtils;
-import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;
-import org.jasypt.iv.RandomIvGenerator;
-import org.jasypt.properties.EncryptableProperties;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * In brewing, krausening (KROI-zen-ing) refers to adding a small amount of
  * fresh wort to prime finished beer for carbonation. In Java, Krausening is a
  * project to populate finished archives for deployment. This approach allows
  * Properties files to be externalized from deployment units, enabling the same
  * deployment unit to be leveraged repeatedly without the need to rebuild or
  * hacking the archive.
- * 
+ *
  * To use, you need to minimally set a system property "KRAUSENING_BASE", which
  * points to a directory where your {@link Properties} files will be located.
  * Krausening will load those up and make them available via the
  * {@code getProperties(<file name>)} method.
- * 
+ *
  * You can then use a system property called "KRAUSENING_EXTENSIONS" to set up
  * extensions to the {@link Properties} files located in "KRAUSENING_BASE". The
  * first the base properties will be loaded, with anything in the extensions
  * location being added on to the top. This allows value to be added or
  * overridden, which is especially useful when you have a standard configuration
  * defined in your base files, but need to specialize some values for different
  * deployments.
- * 
+ *
  * Only .properties files will be loaded. Any other file encountered will be
  * skipped.
  */
@@ -84,9 +84,9 @@ public final class Krausening {
 
     /** Whether or not KRAUSENING_PASSWORD is non-blank. */
     private boolean hasMasterPassword;
-    
+
     private static Map<String, Krausening> instanceMap = new HashMap<>();
-    
+
     private static String defaultInstanceKey = UUID.randomUUID().toString();
 
     /**
@@ -97,7 +97,7 @@ private Krausening() {}
 
     /**
      * Returns the singleton instance of this class.
-     * 
+     *
      * @return singleton reference to Krausening
      */
     public static Krausening getInstance() {
@@ -109,14 +109,14 @@ public static Krausening getInstance() {
 		}
 		return instance;
     }
-    
+
     protected void updateDefaultInstance() {
 		instanceMap.put(defaultInstanceKey, this);
     }
-    
+
     /**
      * Returns an instance of the class based on the overrideExtensionsSubfolder requested.
-     * 
+     *
      * @param overrideExtensionsSubfolder
      * @return
      */
@@ -186,7 +186,7 @@ protected void setEncryptionFoundation() {
     /**
      * Log an error for the file and location type when the location does not
      * exist.
-     * 
+     *
      * @param file
      *            The file that does not exist
      * @param location
@@ -228,7 +228,7 @@ private boolean setLocations() {
 
     /**
      * Loads all .properties files from the passed location.
-     * 
+     *
      * @param location
      *            the location containing properties files
      * @param locationType
@@ -267,7 +267,7 @@ private void loadPropertiesFromLocation(File location, String locationType) {
     /**
      * Creates an empty Properties file, either standard or encrypted, based on
      * whether or not the master password is set.
-     * 
+     *
      * @return An empty properties instance
      */
     private Properties createEmptyProperties() {
@@ -291,7 +291,7 @@ private Properties createEmptyProperties() {
 
     /**
      * Returns the properties file loaded by Krausening for given file name.
-     * 
+     *
      * @param propertiesFileName
      *            The file name to retrieve
      * @return The file or null if that file name is not know
@@ -306,7 +306,7 @@ public Properties getProperties(String propertiesFileName) {
      * for the entire system. It acts a second level extension effectively. A
      * property is first set in base, the extensions, then finally in a
      * subfolder within the override extension location.
-     * 
+     *
      * @param overrideExtensionSubfolder
      */
     protected void setOverrideExtensionsSubfolder(String overrideExtensionSubfolder) {
@@ -315,7 +315,7 @@ protected void setOverrideExtensionsSubfolder(String overrideExtensionSubfolder)
         // extensions directory
         this.overrideExtensionSubfolder = overrideExtensionSubfolder;
     }
-    
-    
-    
+
+
+
 }

krausening/src/test/java/org/technologybrewery/krausening/TestEncryptedKrausening.java

@@ -4,6 +4,7 @@
 import static org.junit.Assert.assertNotNull;
 
 import java.util.Properties;
+import java.util.Set;
 
 import org.aeonbits.owner.KrauseningConfig;
 import org.aeonbits.owner.KrauseningConfig.KrauseningSources;
@@ -28,6 +29,13 @@ public void testEncryptedPropertyReadProvidesDecryptedValue() {
 		krausening.loadProperties();
 		Properties properties = krausening.getProperties(ENCRYPTED_PROPERTIES);
 		assertNotNull(properties);
+		Set<Object> keys = properties.keySet();
+		for (Object key : keys) {
+			String keyAsString = key.toString();
+			if (PASSWORD_KEY.equals(keyAsString)) {
+				assertEquals(DECRYPTED_PASSWORD_VALUE, properties.getProperty(keyAsString));
+			}
+		}
 		assertEquals(DECRYPTED_PASSWORD_VALUE, properties.getProperty(PASSWORD_KEY));
 	}
 

pom.xml

@@ -3,7 +3,7 @@
     <parent>
         <groupId>org.technologybrewery</groupId>
         <artifactId>parent</artifactId>
-        <version>9</version>
+        <version>10</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>
@@ -47,7 +47,6 @@
         <connection>scm:git:ssh://git@github.com/TechnologyBrewery/krausening.git</connection>
         <developerConnection>scm:git:ssh://git@github.com/TechnologyBrewery/krausening.git</developerConnection>
         <url>https://github.com/TechnologyBrewery/krausening</url>
-        <tag>krausening-root-16</tag>
     </scm>
 
     <modules>
@@ -61,7 +60,7 @@
                 <plugin>
                     <groupId>org.technologybrewery.habushu</groupId>
                     <artifactId>habushu-maven-plugin</artifactId>
-                    <version>2.15.0</version>
+                    <version>2.16.1</version>
                     <extensions>true</extensions>
                 </plugin>
             </plugins>