Provide basic test runner and output pane

This commit is contained in:
Christian Stenger
2014-10-07 15:51:02 +02:00
committed by Christian Stenger
parent 2f4139e5d3
commit 44db2be195
34 changed files with 1877 additions and 26 deletions

View File

@@ -0,0 +1,371 @@
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc
** All rights reserved.
** For any questions to Digia, please use contact form at http://qt.digia.com
**
** This file is part of the Qt Creator Enterprise Auto Test Add-on.
**
** Licensees holding valid Qt Enterprise licenses may use this file in
** accordance with the Qt Enterprise License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** contact form at http://qt.digia.com
**
****************************************************************************/
#include "testresultspane.h"
#include "testrunner.h"
#include <QDebug> // REMOVE
#include <projectexplorer/buildmanager.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <QTime>
namespace Autotest {
namespace Internal {
static TestRunner* m_instance = 0;
TestRunner *TestRunner::instance()
{
if (!m_instance)
m_instance = new TestRunner;
return m_instance;
}
TestRunner::TestRunner(QObject *parent) :
QObject(parent),
m_building(false)
{
m_runner.setReadChannelMode(QProcess::MergedChannels);
m_runner.setReadChannel(QProcess::StandardOutput);
connect(&m_runner, &QProcess::readyReadStandardOutput,
this, &TestRunner::processOutput, Qt::DirectConnection);
connect(&m_runner, SIGNAL(finished(int,QProcess::ExitStatus)),
this, SLOT(onRunnerFinished(int,QProcess::ExitStatus)), Qt::DirectConnection);
}
TestRunner::~TestRunner()
{
qDeleteAll(m_selectedTests);
m_selectedTests.clear();
m_instance = 0;
}
void TestRunner::setSelectedTests(const QList<TestConfiguration *> &selected)
{
qDeleteAll(m_selectedTests);
m_selectedTests.clear();
m_selectedTests = selected;
}
void TestRunner::runTests()
{
if (m_selectedTests.empty()) {
TestResultsPane::instance()->addTestResult(
TestResult(QString(), QString(), QString(), ResultType::MESSAGE_FATAL,
tr("*** No tests selected - canceling Test Run ***")));
return;
}
ProjectExplorer::Project *project = m_selectedTests.at(0)->project();
if (!project) {// add a warning or info to output? possible at all?
return;
}
ProjectExplorer::ProjectExplorerPlugin *pep = ProjectExplorer::ProjectExplorerPlugin::instance();
ProjectExplorer::Internal::ProjectExplorerSettings pes = pep->projectExplorerSettings();
if (pes.buildBeforeDeploy) {
if (!project->hasActiveBuildSettings()) {
qDebug() << "no active build settings...???"; // let it configure?
return;
}
buildProject(project);
while (m_building) {
qApp->processEvents();
}
if (!m_buildSucceeded) {
TestResultsPane::instance()->addTestResult(
TestResult(QString(), QString(), QString(), ResultType::MESSAGE_FATAL,
tr("*** Build failed - canceling Test Run ***")));
return;
}
}
// clear old log and output pane
m_xmlLog.clear();
TestResultsPane::instance()->clearContents();
foreach (TestConfiguration *tc, m_selectedTests) {
QString cmd = tc->targetFile();
QString workDir = tc->workingDirectory();
QStringList args;
Utils::Environment env = tc->environment();
args << QLatin1String("-xml");
if (tc->testCases().count())
args << tc->testCases();
exec(cmd, args, workDir, env);
}
qDebug("test run finished");
}
void TestRunner::stopTestRun()
{
}
/******************** XML line parser helper ********************/
static bool xmlStartsWith(const QString &code, const QString &start, QString &result)
{
if (code.startsWith(start)) {
result = code.mid(start.length());
result = result.left(result.indexOf(QLatin1Char('"')));
result = result.left(result.indexOf(QLatin1String("</")));
return !result.isEmpty();
}
return false;
}
static bool xmlCData(const QString &code, const QString &start, QString &result)
{
if (code.startsWith(start)) {
int index = code.indexOf(QLatin1String("<![CDATA[")) + 9;
result = code.mid(index, code.indexOf(QLatin1String("]]>"), index) - index);
return !result.isEmpty();
}
return false;
}
static bool xmlExtractTypeFileLine(const QString &code, const QString &tagStart,
ResultType &result, QString &file, int &line)
{
if (code.startsWith(tagStart)) {
int start = code.indexOf(QLatin1String(" type=\"")) + 7;
result = TestResult::resultFromString(
code.mid(start, code.indexOf(QLatin1Char('"'), start) - start));
start = code.indexOf(QLatin1String(" file=\"")) + 7;
file = code.mid(start, code.indexOf(QLatin1Char('"'), start) - start);
start = code.indexOf(QLatin1String(" line=\"")) + 7;
line = code.mid(start, code.indexOf(QLatin1Char('"'), start) - start).toInt();
return true;
}
return false;
}
/****************** XML line parser helper end ******************/
void TestRunner::processOutput()
{
static QString className;
static QString testCase;
static QString dataTag;
static ResultType result = ResultType::UNKNOWN;
static QString description;
static QString file;
static int lineNumber = 0;
static QString duration;
static bool readingDescription = false;
static QString qtVersion;
static QString qtestVersion;
while (m_runner.canReadLine()) {
// TODO Qt5 uses UTF-8 - while Qt4 uses ISO-8859-1 - could this be a problem?
QString line = QString::fromUtf8(m_runner.readLine());
line = line.trimmed();
m_xmlLog.append(line);
if (line.isEmpty() || line.startsWith(QLatin1String("<?xml version"))) {
className = QString();
continue;
}
if (xmlStartsWith(line, QLatin1String("<TestCase name=\""), className))
continue;
if (xmlStartsWith(line, QLatin1String("<TestFunction name=\""), testCase)) {
dataTag = QString();
description = QString();
duration = QString();
file = QString();
result = ResultType::UNKNOWN;
lineNumber = 0;
readingDescription = false;
continue;
}
if (xmlStartsWith(line, QLatin1String("<Duration msecs=\""), duration)) {
continue;
}
if (xmlExtractTypeFileLine(line, QLatin1String("<Message"), result, file, lineNumber))
continue;
if (xmlCData(line, QLatin1String("<DataTag>"), dataTag))
continue;
if (xmlCData(line, QLatin1String("<Description>"), description)) {
if (!line.endsWith(QLatin1String("</Description>")))
readingDescription = true;
continue;
}
if (xmlExtractTypeFileLine(line, QLatin1String("<Incident"), result, file, lineNumber)) {
if (line.endsWith(QLatin1String("/>"))) {
TestResult testResult(className, testCase, dataTag, result, description);
if (!file.isEmpty())
file = QFileInfo(m_runner.workingDirectory(), file).canonicalFilePath();
testResult.setFileName(file);
testResult.setLine(lineNumber);
TestResultsPane::instance()->addTestResult(testResult);
}
continue;
}
if (line == QLatin1String("</Message>") || line == QLatin1String("</Incident>")) {
TestResult testResult(className, testCase, dataTag, result, description);
if (!file.isEmpty())
file = QFileInfo(m_runner.workingDirectory(), file).canonicalFilePath();
testResult.setFileName(file);
testResult.setLine(lineNumber);
TestResultsPane::instance()->addTestResult(testResult);
description = QString();
} else if (line == QLatin1String("</TestFunction>") && !duration.isEmpty()) {
TestResult testResult(className, testCase, QString(), ResultType::MESSAGE_INTERNAL,
tr("execution took %1ms").arg(duration));
TestResultsPane::instance()->addTestResult(testResult);
} else if (line == QLatin1String("</TestCase>") && !duration.isEmpty()) {
TestResult testResult(className, QString(), QString(), ResultType::MESSAGE_INTERNAL,
tr("Test execution took %1ms").arg(duration));
TestResultsPane::instance()->addTestResult(testResult);
} else if (readingDescription) {
if (line.endsWith(QLatin1String("]]></Description>"))) {
description.append(QLatin1Char('\n'));
description.append(line.left(line.indexOf(QLatin1String("]]></Description>"))));
readingDescription = false;
} else {
description.append(QLatin1Char('\n'));
description.append(line);
}
} else if (xmlStartsWith(line, QLatin1String("<QtVersion>"), qtVersion)) {
TestResultsPane::instance()->addTestResult(
TestResult(QString(), QString(), QString(), ResultType::MESSAGE_INTERNAL,
tr("Qt Version: %1").arg(qtVersion)));
} else if (xmlStartsWith(line, QLatin1String("<QTestVersion>"), qtestVersion)) {
TestResultsPane::instance()->addTestResult(
TestResult(QString(), QString(), QString(), ResultType::MESSAGE_INTERNAL,
tr("QTest Version: %1").arg(qtestVersion)));
} else {
// qDebug() << "Unhandled line:" << line; // TODO remove
}
}
}
void TestRunner::onRunnerFinished(int exitCode, QProcess::ExitStatus exitStatus)
{
qDebug("runnerFinished");
}
void TestRunner::buildProject(ProjectExplorer::Project *project)
{
m_building = true;
m_buildSucceeded = false;
ProjectExplorer::BuildManager *mgr = static_cast<ProjectExplorer::BuildManager *>(
ProjectExplorer::BuildManager::instance());
ProjectExplorer::ProjectExplorerPlugin *pep = ProjectExplorer::ProjectExplorerPlugin::instance();
pep->buildProject(project);
connect(mgr, &ProjectExplorer::BuildManager::buildQueueFinished,
this, &TestRunner::buildFinished);
}
void TestRunner::buildFinished(bool success)
{
ProjectExplorer::BuildManager *mgr = static_cast<ProjectExplorer::BuildManager *>(
ProjectExplorer::BuildManager::instance());
disconnect(mgr, &ProjectExplorer::BuildManager::buildQueueFinished,
this, &TestRunner::buildFinished);
m_building = false;
m_buildSucceeded = success;
}
static QString which(const QString &path, const QString &cmd)
{
if (path.isEmpty() || cmd.isEmpty())
return QString();
QStringList paths;
#ifdef Q_OS_WIN
paths = path.split(QLatin1Char(';'));
#else
paths = path.split(QLatin1Char(':'));
#endif
foreach (const QString p, paths) {
QString fName = p + QDir::separator() + cmd;
QFileInfo fi(fName);
if (fi.exists() && fi.isExecutable())
return fName;
#ifdef Q_OS_WIN
fi = QFileInfo(fName + QLatin1String(".exe"));
if (fi.exists())
return fi.absoluteFilePath();
fi = QFileInfo(fName + QLatin1String(".bat"));
if (fi.exists())
return fi.absoluteFilePath();
fi = QFileInfo(fName + QLatin1String(".cmd"));
if (fi.exists())
return fi.absoluteFilePath();
#endif
}
return QString();
}
bool TestRunner::exec(const QString &cmd, const QStringList &args, const QString &workingDir,
const Utils::Environment &env, int timeout)
{
if (m_runner.state() != QProcess::NotRunning) { // kill the runner if it's running already
m_runner.kill();
m_runner.waitForFinished();
}
QString runCmd;
if (!QDir::toNativeSeparators(cmd).contains(QDir::separator())) {
if (env.hasKey(QLatin1String("PATH")))
runCmd = which(env.value(QLatin1String("PATH")), cmd);
} else if (QFileInfo(cmd).exists()) {
runCmd = cmd;
}
if (runCmd.isEmpty()) {
qDebug("Could not find cmd...");
return false;
}
m_runner.setWorkingDirectory(workingDir);
m_runner.setProcessEnvironment(env.toProcessEnvironment());
QTime executionTimer;
if (args.count()) {
m_runner.start(runCmd, args);
} else {
m_runner.start(runCmd);
}
bool ok = m_runner.waitForStarted();
executionTimer.start();
if (ok) {
while (m_runner.state() == QProcess::Running && executionTimer.elapsed() < timeout) {
qApp->processEvents();
}
}
if (ok && executionTimer.elapsed() < timeout) {
return m_runner.exitCode() == 0;
} else {
return false;
}
}
} // namespace Internal
} // namespace Autotest