Übergeben von Argumenten von der Befehlszeile an gradle

103

Ich versuche, ein Argument von der Befehlszeile an eine Java-Klasse zu übergeben. Ich bin diesem Beitrag gefolgt: http://gradle.1045684.n5.nabble.com/Gradle-application-plugin-question-td5539555.html, aber der Code funktioniert bei mir nicht (vielleicht ist er nicht für JavaExec gedacht?). Folgendes habe ich versucht:

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
    }
    */
}

Die Ausgabe des obigen fest codierten Args-Werts lautet:

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

Sobald ich jedoch den Code so ändere, dass der Abschnitt hasProperty verwendet wird, und "demo" als Argument in der Befehlszeile übergebe, erhalte ich eine 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) 

Unter http://gradle.1045684.n5.nabble.com/file/n5709919/testgradle.zip steht ein einfaches Testprojekt zur Verfügung , das das Problem veranschaulicht.

Dies verwendet Gradle 1.0-rc-3. Der NullPointer stammt aus dieser Codezeile:

args group 

Ich habe vor der Aufgabendefinition die folgende Zuordnung hinzugefügt, aber das Ergebnis hat sich nicht geändert:

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

Alle Hinweise, wie Befehlszeilenargumente an gradle übergeben werden können, werden geschätzt.

Lidia
quelle
TNX viel @ Joshua Goldberg. Beispiel für ein Argument: stackoverflow.com/a/58202665/2201814
MHSFisher

Antworten:

62

project.groupist eine vordefinierte Eigenschaft. Mit -Pkönnen Sie nur Projekteigenschaften festlegen, die nicht vordefiniert sind. Alternativ können Sie Java-Systemeigenschaften festlegen ( -D).

Peter Niederwieser
quelle
3
Danke für die Information! Das Ändern des Namens in testngGroup hat das Problem behoben. Eine Liste vordefinierter Eigenschaften finden Sie in Tabelle 13.1 unter gradle.org/docs/current/userguide/writing_build_scripts.html .
Lidia
2
Nur um den Link zu aktualisieren: docs.gradle.org/current/userguide/…
Kikiwa
56

Aufbauend auf der Antwort von Peter N ist dies ein Beispiel für das Hinzufügen von (optionalen) benutzerdefinierten Argumenten, die für eine JavaExec-Aufgabe an Java main übergeben werden sollen (da Sie die Eigenschaft 'args' aus dem von ihm genannten Grund nicht manuell festlegen können).

Fügen Sie dies der Aufgabe hinzu:

task(runProgram, type: JavaExec) {

  [...]

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

... und laufen Sie so über die Kommandozeile

% ./gradlew runProgram '-Pmyargs=-x,7,--no-kidding,/Users/rogers/tests/file.txt'
Joshua Goldberg
quelle
2
Wie könnte ich getrennte Parameter haben? Beispiel: gradle run -Purl='localhost', -Pport='8080', -Pusername='admin' Wie würde mein Code in build.gradle aussehen?
Tomas
@Tomas Ich würde vorschlagen, eine Frage der obersten Ebene dafür zu konkretisieren. (Ich kenne diese Situation nicht gut genug, um hier selbst eine schnelle Inline-Antwort zu geben.)
Joshua Goldberg
1
Keine Sorge, habe es schon getan und wurde hier
Tomas
28

Mein Programm mit zwei Argumenten, args [0] und 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]);

mein build.gradle

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

meine Terminal-Eingabeaufforderung:

gradle run  -PappArgsWhatEverIWant="['localhost','8080']"
Oscar Raig Colon
quelle
17

Ab Gradle 4.9 versteht das Anwendungs-Plugin die --argsOption, sodass das Übergeben der Argumente so einfach ist wie:

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'
verrückter Kopf
quelle
15

Es ist möglich, benutzerdefinierte Befehlszeilenoptionen in Gradle zu verwenden, um Folgendes zu erhalten:

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

Benutzerdefinierte Befehlszeilenoptionen in Gradle sind jedoch eine Inkubationsfunktion .

Java-Lösung

Befolgen Sie die Anweisungen hier, um so etwas zu erhalten :

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);
    }
}

Dann registrieren Sie es:

task printPet(type: PrintPet)

Jetzt können Sie tun:

./gradlew printPet --pet="puppies"

Ausgabe:

Welpen! sind genial!

Kotlin-Lösung

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!")
    }
}

Registrieren Sie dann die Aufgabe mit:

tasks.register<PrintPet>("printPet")
David Rawson
quelle
5

Wenn Sie ein Argument überprüfen und festlegen müssen, sieht Ihre build.gradleDatei folgendermaßen aus:

....

def coverageThreshold = 0.15

if (project.hasProperty('threshold')) {
    coverageThreshold = project.property('threshold').toString().toBigDecimal()
}

//print the value of variable
println("Coverage Threshold: $coverageThreshold")
...

Und der Beispielbefehl in Windows:

Gradlew Clean Test -Pthreshold = 0,25

MHSFisher
quelle
4

Ich habe einen Code geschrieben, der die Befehlszeilenargumente in das von gradle erwartete Format bringt.

// this method creates a command line arguments
def setCommandLineArguments(commandLineArgs) {
    // remove spaces 
    def arguments = commandLineArgs.tokenize()

            // create a string that can be used by Eval 
            def cla = "["
            // go through the list to get each argument
            arguments.each {
                    cla += "'" + "${it}" + "',"
            }

    // remove last "," add "]" and set the args 
    return cla.substring(0, cla.lastIndexOf(',')) + "]"
}

meine aufgabe sieht so aus:

task runProgram(type: JavaExec) {
    if ( project.hasProperty("commandLineArgs") ) {
            args Eval.me( setCommandLineArguments(commandLineArgs) )
    }
}

Um die Argumente über die Befehlszeile zu übergeben, führen Sie Folgendes aus:

gradle runProgram -PcommandLineArgs="arg1 arg2 arg3 arg4"    
Sebastian Musial
quelle
0

Hier gibt es ein gutes Beispiel:

https://kb.novaordis.com/index.php/Gradle_Pass_Configuration_on_Command_Line

Welche Details können Sie Parameter übergeben und dann einen Standard in einer ext-Variablen wie folgt angeben:

gradle -Dmy_app.color=blue

und dann in Gradle verweisen als:

ext {
   color = System.getProperty("my_app.color", "red");
}

Und dann können Sie es überall in Ihrem Build-Skript als Kurs referenzieren, wo immer Sie es referenzieren können project.ext.color

Weitere Tipps hier: https://kb.novaordis.com/index.php/Gradle_Variables_and_Properties

Matt Wolfe
quelle
-4

Übergeben Sie eine URL über die Befehlszeile. Behalten Sie Ihre URL wie folgt in der App-Gradle-Datei resValue "string", "url", CommonUrl

und geben Sie einen Parameter in gradle.properties-Dateien wie folgt an CommonUrl = "Geben Sie Ihre URL hier ein oder sind Sie möglicherweise leer"

und übergeben Sie einen Befehl wie folgt an die Befehlszeile gradle assembleRelease -Pcommanurl = Geben Sie hier Ihre URL ein

Arun Kawdiya
quelle