org.gradle.internal.buildevents.BuildExceptionReporterTest.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 5.5.1 API redistribution.
/*
* Copyright 2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.internal.buildevents
import org.gradle.BuildResult
import org.gradle.StartParameter
import org.gradle.api.GradleException
import org.gradle.api.invocation.Gradle
import org.gradle.api.logging.LogLevel
import org.gradle.api.logging.configuration.LoggingConfiguration
import org.gradle.api.logging.configuration.ShowStacktrace
import org.gradle.execution.MultipleBuildFailures
import org.gradle.initialization.BuildClientMetaData
import org.gradle.internal.exceptions.DefaultMultiCauseException
import org.gradle.internal.exceptions.LocationAwareException
import org.gradle.internal.logging.DefaultLoggingConfiguration
import org.gradle.internal.logging.text.StyledTextOutputFactory
import org.gradle.internal.logging.text.TestStyledTextOutput
import org.gradle.util.TreeVisitor
import spock.lang.Specification
class BuildExceptionReporterTest extends Specification {
final TestStyledTextOutput output = new TestStyledTextOutput()
final StyledTextOutputFactory factory = Mock()
final BuildClientMetaData clientMetaData = Mock()
final LoggingConfiguration configuration = new DefaultLoggingConfiguration()
final BuildExceptionReporter reporter = new BuildExceptionReporter(factory, configuration, clientMetaData)
def setup() {
factory.create(BuildExceptionReporter.class, LogLevel.ERROR) >> output
clientMetaData.describeCommand(!null, !null) >> { args -> args[0].append("[gradle ${args[1].join(' ')}]") }
}
def doesNothingWhenBuildIsSuccessful() {
expect:
reporter.buildFinished(result(null))
output.value == ''
}
def reportsBuildFailure() {
GradleException exception = new GradleException("");
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* What went wrong:
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def "suggests to use --scan even if option was on command line"() {
GradleException exception = new GradleException("");
def result = result(exception)
result.gradle >> Mock(Gradle) {
getStartParameter() >> Mock(StartParameter) {
isBuildScan() >> true
isNoBuildScan() >> false
}
}
expect:
reporter.buildFinished(result)
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* What went wrong:
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def "suggests to use --scan if --no-scan is on command line"() {
GradleException exception = new GradleException("");
def result = result(exception)
result.gradle >> Mock(Gradle) {
getStartParameter() >> Mock(StartParameter) {
isBuildScan() >> false
isNoBuildScan() >> true
}
}
expect:
reporter.buildFinished(result)
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* What went wrong:
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsBuildFailureWhenFailureHasNoMessage() {
GradleException exception = new GradleException();
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* What went wrong:
org.gradle.api.GradleException (no error message)
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsLocationAwareException() {
Throwable exception = exception("", new RuntimeException(""), new RuntimeException(""));
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* Where:
* What went wrong:
{info}> {normal}
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsLocationAwareExceptionWithNoMessage() {
Throwable exception = exception("", new RuntimeException(), new IOException());
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* Where:
* What went wrong:
java.lang.RuntimeException (no error message)
{info}> {normal}java.io.IOException (no error message)
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsLocationAwareExceptionWithMultipleCauses() {
Throwable exception = exception("", new RuntimeException(""), new RuntimeException(""), new RuntimeException(""));
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* Where:
* What went wrong:
{info}> {normal}
{info}> {normal}
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsLocationAwareExceptionWithMultipleNestedCauses() {
def cause1 = nested("", new RuntimeException(""), new RuntimeException(""))
def cause2 = nested("", new RuntimeException(""))
Throwable exception = exception("", new RuntimeException(""), cause1, cause2);
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* Where:
* What went wrong:
{info}> {normal}
{info}> {normal}
{info}> {normal}
{info}> {normal}
{info}> {normal}
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsLocationAwareExceptionWhenCauseHasNoMessage() {
Throwable exception = exception("", new RuntimeException(""), new RuntimeException());
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* Where:
* What went wrong:
{info}> {normal}java.lang.RuntimeException (no error message)
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def showsStacktraceOfCauseOfLocationAwareException() {
configuration.showStacktrace = ShowStacktrace.ALWAYS
Throwable exception = exception("", new GradleException(""), new GradleException(''))
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* Where:
* What went wrong:
{info}> {normal}
* Try:
Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Exception is:
org.gradle.api.GradleException:
{stacktrace}
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsMultipleBuildFailures() {
def failure1 = exception("", new RuntimeException(""), new RuntimeException(""))
def failure2 = new GradleException("")
def failure3 = new RuntimeException("")
Throwable exception = new MultipleBuildFailures([failure1, failure2, failure3])
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: Build completed with 3 failures.{normal}
{failure}1: {normal}{failure}Task failed with an exception.{normal}
-----------
* Where:
* What went wrong:
{info}> {normal}
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
==============================================================================
{failure}2: {normal}{failure}Task failed with an exception.{normal}
-----------
* What went wrong:
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
==============================================================================
{failure}3: {normal}{failure}Task failed with an exception.{normal}
-----------
* What went wrong:
* Try:
Run with {userinput}--stacktrace{normal} option to get the stack trace. Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
==============================================================================
* Get more help at {userinput}https://help.gradle.org{normal}
''';
}
def reportsBuildFailureWhenShowStacktraceEnabled() {
configuration.showStacktrace = ShowStacktrace.ALWAYS
GradleException exception = new GradleException('')
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* What went wrong:
* Try:
Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Exception is:
org.gradle.api.GradleException:
{stacktrace}
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def reportsBuildFailureWhenShowFullStacktraceEnabled() {
configuration.showStacktrace = ShowStacktrace.ALWAYS_FULL
GradleException exception = new GradleException('')
expect:
reporter.buildFinished(result(exception))
output.value == '''
{failure}FAILURE: {normal}{failure}Build failed with an exception.{normal}
* What went wrong:
* Try:
Run with {userinput}--info{normal} or {userinput}--debug{normal} option to get more log output. Run with {userinput}--scan{normal} to get full insights.
* Exception is:
org.gradle.api.GradleException:
{stacktrace}
* Get more help at {userinput}https://help.gradle.org{normal}
'''
}
def result(Throwable failure) {
BuildResult result = Mock()
result.failure >> failure
result
}
def nested(String message, Throwable... causes) {
return new TestException(message, causes)
}
def exception(String location, RuntimeException target, Throwable... causes) {
LocationAwareException exception = Mock()
exception.location >> location
exception.cause >> target
exception.visitReportableCauses(!null) >> { TreeVisitor visitor ->
visitor.node(exception)
visitor.startChildren()
causes.each {
visitor.node(it)
if (it instanceof TestException) {
visitor.startChildren()
it.causes.each { child ->
visitor.node(child)
}
visitor.endChildren()
}
}
visitor.endChildren()
}
exception
}
}
class TestException extends DefaultMultiCauseException {
TestException(String message, Throwable... causes) {
super(message, causes)
}
}