Gradle Pass Configuration on Command Line: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 2: Line 2:


* [[Gradle_Operations#Pass_Configuration_on_Command_Line|Gradle Operations]]
* [[Gradle_Operations#Pass_Configuration_on_Command_Line|Gradle Operations]]
* [[Gradle_Variables_and_Properties#System_Properties|Gradle Variables and Properties - System Properties]]


=Overview=
=Overview=


It is sometimes necessary to pass environment-specific configuration to the build. An example is the URL of a container registry, which may different values relative to the environment the build is executed. The best place for such configuration is not build.gradle, as we would like to avoid editing it for each environment the build is supposed to execute in. One option, which works well for build containers, is to [[Passing Configuration to a Gradle Build via Custom Environment Variables|use custom environment variables]]. Another option is to use command line-specified system properties, as shown below.
It is sometimes necessary to pass environment-specific configuration to the build. An example is the URL of a container registry, which may different values relative to the environment the build is executed. The best place for such configuration is not build.gradle, as we would like to avoid editing it for each environment the build is supposed to execute in. One option, which works well for build containers, is to [[Passing Configuration to a Gradle Build via Custom Environment Variables|use custom environment variables]]. Another option is to use command line-specified system properties, as shown below:


Let's assume we use [[Com.palantir.docker|com.palantir.docker]], but we don't want to hardcode the registry URL and the image tag in build.gradle. We want to read it from the build environment instead, in a way similar to:
gradle -Dmy.environment.dependent.config=blue ...


gradle -Decr.registry.url=... -Decr.image.tag= docker dockerPush
If not provided on command line, those configuration elements can always fall back to build.gradle hardcoded values.
 
=Playground=
 
{{External|https://github.com/ovidiuf/playground/tree/master/gradle/passing-configuration-on-command-line}}
 
=Implementation=
 
We assign the value of the system property to a [[Gradle_Variables_and_Properties#Extra_Properties|project extra property]], for convenient handling. The same statement is also use to specify a default value, in case the system property is not provided:
 
<syntaxhighlight lang='groovy'>
ext {
 
    myEnvironmentDependentConfig = System.getProperty("my.environment.dependent.config", "red");
}
</syntaxhighlight>
 
The value can be access as such:
<syntaxhighlight lang='groovy'>
task displayPropertyValueAtExecutionTime {
 
    doLast {
 
        println "myEnvironmentDependentConfig: " + myEnvironmentDependentConfig
    }
}
</syntaxhighlight>


If not provided on command line, those configuration elements can always fall back to build.gradle hardcoded values.
Setting the value on command line results in:
 
gradle -Dmy.environment.dependent.config=blue displayPropertyValueAtExecutionTime
...
myEnvironmentDependentConfig: blue
 
Not setting reverts to default:
 
gradle displayPropertyValueAtExecutionTime
...
myEnvironmentDependentConfig: red

Latest revision as of 20:38, 20 March 2019

Internal

Overview

It is sometimes necessary to pass environment-specific configuration to the build. An example is the URL of a container registry, which may different values relative to the environment the build is executed. The best place for such configuration is not build.gradle, as we would like to avoid editing it for each environment the build is supposed to execute in. One option, which works well for build containers, is to use custom environment variables. Another option is to use command line-specified system properties, as shown below: 

gradle -Dmy.environment.dependent.config=blue ...

If not provided on command line, those configuration elements can always fall back to build.gradle hardcoded values.

Playground

https://github.com/ovidiuf/playground/tree/master/gradle/passing-configuration-on-command-line

Implementation

We assign the value of the system property to a project extra property, for convenient handling. The same statement is also use to specify a default value, in case the system property is not provided: 

ext {

    myEnvironmentDependentConfig = System.getProperty("my.environment.dependent.config", "red");
}

The value can be access as such: 

task displayPropertyValueAtExecutionTime {

    doLast {

        println "myEnvironmentDependentConfig: " + myEnvironmentDependentConfig
    }
}

Setting the value on command line results in: 

gradle -Dmy.environment.dependent.config=blue displayPropertyValueAtExecutionTime
...
myEnvironmentDependentConfig: blue

Not setting reverts to default: 

gradle displayPropertyValueAtExecutionTime
...
myEnvironmentDependentConfig: red
Retrieved from "https://kb.novaordis.com/index.php?title=Gradle_Pass_Configuration_on_Command_Line&oldid=56617"