diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 47b05dc..df92613 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -33,6 +33,10 @@ jobs: ./gradlew clean --refresh-dependencies echo 'dotenv.filename=.env.staging' > gradle.properties ./gradlew clean + - name: Run change template file example + run: | + cd examples/change_template_file + ./gradlew clean --refresh-dependencies - name: Run hierarchical definitions example run: | cd examples/hierarchical_definitions diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index fe6ddb2..0cb0865 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -35,6 +35,10 @@ jobs: ./gradlew clean --refresh-dependencies echo 'dotenv.filename=.env.staging' > gradle.properties ./gradlew clean + - name: Run change template file example + run: | + cd examples/change_template_file + ./gradlew clean --refresh-dependencies - name: Run hierarchical definitions example run: | cd examples/hierarchical_definitions diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index fdfa0e0..ff7707c 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -47,6 +47,10 @@ jobs: ./gradlew clean --refresh-dependencies echo 'dotenv.filename=.env.staging' > gradle.properties ./gradlew clean + - name: Run change template file example + run: | + cd examples/change_template_file + ./gradlew clean --refresh-dependencies - name: Run hierarchical definitions example run: | cd examples/hierarchical_definitions diff --git a/CHANGELOG.md b/CHANGELOG.md index aca6df1..f34e7af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - `(Map) env.allVariablesOrNull()` to get all environment variables includes variables specified in `.env` includes null variables. - The Plugin set key if defined in .env template files, but it could not be retrieved as nullable value entries by using allVariables() - By using allVariablesOrNull instead of allVariables, it is possible to retrieve all environment variables, including those that are only defined in the .env template (which means their values are null). +- Change `.env.template` filename feature use gradle property `dotenv.template.filename` + - Almost cases are work fine, but has similler problem with [#39](https://github.com/uzzu/dotenv-gradle/issues/39) ### Deprecated diff --git a/README.md b/README.md index 9c421de..1e54c1a 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,10 @@ If environment variable `ENV_FILE` is set, The plugin read a file specified `ENV [See example](/examples/change_file) +### Change a template filename to read instead of `.env.template` file. + +[See example](/examples/change_template_file) + ### Hierarchical dotenv definitions Support subproject-only variables and extensions. diff --git a/examples/change_template_file/.env b/examples/change_template_file/.env new file mode 100644 index 0000000..a22d7b6 --- /dev/null +++ b/examples/change_template_file/.env @@ -0,0 +1 @@ +BAZ= diff --git a/examples/change_template_file/.env.example b/examples/change_template_file/.env.example new file mode 100644 index 0000000..15a1b99 --- /dev/null +++ b/examples/change_template_file/.env.example @@ -0,0 +1 @@ +FOO= diff --git a/examples/change_template_file/.gitattributes b/examples/change_template_file/.gitattributes new file mode 100644 index 0000000..00a51af --- /dev/null +++ b/examples/change_template_file/.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/change_template_file/.gitignore b/examples/change_template_file/.gitignore new file mode 100644 index 0000000..1b6985c --- /dev/null +++ b/examples/change_template_file/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/examples/change_template_file/README.md b/examples/change_template_file/README.md new file mode 100644 index 0000000..f7354cb --- /dev/null +++ b/examples/change_template_file/README.md @@ -0,0 +1,9 @@ +## Change template file example + +version since: 2.1.0 + +Run the following command to confirm that the DotEnv template file to be loaded has changed. + +- `./gradlew clean` +- Edit `gradle.properties`, and `./gradlew clean` + diff --git a/examples/change_template_file/build.gradle.kts b/examples/change_template_file/build.gradle.kts new file mode 100644 index 0000000..3bdeec6 --- /dev/null +++ b/examples/change_template_file/build.gradle.kts @@ -0,0 +1,12 @@ +plugins { + base + id("co.uzzu.dotenv.gradle") version "2.0.0" +} + +val keys = listOf( + "FOO", + "BAR", + "BAZ", +) + +println(env.allVariablesOrNull().filterKeys { keys.contains(it) }) diff --git a/examples/change_template_file/gradle.properties b/examples/change_template_file/gradle.properties new file mode 100644 index 0000000..e1fb9e2 --- /dev/null +++ b/examples/change_template_file/gradle.properties @@ -0,0 +1,2 @@ +# If uncomment the following, a different template file will be loaded. +dotenv.template.filename=.env.example diff --git a/examples/change_template_file/gradle/wrapper/gradle-wrapper.jar b/examples/change_template_file/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 Binary files /dev/null and b/examples/change_template_file/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/change_template_file/gradle/wrapper/gradle-wrapper.properties b/examples/change_template_file/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ffed3a2 --- /dev/null +++ b/examples/change_template_file/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/change_template_file/gradlew b/examples/change_template_file/gradlew new file mode 100755 index 0000000..1b6c787 --- /dev/null +++ b/examples/change_template_file/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/change_template_file/gradlew.bat b/examples/change_template_file/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/examples/change_template_file/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/change_template_file/settings.gradle.kts b/examples/change_template_file/settings.gradle.kts new file mode 100644 index 0000000..ab64ffb --- /dev/null +++ b/examples/change_template_file/settings.gradle.kts @@ -0,0 +1,8 @@ +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + } +} + +rootProject.name = "change_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 index bdba99e..6b6011d 100644 --- a/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvResolver.kt +++ b/plugin/src/main/kotlin/co/uzzu/dotenv/gradle/DotEnvResolver.kt @@ -47,8 +47,25 @@ internal class DotEnvResolver(project: Project) { return checkNotNull(dotenvCache[project]) } - private fun Project.dotenvTemplate(filename: String = ".env.template"): Map = - readText(filename).let(DotEnvParser::parse) + private fun Project.dotenvTemplate(): Map { + val filename = dotenvTemplateFilename() + .let { + if (it != DEFAULT_TEMPLATE_FILENAME) { + val templateFile = file(it) + if (!templateFile.exists() || !templateFile.canRead()) { + throw IOException( + buildString { + append("Could not read the dotenv template file specified in the gradle.properties.") + append(" $PROPERTY_TEMPLATE_FILENAME: $it,") + append(" path: ${templateFile.absolutePath}") + } + ) + } + } + it + } + return readText(filename).let(DotEnvParser::parse) + } private fun Project.dotenvSource(): Map { val envFilename = dotenvFilename() @@ -59,7 +76,7 @@ internal class DotEnvResolver(project: Project) { throw IOException( buildString { append("Could not read the dotenv file specified in the gradle.properties.") - append(" dotenv.filename: $it,") + append(" $PROPERTY_FILENAME: $it,") append(" path: ${envFile.absolutePath}") } ) @@ -77,6 +94,13 @@ internal class DotEnvResolver(project: Project) { DEFAULT_FILENAME } + private fun Project.dotenvTemplateFilename(): String = + if (properties.containsKey(PROPERTY_TEMPLATE_FILENAME)) { + properties[PROPERTY_TEMPLATE_FILENAME] as String + } else { + DEFAULT_TEMPLATE_FILENAME + } + private fun Project.readText(filename: String): String { val file = file(filename) return if (file.exists()) { @@ -88,6 +112,8 @@ internal class DotEnvResolver(project: Project) { companion object { private const val DEFAULT_FILENAME = ".env" + private const val DEFAULT_TEMPLATE_FILENAME = ".env.template" private const val PROPERTY_FILENAME = "dotenv.filename" + private const val PROPERTY_TEMPLATE_FILENAME = "dotenv.template.filename" } } diff --git a/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvTemplateFileTest.kt b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvTemplateFileTest.kt new file mode 100644 index 0000000..bf180f6 --- /dev/null +++ b/plugin/src/test/kotlin/co/uzzu/dotenv/gradle/ChangeDotEnvTemplateFileTest.kt @@ -0,0 +1,169 @@ +package co.uzzu.dotenv.gradle + +import assertk.assertAll +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 + +class ChangeDotEnvTemplateFileTest { + + @TempDir + lateinit var projectDir: File + + @Test + fun changeFileByGradleProperties() { + RootProject(projectDir) { + settingsGradle() + buildGradle( + """ + plugins { + base + id("co.uzzu.dotenv.gradle") + } + println("PIYO is present: ${'$'}{env.PIYO.isPresent}") + """.trimIndent() + ) + file( + ".env.example", + """ + PIYO= + """.trimIndent() + ) + file( + "gradle.properties", + """ + dotenv.template.filename=.env.example + """.trimIndent() + ) + } + + val result = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + .build() + + assertThat(result.output).contains("PIYO is present: false") + } + + @Test + fun throwsIfChangedFileNotFound() { + RootProject(projectDir) { + settingsGradle() + buildGradle( + """ + plugins { + base + id("co.uzzu.dotenv.gradle") + } + println("Result: ${'$'}{env.HOGE.value}") + """.trimIndent() + ) + file( + ".env.example", + """ + HOGE=100 + """.trimIndent() + ) + file( + "gradle.properties", + """ + dotenv.template.filename=.env.exampururu + """.trimIndent() + ) + } + + val runner = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + + var error: UnexpectedBuildFailure? = null + try { + runner.build() + } catch (e: UnexpectedBuildFailure) { + error = e + } + assertThat(error) + .isNotNull() + .messageContains( + buildString { + append("Could not read the dotenv template file specified in the gradle.properties.") + append(" dotenv.template.filename: .env.exampururu") + } + ) + } + + @Test + fun changeFileOnlySubProject() { + RootProject(projectDir) { + settingsGradle( + """ + include("sub") + """.trimIndent() + ) + buildGradle( + """ + plugins { + base + id("co.uzzu.dotenv.gradle") + } + println("[root] FOO: ${'$'}{env.FOO.value}") + """.trimIndent() + ) + file( + ".env.template", + """ + FOO= + """.trimIndent() + ) + file( + ".env", + """ + FOO=100 + """.trimIndent() + ) + directory("sub") + file( + "sub/build.gradle", + """ + println("[sub] BAR: ${'$'}{env.BAR.orNull()}") + println("[sub] BAZ: ${'$'}{env.BAZ.value}") + """.trimIndent() + ) + file( + "sub/.env.example", + """ + BAR= + """.trimIndent() + ) + file( + "sub/.env", + """ + BAZ=200 + """.trimIndent() + ) + file( + "sub/gradle.properties", + """ + dotenv.template.filename=.env.example + """.trimIndent() + ) + } + + val result = GradleRunner.create() + .withPluginClasspath() + .withProjectDir(projectDir) + .build() + + assertAll { + assertThat(result.output).contains("[root] FOO: 100") + assertThat(result.output).contains("[sub] BAR: null") + assertThat(result.output).contains("[sub] BAZ: 200") + } + } +}