Unable to copy .env file in dev mode #8297

Legion2 · 2020-03-31T10:42:09Z

Describe the bug
The .env file for environment variables at project root can't be used on Windows 10.
When creating this file and running mvnw quarkus:dev it produces a warning in the log and the environment variables are not used by quarkus.
Expected behavior
I can define environment variables in .env file and use it in application.properties like this:
greeting.message = ${MESSAGE}

Actual behavior
A warning and exception is printed to the console:

Listening for transport dt_socket at address: 5005
__  ____  __  _____   ___  __ ____  ______ 
 --/ __ \/ / / / _ | / _ \/ //_/ / / / __/
 -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/
2020-03-31 12:12:54,098 WARN  [io.qua.dev.DevModeMain] (main) Unable to copy .env file
2020-03-31 12:12:57,080 ERROR [io.qua.application] (main) Failed to start application: java.util.NoSuchElementException: Property MESSAGE not found
        at io.smallrye.config.SmallRyeConfig.propertyNotFound(SmallRyeConfig.java:209)
        at io.smallrye.config.SmallRyeConfig.getValue(SmallRyeConfig.java:96)
        at io.smallrye.config.SmallRyeConfig.getValue(SmallRyeConfig.java:80)
        at io.quarkus.runtime.configuration.ConfigExpander.accept(ConfigExpander.java:55)
        at io.quarkus.runtime.configuration.ConfigExpander.accept(ConfigExpander.java:15)
        at org.wildfly.common.expression.ExpressionNode.emit(ExpressionNode.java:42)
        at org.wildfly.common.expression.Expression.evaluateException(Expression.java:75)
        at org.wildfly.common.expression.Expression.evaluate(Expression.java:89)
        at io.quarkus.runtime.configuration.ExpandingConfigSource.expandValue(ExpandingConfigSource.java:101)
        at io.quarkus.runtime.configuration.ExpandingConfigSource.expand(ExpandingConfigSource.java:69)   
        at io.quarkus.runtime.configuration.ExpandingConfigSource.getValue(ExpandingConfigSource.java:47) 
        at io.quarkus.runtime.configuration.DeploymentProfileConfigSource.getValue(DeploymentProfileConfigSource.java:80)
        at io.smallrye.config.SmallRyeConfig.getRawValue(SmallRyeConfig.java:121)
        at io.smallrye.config.SmallRyeConfig.getValue(SmallRyeConfig.java:84)
        at io.smallrye.config.SmallRyeConfig.getOptionalValue(SmallRyeConfig.java:131)
        at io.quarkus.arc.runtime.ConfigRecorder.validateConfigProperties(ConfigRecorder.java:35)
        at io.quarkus.deployment.steps.ConfigBuildStep$validateConfigProperties24.deploy_0(ConfigBuildStep$validateConfigProperties24.zig:120)
        at io.quarkus.deployment.steps.ConfigBuildStep$validateConfigProperties24.deploy(ConfigBuildStep$validateConfigProperties24.zig:36)
        at io.quarkus.runner.ApplicationImpl.doStart(ApplicationImpl.zig:154)
        at io.quarkus.runtime.Application.start(Application.java:90)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.lang.reflect.Method.invoke(Method.java:498)
        at io.quarkus.runner.bootstrap.StartupActionImpl.run(StartupActionImpl.java:99)
        at io.quarkus.dev.IsolatedDevModeMain.firstStart(IsolatedDevModeMain.java:60)
        at io.quarkus.dev.IsolatedDevModeMain.accept(IsolatedDevModeMain.java:236)
        at io.quarkus.dev.IsolatedDevModeMain.accept(IsolatedDevModeMain.java:39)
        at io.quarkus.bootstrap.app.CuratedApplication.runInCl(CuratedApplication.java:131)
        at io.quarkus.bootstrap.app.CuratedApplication.runInAugmentClassLoader(CuratedApplication.java:84)
        at io.quarkus.dev.DevModeMain.start(DevModeMain.java:113)
        at io.quarkus.dev.DevModeMain.main(DevModeMain.java:54)

