diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a50bd8..eb7b255 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,12 +5,29 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## [Unreleased] + +## [2.0.0] - 2022-03-02 + +### Added + +- Hierarchical dotenv definitions support [#19](https://github.com/uzzu/dotenv-gradle/issues/19) + - [See example](/examples/hierarchical_definitions) + +### Changed + +- Change `.env` filename feature use gradle property `dotenv.filename` , instead of environment variable `ENV_FILE` + . [#20](https://github.com/uzzu/dotenv-gradle/issues/20) + - [See migration guide](/examples/change_file/README.md#Migrate-from-1x) +- Update Gradle to 7.1.1 [#16](https://github.com/uzzu/dotenv-gradle/issues/16) +- Update Kotlin to 1.4.31 used into Gradle 7.1.1 + ## [1.2.0] - 2021-09-24 ## Added - Changing `.env` file [#14](https://github.com/uzzu/dotenv-gradle/issues/14) - - If environment variable `ENV_FILE` is set, The plugin read a file specified `ENV_FILE` instead of `.env` file. + - If environment variable `ENV_FILE` is set, The plugin read a file specified `ENV_FILE` instead of `.env` file. ## Changed diff --git a/LICENSE.txt b/LICENSE.txt index 75d8cbc..7de0f5d 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -187,7 +187,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2021 Hirokazu Uzu + Copyright 2022 Hirokazu Uzu Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index b32097d..31a5f5a 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ ### Setup -Apply this plugin to root project. -This plugin is not registered to Maven Central. +Apply this plugin to root project. This plugin is not registered to Maven Central. [Read the Gradle Plugin Portal to setup plugin.](https://plugins.gradle.org/plugin/co.uzzu.dotenv.gradle) Don't need to apply this plugin to subprojects. @@ -39,25 +38,36 @@ println(env.BAZ.orElse("default baz")) // => baz **Don't commit `.env` file** -### [Optional] Create a `.env.template` file for script completion +### Create a `.env.template` file for script completion -If a `.env.template` file exists, this plugin refer it to create a environemnt variable properties in the `env` extension. +If a `.env.template` file exists, this plugin refer it to create a environemnt variable properties in the `env` +extension. -### [Optional] Change a file to read instead of `.env` file. +### Change a file to read instead of `.env` file. If environment variable `ENV_FILE` is set, The plugin read a file specified `ENV_FILE` instead of `.env` file. [See example](/examples/change_file) +### 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. + - If the same variable name value is defined in both the `.env` file and the system environment variable, the system + environment variable takes precedence. - `(Boolean) env.isPresent(name: String)` : Indicates an environment variable with specified name is present. - `(String) env.fetch(name: String)` : Returns an environment variable. -- `(String) env.fetch(name: String, defaultValue: String)` : Returns an environment variable, or specified default value if environment variable was not set. -- `(String?) env.fetchOrNull(name: String)` : Returns an environment variable, or null if environment variable was not set. +- `(String) env.fetch(name: String, defaultValue: String)` : Returns an environment variable, or specified default value + if environment variable was not set. +- `(String?) env.fetchOrNull(name: String)` : Returns an environment variable, or null if environment variable was not + set. - `(Map '} + 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/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 3ab0b72..05679dc 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.9.1-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.1.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/plugin/build.gradle.kts b/plugin/build.gradle.kts index f32552f..af19e0e 100644 --- a/plugin/build.gradle.kts +++ b/plugin/build.gradle.kts @@ -42,7 +42,7 @@ tasks { object Artifact { val groupId = "co.uzzu.dotenv" val artifactId = "gradle" - val version = "1.2.0" + val version = "2.0.0" } group = Artifact.groupId 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..bdba99e --- /dev/null +++ b/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvResolver.kt @@ -0,0 +1,93 @@ +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(): Map { + val envFilename = dotenvFilename() + .let { + if (it != DEFAULT_FILENAME) { + val envFile = file(it) + if (!envFile.exists() || !envFile.canRead()) { + throw IOException( + buildString { + append("Could not read the dotenv file specified in the gradle.properties.") + append(" dotenv.filename: $it,") + append(" path: ${envFile.absolutePath}") + } + ) + } + } + it + } + return readText(envFilename).let(DotEnvParser::parse) + } + + private fun Project.dotenvFilename(): String = + if (properties.containsKey(PROPERTY_FILENAME)) { + properties[PROPERTY_FILENAME] as String + } else { + DEFAULT_FILENAME + } + + 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 DEFAULT_FILENAME = ".env" + private const val PROPERTY_FILENAME = "dotenv.filename" + } +} 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..482ca2b 100644 --- a/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvFileTest.kt +++ b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvFileTest.kt @@ -1,5 +1,6 @@ package co.uzzu.dotenv.gradle +import assertk.assertAll import assertk.assertThat import assertk.assertions.contains import assertk.assertions.isNotNull @@ -17,7 +18,7 @@ class ChangeDotEnvFileTest { lateinit var projectDir: File @Test - fun original() { + fun changeFileByGradleProperties() { RootProject(projectDir) { settingsGradle() buildGradle( @@ -47,6 +48,12 @@ class ChangeDotEnvFileTest { HOGE=200 """.trimIndent() ) + file( + "gradle.properties", + """ + dotenv.filename=.env.staging + """.trimIndent() + ) } val result = GradleRunner.create() @@ -54,11 +61,11 @@ class ChangeDotEnvFileTest { .withProjectDir(projectDir) .build() - assertThat(result.output).contains("Result: 100") + assertThat(result.output).contains("Result: 200") } @Test - fun changeFileByEnvironmentVariables() { + fun throwsIfChangedFileNotFound() { RootProject(projectDir) { settingsGradle() buildGradle( @@ -83,62 +90,106 @@ class ChangeDotEnvFileTest { """.trimIndent() ) file( - ".env.staging", + "gradle.properties", """ - HOGE=200 + dotenv.filename=.env.staging """.trimIndent() ) } - val result = GradleRunner.create() + val runner = GradleRunner.create() .withPluginClasspath() .withProjectDir(projectDir) - .withEnvironment(mapOf("ENV_FILE" to ".env.staging")) - .build() - assertThat(result.output).contains("Result: 200") + var error: UnexpectedBuildFailure? = null + try { + runner.build() + } catch (e: UnexpectedBuildFailure) { + error = e + } + assertThat(error) + .isNotNull() + .messageContains( + "Could not read the dotenv file specified in the gradle.properties. dotenv.filename: .env.staging" + ) } @Test - fun throwsIfChangedFileNotFound() { + fun changeFileOnlySubProject() { RootProject(projectDir) { - settingsGradle() + settingsGradle( + """ + include("sub") + """.trimIndent() + ) buildGradle( """ plugins { base id("co.uzzu.dotenv.gradle") } - println("Result: ${'$'}{env.HOGE.value}") + println("[root] FOO: ${'$'}{env.FOO.value}") """.trimIndent() ) file( ".env.template", """ - HOGE= + FOO= """.trimIndent() ) file( ".env", """ - HOGE=100 + FOO=100 + """.trimIndent() + ) + file( + ".env.staging", + """ + FOO=1000 + """.trimIndent() + ) + directory("sub") + file( + "sub/build.gradle", + """ + println("[sub] BAR: ${'$'}{env.BAR.value}") + """.trimIndent() + ) + file( + "sub/.env.template", + """ + BAR= + """.trimIndent() + ) + file( + "sub/.env", + """ + BAR=200 + """.trimIndent() + ) + file( + "sub/.env.staging", + """ + BAR=2000 + """.trimIndent() + ) + file( + "sub/gradle.properties", + """ + dotenv.filename=.env.staging """.trimIndent() ) } - val runner = GradleRunner.create() + val result = GradleRunner.create() .withPluginClasspath() .withProjectDir(projectDir) - .withEnvironment(mapOf("ENV_FILE" to ".env.staging")) + .build() - var error: UnexpectedBuildFailure? = null - try { - runner.build() - } catch (e: UnexpectedBuildFailure) { - error = e + assertAll { + assertThat(result.output).contains("[root] FOO: 100") + assertThat(result.output).contains("[sub] BAR: 2000") } - assertThat(error) - .isNotNull() - .messageContains("Could not read the dotenv file specified in the environment variables. ENV_FILE: .env.staging") } } 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..4a2b00a --- /dev/null +++ b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/HierarchicalDotEnvDefinitionsTest.kt @@ -0,0 +1,126 @@ +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") + } + } +}