diff --git a/CHANGELOG.md b/CHANGELOG.md index f105db1..4a3c108 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] - xxxx-xx-xx ### Added +- Hierarchical dotenv definitions support [#19](https://github.com/uzzu/dotenv-gradle/issues/19) + - [See example](/examples/hierarchical_definitions) ### Changed - Update Gradle to 7.1.1 [#16](https://github.com/uzzu/dotenv-gradle/issues/16) diff --git a/README.md b/README.md index b32097d..7878db2 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,12 @@ If environment variable `ENV_FILE` is set, The plugin read a file specified `ENV [See example](/examples/change_file) +### [Optional] Hierarchical dotenv definitions + +Support subproject-only variables and extensions. + +[See example](/examples/hierarchical_definitions) + ### Others - All APIs of `env` extension consider `.env` file. - If the same variable name value is defined in both the `.env` file and the system environment variable, the system environment variable takes precedence. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..17a21d0 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,3 @@ +- [Basic Usage](/examples/basic) +- [Change `.env` filename](/examples/change_file) +- [Hierarchical dotenv definitions](/examples/hierarchical_definitions) diff --git a/examples/change_file/README.md b/examples/change_file/README.md index 9f12222..02b219d 100644 --- a/examples/change_file/README.md +++ b/examples/change_file/README.md @@ -1,5 +1,7 @@ ## Change file example +version since: 1.2.0 + Run the following command to confirm that the DotEnv file to be loaded has changed. - `./gradlew clean` diff --git a/examples/hierarchical_definitions/.env b/examples/hierarchical_definitions/.env new file mode 100644 index 0000000..df4f4ca --- /dev/null +++ b/examples/hierarchical_definitions/.env @@ -0,0 +1 @@ +FOO=100 diff --git a/examples/hierarchical_definitions/.env.template b/examples/hierarchical_definitions/.env.template new file mode 100644 index 0000000..15a1b99 --- /dev/null +++ b/examples/hierarchical_definitions/.env.template @@ -0,0 +1 @@ +FOO= diff --git a/examples/hierarchical_definitions/.gitattributes b/examples/hierarchical_definitions/.gitattributes new file mode 100644 index 0000000..00a51af --- /dev/null +++ b/examples/hierarchical_definitions/.gitattributes @@ -0,0 +1,6 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# These are explicitly windows files and should use crlf +*.bat text eol=crlf + diff --git a/examples/hierarchical_definitions/.gitignore b/examples/hierarchical_definitions/.gitignore new file mode 100644 index 0000000..1b6985c --- /dev/null +++ b/examples/hierarchical_definitions/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/examples/hierarchical_definitions/README.md b/examples/hierarchical_definitions/README.md new file mode 100644 index 0000000..bc86a34 --- /dev/null +++ b/examples/hierarchical_definitions/README.md @@ -0,0 +1,58 @@ +## Hierarchical dotenv definitions example + +version since: 2.0.0 + +The plugin until version 1.x, refers only to `.env` file in root project directory, and could not create environement variable extension which only to use in subproject. +So organization of environment variable names makes complicated for a bit. (e.g. Appends prefix to name.) + +This feature reduces complexity of environment variable names. + +``` +(Root). +├── .env # Adds extension to all subprojects. +├── .env.template # Adds extension to all subprojects. +├── build.gradle.kts +├── settings.gradle.kts +├── foo +│   ├── .env # Adds extension only to subproject ':foo'. +│   ├── .env.template # Adds extension only to subproject ':foo'. +│   ├── build.gradle.kts +│   └── src +└── bar +    ├── .env # Adds extension only to subproject ':bar'. +    ├── .env.template # Adds extension only to subproject ':bar'. + ├── build.gradle.kts + └── src +``` + +If an environment variable with the same name as the parent project is declared in a child project, the value specified in the child project takes precedence in the child project. + +The hierarchy of this feature means not a directory structure, but a parent-child relationship of Projects. +Supporting entire directory hierarchy is out of scope, as shown below. + +``` +(Root). +├── .env # Adds extension to all subprojects. +├── .env.template # Adds extension to all subprojects. +├── build.gradle.kts +├── settings.gradle.kts +└── subprojects + ├── .env # [!] Does not refer. + ├── .env.template # [!] Does not refer. + ├── foo + │   ├── .env # Adds extension only to subproject ':subprojects:foo'. + │   ├── .env.template # Adds extension only to subproject ':subprojects:foo'. + │   ├── build.gradle.kts + │   └── src + └── bar +    ├── .env # Adds extension only to subproject ':subprojects:bar'. +    ├── .env.template # Adds extension only to subproject ':subprojects:bar'. + ├── build.gradle.kts + └── src +``` + +Because in Gradle, the directory hierarchy only means default name of subproject. (so it can be changed) + + +Run `./gradlew clean` and see console outputs. +Edit `build.gradle.kts`, `sub1/build.gradle.kts`, `sub2/build.gradle.kts` or each `.env` file. Then run to see if how it works. diff --git a/examples/hierarchical_definitions/build.gradle.kts b/examples/hierarchical_definitions/build.gradle.kts new file mode 100644 index 0000000..a3a5190 --- /dev/null +++ b/examples/hierarchical_definitions/build.gradle.kts @@ -0,0 +1,8 @@ +plugins { + base + id("co.uzzu.dotenv.gradle") version "1.2.0" +} + +println("[$name] FOO: ${env.FOO.value}") +println("""[$name] BAR is present: ${env.isPresent("BAR")}""") +println("""[$name] BAZ is present: ${env.isPresent("BAZ")}""") diff --git a/examples/hierarchical_definitions/gradle/wrapper/gradle-wrapper.jar b/examples/hierarchical_definitions/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..41d9927 Binary files /dev/null and b/examples/hierarchical_definitions/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/hierarchical_definitions/gradle/wrapper/gradle-wrapper.properties b/examples/hierarchical_definitions/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..41dfb87 --- /dev/null +++ b/examples/hierarchical_definitions/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/hierarchical_definitions/gradlew b/examples/hierarchical_definitions/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/examples/hierarchical_definitions/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/hierarchical_definitions/gradlew.bat b/examples/hierarchical_definitions/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/examples/hierarchical_definitions/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/examples/hierarchical_definitions/settings.gradle.kts b/examples/hierarchical_definitions/settings.gradle.kts new file mode 100644 index 0000000..67e63d0 --- /dev/null +++ b/examples/hierarchical_definitions/settings.gradle.kts @@ -0,0 +1,9 @@ +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + } +} + +rootProject.name = "hierarchical_definitions" +include("sub1", "sub2") diff --git a/examples/hierarchical_definitions/sub1/.env b/examples/hierarchical_definitions/sub1/.env new file mode 100644 index 0000000..0101f1b --- /dev/null +++ b/examples/hierarchical_definitions/sub1/.env @@ -0,0 +1 @@ +BAR=200 diff --git a/examples/hierarchical_definitions/sub1/.env.template b/examples/hierarchical_definitions/sub1/.env.template new file mode 100644 index 0000000..01b053f --- /dev/null +++ b/examples/hierarchical_definitions/sub1/.env.template @@ -0,0 +1 @@ +BAR= diff --git a/examples/hierarchical_definitions/sub1/build.gradle.kts b/examples/hierarchical_definitions/sub1/build.gradle.kts new file mode 100644 index 0000000..d6ea575 --- /dev/null +++ b/examples/hierarchical_definitions/sub1/build.gradle.kts @@ -0,0 +1,3 @@ +println("[${name}] FOO: ${env.FOO.value}") +println("[${name}] BAR: ${env.BAR.value}") +println("""[${name}] BAZ is present: ${env.isPresent("BAZ")}""") diff --git a/examples/hierarchical_definitions/sub2/.env b/examples/hierarchical_definitions/sub2/.env new file mode 100644 index 0000000..298e4a4 --- /dev/null +++ b/examples/hierarchical_definitions/sub2/.env @@ -0,0 +1,2 @@ +FOO=1000 +BAZ=300 diff --git a/examples/hierarchical_definitions/sub2/.env.template b/examples/hierarchical_definitions/sub2/.env.template new file mode 100644 index 0000000..aad2653 --- /dev/null +++ b/examples/hierarchical_definitions/sub2/.env.template @@ -0,0 +1,2 @@ +FOO= +BAZ= diff --git a/examples/hierarchical_definitions/sub2/build.gradle.kts b/examples/hierarchical_definitions/sub2/build.gradle.kts new file mode 100644 index 0000000..46f2ad9 --- /dev/null +++ b/examples/hierarchical_definitions/sub2/build.gradle.kts @@ -0,0 +1,3 @@ +println("[${name}] FOO: ${env.FOO.value} (override)") +println("""[${name}] BAR is present: ${env.isPresent("BAR")}""") +println("[${name}] BAZ: ${env.BAZ.value}") diff --git a/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvPlugin.kt b/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvPlugin.kt index 351e788..b3c62c0 100644 --- a/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvPlugin.kt +++ b/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvPlugin.kt @@ -1,69 +1,33 @@ package co.uzzu.dotenv.gradle -import co.uzzu.dotenv.DotEnvParser import co.uzzu.dotenv.EnvProvider import co.uzzu.dotenv.SystemEnvProvider import org.gradle.api.Plugin import org.gradle.api.Project import org.gradle.api.plugins.ExtensionAware -import java.io.IOException -import java.nio.charset.Charset @Suppress("unused") class DotEnvPlugin : Plugin { override fun apply(target: Project) { + check(target == target.rootProject) { "This plugin must be applied to root project." } + val envProvider = SystemEnvProvider() - val dotenvTemplate = target.rootProject.dotenvTemplate() - val dotenvSource = target.rootProject.dotenvSource() - val dotenvMerged = dotenvTemplate.keys - .union(dotenvSource.keys) - .map { it to dotenvSource[it] } - .toMap() + val resolver = DotEnvResolver(target) + val rootVariables = resolver.resolve(target) - target.applyEnv(envProvider, dotenvMerged) - target.subprojects { it.applyEnv(envProvider, dotenvMerged) } + target.applyEnv(envProvider, rootVariables) + target.subprojects { it.applyEnv(envProvider, resolver.resolve(it)) } } private fun Project.applyEnv(envProvider: EnvProvider, dotenvProperties: Map) { - val env = - extensions.create("env", DotEnvRoot::class.java, envProvider, dotenvProperties) as ExtensionAware + val env = extensions.create( + "env", + DotEnvRoot::class.java, + envProvider, + dotenvProperties + ) as ExtensionAware dotenvProperties.forEach { (name, value) -> env.extensions.create(name, DotEnvProperty::class.java, envProvider, name, value) } } - - private fun Project.dotenvTemplate(filename: String = ".env.template"): Map = - readText(filename).let(DotEnvParser::parse) - - private fun Project.dotenvSource(filename: String = ".env"): Map { - val envFilename = System.getenv(Companion.KEY_ENV_FILE) - ?.takeIf { - val envFile = file(it) - if (!envFile.exists() || !envFile.canRead()) { - throw IOException( - buildString { - append("Could not read the dotenv file specified in the environment variables.") - append(" $KEY_ENV_FILE: $it,") - append(" path: ${envFile.absolutePath}") - } - ) - } - true - } - ?: filename - return readText(envFilename).let(DotEnvParser::parse) - } - - private fun Project.readText(filename: String): String { - val file = file(filename) - return if (file.exists()) { - file.readText(Charset.forName("UTF-8")) - } else { - "" - } - } - - companion object { - private const val KEY_ENV_FILE = "ENV_FILE" - } } diff --git a/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvResolver.kt b/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvResolver.kt new file mode 100644 index 0000000..93eca9a --- /dev/null +++ b/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvResolver.kt @@ -0,0 +1,84 @@ +package co.uzzu.dotenv.gradle + +import co.uzzu.dotenv.DotEnvParser +import org.gradle.api.Project +import java.io.IOException +import java.nio.charset.Charset + +internal class DotEnvResolver(project: Project) { + + private val rootProject: Project + private val dotenvCache: MutableMap> = mutableMapOf() + + init { + rootProject = project.rootProject + } + + fun resolve(project: Project): Map { + val dotenvList = mutableListOf>() + + var current = project + while (true) { + val dotenv = current.dotenv() + dotenvList.add(0, dotenv) + if (current == rootProject) { + break + } + if (current.parent == null) { + break + } + current = checkNotNull(current.parent) + } + return dotenvList + .fold(mutableMapOf()) { destination, dotenv -> destination.apply { putAll(dotenv) } } + .toMap() + } + + private fun Project.dotenv(): Map { + require(this@dotenv.rootProject == this@DotEnvResolver.rootProject) + if (dotenvCache[this] == null) { + val dotenvTemplate = dotenvTemplate() + val dotenvSource = dotenvSource() + val variables = dotenvTemplate.keys + .union(dotenvSource.keys) + .associateWith { dotenvSource[it] } + dotenvCache[project] = variables + } + return checkNotNull(dotenvCache[project]) + } + + private fun Project.dotenvTemplate(filename: String = ".env.template"): Map = + readText(filename).let(DotEnvParser::parse) + + private fun Project.dotenvSource(filename: String = ".env"): Map { + val envFilename = System.getenv(KEY_ENV_FILE) + ?.takeIf { + val envFile = file(it) + if (!envFile.exists() || !envFile.canRead()) { + throw IOException( + buildString { + append("Could not read the dotenv file specified in the environment variables.") + append(" $KEY_ENV_FILE: $it,") + append(" path: ${envFile.absolutePath}") + } + ) + } + true + } + ?: filename + return readText(envFilename).let(DotEnvParser::parse) + } + + private fun Project.readText(filename: String): String { + val file = file(filename) + return if (file.exists()) { + file.readText(Charset.forName("UTF-8")) + } else { + "" + } + } + + companion object { + private const val KEY_ENV_FILE = "ENV_FILE" + } +} diff --git a/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/BasicUsageTest.kt b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/BasicUsageTest.kt new file mode 100644 index 0000000..414c8b5 --- /dev/null +++ b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/BasicUsageTest.kt @@ -0,0 +1,147 @@ +package co.uzzu.dotenv.gradle + +import assertk.assertThat +import assertk.assertions.contains +import assertk.assertions.isNotNull +import assertk.assertions.messageContains +import org.gradle.testkit.runner.GradleRunner +import org.gradle.testkit.runner.UnexpectedBuildFailure +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.io.TempDir +import java.io.File + +@Suppress("UnstableApiUsage") // GradleRunner#withPluginClasspath +class BasicUsageTest { + + @TempDir + lateinit var projectDir: File + + @Test + fun applyToRootProject() { + RootProject(projectDir) { + settingsGradle() + buildGradle( + """ + plugins { + base + id("co.uzzu.dotenv.gradle") + } + println("Result: ${'$'}{env.HOGE.value}") + """.trimIndent() + ) + file( + ".env.template", + """ + HOGE= + """.trimIndent() + ) + file( + ".env", + """ + HOGE=100 + """.trimIndent() + ) + } + + val result = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + .build() + + assertThat(result.output).contains("Result: 100") + } + + @Test + fun applyToSubProject() { + RootProject(projectDir) { + settingsGradle( + """ + include("sub") + """.trimIndent() + ) + buildGradle( + """ + plugins { + base + id("co.uzzu.dotenv.gradle") + } + println("Result: ${'$'}{env.HOGE.value}") + """.trimIndent() + ) + file( + ".env.template", + """ + HOGE= + """.trimIndent() + ) + file( + ".env", + """ + HOGE=100 + """.trimIndent() + ) + file( + ".env.staging", + """ + HOGE=200 + """.trimIndent() + ) + directory("sub") + file( + "sub/build.gradle", + """ + println("[Sub] Result: ${'$'}{env.HOGE.value}") + """.trimIndent() + ) + } + + val result = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + .build() + + assertThat(result.output).contains("Result: 100") + assertThat(result.output).contains("[Sub] Result: 100") + } + + @Test + fun throwIfAppliedSubProject() { + RootProject(projectDir) { + settingsGradle( + """ + include("sub") + """.trimIndent() + ) + buildGradle( + """ + plugins { + base + } + """.trimIndent() + ) + directory("sub") + file( + "sub/build.gradle", + """ + plugins { + id("co.uzzu.dotenv.gradle") + } + """.trimIndent() + ) + } + + val runner = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + + var error: UnexpectedBuildFailure? = null + try { + runner.build() + } catch (e: UnexpectedBuildFailure) { + error = e + } + assertThat(error) + .isNotNull() + .messageContains("This plugin must be applied to root project.") + } +} diff --git a/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvFileTest.kt b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvFileTest.kt index 8b89d9c..0b83539 100644 --- a/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvFileTest.kt +++ b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvFileTest.kt @@ -16,47 +16,6 @@ class ChangeDotEnvFileTest { @TempDir lateinit var projectDir: File - @Test - fun original() { - RootProject(projectDir) { - settingsGradle() - buildGradle( - """ - plugins { - base - id("co.uzzu.dotenv.gradle") - } - println("Result: ${'$'}{env.HOGE.value}") - """.trimIndent() - ) - file( - ".env.template", - """ - HOGE= - """.trimIndent() - ) - file( - ".env", - """ - HOGE=100 - """.trimIndent() - ) - file( - ".env.staging", - """ - HOGE=200 - """.trimIndent() - ) - } - - val result = GradleRunner.create() - .withPluginClasspath() - .withProjectDir(projectDir) - .build() - - assertThat(result.output).contains("Result: 100") - } - @Test fun changeFileByEnvironmentVariables() { RootProject(projectDir) { diff --git a/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/HierarchicalDotEnvDefinitionsTest.kt b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/HierarchicalDotEnvDefinitionsTest.kt new file mode 100644 index 0000000..0d33e4c --- /dev/null +++ b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/HierarchicalDotEnvDefinitionsTest.kt @@ -0,0 +1,125 @@ +package co.uzzu.dotenv.gradle + +import assertk.assertAll +import assertk.assertThat +import assertk.assertions.contains +import org.gradle.testkit.runner.GradleRunner +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.io.TempDir +import java.io.File + +@Suppress("UnstableApiUsage") // GradleRunner#withPluginClasspath +class HierarchicalDotEnvDefinitionsTest { + + @TempDir + lateinit var projectDir: File + + @Test + fun subProjectOnlyVariables() { + RootProject(projectDir) { + settingsGradle( + """ + include("sub") + """.trimIndent() + ) + buildGradle( + """ + plugins { + base + id("co.uzzu.dotenv.gradle") } + println("[root] present FUGA: ${'$'}{env.isPresent("FUGA")}") + """.trimIndent() + ) + directory("sub") + file( + "sub/build.gradle", + """ + println("[sub] present FUGA: ${'$'}{env.isPresent("FUGA")}") + """.trimIndent() + ) + file( + "sub/.env.template", + """ + FUGA= + """.trimIndent() + ) + file( + "sub/.env", + """ + FUGA=200 + """.trimIndent() + ) + } + + val result = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + .build() + + assertAll { + assertThat(result.output).contains("[root] present FUGA: false") + assertThat(result.output).contains("[sub] present FUGA: true") + } + } + + @Test + fun useSubProjectVariablesIfDuplicatedWithRootProject() { + RootProject(projectDir) { + settingsGradle( + """ + include("sub") + """.trimIndent() + ) + buildGradle( + """ + plugins { + base + id("co.uzzu.dotenv.gradle") + } + println("[root] HOGE: ${'$'}{env.HOGE.value}") + """.trimIndent() + ) + file( + ".env.template", + """ + HOGE= + """.trimIndent() + ) + file( + ".env", + """ + HOGE=100 + """.trimIndent() + ) + directory("sub") + file( + "sub/build.gradle", + """ + println("[sub] HOGE: ${'$'}{env.HOGE.value}") + """.trimIndent() + ) + file( + "sub/.env.template", + """ + HOGE= + """.trimIndent() + ) + file( + "sub/.env", + """ + HOGE=200 + """.trimIndent() + ) + } + + val result = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + .build() + + assertAll { + assertThat(result.output).contains("[root] HOGE: 100") + assertThat(result.output).contains("[sub] HOGE: 200") + } + } +}