2020-03-31 12:12:57,111 ERROR [io.qua.dev.DevModeMain] (main) Failed to start Quarkus: java.lang.RuntimeException: Failed to start quarkus
        at io.quarkus.runner.ApplicationImpl.doStart(ApplicationImpl.zig:232)
        at io.quarkus.runtime.Application.start(Application.java:90)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.lang.reflect.Method.invoke(Method.java:498)
        at io.quarkus.runner.bootstrap.StartupActionImpl.run(StartupActionImpl.java:99)
        at io.quarkus.dev.IsolatedDevModeMain.firstStart(IsolatedDevModeMain.java:60)
        at io.quarkus.dev.IsolatedDevModeMain.accept(IsolatedDevModeMain.java:236)
        at io.quarkus.dev.IsolatedDevModeMain.accept(IsolatedDevModeMain.java:39)
        at io.quarkus.bootstrap.app.CuratedApplication.runInCl(CuratedApplication.java:131)
        at io.quarkus.bootstrap.app.CuratedApplication.runInAugmentClassLoader(CuratedApplication.java:84)
        at io.quarkus.dev.DevModeMain.start(DevModeMain.java:113)
        at io.quarkus.dev.DevModeMain.main(DevModeMain.java:54)
Caused by: java.util.NoSuchElementException: Property MESSAGE not found
        at io.smallrye.config.SmallRyeConfig.propertyNotFound(SmallRyeConfig.java:209)
        at io.smallrye.config.SmallRyeConfig.getValue(SmallRyeConfig.java:96)
        at io.smallrye.config.SmallRyeConfig.getValue(SmallRyeConfig.java:80)
        at io.quarkus.runtime.configuration.ConfigExpander.accept(ConfigExpander.java:55)
        at io.quarkus.runtime.configuration.ConfigExpander.accept(ConfigExpander.java:15)
        at org.wildfly.common.expression.ExpressionNode.emit(ExpressionNode.java:42)
        at org.wildfly.common.expression.Expression.evaluateException(Expression.java:75)
        at org.wildfly.common.expression.Expression.evaluate(Expression.java:89)
        at io.quarkus.runtime.configuration.ExpandingConfigSource.expandValue(ExpandingConfigSource.java:101)
        at io.quarkus.runtime.configuration.ExpandingConfigSource.expand(ExpandingConfigSource.java:69)   
        at io.quarkus.runtime.configuration.ExpandingConfigSource.getValue(ExpandingConfigSource.java:47) 
        at io.quarkus.runtime.configuration.DeploymentProfileConfigSource.getValue(DeploymentProfileConfigSource.java:80)
        at io.smallrye.config.SmallRyeConfig.getRawValue(SmallRyeConfig.java:121)
        at io.smallrye.config.SmallRyeConfig.getValue(SmallRyeConfig.java:84)
        at io.smallrye.config.SmallRyeConfig.getOptionalValue(SmallRyeConfig.java:131)
        at io.quarkus.arc.runtime.ConfigRecorder.validateConfigProperties(ConfigRecorder.java:35)
        at io.quarkus.deployment.steps.ConfigBuildStep$validateConfigProperties24.deploy_0(ConfigBuildStep$validateConfigProperties24.zig:120)
        at io.quarkus.deployment.steps.ConfigBuildStep$validateConfigProperties24.deploy(ConfigBuildStep$validateConfigProperties24.zig:36)
        at io.quarkus.runner.ApplicationImpl.doStart(ApplicationImpl.zig:154)
        ... 13 more

To Reproduce
Steps to reproduce the behavior:

git clone https://github.com/quarkusio/quarkus-quickstarts.git (tag: 1.3.1.Final)
go to config-quickstart directory
add a .env file in the config-quickstart directory, see below for the content
modify application.properties like below
run mvnw quarkus:dev

Configuration
application.properties:

# Your configuration properties
greeting.message = ${MESSAGE}
greeting.name = quarkus

.env:

MESSAGE=hello

Screenshots
(If applicable, add screenshots to help explain your problem.)

