Gradle. pass parameters to dependent project build script - gradle

I have project ("backend") configuration:
dependencies {
compile project(':model') //I would like to pass some params into this being build.
...
And other project ("frontend") configuration is very similar:
dependencies {
compile project(':model') //but from this project I will not pass params.
...
And when I build the dependant project model- I need to pass a parameter to it's build parameter and do something on condition. So for all projects who needs the sub-projects it will be built according to their needs.
To be more specific: When I build "backtend" - "model"'s project should run some task, but when I build "frontend" I don't.
Is it possible to force clean the sub-project as well?

You can easily pass parameters from command line, or by properties defined in gradle.properties or in ext. Here's a little project:
/build.gradle
ext {
var = "alpha"
}
task hello {
println "Name: $project.name"
println "Var: $var"
println "Param: $param"
println "Prop: $prop"
}
/gradle.properties
prop=gama
/settings.gradle
project.name = 'foo'
include 'bar'
/bar/build.gradle
task hello {
println "Name: $project.name"
println "Var: $var"
println "Param: $param"
println "Prop: $prop"
}
If you run gradle hello -Pparam=beta it will print:
Name: foo
Var: alpha
Param: beta
Prop: gama
Name: bar
Var: alpha
Param: beta
Prop: gama
:hello UP-TO-DATE
:bar:hello UP-TO-DATE

Related

How to use commandLine() within buildFinished

In $HOME/.gradle/init.gradle I have:
gradle.buildFinished { buildResult ->
commandLine 'bash', "blah blah blah"
}
Doing gradle build the build succeeds, but after it succeeds I get the error:
Could not find method commandLine() for arguments [bash, blah blah blah] on build 'FooBar' of type org.gradle.invocation.DefaultGradle.
The answer to the question Could not find method commandLine() doesn't help as either putting (type: Exec) after gradle.buildFinished or wrapping the whole thing in exec { } causes Gradle to fail right from the start rather than the build succeeding and then my post-build hook failing.
I'm using Gradle version 6.3
You've misconfigured commandLine. With the following build.gradle:
task lol {
doLast {
println "lol"
}
}
and ~/.gradle/init.gradle:
gradle.buildFinished { buildResult ->
exec {
commandLine 'bash', '-c', 'echo lol2'
}
}
it works as expected.

Can't access gitlab-ci environment variables in build.gradle UPD: when using kaniko

I want to get gitlab environment variable and use it in build.gradle script. I defined the variable in gitlab-ci:
build:
stage: build
variables:
TEST: "HELLO WORLD"
script:
- export
Also, I use -export command to print all variables. And I see my TEST variable in gitlab job console. But when I'm trying to get this variable in build.gradle it is null. Here is build.gradle code fragment:
if (System.getenv('TEST') != null) {
repositories {
println 'CI=' + System.getenv('CI')
println 'M- ' + System.getenv('MAVEN_REPO_USER')
println 'T- ' + System.getenv('TEST')
println 'CI_JOB_STAGE ' + System.getenv('CI_JOB_STAGE')
mavenCentral()
}
} else {
repositories {
println '*CI= ' + System.getenv('CI')
println '*MAven ' + System.getenv('MAVEN_REPO_USER')
println '* ' + System.getenv('CI_JOB_STAGE')
println 'T-+++ ' + System.getenv('TEST')
mavenCentral()
mavenLocal()
}
}
All environment variables printed as null's, but I see all of these in gitlab job console printed by -export command, before gradle trying to print them. What is wrong?
UPDATE: In ci-gitlab I'm using kaniko : - /kaniko/executor
To get variable it must be defined with ARG instruction in Dockerfile and in gitlab-ci as build-arg. The ARG instruction sets the variables that the user passes to the image collector.
Dockerfile:
ARG TEST
gitlab-ci:
build:
stage: build
script:
- /kaniko/executor
--build-arg TEST="HELLO WORLD"
'variables: ' section is not neccessary

How gradle interprets a command run at parent level

Let's say there are 3 sub projects: sub1, sub2, and sub3. They all have task uploadArchives. If we run gradle uploadArchives, how it is cascaded to sub projects?
Assume your project layout as bellow
gradle-tasks
|- sub1
|- sub2
|- sub3
settings.gradle as below:
include 'sub1', 'sub2', 'sub3'
rootProject.name = 'gradle-tasks'
And your build.gradle is like this:
allprojects {
task uploadArchives {
doLast { task ->
println "I'm $task.project.name"
}
}
}
Then when you execute ./gradlew uploadArchives in root, you will have
$ ./gradlew uploadArchives
> Task :uploadArchives
I'm gradle-tasks
> Task :sub1:uploadArchives
I'm sub1
> Task :sub2:uploadArchives
I'm sub2
> Task :sub3:uploadArchives
I'm sub3
Ref: https://docs.gradle.org/current/userguide/multi_project_builds.html

Purpose of << in gradle

I starting playing around gradle and trying to understand the purpose of <<.
On executing gradle -q task0 when build.gradle contains gave me task 0
4.times { counter ->
task "task$counter" <<{
println "task $counter"
}
}
where as executing gradle -q test{0123} when build.gradle contains
4.times { counter ->
task "task$counter" {
println "task $counter"
}
}
returning
task 0
task 1
task 2
task 3
Can someone help in understanding purpose of <<?
If you have << it will execute the print lines when the task is executed and not having it executes the print lines when the task is configured.
This can effect your output since the Gradle Lifecycle is Initialization > Configuration > Execution.
For example if your build.gradle contains:
task "task0" << {
println "task 0"
}
task "task1" {
println "task 1"
}
Then if you execute task0 you will get:
> gradlew -q task0
task 1
task 0
Even though you would only expect task 0 to print. While if you execute task1 you get:
> gradlew -q task1
task 1
This is because task1 is printing out during configuration which even though you are not running it, the whole build.gradle file gets read in during the configuration phase to determine what gets executed. You could even go:
> gradlew clean
task 1
And you get your output from task1.
I think the problem here is what << means. It is predefined shift left operator and with it we say to a Gradle task. "Gradle task, I want closure which is after << to be put as your last action".So with
task "taskHello" <<{
println "Hello Gradle action"
}
you say in my build I have a task, which name is taskHello and I want when excecute it with
gradle taskHello
To do action
{
println "Hello Gradle action"
}
<< is a syntax sugar short for doLast{}, so you can rewrite your task like this:
4.times { counter ->
task "task$counter" {
doLast{
println "task $counter"
}
}
}

Isolated Gradle Tasks?

I'm trying to port over a somewhat convoluted Makefile to Gradle. I need to be able to have some tasks that execute in isolation of each other, but I cannot figure out how to do this in Gradle; for example, if I have a build.gradle that looks like the following:
apply plugin: 'eclipse'
apply plugin: 'idea'
task foo {
println 'foo'
}
task bar {
println 'bar'
}
task baz {
println 'baz'
}
If I run:
gradle -q foo
Then I expect to see
foo
But instead I see:
foobarbaz
printed to my terminal.
How can I configure Gradle to only perform the single task?
You haven't given the tasks any functionality; what you're seeing is the output of the tasks being instantiated.
Change your build.gradle to this...
task foo {
doLast {
println 'foo'
}
}
task bar << {
println 'bar'
}
task baz {
println 'baz'
}
and then run the foo task:
gradle foo
Your output should be...
baz
:foo
foo
...showing that baz was output when the baz task was created, then the foo task was executed (":foo") followed by the output of the foo task. Note that the "<<" operator is an alias for doLast.
See Build Script Basics in the Gradle User Guide.

Resources