1 package org.apache.maven.plugin.surefire.booterclient.output;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.surefire.report.ReportEntry;
23
24 /**
25 * Surefire output consumer that will be called from Surefire when forking tests to process
26 * the lines of the surefire header, messages, footer and test output from the forked Surefire execution.
27 *
28 * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
29 * @version $Id: OutputConsumer.java 1039320 2010-11-26 11:48:24Z krosenvold $
30 * @since 2.1
31 */
32 public interface OutputConsumer
33 {
34
35 /**
36 * Process a line from Surefire header
37 *
38 * @param line the line to process
39 */
40 void consumeHeaderLine( String line );
41
42 /**
43 * Process a line with a Surefire message (not part of test output)
44 *
45 * @param line the line to process
46 */
47 void consumeMessageLine( String line );
48
49 /**
50 * Process a line from Surefire footer
51 *
52 * @param line the line to process
53 */
54 void consumeFooterLine( String line );
55
56 /**
57 * Process a line from test output
58 *
59 * @param line the line to process
60 */
61 void consumeOutputLine( String line );
62
63 /**
64 * This method will be called when a test set starts, before consuming surefire message lines.
65 *
66 * @param reportEntry The {@link ReportEntry} with the name and group (optional) of the test that starts
67 */
68 void testSetStarting( ReportEntry reportEntry );
69
70 /**
71 * This method will be called when a test set ends, after consuming all its surefire message lines.
72 */
73 void testSetCompleted();
74
75 }