Méthode recommandée pour arrêter une compilation Gradle

Comment puis-je arrêter une compilation Gradle après avoir détecté un problème? Je peux utiliser une assert, lancer une exception, faire un System.exit (mauvaise idée) ou utiliser une fonction dédiée dans Gradle (mais je n'ai pas pu en trouver). Quelle est la meilleure façon pour Gradle (et pourquoi?).

Je lance généralement l'exception pertinente du org.gradle.apipackage , par exemple InvalidUserDataExceptionlorsque quelqu'un a entré quelque chose d'invalide, ou GradleScriptExceptionpour des erreurs plus générales.

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

Si vous souhaitez arrêter la compilation, lancez:

throw new GradleException('error occurred')

ou lancez les sous-classes pour l'exception ci-dessus. Certaines des exceptions de sous-classe échouent en fait uniquement la tâche en cours, mais continuent avec la génération.

Il n'y a actuellement pas de méthode dédiée, bien qu'il y ait eu des discussions pour en ajouter une.

La méthode recommandée pour arrêter une génération Gradle est de lever une exception. Puisque Groovy n'a pas vérifié les exceptions et que Gradle par défaut n'imprime pas le type d'exception, ce n'est pas si critique quelle exception est levée. Dans les scripts de construction, GradleException est souvent utilisé, mais une assertion Groovy semble également raisonnable (selon les circonstances et le public). L'important est de fournir un message clair. L'ajout d'une cause (si disponible) aide au débogage ( --stacktrace).

Gradle fournit des types d'exception dédiés StopExecutionException/ StopActionExceptionpour arrêter la tâche / action de tâche en cours mais continuer la construction.

Une autre option si vous ne souhaitez pas pouvoir attraper l'exception plus tard est d'appeler la tâche ant fail. C'est un peu plus facile à lire à mon avis et vous pouvez donner un beau message à l'utilisateur sans utiliser --stacktrace.

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

Vous donne un message comme:

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

Vous pouvez probablement attraper cela (peut-être que cela lance l'exception BuildException de fourmi?) Mais si c'est un objectif, je n'utiliserais pas ant.fail. Je rendrais juste facile de voir quelle exception attraper en lançant une exception gradle standard comme tim_yates l'a suggéré.

Lancer une simple GradleException permet d'arrêter le script de construction. Cela fonctionne très bien pour vérifier la configuration de l'environnement requise.

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.')
}

Voici un fragment de code qui tente d'émuler la manière dont la tâche javac Gradle génère des 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." )
            )
        }
    }
}

Lorsque la commande revient, 0il n'y a pas de sortie. Toute autre valeur imprimera le standardOutput et arrêtera la génération.

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