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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
// Copyright (C) 2022 The Qt Company Ltd
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "squishperspective.h"
#include "squishrunnerprocess.h"
#include "squishserverprocess.h"
#include "suiteconf.h"
#include <utils/environment.h>
#include <utils/process.h>
#include <QObject>
#include <QStringList>
#include <memory>
QT_BEGIN_NAMESPACE
class QFile;
class QFileSystemWatcher;
QT_END_NAMESPACE
namespace Squish {
namespace Internal {
class SquishXmlOutputHandler;
class SquishTools : public QObject
{
Q_OBJECT
public:
explicit SquishTools(QObject *parent = nullptr);
~SquishTools() override;
static SquishTools *instance();
enum State {
Idle,
ServerStarting,
ServerStarted,
ServerStartFailed,
ServerStopped,
ServerStopFailed,
RunnerStarting,
RunnerStarted,
RunnerStartFailed,
RunnerStopped
};
using QueryCallback = std::function<void(const QString &, const QString &)>;
State state() const { return m_state; }
void runTestCases(const Utils::FilePath &suitePath,
const QStringList &testCases = QStringList());
void recordTestCase(const Utils::FilePath &suitePath, const QString &testCaseName,
const SuiteConf &suiteConf);
void queryGlobalScripts(QueryCallback callback);
void queryServerSettings(QueryCallback callback);
void requestSetSharedFolders(const Utils::FilePaths &sharedFolders);
void writeServerSettingsChanges(const QList<QStringList> &changes);
void requestExpansion(const QString &name);
bool shutdown();
signals:
void logOutputReceived(const QString &output);
void squishTestRunStarted();
void squishTestRunFinished();
void resultOutputCreated(const QByteArray &output);
void configChangesFailed(QProcess::ProcessError error);
void configChangesWritten();
void localsUpdated(const QString &output);
void shutdownFinished();
private:
enum Request {
None,
ServerStopRequested,
ServerConfigChangeRequested,
RunnerQueryRequested,
RunTestRequested,
RecordTestRequested,
KillOldBeforeRunRunner,
KillOldBeforeRecordRunner,
KillOldBeforeQueryRunner
};
enum RunnerQuery { ServerInfo, GetGlobalScriptDirs, SetGlobalScriptDirs };
void logAndChangeRunnerState(RunnerState to);
void logAndChangeToolsState(SquishTools::State to);
void onServerStateChanged(SquishProcessState state);
void onServerPortRetrieved();
void onServerStopped();
void onServerStartFailed();
void onServerStopFailed();
void onRunnerStateChanged(SquishProcessState state);
void onRunnerStopped();
void onRunnerError(SquishRunnerProcess::RunnerError error);
void setIdle();
void startSquishServer(Request request);
void stopSquishServer();
void startSquishRunner();
void setupAndStartRecorder();
void stopRecorder();
void queryServer(RunnerQuery query);
void executeRunnerQuery();
static Utils::Environment squishEnvironment();
void handleQueryDone(const QString &stdOut, const QString &error);
void onRunnerFinished();
void onRecorderFinished();
void onRunnerOutput(); // runner's results file
void handlePrompt(const QString &fileName = {}, int line = -1, int column = -1);
void onResultsDirChanged(const QString &filePath);
static void logrotateTestResults();
void minimizeQtCreatorWindows();
void restoreQtCreatorWindows();
void updateLocationMarker(const Utils::FilePath &file, int line);
void clearLocationMarker();
void onRunnerRunRequested(StepMode step);
void interruptRunner();
void terminateRunner();
bool isValidToStartRunner();
void handleSquishServerAlreadyRunning();
QStringList serverArgumentsFromSettings() const;
QStringList runnerArgumentsFromSettings();
bool setupRunnerPath();
void setupAndStartSquishRunnerProcess(const Utils::CommandLine &cmdLine);
void setupRunnerForQuery();
void setupRunnerForRun();
SquishPerspective m_perspective;
std::unique_ptr<SquishXmlOutputHandler> m_xmlOutputHandler;
SquishServerProcess m_serverProcess;
SquishRunnerProcess *m_primaryRunner = nullptr;
SquishRunnerProcess *m_secondaryRunner = nullptr;
QString m_serverHost;
Request m_request = None;
State m_state = Idle;
RunnerState m_squishRunnerState = RunnerState::None;
Utils::FilePath m_suitePath;
QStringList m_testCases;
SuiteConf m_suiteConf; // holds information of current test suite e.g. while recording
Utils::FilePaths m_reportFiles;
Utils::FilePath m_currentResultsDirectory;
QString m_queryParameter;
Utils::FilePath m_currentTestCasePath;
Utils::FilePath m_currentRecorderSnippetFile;
QFile *m_currentResultsXML = nullptr;
QFileSystemWatcher *m_resultsFileWatcher = nullptr;
QStringList m_additionalRunnerArguments;
QList<QStringList> m_serverConfigChanges;
QWindowList m_lastTopLevelWindows;
class SquishLocationMark *m_locationMarker = nullptr;
QTimer *m_requestVarsTimer = nullptr;
qint64 m_readResultsCount;
QueryCallback m_queryCallback;
RunnerQuery m_query = ServerInfo;
bool m_shutdownInitiated = false;
bool m_closeRunnerOnEndRecord = false;
};
} // namespace Internal
} // namespace Squish
|