Environment (please complete the following information):

Output of uname -a or ver: Microsoft Windows [Version 10.0.18363.720]

Output of java -version:

openjdk version "1.8.0_232"
OpenJDK Runtime Environment (AdoptOpenJDK)(build 1.8.0_232-b09)
OpenJDK 64-Bit Server VM (AdoptOpenJDK)(build 25.232-b09, mixed mode)

GraalVM version (if different from Java): not installed
Quarkus version or git rev: 1.3.1.Final

Build tool (ie. output of mvnw --version or gradlew --version):

Apache Maven 3.6.2 (40f52333136460af0dc0d7232c0dc0bcf0d9e117; 2019-08-27T17:06:16+02:00)
Maven home: C:\Users\Leon\.m2\wrapper\dists\apache-maven-3.6.2-bin\795eh28tki48bv3l67maojf0ra\apache-maven-3.6.2
Java version: 1.8.0_232, vendor: AdoptOpenJDK, runtime: C:\Program Files\AdoptOpenJDK\jdk-8.0.232.09-hotspot\jre
Default locale: de_DE, platform encoding: Cp1252
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

Additional context
Feature was added in #7519

The text was updated successfully, but these errors were encountered:

geoand · 2020-03-31T12:10:20Z

This is weird since the feature is being tested in Windows as well. We would need someone with a Windows machine to take a look and find the root cause of this.
@jaikiran would you be able to take a look?

jaikiran · 2020-04-01T04:00:59Z

I borrowed a Windows setup and gave this a quick try and I haven't been able to reproduce this. I even tried hot reload and a few other things and even that worked fine.
I've opened #8319 so that we atleast know why it's failing on @Legion2's setup

geoand · 2020-04-01T05:20:20Z

Thanks a lot @jaikiran!!!

jaikiran · 2020-04-03T03:22:05Z

@Legion2, the linked PR has been merged to upstream master branch. Would it be possible for you to build the latest Quarkus master branch and then use the 999-SNAPSHOT version of Quarkus in your application and get us the exception stacktrace that you would see when the .env file copying fails?

Legion2 · 2020-04-03T08:33:42Z

I didn't get the exception printed in english, but here is the corresponding translation: "A required privilege is not held by the client".

2020-04-03 10:16:24,686 WARN  [io.qua.dev.DevModeMain] (main) Unable to copy .env file: java.nio.file.FileSystemException: C:\Users\Leon\git\TIK\viplab\quarkus-quickstarts\config-quickstart\target\.env: Dem Client fehlt ein erforderliches Recht.

        at sun.nio.fs.WindowsException.translateToIOException(WindowsException.java:86)
        at sun.nio.fs.WindowsException.rethrowAsIOException(WindowsException.java:97)
        at sun.nio.fs.WindowsException.rethrowAsIOException(WindowsException.java:102)
        at sun.nio.fs.WindowsFileSystemProvider.createSymbolicLink(WindowsFileSystemProvider.java:585)
        at java.nio.file.Files.createSymbolicLink(Files.java:1043)
        at io.quarkus.dev.DevModeMain.copyDotEnvFile(DevModeMain.java:137)
        at io.quarkus.dev.DevModeMain.start(DevModeMain.java:107)
        at io.quarkus.dev.DevModeMain.main(DevModeMain.java:54)

But I can create the symlink by hand from the same terminal I started quarkus dev:

C:\Users\Leon\git\TIK\viplab\quarkus-quickstarts\config-quickstart\target>mklink .env ..\.env
symbolische Verknüpfung erstellt für .env <<===>> ..\.env

arvidvillen · 2020-04-06T17:57:12Z

I have the same issue, is there any known workarounds?

geoand · 2020-04-06T18:04:09Z

Not unless we can figure out what exactly is causing the symlink creation failure on Windows (it works on Windows CI)

Legion2 · 2020-04-06T18:09:29Z

Does the windows CI use administrator rights?

haraldatbmw · 2020-04-23T10:14:16Z

I have the same warning on my Windows10 machine if I call mvn quarkus:dev in a command-prompt without administrator rights.
If I open a command-prompt with admin rights Quarkus starts without warnings.

