tests migrated to kotest;

fixed an issue with resoling default value as a reference;

Author: Maskim Buryshynets

build.gradle

@@ -2,10 +2,11 @@ plugins {
     id 'jacoco'
     id 'java-library'
     id 'maven-publish'
+    id 'org.jetbrains.kotlin.jvm'
 }
 
 group = 'com.github.arhor'
-version = '0.1.3'
+version = '0.1.4'
 
 sourceCompatibility = property('version.java')
 targetCompatibility = property('version.java')
@@ -24,13 +25,9 @@ repositories {
 }
 
 dependencies {
-    implementation "com.github.spotbugs:spotbugs-annotations:${property('version.spotbugs-annotations')}"
+    implementation "com.github.spotbugs:spotbugs-annotations:${property('version.spotbugs')}"
 
-    testImplementation "org.assertj:assertj-core:${property('version.assertj-core')}"
-    testImplementation "org.junit.jupiter:junit-jupiter-params:${property('version.junit-jupiter')}"
-    testImplementation "org.junit.jupiter:junit-jupiter-api:${property('version.junit-jupiter')}"
-
-    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${property('version.junit-jupiter')}"
+    testImplementation "io.kotest:kotest-runner-junit5-jvm:${property('version.kotest')}"
 }
 
 tasks.withType(JavaCompile) {
@@ -41,13 +38,23 @@ tasks.withType(JavaCompile) {
     ]
 }
 
+tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile) {
+    kotlinOptions {
+        freeCompilerArgs = [
+            '-Xjsr305=strict',
+            '-Xjvm-default=all',
+        ]
+        jvmTarget = project.property('version.java')
+        javaParameters = true
+    }
+}
+
 jacoco {
     toolVersion = property('version.jacoco')
 }
 
 jacocoTestReport {
-    shouldRunAfter test
-
+    dependsOn test
     reports {
         xml.required.set(false)
         csv.required.set(false)
@@ -59,14 +66,15 @@ jacocoTestCoverageVerification {
     violationRules {
         rule {
             limit {
-                minimum = 0.90
+                minimum = 0.95
             }
         }
     }
 }
 
 test {
     useJUnitPlatform()
+    finalizedBy jacocoTestReport
     environment 'TEST_RESOURCES_DIR', file('src/test/resources')
 }
 

gradle.properties

@@ -6,7 +6,7 @@ org.gradle.parallel=false
 
 version.java=11
 version.jacoco=0.8.7
+version.kotest=5.5.2
+version.kotlin=1.7.20
 version.gradle=7.5.1
-version.spotbugs-annotations=4.5.3
-version.assertj-core=3.22.0
-version.junit-jupiter=5.8.2
+version.spotbugs=4.5.3

settings.gradle

@@ -1 +1,7 @@
+pluginManagement {
+    plugins {
+        id 'org.jetbrains.kotlin.jvm' version settings['version.kotlin']
+    }
+}
+
 rootProject.name = 'java-dotenv-revised'

src/main/java/io/github/arhor/dotenv/DotenvConfigurer.java

@@ -2,40 +2,38 @@
 
 import javax.annotation.Nonnull;
 import java.util.Objects;
+import java.util.StringJoiner;
 
 public final class DotenvConfigurer {
 
     private static final class LazyHolder {
         private static final DotenvConfigurer DEFAULT = new DotenvConfigurer(
-            /* strictMode =                   */ false,
-            /* includeSystemVariables =       */ true,
-            /* allowOverrideSystemVariables = */ true,
-            /* location =                     */ ".",
-            /* filename =                     */ ".env"
+            /* location =               */ ".",
+            /* filename =               */ ".env",
+            /* strictMode =             */ false,
+            /* includeSystemVariables = */ true,
+            /* replaceSystemVariables = */ true
         );
     }
 
-    private final boolean strictMode;
-    private final boolean includeSystemVariables;
-    private final boolean allowOverrideSystemVariables;
     private final String location;
     private final String filename;
+    private final boolean strictMode;
+    private final boolean includeSystemVariables;
+    private final boolean replaceSystemVariables;
 
     private DotenvConfigurer(
+        final String location,
+        final String filename,
         final boolean strictMode,
         final boolean includeSystemVariables,
-        final boolean allowOverrideSystemVariables,
-        final String location,
-        final String filename
+        final boolean replaceSystemVariables
     ) {
-        Objects.requireNonNull(location, "location must not be null");
-        Objects.requireNonNull(filename, "filename must not be null");
-
+        this.location = Objects.requireNonNull(location, "location must not be null");
+        this.filename = Objects.requireNonNull(filename, "filename must not be null");
         this.strictMode = strictMode;
         this.includeSystemVariables = includeSystemVariables;
-        this.allowOverrideSystemVariables = allowOverrideSystemVariables;
-        this.location = location;
-        this.filename = filename;
+        this.replaceSystemVariables = replaceSystemVariables;
     }
 
     static DotenvConfigurer getInstance() {
@@ -45,70 +43,78 @@ static DotenvConfigurer getInstance() {
     @Nonnull
     public Dotenv load() {
         try {
-            final var fileContent = DotenvFileLoader.readDotenvFileAsProperties(location, filename);
-            return new DotenvImpl(this, fileContent);
+            final var properties = DotenvFileLoader.readDotenvFileAsProperties(location, filename);
+            return new DotenvImpl(this, properties);
         } catch (final Exception e) {
             throw new LoadingException(e);
         }
     }
 
     @Nonnull
-    public DotenvConfigurer strictMode(final boolean strictMode) {
+    public DotenvConfigurer location(@Nonnull final String location) {
         return new DotenvConfigurer(
-            strictMode,
+            location,
+            this.filename,
+            this.strictMode,
             this.includeSystemVariables,
-            this.allowOverrideSystemVariables,
-            this.location,
-            this.filename
+            this.replaceSystemVariables
         );
     }
 
     @Nonnull
-    public DotenvConfigurer includeSystemVariables(final boolean includeSystemVariables) {
+    public DotenvConfigurer filename(@Nonnull final String filename) {
         return new DotenvConfigurer(
-            this.strictMode,
-            includeSystemVariables,
-            this.allowOverrideSystemVariables,
             this.location,
-            this.filename
+            filename,
+            this.strictMode,
+            this.includeSystemVariables,
+            this.replaceSystemVariables
         );
     }
 
-
     @Nonnull
-    public DotenvConfigurer allowOverrideSystemVariables(final boolean allowOverrideSystemVariables) {
+    public DotenvConfigurer strictMode(final boolean strictMode) {
         return new DotenvConfigurer(
-            this.strictMode,
-            this.includeSystemVariables,
-            allowOverrideSystemVariables,
             this.location,
-            this.filename
+            this.filename,
+            strictMode,
+            this.includeSystemVariables,
+            this.replaceSystemVariables
         );
     }
 
-
     @Nonnull
-    public DotenvConfigurer location(@Nonnull final String location) {
+    public DotenvConfigurer includeSystemVariables(final boolean includeSystemVariables) {
         return new DotenvConfigurer(
+            this.location,
+            this.filename,
             this.strictMode,
-            this.includeSystemVariables,
-            this.allowOverrideSystemVariables,
-            location,
-            this.filename
+            includeSystemVariables,
+            this.replaceSystemVariables
         );
     }
 
     @Nonnull
-    public DotenvConfigurer filename(@Nonnull final String filename) {
+    public DotenvConfigurer replaceSystemVariables(final boolean replaceSystemVariables) {
         return new DotenvConfigurer(
-            strictMode,
-            includeSystemVariables,
-            allowOverrideSystemVariables,
-            location,
-            filename
+            this.location,
+            this.filename,
+            this.strictMode,
+            this.includeSystemVariables,
+            replaceSystemVariables
         );
     }
 
+    @Nonnull
+    public String getLocation() {
+        return location;
+    }
+
+    @Nonnull
+    public String getFilename() {
+        return filename;
+    }
+
     public boolean isStrictMode() {
         return strictMode;
     }
@@ -117,17 +123,46 @@ public boolean isIncludeSystemVariables() {
         return includeSystemVariables;
     }
 
-    public boolean isAllowOverrideSystemVariables() {
-        return allowOverrideSystemVariables;
+    public boolean isReplaceSystemVariables() {
+        return replaceSystemVariables;
     }
 
-    @Nonnull
-    public String getLocation() {
-        return location;
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        DotenvConfigurer that = (DotenvConfigurer) o;
+
+        return strictMode == that.strictMode
+            && includeSystemVariables == that.includeSystemVariables
+            && replaceSystemVariables == that.replaceSystemVariables
+            && location.equals(that.location)
+            && filename.equals(that.filename);
     }
 
-    @Nonnull
-    public String getFilename() {
-        return filename;
+    @Override
+    public int hashCode() {
+        int result = location.hashCode();
+        result = 31 * result + filename.hashCode();
+        result = 31 * result + (strictMode ? 1 : 0);
+        result = 31 * result + (includeSystemVariables ? 1 : 0);
+        result = 31 * result + (replaceSystemVariables ? 1 : 0);
+        return result;
+    }
+
+    @Override
+    public String toString() {
+        return new StringJoiner(", ", DotenvConfigurer.class.getSimpleName() + "(", ")")
+            .add("location='" + location + "'")
+            .add("filename='" + filename + "'")
+            .add("strictMode=" + strictMode)
+            .add("includeSystemVariables=" + includeSystemVariables)
+            .add("replaceSystemVariables=" + replaceSystemVariables)
+            .toString();
     }
 }

src/main/java/io/github/arhor/dotenv/DotenvImpl.java

@@ -24,41 +24,47 @@ final class DotenvImpl implements Dotenv {
     private final Set<String> currentSearchHistory = new LinkedHashSet<>();
 
     DotenvImpl(final DotenvConfigurer configurer, final Properties properties) {
-        Objects.requireNonNull(configurer, "config must not be null");
-        Objects.requireNonNull(properties, "fileContent must not be null");
-
-        this.configurer = configurer;
-        this.properties = properties;
+        this.configurer = Objects.requireNonNull(configurer, "configurer must not be null");
+        this.properties = Objects.requireNonNull(properties, "properties must not be null");
     }
 
     @Nullable
     @Override
     public String get(@Nullable final String name) {
-        return getPropertyThenClearSearchHistory(name);
+        return getPropertyThenClearSearchHistory(name, null, false);
     }
 
     @Nullable
     @Override
     public String get(@Nullable final String name, @Nullable final String defaultValue) {
-        final var property = getPropertyThenClearSearchHistory(name);
-        return (property != null)
-            ? property
-            : defaultValue;
+        return getPropertyThenClearSearchHistory(name, defaultValue, true);
     }
 
     @Nonnull
     @Override
     public String getRequired(@Nonnull final String name) throws MissingPropertyException {
-        final var property = getPropertyThenClearSearchHistory(name);
+        final var property = getPropertyThenClearSearchHistory(name, null, false);
         if (property != null) {
             return property;
         }
         throw new MissingPropertyException(name);
     }
 
-    private String getPropertyThenClearSearchHistory(final String name) {
+    private String getPropertyThenClearSearchHistory(
+        final String name,
+        final String defaultValue,
+        final boolean useDefaultValue
+    ) {
         try {
-            return getProperty(name);
+            final var property = getProperty(name);
+
+            if (property != null || !useDefaultValue) {
+                return property;
+            } else if (defaultValue != null) {
+                return resolveReferences(defaultValue);
+            } else {
+                return null;
+            }
         } finally {
             currentSearchHistory.clear();
         }
@@ -78,7 +84,7 @@ private String findProperty(final String name) {
         final var property = configurer.isIncludeSystemVariables()
             ? System.getenv().get(name)
             : null;
-        return ((property == null) || configurer.isAllowOverrideSystemVariables())
+        return ((property == null) || configurer.isReplaceSystemVariables())
             ? properties.getProperty(name)
             : property;
     }