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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
|
#include "tst_shell.h"
#include <gui/mainwindow.h>
#include <msgpackrequest.h>
#include <QClipboard>
#include <QFontDatabase>
#include <QLocalSocket>
#include <QtGlobal>
#include <QtTest/QtTest>
#include "common.h"
#include "common_gui.h"
#if defined(Q_OS_WIN) && defined(USE_STATIC_QT)
#include <QtPlugin>
Q_IMPORT_PLUGIN (QWindowsIntegrationPlugin);
#endif
namespace NeovimQt {
class TestShell : public QObject
{
Q_OBJECT
private slots:
void initTestCase() noexcept;
void benchStart() noexcept;
void startVarsShellWidget() noexcept;
void startVarsMainWindow() noexcept;
void gviminit() noexcept;
void guiShimCommands() noexcept;
void CloseEvent_data() noexcept;
void CloseEvent() noexcept;
void GetClipboard_data() noexcept;
void GetClipboard() noexcept;
void SetClipboard_data() noexcept;
void SetClipboard() noexcept;
protected:
void checkStartVars(NeovimQt::NeovimConnector* conn) noexcept;
void grabShellScreenshot(Shell& s, const QString& filename) noexcept;
};
static void SignalPrintError(QString msg, const QVariant& err) noexcept
{
qWarning() << "Error Signal!" << msg << err;
}
void TestShell::initTestCase() noexcept
{
const QStringList fonts{
QStringLiteral("third-party/DejaVuSansMono.ttf"),
QStringLiteral("third-party/DejaVuSansMono-Bold.ttf"),
QStringLiteral("third-party/DejaVuSansMono-BoldOblique.ttf") };
for (const auto& path : fonts) {
QString abs_path_to_font(CMAKE_SOURCE_DIR);
abs_path_to_font.append("/").append(path);
QFontDatabase::addApplicationFont(abs_path_to_font);
}
}
void TestShell::benchStart() noexcept
{
QBENCHMARK
{
auto s = CreateShellWidget();
QSignalSpy onResize(s.get(), &Shell::neovimResized);
QVERIFY(onResize.isValid());
QVERIFY(SPYWAIT(onResize));
}
}
void TestShell::startVarsShellWidget() noexcept
{
auto s = CreateShellWidget();
checkStartVars(s->nvim());
}
void TestShell::startVarsMainWindow() noexcept
{
auto w = CreateMainWindow();
checkStartVars(w->shell()->nvim());
}
void TestShell::gviminit() noexcept
{
qputenv("GVIMINIT", "let g:test_gviminit = 1");
auto s = CreateShellWidget();
NeovimConnector* c = s->nvim();
MsgpackRequest* req{ c->api0()->vim_command_output(c->encode("echo g:test_gviminit")) };
QSignalSpy cmd{ req, &MsgpackRequest::finished };
QVERIFY(cmd.isValid());
QVERIFY(SPYWAIT(cmd));
QCOMPARE(cmd.at(0).at(2).toByteArray(), QByteArray("1"));
}
void TestShell::guiShimCommands() noexcept
{
auto w = CreateMainWindowWithRuntime();
auto c = w->shell()->nvim();
QObject::connect(c->neovimObject(), &NeovimApi1::err_vim_command_output, SignalPrintError);
QSignalSpy cmd_font(
c->neovimObject()->vim_command_output(c->encode("GuiFont!")), &MsgpackRequest::finished);
QVERIFY(cmd_font.isValid());
QVERIFY2(SPYWAIT(cmd_font), "Waiting for GuiFont");
QSignalSpy cmd_ls(
c->neovimObject()->vim_command_output(c->encode("GuiLinespace")),
&MsgpackRequest::finished);
QVERIFY(cmd_ls.isValid());
QVERIFY2(SPYWAIT(cmd_ls), "Waiting for GuiLinespace");
// Test font attributes
const QString cmdFontSize14{ QStringLiteral("GuiFont! %1:h14").arg(GetPlatformTestFont()) };
const QString expectedFontSize14{ QStringLiteral("%1:h14").arg(GetPlatformTestFont()) };
QSignalSpy cmd_gf{ c->neovimObject()->vim_command_output(c->encode(cmdFontSize14)),
&MsgpackRequest::finished };
QVERIFY(cmd_gf.isValid());
QVERIFY(SPYWAIT(cmd_gf));
QSignalSpy spy_fontchange(w->shell(), &ShellWidget::shellFontChanged);
// Test Performance: timeout occurs often, set value carefully.
SPYWAIT(spy_fontchange, 2500 /*msec*/);
QCOMPARE(w->shell()->fontDesc(), expectedFontSize14);
// Normalization removes the :b attribute
const QString cmdFontBoldRemoved{
QStringLiteral("GuiFont! %1:h16:b:l").arg(GetPlatformTestFont())
};
const QString expectedFontBoldRemoved{ QStringLiteral("%1:h16:l").arg(GetPlatformTestFont()) };
QSignalSpy spy_fontchange2(w->shell(), &ShellWidget::shellFontChanged);
QSignalSpy cmd_gf2{ c->neovimObject()->vim_command_output(c->encode(cmdFontBoldRemoved)),
&MsgpackRequest::finished };
QVERIFY(cmd_gf2.isValid());
QVERIFY(SPYWAIT(cmd_gf2, 5000));
// Test Performance: timeout occurs often, set value carefully.
SPYWAIT(spy_fontchange2, 5000 /*msec*/);
QCOMPARE(w->shell()->fontDesc(), expectedFontBoldRemoved);
// GuiRenderFontAttr
QCOMPARE(w->shell()->renderFontAttr(), true);
QSignalSpy spy_fontattr_change(w->shell(), &ShellWidget::renderFontAttrChanged);
QVERIFY(spy_fontattr_change.isValid());
QSignalSpy cmd_fontattr(
c->neovimObject()->vim_command_output(c->encode("GuiRenderFontAttr 0")),
&MsgpackRequest::finished);
QVERIFY(cmd_fontattr.isValid());
QVERIFY2(SPYWAIT(cmd_fontattr), "Waiting for GuiRenderFontAttr cmd");
QVERIFY2(SPYWAIT(spy_fontattr_change), "Waiting for renderFontAttrChanged");
QCOMPARE(w->shell()->renderFontAttr(), false);
QSignalSpy spy_fontattr_change2(w->shell(), &ShellWidget::renderFontAttrChanged);
QVERIFY(spy_fontattr_change2.isValid());
QSignalSpy cmd_fontattr2(
c->neovimObject()->vim_command_output(c->encode("GuiRenderFontAttr 1")),
&MsgpackRequest::finished);
QVERIFY(cmd_fontattr2.isValid());
QVERIFY2(SPYWAIT(cmd_fontattr2), "Waiting for GuiRenderFontAttr cmd");
QVERIFY2(SPYWAIT(spy_fontattr_change2), "Waiting for renderFontAttrChanged");
QCOMPARE(w->shell()->renderFontAttr(), true);
}
void TestShell::CloseEvent_data() noexcept
{
QTest::addColumn<int>("msgpack_status");
QTest::addColumn<int>("exit_status");
QTest::addColumn<QByteArray>("command");
QTest::newRow("Normal Exit: q") << 0 << 0 << QByteArray("q");
QTest::newRow("Exit with Code 1: cq") << 1 << 1 << QByteArray("cq");
QTest::newRow("Exit with Code 2: 2cq") << 2 << 2 << QByteArray("2cq");
QTest::newRow("Exit with Code 255: 255cq") << 255 << 255 << QByteArray("255cq");
// Some exit-status scenarios are platform dependent.
// Ex) Overflow on UNIX-like operating systems.
AddPlatformSpecificExitCodeCases();
}
void TestShell::CloseEvent() noexcept
{
auto w = CreateMainWindowWithRuntime();
auto c = w->shell()->nvim();
QFETCH(int, msgpack_status);
QFETCH(int, exit_status);
QFETCH(QByteArray, command);
// GUI shim Close event
QSignalSpy onClose(w->shell(), &Shell::neovimGuiCloseRequest);
QVERIFY(onClose.isValid());
QSignalSpy onWindowClosing(w.get(), &MainWindow::closing);
QVERIFY(onWindowClosing.isValid());
c->api0()->vim_command(c->encode(command));
QVERIFY(SPYWAIT(onClose));
QCOMPARE(onClose.takeFirst().at(0).toInt(), msgpack_status);
QVERIFY(SPYWAIT(onWindowClosing));
QCOMPARE(onWindowClosing.takeFirst().at(0).toInt(), msgpack_status);
// and finally a call to nvim-qt
QProcess p;
p.setProgram(NVIM_QT_BINARY);
QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
env.insert("NVIM_QT_RUNTIME_PATH", GetRuntimeAbsolutePath());
p.setProcessEnvironment(env);
p.setArguments(BinaryAndArgumentsNoForkWithCommand(command));
p.start();
p.waitForFinished(-1);
QCOMPARE(p.exitStatus(), QProcess::NormalExit);
int actual_exit_status{ p.exitCode() };
QCOMPARE(actual_exit_status, exit_status);
}
void TestShell::GetClipboard_data() noexcept
{
// * or +
QTest::addColumn<char>("reg");
// data set in the register when starting test, this is set
// externaly (i.e. without going through the provider)
QTest::addColumn<QByteArray>("register_data");
QTest::newRow("empty *") << '*' << QByteArray();
QTest::newRow("set *") << '*' << QByteArray("something");
QTest::newRow("empty +") << '+' << QByteArray();
QTest::newRow("set +") << '+' << QByteArray("something");
QTest::newRow("paste *") << '*' << QByteArray("something");
QTest::newRow("paste +") << '+' << QByteArray("something");
}
void TestShell::GetClipboard() noexcept
{
auto w = CreateMainWindowWithRuntime();
NeovimConnector* c = w->shell()->nvim();
QFETCH(char, reg);
QFETCH(QByteArray, register_data);
QObject::connect(c->neovimObject(), &NeovimApi1::err_vim_command_output, SignalPrintError);
// provided by the GUI shim
c->api0()->vim_command(c->encode("call GuiClipboard()"));
QGuiApplication::clipboard()->setText(register_data, GetClipboardMode(reg));
QString getreg_cmd = QStringLiteral("getreg('%1')").arg(reg);
QSignalSpy cmd_clip(c->api1()->nvim_eval(c->encode(getreg_cmd)), &MsgpackRequest::finished);
QVERIFY(cmd_clip.isValid());
QVERIFY(SPYWAIT(cmd_clip));
QCOMPARE(cmd_clip.takeFirst().at(2), QVariant(register_data));
}
void TestShell::SetClipboard_data() noexcept
{
// * or +
QTest::addColumn<char>("reg");
// data set in the register when starting test, this is set
// externaly (i.e. without going through the provider)
QTest::addColumn<QByteArray>("register_data");
QTest::newRow("empty *") << '*' << QByteArray();
QTest::newRow("set *") << '*' << QByteArray("something");
QTest::newRow("empty +") << '+' << QByteArray();
QTest::newRow("set +") << '+' << QByteArray("something");
QTest::newRow("paste *") << '*' << QByteArray("something");
QTest::newRow("paste +") << '+' << QByteArray("something");
}
void TestShell::SetClipboard() noexcept
{
auto w = CreateMainWindowWithRuntime();
NeovimConnector* c = w->shell()->nvim();
QFETCH(char, reg);
QFETCH(QByteArray, register_data);
QObject::connect(c->neovimObject(), &NeovimApi1::err_vim_command_output, SignalPrintError);
// provided by the GUI shim
c->api0()->vim_command(c->encode("call GuiClipboard()"));
QString setreg_cmd =
QStringLiteral("setreg('%1', '%2')\n").arg(reg).arg(QString::fromUtf8(register_data));
c->neovimObject()->vim_command(c->encode(setreg_cmd));
QSignalSpy spy_sync(c->neovimObject()->vim_feedkeys("", "", false), &MsgpackRequest::finished);
SPYWAIT(spy_sync);
QVERIFY(spy_sync.isValid());
QVERIFY(SPYWAIT(spy_sync));
QGuiApplication::clipboard()->setText(register_data, GetClipboardMode(reg));
}
void TestShell::checkStartVars(NeovimQt::NeovimConnector* conn) noexcept
{
auto* nvim = conn->api1();
connect(nvim, &NeovimQt::NeovimApi1::err_vim_get_var, SignalPrintError);
const QStringList vars{ "GuiWindowId", "GuiWindowMaximized", "GuiWindowFullScreen", "GuiFont", "GuiWindowFrameless" };
for (const auto& var : vars) {
QSignalSpy onVar(nvim, SIGNAL(on_vim_get_var(QVariant)));
QVERIFY(onVar.isValid());
nvim->vim_get_var(conn->encode(var));
QVERIFY(SPYWAIT(onVar));
}
// v:windowid
QSignalSpy onVarWindowId(nvim, SIGNAL(on_vim_get_vvar(QVariant)));
QVERIFY(onVarWindowId.isValid());
nvim->vim_get_vvar(conn->encode("windowid"));
QVERIFY(SPYWAIT(onVarWindowId));
}
void TestShell::grabShellScreenshot(Shell& s, const QString& filename) noexcept
{
s.repaint();
QPixmap p{ s.grab() };
p.save(filename);
}
} // Namespace NeovimQt
QTEST_MAIN(NeovimQt::TestShell)
#include "tst_shell.moc"
|