Comment passer des arguments de la ligne de commande à Gradle ?

Question

J'essaie de passer un argument de la ligne de commande à une classe Java. J'ai suivi ce post : http://gradle.1045684.n5.nabble.com/Gradle-application-plugin-question-td5539555.html mais le code ne fonctionne pas pour moi (peut-être n'est-il pas destiné à JavaExec ?). Voici ce que j'ai essayé :

task listTests(type:JavaExec){
    main = "util.TestGroupScanner"
    classpath = sourceSets.util.runtimeClasspath
    // this works...
    args 'demo'
    /*
    // this does not work!
    if (project.hasProperty("group")){
        args group
    }
    */
}

La sortie de la valeur d'args codée en dur ci-dessus est :

C:\ws\svn\sqe\sandbox\selenium2forbg\testgradle>g listTests
:compileUtilJava UP-TO-DATE
:processUtilResources UP-TO-DATE
:utilClasses UP-TO-DATE
:listTests
Received argument: demo

BUILD SUCCESSFUL

Total time: 13.422 secs

Cependant, dès que je modifie le code pour utiliser la section hasProperty et passer "demo" comme argument sur la ligne de commande, j'obtiens une NullPointerException :

C:\ws\svn\sqe\sandbox\selenium2forbg\testgradle>g listTests -Pgroup=demo -s

FAILURE: Build failed with an exception.

* Where:
Build file 'C:\ws\svn\sqe\sandbox\selenium2forbg\testgradle\build.gradle' line:25

* What went wrong:
A problem occurred evaluating root project 'testgradle'.
> java.lang.NullPointerException (no error message)

* Try:
Run with --info or --debug option to get more log output.

* Exception is:
org.gradle.api.GradleScriptException: A problem occurred evaluating root project
 'testgradle'.
    at org.gradle.groovy.scripts.internal.DefaultScriptRunnerFactory$ScriptRunnerImpl.run(DefaultScriptRunnerFactory.java:54)
    at org.gradle.configuration.DefaultScriptPluginFactory$ScriptPluginImpl.apply(DefaultScriptPluginFactory.java:127)
    at org.gradle.configuration.BuildScriptProcessor.evaluate(BuildScriptProcessor.java:38) 

Un projet de test simple est disponible à l'adresse suivante http://gradle.1045684.n5.nabble.com/file/n5709919/testgradle.zip qui illustre le problème.

J'utilise Gradle 1.0-rc-3. Le NullPointer provient de cette ligne de code :

args group 

J'ai ajouté l'affectation suivante avant la définition de la tâche, mais cela n'a pas changé le résultat :

group = hasProperty('group') ? group : 'nosuchgroup' 

Toute indication sur la façon de passer des arguments de ligne de commande à gradle sera appréciée.

Answer 1

project.group est une propriété prédéfinie. Avec -P vous pouvez seulement définir les propriétés du projet qui sont no prédéfini. Vous pouvez également définir les propriétés du système Java ( -D ).

Answer 2

Dans le prolongement de la réponse de Peter N, voici un exemple de la manière d'ajouter des arguments (facultatifs) spécifiés par l'utilisateur à transmettre à Java main pour une tâche JavaExec (puisque vous ne pouvez pas définir manuellement la propriété "args" pour la raison qu'il cite).

Ajoutez ceci à la tâche :

task(runProgram, type: JavaExec) {

  [...]

  if (project.hasProperty('myargs')) {
      args(myargs.split(','))
  }

... et exécuté à la ligne de commande comme ceci

% ./gradlew runProgram '-Pmyargs=-x,7,--no-kidding,/Users/rogers/tests/file.txt'

Answer 3

Mon programme avec deux arguments, args[0] et args[1] :

public static void main(String[] args) throws Exception {
    System.out.println(args);
    String host = args[0];
    System.out.println(host);
    int port = Integer.parseInt(args[1]);

mon build.gradle

run {
    if ( project.hasProperty("appArgsWhatEverIWant") ) {
        args Eval.me(appArgsWhatEverIWant)
    }
}

l'invite de mon terminal :

gradle run  -PappArgsWhatEverIWant="['localhost','8080']"

Answer 4

A partir de Gradle 4.9, le plugin d'application comprend --args de sorte que le passage des arguments est aussi simple que :

build.gradle

plugins {
    id 'application'
}

mainClassName = "my.App"

src/main/java/my/App.java

public class App {
    public static void main(String[] args) {
        System.out.println(args);
    }
}

bash

./gradlew run --args='This string will be passed into my.App#main arguments'

ou sous Windows, utilisez des guillemets doubles :

gradlew run --args="This string will be passed into my.App#main arguments"

Answer 5

Vous pouvez utiliser des options de ligne de commande personnalisées dans Gradle :

./gradlew printPet --pet="Puppies!"

Les options de ligne de commande personnalisées étaient un fonction d'incubation dans Gradle 5.0 mais est devenu public dans Gradle 6.0.

Solution Java

Suivez les instructions aquí :

import org.gradle.api.tasks.options.Option;

public class PrintPet extends DefaultTask {
    private String pet;

    @Option(option = "pet", description = "Name of the cute pet you would like to print out!")
    public void setPet(String pet) {
        this.pet = pet;
    }

    @Input
    public String getPet() {
        return pet;
    }

    @TaskAction
    public void print() {
        getLogger().quiet("'{}' are awesome!", pet);
    }
}

Alors, enregistrez-la :

task printPet(type: PrintPet)

Maintenant vous pouvez le faire :

./gradlew printPet --pet="Puppies!"

sortie :

Les chiots sont géniaux !

Solution Kotlin

open class PrintPet : DefaultTask() {

    @Suppress("UnstableApiUsage")
    @set:Option(option = "pet", description = "The cute pet you would like to print out")
    @get:Input
    var pet: String = ""

    @TaskAction
    fun print() {    
        println("$pet are awesome!")
    }
}

puis enregistrer la tâche avec :

tasks.register<PrintPet>("printPet")