How to set an environment variable from a Gradle build

Question

I m trying to set an environment variable from my Gradle build  I m on MacOS X  El Capitan   The command is  gradle test    I m trying this in my build gradle   task setenv type  Exec        commandLine  export    SOME TEST VAR aaa    test dependsOn setenv   and the build fails      Execution failed for task   myproject setenv             A problem occurred starting process  command  export        I also tried this   test doFirst       ProcessBuilder pb1   new ProcessBuilder  export SOME TEST VAR some test value       pb1 start        The build succeeds  However  if I check the environment variable in my JUnit test it fails   assertTrue System getenv   containsKey  SOME TEST VAR       Is there any way to set an environment variable from a Gradle build  in the build gradle file    Update   I ve tested it in isolation  the values do get passed and my test task receives everything  be it a systemProperty  environment variables or jvmArgs     So  it s nothing wrong with Gradle itself here     The problem arises when I m trying it on the real project  It uses Spring for dependency injection  I may be wrong but it looks like the Spring framework purges those values somewhere     That sub-project is currently being frozen and I can t check my guess in detail right now

User · Answer

This looks like an old thread but there is one more variant of how we can set an environment variable in the Gradle task.

task runSomeRandomTask(type: NpmTask, dependsOn: [npmInstall]) {
    environment = [ 'NODE_ENV': 'development', BASE_URL: '3000' ]
    args = ['run']
}

The above Gradle task integrates the Gradle and npm tasks.

This way we can pass multiple environment variables. Hope this helps to broaden the understanding which the answers above have already provided. Cheers!!

User · Answer

In my project I have Gradle task for integration test in sub-module   task intTest type  Test        system properties System properties        this is the main point to inject all your system params into test environment  So  now you can run gradle like this to pass param with ABC value and use its value by   param  in your code  gradle  some-service intTest -Dparam ABC

User · Answer

In case you re using Gradle Kotlin syntax  you also can do  tasks taskName       environment mapOf  quot A quot  to 1   quot B quot  to  quot C quot       So for test task this would be  tasks test       environment mapOf  quot SOME TEST VAR quot  to  quot aaa quot

User · Answer

If you are using an IDE  go to run  edit configurations  gradle  select gradle task and update the environment variables  See the picture below   Alternatively  if you are executing gradle commands using terminal  just type  export KEY VALUE   and your job is done

User · Answer

For a test task  you can use the environment property like this   test     environment  VAR    val      you can also use the environment property in an exec task  task dropDatabase type  Exec        environment  VAR    val      commandLine  doit      Note that with this method the environment variables are set only during the task

User · Answer

This one is working for me for settings environment variable for the test plugin  test       systemProperties              catalina home    c  test            println  Starting Tests      beforeTest   descriptor - gt         logger lifecycle  Running test      descriptor

User · Answer

You can also  prepend  the environment variable setting by using  environment  command   run doFirst   environment  SPARK LOCAL IP    localhost

User · Answer

If you have global environment variables defined outside Gradle   test       environment  ENV VAR    System getenv  ENV VAR       useJUnitPlatform

User · Answer

Please try this one option    task RunTest type  Test             systemProperty  spring profiles active   System getProperty  DEV            include  com db project Test1 class

[gradle] How to set an environment variable from a Gradle build?

Examples related to gradle

Examples related to environment-variables

Examples related to build.gradle