Maneira recomendada de interromper uma compilação Gradle

Como posso parar uma compilação Gradle depois de detectar um problema? Posso usar uma declaração, lançar uma exceção, fazer um System.exit (má ideia) ou usar uma função dedicada no Gradle (mas não consegui encontrar uma). Qual é a melhor maneira para Gradle (e por quê?).

Eu costumo lançar a exceção relevante do org.gradle.apipacote , por exemplo, InvalidUserDataExceptionquando alguém digitou algo inválido ou GradleScriptExceptionpor erros mais gerais.

Se você deseja interromper a tarefa ou ação atual e passar para a próxima, também pode lançar um StopActionException

Se você deseja interromper a construção, lance:

throw new GradleException('error occurred')

ou jogue as subclasses para a exceção acima. Algumas das exceções da subclasse, na verdade, apenas falham na tarefa atual, mas continuam com a construção.

Atualmente, não existe um método dedicado, embora tenha havido discussões para adicionar um.

A maneira recomendada de interromper uma compilação Gradle é lançar uma exceção. Como o Groovy não tem exceções verificadas e o Gradle, por padrão, não imprime o tipo de exceção, não é tão crítico qual exceção é lançada. Nos scripts de construção, o GradleException é frequentemente usado, mas uma asserção Groovy também parece razoável (dependendo das circunstâncias e do público). O importante é fornecer uma mensagem clara. Adicionar uma causa (se disponível) ajuda na depuração ( --stacktrace).

Gradle fornece tipos de exceção dedicados StopExecutionException/ StopActionExceptionpara interromper a tarefa / ação atual, mas continuando a construção.

Outra opção, se você não deseja capturar a exceção mais tarde, é chamar a tarefa Ant Fail. É um pouco mais fácil de ler na minha opinião e você pode dar uma boa mensagem ao usuário sem usar o --stacktrace.

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

Dá uma mensagem como:

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

Provavelmente você pode entender isso (talvez ele ative o BuildException da formiga?), Mas se esse for um objetivo, eu não usaria o ant.fail. Eu facilitaria a visualização de qual exceção capturar, lançando a exceção gradle padrão, como tim_yates sugeriu.

Lançar uma GradleException simples funciona para interromper o script de construção. Isso funciona muito bem para verificar a configuração do ambiente necessária.

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

Exemplo:

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

Aqui está um fragmento de código que tenta emular como a tarefa Gradle javac gera erros:

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

Quando o comando retorna, 0não há saída. Qualquer outro valor imprimirá o standardOutput e interromperá a compilação.

NOTA: Se o seu comando também gravar no errorOutput, talvez seja necessário incluí-lo no log de erros.