summaryrefslogtreecommitdiff
path: root/build-system/integration-test/framework/src/main/java/com/android/build/gradle/integration/common/fixture/GradleBuildResult.kt
blob: 6533947041c539d1dcb250b4fdc7c21f5223dcfe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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 com.android.build.gradle.integration.common.fixture

import com.android.build.gradle.integration.common.truth.TaskStateList
import com.google.common.base.Preconditions
import com.google.common.base.Throwables
import com.google.common.collect.ImmutableList
import org.gradle.api.ProjectConfigurationException
import org.gradle.api.tasks.TaskExecutionException
import org.gradle.internal.serialize.ContextualPlaceholderException
import org.gradle.internal.serialize.PlaceholderException
import org.gradle.tooling.BuildException
import org.gradle.tooling.GradleConnectionException
import org.gradle.tooling.events.ProgressEvent
import java.io.File
import java.util.Scanner

/**
 * The result from running a build.
 * See [GradleTestProject.executor] and [GradleTaskExecutor].
 *
 * @property exception The exception from the build, null if the build succeeded.
 */
class GradleBuildResult(
    private val stdoutFile: File,
    private val stderrFile: File,
    private val taskEvents: ImmutableList<ProgressEvent>,
    val exception: GradleConnectionException?,
) {
    /**
     * Returns a new [Scanner] for the stderr messages. This instance MUST be closed when done.
     */
    val stderr
        get() = Scanner(stderrFile)

    /**
     * Returns a new [Scanner] for the stdout messages. This instance MUST be closed when done.
     */
    val stdout
        get() = Scanner(stdoutFile)

    /**
     * Most tests don't examine the state of the build's tasks and [TaskStateList] is relatively
     * expensive to initialize, so this is done lazily.
     */
    private val taskStateList: TaskStateList by lazy {
        TaskStateList(taskEvents, this.stdout)
    }

    /**
     * Returns the short (single-line) message that Gradle would print out in the console, without
     * `--stacktrace`. If the build succeeded, returns null.
     */
    val failureMessage: String?
        get() = exception?.let {
            val causalChain = Throwables.getCausalChain(exception)
            // Try the common scenarios: configuration or task failure.
            for (throwable in causalChain) {
                // Because of different class loaders involved, we are forced to do stringly-typed
                // programming.
                val throwableType = throwable.javaClass.name
                if (throwableType == ProjectConfigurationException::class.java.name) {
                    return throwable.cause?.message ?: throw AssertionError(
                        "Exception had unexpected structure.",
                        exception
                    )
                } else if (isPlaceholderEx(throwableType)) {
                    if (throwable.toString().startsWith(TaskExecutionException::class.java.name)) {
                        var cause = throwable
                        // there can be several levels of PlaceholderException when dealing with
                        // Worker API failures.
                        while (isPlaceholderEx(throwableType) && cause.cause != null) {
                            cause = cause.cause
                        }
                        return cause.message
                    }
                }
            }

            // Look for any BuildException, for other cases.
            for (throwable in causalChain) {
                val throwableType = throwable.javaClass.name
                if (throwableType == BuildException::class.java.name) {
                    return throwable.cause?.message ?: throw AssertionError(
                        "Exception had unexpected structure.",
                        exception
                    )
                }
            }

            throw AssertionError("Failed to determine the failure message.", exception)
        }

    val tasks: List<String>
        get() = taskStateList.tasks

    val taskStates: Map<String, TaskStateList.ExecutionState>
        get() = taskStateList.taskStates

    val upToDateTasks: Set<String>
        get() = taskStateList.upToDateTasks

    val fromCacheTasks: Set<String>
        get() = taskStateList.fromCacheTasks

    val didWorkTasks: Set<String>
        get() = taskStateList.didWorkTasks

    val skippedTasks: Set<String>
        get() = taskStateList.skippedTasks

    val failedTasks: Set<String>
        get() = taskStateList.failedTasks

    /**
     * Returns the task info given the task name, or null if the task is not found (if it is not in
     * the task execution plan).
     *
     * @see getTask
     */
    fun findTask(name: String): TaskStateList.TaskInfo? {
        return taskStateList.findTask(name)
    }

    /**
     * Returns the task info given the task name. The task must exist (it must be in the task
     * execution plan).
     *
     * @see findTask
     */
    fun getTask(name: String): TaskStateList.TaskInfo {
        Preconditions.checkArgument(name.startsWith(":"), "Task name must start with :")
        return taskStateList.getTask(name)
    }

    private fun isPlaceholderEx(throwableType: String) =
        throwableType == PlaceholderException::class.java.name
                || throwableType == ContextualPlaceholderException::class.java.name
}