blob: 6a81549f2f9681f530e7619f4e73e8b664c83aff (
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
|
/*
* Copyright (c) 2016 Cisco and/or its affiliates.
*
* 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 io.fd.honeycomb.vpp.test.util;
import java.util.concurrent.CompletableFuture;
import javax.annotation.Nonnull;
import org.openvpp.jvpp.VppCallbackException;
import org.openvpp.jvpp.core.future.FutureJVppCore;
/**
* <p>VPP translation test helper, that produces instances of {@link CompletableFuture} with desired results.</p>
* <p>Useful when stubbing {@link FutureJVppCore} methods: <br>{@code when(api.showVersion(any())).thenReturn(future(new
* ShowVersionReply()));}</p>
*/
public interface FutureProducer {
/**
* Returns {@link CompletableFuture} with desired result.
*
* @param result returned when {@link CompletableFuture#get()} is invoked
* @param <T> the result type of returned future
*/
default <T> CompletableFuture<T> future(@Nonnull final T result) {
final CompletableFuture<T> future = new CompletableFuture<>();
future.complete(result);
return future;
}
/**
* Returns {@link CompletableFuture} with provided {@link Exception} as a result.
*
* @param exception to be thrown when {@link CompletableFuture#get()} is invoked
* @param <T> the result type of returned future
*/
default <T> CompletableFuture<T> failedFuture(@Nonnull final Exception exception) {
final CompletableFuture<T> future = new CompletableFuture<>();
future.completeExceptionally(exception);
return future;
}
/**
* Returns {@link CompletableFuture} with VppCallbackException(retval = -1) as a cause.
*
* @param <T> the result type of returned future
*/
default <T> CompletableFuture<T> failedFuture() {
return failedFuture(new VppCallbackException("test-call", 1 /* ctxId */, -1 /* retval */));
}
}
|
