1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugin.surefire.booterclient.lazytestprovider;
20
21 import org.apache.maven.surefire.api.booter.Shutdown;
22
23 /**
24 * Remote interface of forked JVM with command methods.
25 * <br>
26 * Implemented by {@link TestProvidingInputStream} and {@link TestLessInputStream} where the method
27 * {@link TestLessInputStream#provideNewTest()} purposefully does nothing. Some methods in
28 * {@link org.apache.maven.plugin.surefire.booterclient.lazytestprovider.TestLessInputStream.TestLessInputStreamBuilder}
29 * throw {@link UnsupportedOperationException}.
30 *
31 * @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
32 * @since 2.19
33 * @see TestProvidingInputStream
34 * @see TestLessInputStream
35 */
36 public interface NotifiableTestStream {
37 /**
38 * Forked jvm notifies master process to provide a new test.
39 * <br>
40 * Notifies {@link TestProvidingInputStream} in order to dispatch a new test back to the forked
41 * jvm (particular fork which hits this call); or do nothing in {@link TestLessInputStream}.
42 */
43 void provideNewTest();
44
45 /**
46 * Sends an event to a fork jvm in order to skip tests.
47 * Returns immediately without blocking.
48 */
49 void skipSinceNextTest();
50
51 void shutdown(Shutdown shutdownType);
52
53 void noop();
54
55 void acknowledgeByeEventReceived();
56 }