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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*
SPDX-FileCopyrightText: 2012 Miha Čančula <miha@noughmad.eu>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_ITESTSUITE_H
#define KDEVPLATFORM_ITESTSUITE_H
#include "interfacesexport.h"
#include <QMetaType>
#include <QStringList>
class KJob;
namespace KDevelop {
class IndexedDeclaration;
class IProject;
/**
* A unit test suite class.
**/
class KDEVPLATFORMINTERFACES_EXPORT ITestSuite
{
public:
/**
* Specifies how much output a test job should produce
**/
enum TestJobVerbosity
{
Silent, ///< No tool view is raised by the job
Verbose ///< The job raises an output tool view
};
/**
* Destructor
**/
virtual ~ITestSuite();
/**
* @returns the display name of this suite. It has to be unique within a project.
**/
virtual QString name() const = 0;
/**
* @returns the list of all test cases in this suite.
**/
virtual QStringList cases() const = 0;
/**
* 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.
**/
virtual IProject* project() const = 0;
/**
* Return a job that will execute all the test cases in this suite.
*
* The implementation of this class is responsible for creating the job
* and interpreting its results. After the job is finished, the test results
* should be made available to the result() function.
*
* Starting the job is up to the caller, usually by registering it with
* the run controller.
**/
virtual KJob* launchAllCases(TestJobVerbosity verbosity) = 0;
/**
* @param testCases list of test cases to run
* @returns a KJob that will run the specified @p testCases.
* @sa launchAllCases()
**/
virtual KJob* launchCases(const QStringList& testCases, TestJobVerbosity verbosity) = 0;
/**
* @param testCase the test case to run
* @returns a KJob that will run only @p testCase.
* @sa launchAllCases()
**/
virtual KJob* launchCase(const QString& testCase, TestJobVerbosity verbosity) = 0;
/**
* The location in source code where the test suite is declared.
* If no such declaration can be found, an invalid declaration is returned.
**/
virtual IndexedDeclaration declaration() const = 0;
/**
* 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.
*
* This function may also return declarations for setup and teardown functions,
* even though these functions are not included in cases().
*
* @param testCase the test case
**/
virtual IndexedDeclaration caseDeclaration(const QString& testCase) const = 0;
};
}
Q_DECLARE_METATYPE(KDevelop::ITestSuite*)
#endif // KDEVPLATFORM_ITESTSUITE_H
|