--\___\_\____/_/ |_/_/|_/_/|_|\____/___/
2020-04-23 12:09:16,529 WARN  [io.qua.dev.DevModeMain] (main) Unable to copy .env file: java.nio.file.FileSystemException: C:\git\Back2Code.CampusStudents\feedylight\target\.env: Dem Client fehlt ein erforderliches Recht.

        at java.base/sun.nio.fs.WindowsException.translateToIOException(WindowsException.java:92)
        at java.base/sun.nio.fs.WindowsException.rethrowAsIOException(WindowsException.java:103)
        at java.base/sun.nio.fs.WindowsException.rethrowAsIOException(WindowsException.java:108)
        at java.base/sun.nio.fs.WindowsFileSystemProvider.createSymbolicLink(WindowsFileSystemProvider.java:585)
        at java.base/java.nio.file.Files.createSymbolicLink(Files.java:1058)
        at io.quarkus.dev.DevModeMain.copyDotEnvFile(DevModeMain.java:137)
        at io.quarkus.dev.DevModeMain.start(DevModeMain.java:107)
        at io.quarkus.dev.DevModeMain.main(DevModeMain.java:54)

@geoand Can you please retest without admin rights?

haraldatbmw · 2020-04-23T10:50:58Z

Per default my windows user has not the permission to create symbolic links.
To overcome this restriction i had to follow these steps:

Run secpol.msc
Go to Security Settings|Local Policies|User Rights Assignment|Create symbolic links
Add your user name
Restart your windows session

But I don't think this is a good way to go. Preventing the usage of symbolic links would be better!

Legion2 · 2020-04-23T11:05:09Z

@haraldatbmw You could also just enable Windows Developer Mode https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/

haraldatbmw · 2020-04-24T09:17:10Z

@Legion2 Windows Developer Mode did not work for me.

manuelbl · 2020-05-22T09:07:18Z

Please don't use symbolic links. They usually require elevated privileges on Windows 10 and therefore just cause pain.

geoand · 2020-05-22T09:09:19Z

What is the proper Windows alternative?

manuelbl · 2020-05-22T09:17:27Z

There isn't any really. You will have to copy the file.

But I guess a symbolic link would be preferable as the .env file is likely to contain credentials and they shouldn't be copied unnecessarily.

geoand · 2020-05-22T09:42:03Z

The reason why we add a symbolic is to be able to track changes to and hot deploy Quarkus when that happens.

jayakrishnankarolilnlsn · 2020-06-03T17:08:23Z

Created a new ticket for a similar issue - #9752. gradlew quarkusDev does not recognize .env file and it is not copied to /build directory.

jayakrishnankarolilnlsn · 2020-06-03T18:27:23Z

One more issue found. The property definition in .env file is case sensitive.

Say for example

application.properties:

greeting.message = ${MESSAGE}
greeting.name = ${name}

.env:

MESSAGE=hello  # -> succeeds
name=quarkus   # -> fails

Run command mvn quarkus:dev

geoand · 2020-06-03T20:06:52Z

Please open a new issue for that find.

famod · 2020-06-26T17:34:33Z

@geoand

What is the proper Windows alternative?

