How to pass environment variables to the gradle wrapper build using only command line?

Question

I am trying to pass env variables locally with strictly a command line command. At deploy, these variables get passed into the docker container, but when running locally, they are not present and need to be set locally.

They need to be removed before committing though because they are access keys so i dont want them exposed in the repo. That is why running tests locally (without an IDE) would require a command that passes these variables.

I have already tried this:

./gradlew clean build -Dspring.profiles.active=local -DMY_ENV_VAR1=xxxxxx -DMY_ENV_VAR2=xxxxxx

and it doesnt seem to be working. i cant find the docs for the build command's options, but i thought this was how you pass them. what am i doing wrong here? or is it not possible?

score 29 · Answer 1 · answered Apr 29 '22 at 14:54

29

Another reason for environment variables not working is the gradle daemon.

Run this to kill any old daemons:

./gradlew --stop

Then try again. Lost far too much time on that.

answered Apr 29 '22 at 14:54

matt burns

24,742
13
105
107

6

Thank you for this! This answer needs a lot more upvotes to bubble it up higher... – jbyler Jun 23 '22 at 19:21
2

We upgraded the Gradle version and when next trying to run it required a daemon restart. Thanks @matt burns – Forge_7 Jul 08 '22 at 08:28
omg thanks a lot, I was even dreaming about this issue, this works on Android Studio Chipmunk and Gradle Wrapper 6.7.1 – Bucci83 Nov 11 '22 at 16:59

Eric · Answer 2 · 2021-07-09T20:27:34.623

28

For passing env variables

MY_ENV_VAR1=xxxxxx MY_ENV_VAR2=xxxxxx ./gradlew bootRun

For arguments/overriding properties values

./gradlew bootRun --args='--spring.profiles.active=local --db.url=something --anotherprop=fafdf'

For both passing env variable and overriding properties values.

MY_ENV_VAR1=xxxxxx MY_ENV_VAR2=xxxxxx ./gradlew bootRun --args='--spring.profiles.active=local --db.url=something --anotherprop=fafdf'

edited Jul 09 '21 at 20:27

answered Jun 08 '21 at 12:19

Eric

1,171
2
14
27

1

and now a version that works in powershell or cmd shell, please? – Kai May 17 '22 at 03:25
seems that --args is provided by the bootRun task. I assumed it was a gradle parameter, so was trying to use it with the integrationTest task, but it's not supported – Forge_7 Aug 09 '22 at 13:48

score 9 · Answer 3 · answered Jun 16 '20 at 17:53

9

This related post worked for me: https://stackoverflow.com/a/57890208/1441210

The solution was to use the --args option of gradlew to get the environment variable to be passed to the spring boot app:

./gradlew bootRun --args='--spring.profiles.active=local'

answered Jun 16 '20 at 17:53

andre

1,084
11
13

1

and the "--" within the string is necessary? – heug Jun 22 '20 at 17:08
@heug indeed it is! – sparkyspider Oct 21 '20 at 20:58
`./../gradlew bootRun --args='--spring.profiles.active=angular'` is not working for me.. it's only working if I set `SPRING_PROFILES_ACTIVE` but I can't use this because I have to run this in a gradle.build.. somebody fml .. – Stefan Falk Jan 08 '21 at 16:55
this is not the right answer. check my answer for the correct value – Eric Jun 08 '21 at 12:18

score 6 · Answer 4 · answered Jan 23 '20 at 03:06

If you want to pass values to the JVM that runs the gradle you can use the '-D' switch. I suppose you have to pass values to the gradle build file from the command line. If that's the case there are two options for that:

You can use the -P switch and specify the value there. For example:

gradle -PmySecretKey="This key is so secret" yourTask
If you are using linux or variants you can set environment variable as follows:

export ORG_GRADLE_PROJECT_mySecretKey="This key is so secret"

After this you can access the value in the gradle build file as follows (I am using kotlin dsl)

val mySecretKey: String by project

println(mySecretKey)

It says project can't be used as delegate. Did Kotlin DSL changed since the answer? — Allan Veloso, Sep 07 '22 at 21:42

score 5 · Answer 5 · answered Feb 17 '21 at 01:08

5

I just put the env variable setting before calling command as the way a regular Unix shell does. Work with my Zsh.

MY_ENV_VAR1=xxxxxx MY_ENV_VAR2=xxxxxx gradlew clean test

answered Feb 17 '21 at 01:08

Chayne P. S.

1,558
12
17

1

but those they do not get passed to my Java application, if I do `MY_ENV=xxxxx ./gradlew buil`. Then in my Java application `MY_ENV` is null. How can I achieve it? – Matteo Apr 20 '21 at 00:39

score -2 · Answer 6 · answered Jan 15 '20 at 00:42

To answer your question, as far as I know, there's no way to set environment variables manually through Gradle. What your doing right now is just passing in regular CLI arguments/parameters to your tests.

when running locally, they are not present and need to be set locally.

running tests locally (without an IDE) would require a command that passes these variables.

I see from your snippet, you are using Spring, likely Spring Boot. And since you're already specifying the profile as local, why not define these variables in a profile specific configuration? Example:

application.yml -- base configuration

my-config-value: ${MY_ENV_VAR}

application-local.yml -- local profile configuration that overrides the base

my-config-value: some-dummy-value-for-local-development

setting local env vars in spring is very simple and i know how to do that, i am asking this question because theres a specific case (for PR build checks at my enterprise) for it long story short — heug, Jan 16 '20 at 21:08

How to pass environment variables to the gradle wrapper build using only command line?

6 Answers6