Méthode recommandée pour arrêter un build Gradle

Comment puis-je arrêter un build Gradle après la détection du problème? Je peux utiliser une assertion, lancer une exception, faire un Système.sortie (mauvaise idée), ou l'utilisation d'une fonction dédiée dans Gradle (mais je ne pouvais pas en trouver un). Quel est le meilleur moyen pour Gradle (et pourquoi?).

InformationsquelleAutor Kartoch | 2012-04-25
  1. 110

    J'ai l'habitude de jeter l'exception de la org.gradle.api le paquet, par exemple InvalidUserDataException pour quand quelqu'un est entré dans quelque chose de pas valide, ou GradleScriptException pour plus d'erreurs générales.

    Si vous souhaitez arrêter la tâche en cours ou de l'action, et de passer à la suivante, vous pouvez également jeter un StopActionException

    • Vous pouvez également utiliser TaskExecutionException si une tâche n'est pas exécutée avec succès. (Ce qui est vrai selon la gradle 1.11 docs, je ne suis pas sûr de quand il a été introduit.)
    • y a-nice options de syntaxe ici? Envisager de kotlin les conditions préalables d'syntaxe: require(something != whatever) { "No good!" } par opposition à la plus prolixe et le type-ee if(something != whatever){ throw new GradleException("No good!") }
    • L'horrible chose à propos de GradleScriptException est qu'il a besoin d'un second paramètre pour une cause.
    • ... Bien sûr, nous sommes en évitant de dire que c'est "programmation par les exceptions"?! J'ai hérité codé écrit de cette façon et c'est une horreur à maintenir ... Dans le vieux jours de la philosophie autour de make est que rules (task-s) a réussi ou échoué. J'ai essayé une fois return false -- Gradle simplement ignoré et a continué à courir.
    InformationsquelleAutor tim_yates
  2. 73

    Si vous voulez arrêter de les construire, de les jeter: 

    throw new GradleException('error occurred')

    ou de jeter les sous-classes de l'exception ci-dessus. Certains de la sous-classe des exceptions en fait, seul l'échec de la tâche en cours, mais continuer à la construire.

    InformationsquelleAutor skipy
  3. 24

    Il n'existe actuellement aucune méthode spécifique, bien qu'il y ait eu des discussions pour en ajouter une.

    La méthode recommandée pour arrêter un build Gradle est de lancer une exception. Depuis Groovy n'a pas vérifié les exceptions, et Gradle par défaut n'imprime pas le type d'exception, ce n'est pas que critique dont exception est levée. Dans les scripts de compilation, GradleException est souvent utilisé, mais Groovy affirmation semble également raisonnable (en fonction des circonstances et de l'auditoire). Ce qui est important est de fournir un message clair. L'ajout d'une cause (si disponible) aide pour le débogage (--stacktrace).

    Gradle offre dédiée exception types StopExecutionException/StopActionException pour l'arrêt de la tâche en cours/action de tâche, mais la poursuite de l'accumulation.

    InformationsquelleAutor Peter Niederwieser
  4. 15

    Une autre option si vous n'avez pas du tout envie d'être capable d'attraper l'exception plus tard, est d'appeler la fourmi échec de la tâche. C'est un peu plus facile à lire, à mon avis, et vous pouvez donner un joli message à l'utilisateur, sans l'utilisation de --stacktrace. 

    task (tarball, dependsOn: warAdmin) << {
    ant.fail('The sky is falling!!')
}

    Vous donne un message du genre:

    * What went wrong:
Execution failed for task ':tarball'.
> The sky is falling!!

    Probablement vous peut attraper cette (peut-être qu'il jette de la fourmi BuildException?) mais si c'est un but alors je ne voudrais pas utiliser ant.un échec. Je venais de faire, il est facile de voir ce que l'exception de l'attraper en jetant standard gradle exception comme tim_yates suggéré.

    • Comment puis-je le configurer? L'appeler?
    • appelez simplement ant.fail ("message de votre choix"), aucune configuration n'est requise
    • Il ressemble à la sortie de ce identique à l'aide de throw new GradleException("The sky is falling!!") (Gradle 3.4.1)
    • Je me souviens qu'il y a 4 ans quand j'ai écrit cela, le message imprimé ne diffèrent (mais c'est beaucoup de temps et je n'ai pas envie de déterminer quel version était courant à l'époque et de la vérification). Au-delà, à mon humble avis ant.échec de plus pour communiquer clairement l'intention d'arrêter totalement le construire, alors que la levée d'une exception se lit comme quelque chose que à être capturées et traitées.
    InformationsquelleAutor Gus
  5. 10

    Jetant un simple GradleException travaille dans l'arrêt du script de construction. Cela fonctionne très bien pour
    la vérification requise la configuration de l'environnement.

    GradleException('your message, why the script is stopped.')

    Exemple:

    if(null == System.getenv()['GRADLE_USER_HOME']) {
    throw new GradleException('Required GRADLE_USER_HOME environment variable not set.')
}
    InformationsquelleAutor edvox1138
  6. 3

    Voici un fragment de code qui tente d'imiter la façon dont le Gradle javac tâche lève erreurs:

    task myCommand(type:Exec) {

    ... normal task setup ....

    ignoreExitValue true
    standardOutput = new ByteArrayOutputStream()
    ext.output = { standardOutput.toString() }
    doLast {
        if (execResult.exitValue) {
            logger.error(output())
            throw new TaskExecutionException( it,
                new Exception( "Command '${commandLine.join(' ')}' failed; "
                              + "see task output for details." )
            )
        }
    }
}

    Lors de la commande retourne 0 il n'y a pas de sortie. Toute autre valeur d'imprimer la standardOutput et de stopper la construction.

    REMARQUE: Si votre commande écrit à errorOutput ainsi, vous devrez peut-être l'inclure dans le journal des erreurs.

    InformationsquelleAutor cmcginty