1 package org.apache.maven.continuum.reports.surefire;
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 java.io.File;
23 import java.util.List;
24
25 /**
26 * @author <a href="mailto:olamy@apache.org">olamy</a>
27 * @version $Id: ReportTestSuiteGenerator.java 1372267 2012-08-13 05:47:30Z brett $
28 * @since 12 nov. 07
29 */
30 public interface ReportTestSuiteGenerator
31 {
32
33 /**
34 * @param directory directory containing surefire tests files
35 * @param includes file types to include
36 * @param excludes file types to exclude
37 * @return List of {@link ReportTestSuite}
38 * @throws ReportTestSuiteGeneratorException
39 *
40 */
41 List<ReportTestSuite> generateReports( File directory, List<String> includes, List<String> excludes )
42 throws ReportTestSuiteGeneratorException;
43
44 /**
45 * Use generateReports with default includes *.xml and default excludes *.txt
46 *
47 * @param directory directory containing surefire tests files
48 * @return List of {@link ReportTestSuite}
49 * @throws ReportTestSuiteGeneratorException
50 *
51 */
52 List<ReportTestSuite> generateReports( File directory )
53 throws ReportTestSuiteGeneratorException;
54
55 /**
56 * @param buildId
57 * @param projectId
58 * @return List of {@link ReportTestSuite}
59 * @throws ReportTestSuiteGeneratorException
60 *
61 */
62 List<ReportTestSuite> generateReports( int buildId, int projectId )
63 throws ReportTestSuiteGeneratorException;
64
65 /**
66 * @param buildId
67 * @param projectId
68 * @return List of {@link ReportTestResult}
69 * @throws ReportTestSuiteGeneratorException
70 *
71 */
72 ReportTestResult generateReportTestResult( int buildId, int projectId )
73 throws ReportTestSuiteGeneratorException;
74 }