Gradle task check if property is defined

Question

I have a Gradle task that executes a TestNG test suite. I want to be able to pass a flag to the task in order to use a special TestNG XML suite file (or just use the default suite if the flag isn't set).

gradle test

... should run the default standard suite of tests

gradle test -Pspecial

... should run the special suite of tests

I've been trying something like this:

test {
    if (special) {
        test(testng_special.xml);
    }
    else {
        test(testng_default.xml);
    }
}

But I get a undefined property error. What is the correct way to go about this?

JB Nizet · Accepted Answer · 2015-07-08T19:51:45.597

105

if (project.hasProperty('special'))

should do it.

Note that what you're doing to select a testng suite won't work, AFAIK: the test task doesn't have any test() method. Refer to https://discuss.gradle.org/t/how-to-run-acceptance-tests-with-testng-from-gradle/4107 for a working example:

test {
    useTestNG {
        suites 'src/main/resources/testng.xml'
    }
}

edited Jul 08 '15 at 19:51

answered Jul 08 '15 at 19:44

JB Nizet

678,734
91
1,224
1,255

@user2506293, that's not necessarily enough. You need to both check if project has a property and if **it's set**. – Opal Jul 10 '15 at 09:48
This is groovy @Opal - a null results in false, so you don't need to explicitly check that. – th3morg May 14 '16 at 00:58
@th3morg Thats wrong, if a property exists but is null, hasProperty(..) will still return true, so you have to use `if (project.hasProperty('special') && project.special)` if you want to check for both existance and not null. – Katharsas Jan 26 '20 at 21:21
I like to use: `project.properties["special"] == "true"` – Venryx May 25 '20 at 17:06

Mahozad · Answer 2 · 2023-08-14T17:41:47.547

4

Here are 3 solutions for Kotlin DSL (build.gradle.kts):

val prop = project.properties["myPropName"] ?: "myDefaultValue"

val prop = project.properties["myPropName"] ?: error("Property not found")

if (project.hasProperty("special")) {
    val prop = project.properties["myPropName"]
}

Note that you can omit the project. prefix as it is implicit in Gradle build files.

edited Aug 14 '23 at 17:41

answered Jun 07 '22 at 16:18

Mahozad

18,032
13
118
133

score 2 · Answer 3 · answered Jul 03 '19 at 13:34

2

This worked for me:

test {
    if (properties.containsKey('special')) {
        test(testng_special.xml);
    }
    else {
        test(testng_default.xml);
    }
}

answered Jul 03 '19 at 13:34

Noelia

3,698
4
17
22

score -1 · Answer 4 · edited Jun 20 '20 at 09:12

-1

From Gradle Documentation:

-P, --project-prop

Sets a project property of the root project, for example -Pmyprop=myvalue

So you should use:

gradle test -Pspecial=true

with a value after the property name

edited Jun 20 '20 at 09:12

Community

1
1

answered Jul 08 '15 at 19:52

Alex Cortinovis

166
9

using JB Nizet's solution it's not necessary to set the property to true, just to define it – user2506293 Jul 08 '15 at 20:06
That's true, because you aren't reading the property value, but just checking if the property exist. Suppose that you were doing the opposite, so instead of `Special` you were using `notSpecial` and you needed a false value for this property in your condition. Using my solution you will not have problems because you will pass `-PnotSpecial=false` using JBNizet's solution instead the value passed was true anyway because the `notSpecial` property exist. – Alex Cortinovis Jul 08 '15 at 21:12

Gradle task check if property is defined

4 Answers4

Linked