jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-11-11 04:23:29 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[Server] Publish the dev server's port through a file

Browse source 
The smoke test parsed the listening port out of the dev server's stdout,
but the server announces it from the main thread while the logger thread
writes to the same stream. A log line can land inside the announcement —
Arch CI caught it — leaving the digits on the next line, so the test read
nothing and failed.

Add --port-file, written through QSaveFile once the server listens, and
read the port from there instead of from the log. The file is either
absent or complete, so logging cannot corrupt the handshake.
This commit is contained in:
Lukas Brübach 2026-11-10 11:54:21 +01:00
parent 16e6e8e3ae
commit 5f6b8b02a5
2 changed files with 56 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

42
tests/server_dev_smoke_test.cpp
View file

@ -17,6 +17,7 @@
#include <QCoreApplication>
#include <QElapsedTimer>
#include <QEventLoop>
#include <QFile>
#include <QList>
#include <QProcess>
#include <QProcessEnvironment>
@ -92,6 +93,7 @@ protected:
void SetUp() override
{
ASSERT_TRUE(tempDir.isValid());
portFilePath = tempDir.filePath(QStringLiteral("listening-port"));
// servatrice-dev writes its throwaway settings under QDir::tempPath(); pointing that at
// a directory the test owns means a terminated server cannot leave an ini behind.
@ -102,9 +104,10 @@ protected:
process.setProcessEnvironment(environment);
process.setProcessChannelMode(QProcess::SeparateChannels);
process.start(QStringLiteral(SERVATRICE_DEV_BINARY),
{QStringLiteral("--port"), QStringLiteral("0"), QStringLiteral("--seed"), QStringLiteral("42")});
{QStringLiteral("--port"), QStringLiteral("0"), QStringLiteral("--seed"), QStringLiteral("42"),
QStringLiteral("--port-file"), portFilePath});
ASSERT_TRUE(process.waitForStarted(kStartupTimeoutMs)) << process.errorString().toStdString();
ASSERT_TRUE(readListeningPort()) << "servatrice-dev did not announce a listening port.\nstdout:\n"
ASSERT_TRUE(readListeningPort()) << "servatrice-dev did not publish its listening port.\nstdout:\n"
<< stdoutText.toStdString() << "\nstderr:\n"
<< stderrText.toStdString();
@ -128,34 +131,32 @@ protected:
}
}
/// @brief Reads the child's output until it announces the ephemeral port it listens on.
/// @brief Waits for the child to publish the ephemeral port it listens on.
bool readListeningPort()
{
const QString prefix = QStringLiteral("servatrice-dev: listening on port ");
QElapsedTimer elapsed;
elapsed.start();
while (elapsed.elapsed() < kStartupTimeoutMs) {
if (!process.waitForReadyRead(100)) {
if (process.state() == QProcess::NotRunning) {
drainProcessOutput();
return false;
}
continue;
}
// The child logs heavily during startup; keep its pipes drained so it cannot block.
drainProcessOutput();
const int at = stdoutText.indexOf(prefix);
if (at < 0) {
continue;
QFile portFile(portFilePath);
if (portFile.open(QIODevice::ReadOnly)) {
bool ok = false;
const int port = QString::fromLatin1(portFile.readAll()).trimmed().toInt(&ok);
if (ok && port > 0) {
listeningPort = port;
return true;
}
}
const int end = stdoutText.indexOf(QLatin1Char('\n'), at);
if (end < 0) {
continue;
if (process.state() == QProcess::NotRunning) {
drainProcessOutput();
return false;
}
bool ok = false;
listeningPort = stdoutText.mid(at + prefix.size(), end - at - prefix.size()).trimmed().toInt(&ok);
return ok && listeningPort > 0;
QThread::msleep(20);
}
drainProcessOutput();
return false;
}
@ -228,6 +229,7 @@ protected:
QProcess process;
QTemporaryDir tempDir;
QString portFilePath;
StubNetworkSettingsProvider provider;
std::unique_ptr<RemoteClient> client;
int listeningPort = 0;