I just checked that on my private machine with Windows 10 Home (please don't ask why it is not a Pro) and with Home you don't even have secpol.msc so you cant even grant yourself the right to create symlinks. Again, please don't ask. 😉

But I was able to create a link via:

mklink.exe /H <linkname> <target>

This will create a hard link, though. But AFAICS this would be a sufficient workaround.
The code could fall back to mklink.exe on Windows if createSymbolicLink() fails (or we figure out how to check it up-front).

mklink should be available for all relevant Windows versions.

Btw, because of this issue DevMojoIT.testThatTheApplicationIsReloadedOnDotEnvConfigChange always fails on my private machine.

PS: Without any elevated rights you can also create a "directory junction" with mklink but I don't see how that can be of real use here.

geoand · 2020-06-26T17:46:31Z

That is excellent information @famod , thanks a lot! Would you like to submit a PR proposing such a fix?

famod · 2020-06-26T17:55:08Z

I can try, yes. It is rather unlikely that this would end up in 1.6.x, isn't it?

geoand · 2020-06-26T17:57:09Z

If it's just a small bug fix, then we can probably backport it. If it's more involved, then it would probably end up in 1.7

famod · 2020-06-26T22:21:43Z

#10316 should fix this. Btw, turns out mklink is not a "standalone" .exe (cmd.exe /C mklink ... has to be used).

Legion2 added the kind/bug Something isn't working label Mar 31, 2020

Legion2 mentioned this issue Mar 31, 2020

.env file copy to target in dev mode #7519

Closed

quarkusbot added the area/devmode label Mar 31, 2020

jaikiran mentioned this issue Apr 1, 2020

Include the original exception that caused .env file copy to fail #8319

Merged

maxandersen added area/devmode and removed area/devmode labels May 18, 2020

jayakrishnankarolilnlsn mentioned this issue Jun 3, 2020

.env file is not recognized while using gradle gradlew quarkusDev #9752

Closed

jayakrishnankarolilnlsn mentioned this issue Jun 3, 2020

The property definition in .env file is case sensitive. #9760

Closed

famod mentioned this issue Jun 26, 2020

Devmode .env: fall back to mklink /H on Windows #10316

Merged

gastaldi closed this as completed in #10316 Jun 27, 2020

gsmet added this to the 1.6.0.Final milestone Jul 2, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unable to copy .env file in dev mode #8297

Unable to copy .env file in dev mode #8297

Legion2 commented Mar 31, 2020

geoand commented Mar 31, 2020

jaikiran commented Apr 1, 2020

geoand commented Apr 1, 2020

jaikiran commented Apr 3, 2020

Legion2 commented Apr 3, 2020

arvidvillen commented Apr 6, 2020

geoand commented Apr 6, 2020

Legion2 commented Apr 6, 2020

haraldatbmw commented Apr 23, 2020 •

edited

haraldatbmw commented Apr 23, 2020

Legion2 commented Apr 23, 2020

haraldatbmw commented Apr 24, 2020

manuelbl commented May 22, 2020

geoand commented May 22, 2020

manuelbl commented May 22, 2020

geoand commented May 22, 2020

jayakrishnankarolilnlsn commented Jun 3, 2020 •

edited

jayakrishnankarolilnlsn commented Jun 3, 2020

geoand commented Jun 3, 2020

famod commented Jun 26, 2020 •

edited

geoand commented Jun 26, 2020

famod commented Jun 26, 2020

geoand commented Jun 26, 2020

famod commented Jun 26, 2020

Unable to copy .env file in dev mode #8297

Unable to copy .env file in dev mode #8297

Comments

Legion2 commented Mar 31, 2020

geoand commented Mar 31, 2020

jaikiran commented Apr 1, 2020

geoand commented Apr 1, 2020

jaikiran commented Apr 3, 2020

Legion2 commented Apr 3, 2020

arvidvillen commented Apr 6, 2020

geoand commented Apr 6, 2020

Legion2 commented Apr 6, 2020

haraldatbmw commented Apr 23, 2020 • edited

haraldatbmw commented Apr 23, 2020

Legion2 commented Apr 23, 2020

haraldatbmw commented Apr 24, 2020

manuelbl commented May 22, 2020

geoand commented May 22, 2020

manuelbl commented May 22, 2020

geoand commented May 22, 2020

jayakrishnankarolilnlsn commented Jun 3, 2020 • edited

jayakrishnankarolilnlsn commented Jun 3, 2020

geoand commented Jun 3, 2020

famod commented Jun 26, 2020 • edited

geoand commented Jun 26, 2020

famod commented Jun 26, 2020

geoand commented Jun 26, 2020

famod commented Jun 26, 2020

haraldatbmw commented Apr 23, 2020 •

edited

jayakrishnankarolilnlsn commented Jun 3, 2020 •

edited

famod commented Jun 26, 2020 •

edited