Forma recomendada para detener una compilación de Gradle

Question

¿Cómo puedo detener una compilación de Gradle después de detectar un problema? Puedo usar una afirmación, lanzar una excepción, hacer un System.exit (mala idea), o usar una función dedicada en Gradle (pero no pude encontrar ninguna). ¿Cuál es la mejor manera para Gradle (y por qué?).

Answer 1

lo general iniciar la excepción relevante desde el org.gradle.api package, por ejemplo InvalidUserDataException para cuando alguien ha entrado algo válido o GradleScriptException de los errores más generales.

Si desea detener la tarea o acción actual, y pasar a la siguiente, también puede lanzar una StopActionException

Answer 2

en la actualidad existe ningún método específico, aunque ha habido discusiones para añadir una.

La forma recomendada de detener una compilación de Gradle es lanzar una excepción. Dado que Groovy no tiene excepciones comprobadas, y Gradle de forma predeterminada no imprime el tipo de excepción, no es tan crítico qué excepción se produce. En los scripts de compilación, GradleException se usa a menudo, pero una afirmación de Groovy también parece razonable (según las circunstancias y el público). Lo importante es proporcionar un mensaje claro. Agregar una causa (si está disponible) ayuda a depurar (--stacktrace).

Gradle proporciona tipos de excepciones dedicadas StopExecutionException/StopActionException para detener la tarea/tarea actual, pero continuar con la compilación.

Answer 3

Si desea detener la acumulación, lanzar:

throw new GradleException('error occurred') 

o tirar las subclases de la excepción anteriormente. Algunas de las excepciones de subclase en realidad solo fallan en la tarea actual pero continúan con la compilación.

Answer 4

Otra opción si no tiene ningún deseo de poder atrapar la excepción más tarde es llamar a la tarea ant fallar. En mi opinión, es un poco más fácil de leer y puedes darle un buen mensaje al usuario sin el uso de --stacktrace.

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

le da un mensaje como:

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

Probablemente puede capturas esto (tal vez lanza de hormiga BuildException?), Pero si eso es una meta, entonces yo no usaría hormiga. fallar. Simplemente haría que fuera más fácil ver qué excepción atrapar arrojando la excepción gradle estándar como sugirieron tim_yates.

Answer 5

Lanzar una GradleException simple funciona para detener el script de compilación. Esto funciona muy bien para comprobando la configuración del entorno requerido.

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

Ejemplo:

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

Answer 6

Aquí es un fragmento de código que trata de emular la forma en la tarea javac Gradle lanza errores:

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

Cuando el comando devuelve 0 no hay salida. Cualquier otro valor imprimirá la salida estándar y detendrá la compilación.

NOTA: Si su comando también escribe en errorOutput, es posible que deba incluirlo en el registro de errores.