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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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.google.devtools.build.lib.analysis.test;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.ArtifactPathResolver;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.exec.TestAttempt;
import com.google.devtools.build.lib.util.Pair;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.view.test.TestStatus.BlazeTestStatus;
import com.google.devtools.build.lib.view.test.TestStatus.TestResultData;
import java.util.Collection;
import java.util.List;
import javax.annotation.Nullable;
/**
* This is the event passed from the various test strategies to the {@code RecordingTestListener}
* upon test completion.
*/
@ThreadSafe
@Immutable
public class TestResult {
private final TestRunnerAction testAction;
private final TestResultData data;
private final boolean cached;
@Nullable protected final Path execRoot;
/**
* Construct the TestResult for the given test / status.
*
* @param testAction The test that was run.
* @param data test result protobuffer.
* @param cached true if this is a locally cached test result.
* @param execRoot The execution root in which the action was carried out; can be null, in which
* case everything depending on the execution root is ignored.
*/
public TestResult(
TestRunnerAction testAction, TestResultData data, boolean cached, @Nullable Path execRoot) {
this.testAction = Preconditions.checkNotNull(testAction);
this.data = data;
this.cached = cached;
this.execRoot = execRoot;
}
public TestResult(TestRunnerAction testAction, TestResultData data, boolean cached) {
this(testAction, data, cached, null);
}
public static boolean isBlazeTestStatusPassed(BlazeTestStatus status) {
return status == BlazeTestStatus.PASSED || status == BlazeTestStatus.FLAKY;
}
/**
* @return The test action.
*/
public TestRunnerAction getTestAction() {
return testAction;
}
/**
* @return The test log path. Note, that actual log file may no longer
* correspond to this artifact - use getActualLogPath() method if
* you need log location.
*/
public Path getTestLogPath() {
return testAction.getTestLog().getPath();
}
/**
* Return if result was loaded from local action cache.
*/
public final boolean isCached() {
return cached;
}
/**
* Returns the list of locally cached test attempts. This method must only be called if {@link
* #isCached} returns <code>true</code>.
*/
public List<TestAttempt> getCachedTestAttempts() {
Preconditions.checkState(isCached());
return ImmutableList.of(
TestAttempt.fromCachedTestResult(
testAction,
data,
1,
getFiles(),
BuildEventStreamProtos.TestResult.ExecutionInfo.getDefaultInstance(),
/*lastAttempt=*/ true));
}
/**
* @return Coverage data artifact, if available and null otherwise.
*/
public Path getCoverageData() {
if (data.getHasCoverage()) {
return testAction.getCoverageData().getPath();
}
return null;
}
/**
* @return The test status artifact.
*/
public Artifact getTestStatusArtifact() {
// these artifacts are used to keep track of the number of pending and completed tests.
return testAction.getCacheStatusArtifact();
}
/**
* Gets the test name in a user-friendly format.
* Will generally include the target name and shard number, if applicable.
*
* @return The test name.
*/
public String getTestName() {
return testAction.getTestName();
}
/**
* @return The test label.
*/
public String getLabel() {
return Label.print(testAction.getOwner().getLabel());
}
/**
* @return The test shard number.
*/
public int getShardNum() {
return testAction.getShardNum();
}
/**
* @return Total number of test shards. 0 means
* no sharding, whereas 1 means degenerate sharding.
*/
public int getTotalShards() {
return testAction.getExecutionSettings().getTotalShards();
}
public TestResultData getData() {
return data;
}
/**
* @return Collection of files created by the test, tagged by their name indicating usage (e.g.,
* "test.log").
*/
private Collection<Pair<String, Path>> getFiles() {
// TODO(ulfjack): Cache the set of generated files in the TestResultData.
return testAction.getTestOutputsMapping(ArtifactPathResolver.forExecRoot(execRoot), execRoot);
}
}
|
