File indexing completed on 2024-04-28 04:36:31

 /*
     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>
 
 class KJob;
 class QString;
 class QStringList;
 
 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