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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/*
This file is part of the KDE libraries
SPDX-FileCopyrightText: 2020 David Faure <faure@kde.org>
SPDX-License-Identifier: LGPL-2.0-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#include "commandlauncherjobtest.h"
#include "commandlauncherjob.h"
#include "kiotesthelper.h" // createTestFile etc.
#include <QStandardPaths>
#include <QTemporaryDir>
#include <QTest>
#include <kprocessrunner_p.h>
QTEST_GUILESS_MAIN(CommandLauncherJobTest)
void CommandLauncherJobTest::initTestCase()
{
QStandardPaths::setTestModeEnabled(true);
}
static void createSrcFile(const QString path)
{
QFile srcFile(path);
QVERIFY2(srcFile.open(QFile::WriteOnly), qPrintable(srcFile.errorString()));
QVERIFY(srcFile.write("Hello world\n") > 0);
}
void CommandLauncherJobTest::startProcessAsCommand_data()
{
QTest::addColumn<bool>("useExec");
QTest::newRow("exec") << true;
QTest::newRow("waitForStarted") << false;
}
void CommandLauncherJobTest::startProcessAsCommand()
{
QFETCH(bool, useExec);
// Given a command
QTemporaryDir tempDir;
const QString srcDir = tempDir.path();
const QString srcFile = srcDir + "/srcfile";
createSrcFile(srcFile);
QVERIFY(QFile::exists(srcFile));
#ifdef Q_OS_WIN
QString command = "copy.exe";
#else
QString command = "cp";
#endif
command += QStringLiteral(" %1 destfile").arg(srcFile);
// When running a CommandLauncherJob
KIO::CommandLauncherJob *job = new KIO::CommandLauncherJob(command, this);
job->setWorkingDirectory(srcDir);
if (useExec) {
QVERIFY(job->exec());
} else {
job->start();
QVERIFY(job->waitForStarted());
}
const qint64 pid = job->pid();
// Then the service should be executed (which copies the source file to "dest")
QVERIFY(pid != 0);
const QString dest = srcDir + "/destfile";
QTRY_VERIFY2(QFile::exists(dest), qPrintable(dest));
QVERIFY(QFile::remove(srcFile)); // cleanup
QVERIFY(QFile::remove(dest));
// Just to make sure
QTRY_COMPARE(KProcessRunner::instanceCount(), 0);
}
void CommandLauncherJobTest::startProcessWithArgs_data()
{
QTest::addColumn<QString>("srcName");
QTest::addColumn<QString>("destName");
QTest::newRow("path without spaces") << QStringLiteral("srcfile") << QStringLiteral("destfile");
QTest::newRow("path with spaces") << QStringLiteral("Source File") << QStringLiteral("Destination File");
}
void CommandLauncherJobTest::startProcessWithArgs()
{
QFETCH(QString, srcName);
QFETCH(QString, destName);
QTemporaryDir tempDir;
const QString srcDir = tempDir.path();
const QString srcPath = srcDir + '/' + srcName;
const QString destPath = srcDir + '/' + destName;
createSrcFile(srcPath);
QVERIFY(QFileInfo::exists(srcPath));
#ifdef Q_OS_WIN
const QString executable = "copy.exe";
#else
const QString executable = "cp";
#endif
auto *job = new KIO::CommandLauncherJob(executable, {srcPath, destName}, this);
job->setWorkingDirectory(srcDir);
job->start();
QVERIFY(job->waitForStarted());
const qint64 pid = job->pid();
// Then the service should be executed (which copies the source file to "dest")
QVERIFY(pid != 0);
QTRY_VERIFY2(QFileInfo::exists(destPath), qPrintable(destPath));
QVERIFY(QFile::remove(srcPath));
QVERIFY(QFile::remove(destPath)); // cleanup
// Just to make sure
QTRY_COMPARE(KProcessRunner::instanceCount(), 0);
}
void CommandLauncherJobTest::startProcessWithSpacesInExecutablePath_data()
{
QTest::addColumn<QString>("srcName");
QTest::addColumn<QString>("destName");
QTest::newRow("path without spaces") << QStringLiteral("srcfile") << QStringLiteral("destfile");
QTest::newRow("path with spaces") << QStringLiteral("Source File") << QStringLiteral("Destination File");
}
void CommandLauncherJobTest::startProcessWithSpacesInExecutablePath()
{
QFETCH(QString, srcName);
QFETCH(QString, destName);
QTemporaryDir tempDir;
const QString srcDir = tempDir.filePath("folder with spaces");
QVERIFY(QDir().mkpath(srcDir));
const QString srcPath = srcDir + '/' + srcName;
const QString destPath = srcDir + '/' + destName;
createSrcFile(srcPath);
QVERIFY(QFileInfo::exists(srcPath));
// Copy the executable into the folder with spaces in its path
#ifdef Q_OS_WIN
const QString executableName = "copy"; // QStandardPaths appends extension as necessary
#else
const QString executableName = "cp";
#endif
const QString executablePath = QStandardPaths::findExecutable(executableName);
QVERIFY(!executablePath.isEmpty());
QFileInfo fi(executablePath);
// Needed since it could be .exe or .bat on Windows
const QString executableFileName = fi.fileName();
const QString executable = srcDir + '/' + executableFileName;
QVERIFY(QFile::copy(executablePath, executable));
auto *job = new KIO::CommandLauncherJob(executable, {srcPath, destName}, this);
job->setWorkingDirectory(srcDir);
job->start();
QVERIFY(job->waitForStarted());
const qint64 pid = job->pid();
// Then the service should be executed (which copies the source file to "dest")
QVERIFY(pid != 0);
QTRY_VERIFY2(QFileInfo::exists(destPath), qPrintable(destPath));
// cleanup
QVERIFY(QFile::remove(destPath));
QVERIFY(QFile::remove(srcPath));
QVERIFY(QFile::remove(executable));
// Just to make sure
QTRY_COMPARE(KProcessRunner::instanceCount(), 0);
}
void CommandLauncherJobTest::startProcessWithEnvironmentVariables()
{
// Given an env var and a command that uses it
QProcessEnvironment env;
env.insert("MYVAR", "myvalue");
#ifdef Q_OS_WIN
const QString command = "echo myvar=%MYVAR% > destfile";
#else
const QString command = "echo myvar=$MYVAR > destfile";
#endif
QTemporaryDir tempDir;
const QString srcDir = tempDir.path();
const QString srcFile = srcDir + "/srcfile";
createSrcFile(srcFile);
// When running a CommandLauncherJob
KIO::CommandLauncherJob *job = new KIO::CommandLauncherJob(command, this);
job->setWorkingDirectory(srcDir);
job->setProcessEnvironment(env);
QVERIFY(job->exec());
// Then the env var was visible
QFile destFile(srcDir + "/destfile");
QTRY_VERIFY(QFileInfo(destFile).size() > 0);
QVERIFY(destFile.open(QIODevice::ReadOnly));
const QByteArray data = destFile.readAll().trimmed();
QCOMPARE(data, "myvar=myvalue");
}
void CommandLauncherJobTest::doesNotFailOnNonExistingExecutable()
{
// Given a command that uses an executable that doesn't exist
const QString command = "does_not_exist foo bar";
// When running a CommandLauncherJob
KIO::CommandLauncherJob *job = new KIO::CommandLauncherJob(command, this);
job->setExecutable("really_does_not_exist");
// Then it doesn't actually fail. QProcess is starting /bin/sh, which works...
QVERIFY(job->exec());
// Wait for KProcessRunner to be deleted
QTRY_COMPARE(KProcessRunner::instanceCount(), 0);
}
void CommandLauncherJobTest::shouldDoNothingOnEmptyCommand()
{
// When running an empty command
KIO::CommandLauncherJob *job = new KIO::CommandLauncherJob(QString(), this);
// THEN it should do nothing
// at least not crash (old bug 186036)
QVERIFY(job->exec());
// Wait for KProcessRunner to be deleted
QTRY_COMPARE(KProcessRunner::instanceCount(), 0);
}
#include "moc_commandlauncherjobtest.cpp"
|
