itestsuite.h 3.67 KB
Newer Older
1
/*  This file is part of KDevelop
Miha Čančula's avatar
Miha Čančula committed
2
    Copyright 2012 Miha Čančula <miha@noughmad.eu>
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

20
21
#ifndef KDEVPLATFORM_ITESTSUITE_H
#define KDEVPLATFORM_ITESTSUITE_H
Miha Čančula's avatar
Miha Čančula committed
22
23

#include "interfacesexport.h"
24

25
26
#include <QMetaType>

27
class KJob;
28
29
class QString;
class QStringList;
30
31
32

namespace KDevelop {

33
class IndexedDeclaration;
34
class IProject;
35

36
/**
37
 * A unit test suite class.
38
 **/
Miha Čančula's avatar
Miha Čančula committed
39
class KDEVPLATFORMINTERFACES_EXPORT ITestSuite
40
41
42
{

public:
Milian Wolff's avatar
rtrim    
Milian Wolff committed
43

44
45
46
47
    /**
     * Specifies how much output a test job should produce
     **/
    enum TestJobVerbosity
Milian Wolff's avatar
rtrim    
Milian Wolff committed
48
    {
49
50
        Silent, ///< No tool view is raised by the job
        Verbose ///< The job raises an output tool view
51
52
    };

53
54
55
    /**
     * Destructor
     **/
56
57
    virtual ~ITestSuite();

58
    /**
59
     * @returns the display name of this suite. It has to be unique within a project.
60
     **/
61
    virtual QString name() const = 0;
62
    /**
63
     * @returns the list of all test cases in this suite.
64
     **/
65
    virtual QStringList cases() const = 0;
66
    /**
67
68
69
70
71
     * Get the project to which this test suite belongs.
     * Since all suites must have a project associated,
     * this function should never return 0.
     *
     * @returns the test suite's project.
72
     **/
73
    virtual IProject* project() const = 0;
74

75
    /**
76
77
     * Return a job that will execute all the test cases in this suite.
     *
78
79
     * The implementation of this class is responsible for creating the job
     * and interpreting its results. After the job is finished, the test results
80
81
82
83
     * should be made available to the result() function.
     *
     * Starting the job is up to the caller, usually by registering it with
     * the run controller.
84
     **/
85
    virtual KJob* launchAllCases(TestJobVerbosity verbosity) = 0;
86

87
88
    /**
     * @param testCases list of test cases to run
89
     * @returns a KJob that will run the specified @p testCases.
90
91
     * @sa launchAllCases()
     **/
92
    virtual KJob* launchCases(const QStringList& testCases, TestJobVerbosity verbosity) = 0;
93

94
95
    /**
     * @param testCase the test case to run
96
     * @returns a KJob that will run only @p testCase.
97
98
     * @sa launchAllCases()
     **/
99
    virtual KJob* launchCase(const QString& testCase, TestJobVerbosity verbosity) = 0;
100

101
    /**
102
103
     * The location in source code where the test suite is declared.
     * If no such declaration can be found, an invalid declaration is returned.
104
     **/
105
    virtual IndexedDeclaration declaration() const = 0;
106

107
    /**
108
109
110
     * The location in source code where the test case @p testCase is declared.
     * If no such declaration can be found, an invalid declaration is returned.
     *
111
     * This function may also return declarations for setup and teardown functions,
112
113
     * even though these functions are not included in cases().
     *
114
115
     * @param testCase the test case
     **/
116
    virtual IndexedDeclaration caseDeclaration(const QString& testCase) const = 0;
117
118
119
120
};

}

121
122
Q_DECLARE_METATYPE(KDevelop::ITestSuite*)

123
#endif // KDEVPLATFORM_ITESTSUITE_H