-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
RemoteSpawnCacheTest.java
653 lines (589 loc) · 27.1 KB
/
RemoteSpawnCacheTest.java
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
// Copyright 2017 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.remote;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.util.concurrent.Futures.immediateVoidFuture;
import static com.google.common.util.concurrent.MoreExecutors.directExecutor;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.doNothing;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
import build.bazel.remote.execution.v2.ActionResult;
import build.bazel.remote.execution.v2.Digest;
import build.bazel.remote.execution.v2.OutputFile;
import build.bazel.remote.execution.v2.RequestMetadata;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.eventbus.EventBus;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.devtools.build.lib.actions.ActionContext;
import com.google.devtools.build.lib.actions.ActionInput;
import com.google.devtools.build.lib.actions.ActionInputHelper;
import com.google.devtools.build.lib.actions.Artifact.ArtifactExpander;
import com.google.devtools.build.lib.actions.ArtifactPathResolver;
import com.google.devtools.build.lib.actions.ExecutionRequirements;
import com.google.devtools.build.lib.actions.ForbiddenActionInputException;
import com.google.devtools.build.lib.actions.InputMetadataProvider;
import com.google.devtools.build.lib.actions.ResourceSet;
import com.google.devtools.build.lib.actions.SimpleSpawn;
import com.google.devtools.build.lib.actions.SpawnResult;
import com.google.devtools.build.lib.actions.SpawnResult.Status;
import com.google.devtools.build.lib.clock.JavaClock;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventKind;
import com.google.devtools.build.lib.events.Reporter;
import com.google.devtools.build.lib.events.StoredEventHandler;
import com.google.devtools.build.lib.exec.SpawnCache.CacheHandle;
import com.google.devtools.build.lib.exec.SpawnCheckingCacheEvent;
import com.google.devtools.build.lib.exec.SpawnInputExpander;
import com.google.devtools.build.lib.exec.SpawnRunner.ProgressStatus;
import com.google.devtools.build.lib.exec.SpawnRunner.SpawnExecutionContext;
import com.google.devtools.build.lib.exec.util.FakeOwner;
import com.google.devtools.build.lib.remote.RemoteExecutionService.RemoteActionResult;
import com.google.devtools.build.lib.remote.common.CacheNotFoundException;
import com.google.devtools.build.lib.remote.common.RemoteActionExecutionContext;
import com.google.devtools.build.lib.remote.common.RemoteCacheClient.ActionKey;
import com.google.devtools.build.lib.remote.common.RemoteCacheClient.CachedActionResult;
import com.google.devtools.build.lib.remote.common.RemotePathResolver;
import com.google.devtools.build.lib.remote.options.RemoteOptions;
import com.google.devtools.build.lib.remote.options.RemoteOutputsMode;
import com.google.devtools.build.lib.remote.util.DigestUtil;
import com.google.devtools.build.lib.remote.util.TempPathGenerator;
import com.google.devtools.build.lib.server.FailureDetails;
import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
import com.google.devtools.build.lib.server.FailureDetails.Spawn.Code;
import com.google.devtools.build.lib.util.io.FileOutErr;
import com.google.devtools.build.lib.vfs.DigestHashFunction;
import com.google.devtools.build.lib.vfs.FileSystem;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.lib.vfs.SyscallCache;
import com.google.devtools.build.lib.vfs.inmemoryfs.InMemoryFileSystem;
import com.google.devtools.common.options.Options;
import java.io.IOException;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.SortedMap;
import javax.annotation.Nullable;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
/** Tests for {@link RemoteSpawnCache}. */
@RunWith(JUnit4.class)
public class RemoteSpawnCacheTest {
private static final RemoteOutputChecker DUMMY_REMOTE_OUTPUT_CHECKER =
new RemoteOutputChecker(
new JavaClock(), "build", /* downloadToplevel= */ false, ImmutableList.of());
private static final ArtifactExpander SIMPLE_ARTIFACT_EXPANDER =
(artifact, output) -> output.add(artifact);
private static final String BUILD_REQUEST_ID = "build-req-id";
private static final String COMMAND_ID = "command-id";
private FileSystem fs;
private DigestUtil digestUtil;
private Path execRoot;
private TempPathGenerator tempPathGenerator;
private SimpleSpawn simpleSpawn;
private FakeActionInputFileCache fakeFileCache;
@Mock private RemoteCache remoteCache;
private FileOutErr outErr;
private final List<ProgressStatus> progressUpdates = new ArrayList<>();
private StoredEventHandler eventHandler = new StoredEventHandler();
private Reporter reporter;
private RemotePathResolver remotePathResolver;
private final SpawnExecutionContext simplePolicy =
new SpawnExecutionContext() {
@Override
public int getId() {
return 0;
}
@Override
public ListenableFuture<Void> prefetchInputs() {
return immediateVoidFuture();
}
@Override
public void lockOutputFiles(int exitCode, String errorMessage, FileOutErr outErr) {}
@Override
public boolean speculating() {
return false;
}
@Override
public InputMetadataProvider getInputMetadataProvider() {
return fakeFileCache;
}
@Override
public ArtifactPathResolver getPathResolver() {
return ArtifactPathResolver.forExecRoot(execRoot);
}
@Override
public ArtifactExpander getArtifactExpander() {
throw new UnsupportedOperationException();
}
@Override
public SpawnInputExpander getSpawnInputExpander() {
return new SpawnInputExpander(execRoot, /*strict*/ false);
}
@Override
public Duration getTimeout() {
return Duration.ZERO;
}
@Override
public FileOutErr getFileOutErr() {
return outErr;
}
@Override
public SortedMap<PathFragment, ActionInput> getInputMapping(
PathFragment baseDirectory, boolean willAccessRepeatedly)
throws IOException, ForbiddenActionInputException {
return getSpawnInputExpander()
.getInputMapping(simpleSpawn, SIMPLE_ARTIFACT_EXPANDER, baseDirectory, fakeFileCache);
}
@Override
public void report(ProgressStatus progress) {
progressUpdates.add(progress);
}
@Override
public boolean isRewindingEnabled() {
return false;
}
@Override
public void checkForLostInputs() {}
@Override
public <T extends ActionContext> T getContext(Class<T> identifyingType) {
throw new UnsupportedOperationException();
}
@Nullable
@Override
public FileSystem getActionFileSystem() {
return null;
}
};
private static SimpleSpawn simpleSpawnWithExecutionInfo(
ImmutableMap<String, String> executionInfo) {
return new SimpleSpawn(
new FakeOwner("Mnemonic", "Progress Message", "//dummy:label"),
ImmutableList.of("/bin/echo", "Hi!"),
ImmutableMap.of("VARIABLE", "value"),
executionInfo,
/* inputs= */ NestedSetBuilder.create(
Order.STABLE_ORDER, ActionInputHelper.fromPath("input")),
/* outputs= */ ImmutableSet.of(ActionInputHelper.fromPath("/random/file")),
ResourceSet.ZERO);
}
private RemoteSpawnCache createRemoteSpawnCache() {
return remoteSpawnCacheWithOptions(Options.getDefaults(RemoteOptions.class));
}
private RemoteSpawnCache remoteSpawnCacheWithOptions(RemoteOptions options) {
RemoteExecutionService service =
spy(
new RemoteExecutionService(
directExecutor(),
reporter,
/* verboseFailures= */ true,
execRoot,
remotePathResolver,
BUILD_REQUEST_ID,
COMMAND_ID,
digestUtil,
options,
remoteCache,
null,
tempPathGenerator,
/* captureCorruptedOutputsDir= */ null,
DUMMY_REMOTE_OUTPUT_CHECKER));
return new RemoteSpawnCache(execRoot, options, /* verboseFailures=*/ true, service);
}
@Before
public final void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
fs = new InMemoryFileSystem(new JavaClock(), DigestHashFunction.SHA256);
digestUtil = new DigestUtil(SyscallCache.NO_CACHE, DigestHashFunction.SHA256);
execRoot = fs.getPath("/exec/root");
execRoot.createDirectoryAndParents();
tempPathGenerator = new TempPathGenerator(fs.getPath("/execroot/_tmp/actions/remote"));
fakeFileCache = new FakeActionInputFileCache(execRoot);
simpleSpawn = simpleSpawnWithExecutionInfo(ImmutableMap.of());
Path stdout = fs.getPath("/tmp/stdout");
Path stderr = fs.getPath("/tmp/stderr");
stdout.getParentDirectory().createDirectoryAndParents();
stderr.getParentDirectory().createDirectoryAndParents();
outErr = new FileOutErr(stdout, stderr);
reporter = new Reporter(new EventBus());
eventHandler = new StoredEventHandler();
reporter.addHandler(eventHandler);
remotePathResolver = RemotePathResolver.createDefault(execRoot);
fakeFileCache.createScratchInput(simpleSpawn.getInputFiles().getSingleton(), "xyz");
}
@Test
public void cacheHit() throws Exception {
// arrange
RemoteSpawnCache cache = createRemoteSpawnCache();
RemoteExecutionService service = cache.getRemoteExecutionService();
ArgumentCaptor<ActionKey> actionKeyCaptor = ArgumentCaptor.forClass(ActionKey.class);
ActionResult actionResult = ActionResult.getDefaultInstance();
when(remoteCache.downloadActionResult(
any(RemoteActionExecutionContext.class),
actionKeyCaptor.capture(),
/* inlineOutErr= */ eq(false)))
.thenAnswer(
new Answer<CachedActionResult>() {
@Override
public CachedActionResult answer(InvocationOnMock invocation) {
RemoteActionExecutionContext context = invocation.getArgument(0);
RequestMetadata meta = context.getRequestMetadata();
assertThat(meta.getCorrelatedInvocationsId()).isEqualTo(BUILD_REQUEST_ID);
assertThat(meta.getToolInvocationId()).isEqualTo(COMMAND_ID);
return CachedActionResult.remote(actionResult);
}
});
doAnswer(
(Answer<Void>)
invocation -> {
RemoteAction action = invocation.getArgument(0);
RemoteActionExecutionContext context = action.getRemoteActionExecutionContext();
RequestMetadata meta = context.getRequestMetadata();
assertThat(meta.getCorrelatedInvocationsId()).isEqualTo(BUILD_REQUEST_ID);
assertThat(meta.getToolInvocationId()).isEqualTo(COMMAND_ID);
return null;
})
.when(service)
.downloadOutputs(
any(), eq(RemoteActionResult.createFromCache(CachedActionResult.remote(actionResult))));
// act
CacheHandle entry = cache.lookup(simpleSpawn, simplePolicy);
assertThat(entry.hasResult()).isTrue();
SpawnResult result = entry.getResult();
// assert
// All other methods on RemoteActionCache have side effects, so we verify all of them.
verify(service)
.downloadOutputs(
any(), eq(RemoteActionResult.createFromCache(CachedActionResult.remote(actionResult))));
verify(service, never()).uploadOutputs(any(), any());
assertThat(result.getDigest())
.isEqualTo(
SpawnResult.Digest.of(
actionKeyCaptor.getValue().getDigest().getHash(),
actionKeyCaptor.getValue().getDigest().getSizeBytes()));
assertThat(result.setupSuccess()).isTrue();
assertThat(result.exitCode()).isEqualTo(0);
assertThat(result.isCacheHit()).isTrue();
// We expect the CachedLocalSpawnRunner to _not_ write to outErr at all.
assertThat(outErr.hasRecordedOutput()).isFalse();
assertThat(outErr.hasRecordedStderr()).isFalse();
assertThat(progressUpdates).containsExactly(SpawnCheckingCacheEvent.create("remote-cache"));
}
@Test
public void cacheMiss() throws Exception {
RemoteSpawnCache cache = createRemoteSpawnCache();
RemoteExecutionService service = cache.getRemoteExecutionService();
CacheHandle entry = cache.lookup(simpleSpawn, simplePolicy);
assertThat(entry.hasResult()).isFalse();
SpawnResult result =
new SpawnResult.Builder()
.setExitCode(0)
.setStatus(Status.SUCCESS)
.setRunnerName("test")
.build();
doNothing().when(service).uploadOutputs(any(), any());
entry.store(result);
verify(service).uploadOutputs(any(), any());
assertThat(progressUpdates).containsExactly(SpawnCheckingCacheEvent.create("remote-cache"));
}
@Test
public void noCacheSpawns() throws Exception {
// Checks that spawns satisfying Spawns.mayBeCached=false are not looked up in the cache
// (even if it is a local cache) and that the results/artifacts are not uploaded to the cache.
RemoteOptions withLocalCache = Options.getDefaults(RemoteOptions.class);
withLocalCache.diskCache = PathFragment.create("/etc/something/cache/here");
for (RemoteSpawnCache remoteSpawnCache :
ImmutableList.of(createRemoteSpawnCache(), remoteSpawnCacheWithOptions(withLocalCache))) {
for (String requirement :
ImmutableList.of(ExecutionRequirements.NO_CACHE, ExecutionRequirements.LOCAL)) {
SimpleSpawn uncacheableSpawn =
simpleSpawnWithExecutionInfo(ImmutableMap.of(requirement, ""));
CacheHandle entry = remoteSpawnCache.lookup(uncacheableSpawn, simplePolicy);
verify(remoteSpawnCache.getRemoteExecutionService(), never()).lookupCache(any());
assertThat(entry.hasResult()).isFalse();
SpawnResult result =
new SpawnResult.Builder()
.setExitCode(0)
.setStatus(Status.SUCCESS)
.setRunnerName("test")
.build();
entry.store(result);
verifyNoMoreInteractions(remoteCache);
assertThat(progressUpdates).isEmpty();
}
}
}
@Test
public void noRemoteCacheSpawns_remoteCache() throws Exception {
// Checks that spawns satisfying Spawns.mayBeCachedRemotely=false are not looked up in the
// remote cache, and that the results/artifacts are not uploaded to the remote cache.
RemoteOptions remoteCacheOptions = Options.getDefaults(RemoteOptions.class);
remoteCacheOptions.remoteCache = "https://somecache.com";
RemoteSpawnCache remoteSpawnCache = remoteSpawnCacheWithOptions(remoteCacheOptions);
for (String requirement :
ImmutableList.of(
ExecutionRequirements.NO_CACHE,
ExecutionRequirements.LOCAL,
ExecutionRequirements.NO_REMOTE_CACHE,
ExecutionRequirements.NO_REMOTE)) {
SimpleSpawn uncacheableSpawn = simpleSpawnWithExecutionInfo(ImmutableMap.of(requirement, ""));
CacheHandle entry = remoteSpawnCache.lookup(uncacheableSpawn, simplePolicy);
verify(remoteCache, never())
.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false));
assertThat(entry.hasResult()).isFalse();
SpawnResult result =
new SpawnResult.Builder()
.setExitCode(0)
.setStatus(Status.SUCCESS)
.setRunnerName("test")
.build();
entry.store(result);
verifyNoMoreInteractions(remoteCache);
assertThat(progressUpdates).isEmpty();
}
}
@Test
public void noRemoteCacheSpawns_combinedCache() throws Exception {
// Checks that spawns satisfying Spawns.mayBeCachedRemotely=false are not looked up in the
// remote cache, and that the results/artifacts are not uploaded to the remote cache.
// The disk cache part of a combined cache is considered as a local cache hence spawns tagged
// with NO_REMOTE can sill hit it.
RemoteOptions combinedCacheOptions = Options.getDefaults(RemoteOptions.class);
combinedCacheOptions.remoteCache = "https://somecache.com";
combinedCacheOptions.diskCache = PathFragment.create("/etc/something/cache/here");
RemoteSpawnCache remoteSpawnCache = remoteSpawnCacheWithOptions(combinedCacheOptions);
for (String requirement :
ImmutableList.of(ExecutionRequirements.NO_CACHE, ExecutionRequirements.LOCAL)) {
SimpleSpawn uncacheableSpawn = simpleSpawnWithExecutionInfo(ImmutableMap.of(requirement, ""));
CacheHandle entry = remoteSpawnCache.lookup(uncacheableSpawn, simplePolicy);
verify(remoteCache, never())
.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false));
assertThat(entry.hasResult()).isFalse();
SpawnResult result =
new SpawnResult.Builder()
.setExitCode(0)
.setStatus(Status.SUCCESS)
.setRunnerName("test")
.build();
entry.store(result);
verifyNoMoreInteractions(remoteCache);
assertThat(progressUpdates).isEmpty();
}
}
@Test
public void noRemoteCacheStillUsesLocalCache() throws Exception {
RemoteOptions remoteOptions = Options.getDefaults(RemoteOptions.class);
remoteOptions.diskCache = PathFragment.create("/etc/something/cache/here");
RemoteSpawnCache cache = remoteSpawnCacheWithOptions(remoteOptions);
SimpleSpawn cacheableSpawn =
simpleSpawnWithExecutionInfo(ImmutableMap.of(ExecutionRequirements.NO_REMOTE_CACHE, ""));
cache.lookup(cacheableSpawn, simplePolicy);
verify(remoteCache)
.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false));
}
@Test
public void noRemoteExecStillUsesCache() throws Exception {
RemoteSpawnCache cache = createRemoteSpawnCache();
SimpleSpawn cacheableSpawn =
simpleSpawnWithExecutionInfo(ImmutableMap.of(ExecutionRequirements.NO_REMOTE_EXEC, ""));
cache.lookup(cacheableSpawn, simplePolicy);
verify(remoteCache)
.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false));
}
@Test
public void failedActionsAreNotUploaded() throws Exception {
// Only successful action results are uploaded to the remote cache.
RemoteSpawnCache cache = createRemoteSpawnCache();
RemoteExecutionService service = cache.getRemoteExecutionService();
CacheHandle entry = cache.lookup(simpleSpawn, simplePolicy);
verify(remoteCache)
.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false));
assertThat(entry.hasResult()).isFalse();
SpawnResult result =
new SpawnResult.Builder()
.setExitCode(1)
.setStatus(Status.NON_ZERO_EXIT)
.setFailureDetail(
FailureDetail.newBuilder()
.setSpawn(FailureDetails.Spawn.newBuilder().setCode(Code.NON_ZERO_EXIT))
.build())
.setRunnerName("test")
.build();
entry.store(result);
verify(service, never()).uploadOutputs(any(), any());
assertThat(progressUpdates).containsExactly(SpawnCheckingCacheEvent.create("remote-cache"));
}
@Test
public void printWarningIfDownloadFails() throws Exception {
RemoteSpawnCache cache = createRemoteSpawnCache();
RemoteExecutionService service = cache.getRemoteExecutionService();
doThrow(new IOException(io.grpc.Status.UNAVAILABLE.asRuntimeException()))
.when(remoteCache)
.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false));
CacheHandle entry = cache.lookup(simpleSpawn, simplePolicy);
assertThat(entry.hasResult()).isFalse();
SpawnResult result =
new SpawnResult.Builder()
.setExitCode(0)
.setStatus(Status.SUCCESS)
.setRunnerName("test")
.build();
doNothing().when(service).uploadOutputs(any(), any());
entry.store(result);
verify(service).uploadOutputs(any(), eq(result));
assertThat(eventHandler.getEvents()).hasSize(1);
Event evt = eventHandler.getEvents().get(0);
assertThat(evt.getKind()).isEqualTo(EventKind.WARNING);
assertThat(evt.getMessage()).contains("UNAVAILABLE");
assertThat(progressUpdates).containsExactly(SpawnCheckingCacheEvent.create("remote-cache"));
}
@Test
public void orphanedCachedResultIgnored() throws Exception {
RemoteSpawnCache cache = createRemoteSpawnCache();
RemoteExecutionService service = cache.getRemoteExecutionService();
Digest digest = digestUtil.computeAsUtf8("bla");
ActionResult actionResult =
ActionResult.newBuilder()
.addOutputFiles(OutputFile.newBuilder().setPath("/random/file").setDigest(digest))
.build();
when(remoteCache.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false)))
.thenAnswer(
new Answer<CachedActionResult>() {
@Override
public CachedActionResult answer(InvocationOnMock invocation) {
RemoteActionExecutionContext context = invocation.getArgument(0);
RequestMetadata meta = context.getRequestMetadata();
assertThat(meta.getCorrelatedInvocationsId()).isEqualTo(BUILD_REQUEST_ID);
assertThat(meta.getToolInvocationId()).isEqualTo(COMMAND_ID);
return CachedActionResult.remote(actionResult);
}
});
doThrow(new CacheNotFoundException(digest))
.when(service)
.downloadOutputs(
any(), eq(RemoteActionResult.createFromCache(CachedActionResult.remote(actionResult))));
CacheHandle entry = cache.lookup(simpleSpawn, simplePolicy);
assertThat(entry.hasResult()).isFalse();
SpawnResult result =
new SpawnResult.Builder()
.setExitCode(0)
.setStatus(Status.SUCCESS)
.setRunnerName("test")
.build();
doNothing().when(service).uploadOutputs(any(), any());
entry.store(result);
verify(service).uploadOutputs(any(), eq(result));
assertThat(progressUpdates).containsExactly(SpawnCheckingCacheEvent.create("remote-cache"));
assertThat(eventHandler.getEvents()).isEmpty(); // no warning is printed.
}
@Test
public void failedCacheActionAsCacheMiss() throws Exception {
RemoteSpawnCache cache = createRemoteSpawnCache();
ActionResult actionResult = ActionResult.newBuilder().setExitCode(1).build();
when(remoteCache.downloadActionResult(
any(RemoteActionExecutionContext.class),
any(ActionKey.class),
/* inlineOutErr= */ eq(false)))
.thenReturn(CachedActionResult.remote(actionResult));
CacheHandle entry = cache.lookup(simpleSpawn, simplePolicy);
assertThat(entry.hasResult()).isFalse();
}
@Test
public void testDownloadMinimal() throws Exception {
// arrange
RemoteOptions remoteOptions = Options.getDefaults(RemoteOptions.class);
remoteOptions.remoteOutputsMode = RemoteOutputsMode.MINIMAL;
RemoteSpawnCache cache = remoteSpawnCacheWithOptions(remoteOptions);
ActionResult success = ActionResult.newBuilder().setExitCode(0).build();
when(remoteCache.downloadActionResult(
any(RemoteActionExecutionContext.class), any(), /* inlineOutErr= */ eq(false)))
.thenReturn(CachedActionResult.remote(success));
doReturn(null).when(cache.getRemoteExecutionService()).downloadOutputs(any(), any());
// act
CacheHandle cacheHandle = cache.lookup(simpleSpawn, simplePolicy);
// assert
assertThat(cacheHandle.hasResult()).isTrue();
assertThat(cacheHandle.getResult().exitCode()).isEqualTo(0);
verify(cache.getRemoteExecutionService())
.downloadOutputs(
any(), eq(RemoteActionResult.createFromCache(CachedActionResult.remote(success))));
}
@Test
public void testDownloadMinimalIoError() throws Exception {
// arrange
RemoteOptions remoteOptions = Options.getDefaults(RemoteOptions.class);
remoteOptions.remoteOutputsMode = RemoteOutputsMode.MINIMAL;
RemoteSpawnCache cache = remoteSpawnCacheWithOptions(remoteOptions);
IOException downloadFailure = new IOException("downloadMinimal failed");
ActionResult success = ActionResult.newBuilder().setExitCode(0).build();
when(remoteCache.downloadActionResult(
any(RemoteActionExecutionContext.class), any(), /* inlineOutErr= */ eq(false)))
.thenReturn(CachedActionResult.remote(success));
doThrow(downloadFailure)
.when(cache.getRemoteExecutionService())
.downloadOutputs(
any(), eq(RemoteActionResult.createFromCache(CachedActionResult.remote(success))));
// act
CacheHandle cacheHandle = cache.lookup(simpleSpawn, simplePolicy);
// assert
assertThat(cacheHandle.hasResult()).isFalse();
verify(cache.getRemoteExecutionService())
.downloadOutputs(
any(), eq(RemoteActionResult.createFromCache(CachedActionResult.remote(success))));
assertThat(eventHandler.getEvents().size()).isEqualTo(1);
Event evt = eventHandler.getEvents().get(0);
assertThat(evt.getKind()).isEqualTo(EventKind.WARNING);
assertThat(evt.getMessage()).contains(downloadFailure.getMessage());
}
}