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
174
175
176
177
178
179
180
|
// Copyright 2016 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.buildeventstream.transports;
import static com.google.common.truth.Truth.assertThat;
import static org.mockito.Mockito.when;
import com.google.devtools.build.lib.buildeventstream.ArtifactGroupNamer;
import com.google.devtools.build.lib.buildeventstream.BuildEvent;
import com.google.devtools.build.lib.buildeventstream.BuildEventContext;
import com.google.devtools.build.lib.buildeventstream.BuildEventProtocolOptions;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.BuildStarted;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.Progress;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.TargetComplete;
import com.google.devtools.build.lib.buildeventstream.PathConverter;
import com.google.devtools.common.options.Options;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.concurrent.Future;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.Matchers;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
/** Tests {@link BinaryFormatFileTransport}. **/
@RunWith(JUnit4.class)
public class BinaryFormatFileTransportTest {
private final BuildEventProtocolOptions defaultOpts =
Options.getDefaults(BuildEventProtocolOptions.class);
@Rule public TemporaryFolder tmp = new TemporaryFolder();
@Mock public BuildEvent buildEvent;
@Mock public PathConverter pathConverter;
@Mock public ArtifactGroupNamer artifactGroupNamer;
@Before
public void initMocks() {
MockitoAnnotations.initMocks(this);
}
@After
public void validateMocks() {
Mockito.validateMockitoUsage();
}
@Test
public void testCreatesFileAndWritesProtoBinaryFormat() throws Exception {
File output = tmp.newFile();
BuildEventStreamProtos.BuildEvent started =
BuildEventStreamProtos.BuildEvent.newBuilder()
.setStarted(BuildStarted.newBuilder().setCommand("build"))
.build();
when(buildEvent.asStreamProto(Matchers.<BuildEventContext>any())).thenReturn(started);
BinaryFormatFileTransport transport =
new BinaryFormatFileTransport(output.getAbsolutePath(), defaultOpts, pathConverter);
transport.sendBuildEvent(buildEvent, artifactGroupNamer);
BuildEventStreamProtos.BuildEvent progress =
BuildEventStreamProtos.BuildEvent.newBuilder().setProgress(Progress.newBuilder()).build();
when(buildEvent.asStreamProto(Matchers.<BuildEventContext>any())).thenReturn(progress);
transport.sendBuildEvent(buildEvent, artifactGroupNamer);
BuildEventStreamProtos.BuildEvent completed =
BuildEventStreamProtos.BuildEvent.newBuilder()
.setCompleted(TargetComplete.newBuilder().setSuccess(true))
.build();
when(buildEvent.asStreamProto(Matchers.<BuildEventContext>any())).thenReturn(completed);
transport.sendBuildEvent(buildEvent, artifactGroupNamer);
transport.close().get();
try (InputStream in = new FileInputStream(output)) {
assertThat(BuildEventStreamProtos.BuildEvent.parseDelimitedFrom(in)).isEqualTo(started);
assertThat(BuildEventStreamProtos.BuildEvent.parseDelimitedFrom(in)).isEqualTo(progress);
assertThat(BuildEventStreamProtos.BuildEvent.parseDelimitedFrom(in)).isEqualTo(completed);
assertThat(in.available()).isEqualTo(0);
}
}
@Test
public void testFileDoesNotExist() throws Exception {
// Get a file that doesn't exist by creating a new file and immediately deleting it.
File output = tmp.newFile();
String path = output.getAbsolutePath();
assertThat(output.delete()).isTrue();
BuildEventStreamProtos.BuildEvent started =
BuildEventStreamProtos.BuildEvent.newBuilder()
.setStarted(BuildStarted.newBuilder().setCommand("build"))
.build();
when(buildEvent.asStreamProto(Matchers.<BuildEventContext>any())).thenReturn(started);
BinaryFormatFileTransport transport =
new BinaryFormatFileTransport(path, defaultOpts, pathConverter);
transport.sendBuildEvent(buildEvent, artifactGroupNamer);
transport.close().get();
try (InputStream in = new FileInputStream(output)) {
assertThat(BuildEventStreamProtos.BuildEvent.parseDelimitedFrom(in)).isEqualTo(started);
assertThat(in.available()).isEqualTo(0);
}
}
@Test
public void testWriteWhenFileClosed() throws Exception {
File output = tmp.newFile();
BuildEventStreamProtos.BuildEvent started =
BuildEventStreamProtos.BuildEvent.newBuilder()
.setStarted(BuildStarted.newBuilder().setCommand("build"))
.build();
when(buildEvent.asStreamProto(Matchers.<BuildEventContext>any())).thenReturn(started);
BinaryFormatFileTransport transport =
new BinaryFormatFileTransport(output.getAbsolutePath(), defaultOpts, pathConverter);
// Close the stream.
transport.out.close();
assertThat(transport.out.isOpen()).isFalse();
// This should not throw an exception.
transport.sendBuildEvent(buildEvent, artifactGroupNamer);
transport.close().get();
// Also, nothing should have been written to the file
try (InputStream in = new FileInputStream(output)) {
assertThat(in.available()).isEqualTo(0);
}
}
@Test
public void testWriteWhenTransportClosed() throws Exception {
File output = tmp.newFile();
BuildEventStreamProtos.BuildEvent started =
BuildEventStreamProtos.BuildEvent.newBuilder()
.setStarted(BuildStarted.newBuilder().setCommand("build"))
.build();
when(buildEvent.asStreamProto(Matchers.<BuildEventContext>any())).thenReturn(started);
BinaryFormatFileTransport transport =
new BinaryFormatFileTransport(output.getAbsolutePath(), defaultOpts, pathConverter);
transport.sendBuildEvent(buildEvent, artifactGroupNamer);
Future<Void> closeFuture = transport.close();
// This should not throw an exception, but also not perform any write.
transport.sendBuildEvent(buildEvent, artifactGroupNamer);
closeFuture.get();
assertThat(transport.out.isOpen()).isFalse();
// There should have only been one write.
try (InputStream in = new FileInputStream(output)) {
assertThat(BuildEventStreamProtos.BuildEvent.parseDelimitedFrom(in)).isEqualTo(started);
assertThat(in.available()).isEqualTo(0);
}
}
}
|
