267 lines
10 KiB
C++
267 lines
10 KiB
C++
#include "../../testhelper/helper.h"
|
|
#include "../../testhelper/syncthingtestinstance.h"
|
|
|
|
#include <c++utilities/io/misc.h>
|
|
#include <c++utilities/tests/testutils.h>
|
|
|
|
#include <cppunit/TestFixture.h>
|
|
|
|
#include <QJsonDocument>
|
|
#include <QJsonObject>
|
|
#include <QJsonValue>
|
|
|
|
#include <filesystem>
|
|
#include <regex>
|
|
|
|
#ifdef stdout
|
|
#undef stdout
|
|
#endif
|
|
#ifdef stderr
|
|
#undef stderr
|
|
#endif
|
|
|
|
using namespace std;
|
|
using namespace Data;
|
|
using namespace CppUtilities;
|
|
using namespace CppUtilities::Literals;
|
|
|
|
using namespace CPPUNIT_NS;
|
|
|
|
/*!
|
|
* \brief The ApplicationTests class tests the overall CLI application.
|
|
*/
|
|
class ApplicationTests : public TestFixture, private SyncthingTestInstance {
|
|
CPPUNIT_TEST_SUITE(ApplicationTests);
|
|
#if defined(PLATFORM_UNIX) || defined(CPP_UTILITIES_HAS_EXEC_APP)
|
|
CPPUNIT_TEST(test);
|
|
#endif
|
|
CPPUNIT_TEST_SUITE_END();
|
|
|
|
public:
|
|
ApplicationTests();
|
|
|
|
void test();
|
|
|
|
void setUp() override;
|
|
void tearDown() override;
|
|
|
|
private:
|
|
DateTime m_startTime;
|
|
std::error_code m_ecCwd;
|
|
std::filesystem::path m_initialCwd;
|
|
std::filesystem::path m_tempPath;
|
|
};
|
|
|
|
CPPUNIT_TEST_SUITE_REGISTRATION(ApplicationTests);
|
|
|
|
ApplicationTests::ApplicationTests()
|
|
{
|
|
}
|
|
|
|
/*!
|
|
* \brief Ensures Syncthing dirs are empty and starts Syncthing.
|
|
*/
|
|
void ApplicationTests::setUp()
|
|
{
|
|
auto ec = std::error_code();
|
|
std::filesystem::remove_all((m_tempPath = std::filesystem::temp_directory_path()) / "some/path/1", ec);
|
|
if (ec && ec != std::errc::no_such_file_or_directory) {
|
|
CPPUNIT_FAIL(argsToString("Unable to clean-up temporary directory \"", m_tempPath.string(), "/some/path/1\": ", ec.message()));
|
|
}
|
|
|
|
SyncthingTestInstance::start();
|
|
m_initialCwd = std::filesystem::current_path(m_ecCwd);
|
|
m_startTime = DateTime::gmtNow();
|
|
}
|
|
|
|
/*!
|
|
* \brief Terminates Syncthing and prints stdout/stderr from Syncthing.
|
|
*/
|
|
void ApplicationTests::tearDown()
|
|
{
|
|
// restore initial cwd
|
|
if (!m_initialCwd.empty() && !m_ecCwd) {
|
|
std::filesystem::current_path(m_initialCwd);
|
|
}
|
|
SyncthingTestInstance::stop();
|
|
}
|
|
|
|
#if defined(PLATFORM_UNIX) || defined(CPP_UTILITIES_HAS_EXEC_APP)
|
|
/*!
|
|
* \brief Tests the overall CLI application.
|
|
* \remarks Tests for rescan are currently disabled for release mode because they sometimes fail.
|
|
*/
|
|
void ApplicationTests::test()
|
|
{
|
|
// prepare executing syncthingctl
|
|
string stdout, stderr;
|
|
const auto apiKey(this->apiKey().toLocal8Bit());
|
|
const auto url(argsToString("http://localhost:", syncthingPort().toInt()));
|
|
|
|
// disable colorful output
|
|
qputenv("ENABLE_ESCAPE_CODES", "0");
|
|
|
|
// load expected status
|
|
const auto expectedStatusData = [] {
|
|
auto data = readFile(testFilePath("expected-status.txt"), 4000);
|
|
findAndReplace(data, "/tmp/", tempDirectory());
|
|
return data;
|
|
}();
|
|
const auto expectedStatusLines = splitString<vector<string>>(expectedStatusData, "\n");
|
|
const auto expectedStatusPatterns = [&] {
|
|
auto regex = std::vector<std::regex>();
|
|
regex.reserve(expectedStatusLines.size());
|
|
for (const auto &line : expectedStatusLines) {
|
|
regex.emplace_back(line);
|
|
}
|
|
CPPUNIT_ASSERT(!regex.empty());
|
|
return regex;
|
|
}();
|
|
|
|
// wait till Syncthing GUI becomes available
|
|
{
|
|
cerr << "\nWaiting till Syncthing GUI becomes available ...\n";
|
|
QByteArray syncthingOutput;
|
|
constexpr auto syncthingCheckInterval = TimeSpan::fromMilliseconds(200.0);
|
|
const auto maxSyncthingStartupTime = TimeSpan::fromSeconds(15.0 * max(timeoutFactor, 5.0));
|
|
auto remainingTimeForSyncthingToComeUp = maxSyncthingStartupTime;
|
|
do {
|
|
// wait for output
|
|
if (!syncthingProcess().bytesAvailable()) {
|
|
// consider test failed if Syncthing takes too long to come up (or we fail to connect)
|
|
if ((remainingTimeForSyncthingToComeUp -= syncthingCheckInterval).isNegative()) {
|
|
CPPUNIT_FAIL(
|
|
argsToString("unable to connect to Syncthing within ", maxSyncthingStartupTime.toString(TimeSpanOutputFormat::WithMeasures)));
|
|
}
|
|
syncthingProcess().waitForReadyRead(static_cast<int>(syncthingCheckInterval.totalMilliseconds()));
|
|
}
|
|
const auto newOutput = syncthingProcess().readAll();
|
|
clog.write(newOutput.data(), newOutput.size());
|
|
syncthingOutput.append(newOutput);
|
|
} while (!syncthingOutput.contains("Access the GUI via the following URL"));
|
|
|
|
setInterleavedOutputEnabledFromEnv();
|
|
cout.flush();
|
|
}
|
|
|
|
// test status for all dirs and devs
|
|
const char *const statusArgs[] = { "syncthingctl", "status", "--api-key", apiKey.data(), "--url", url.data(), "--no-color", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(statusArgs);
|
|
cout << stderr;
|
|
cout << stdout;
|
|
const auto statusLines(splitString(stdout, "\n"));
|
|
auto currentStatusLine = statusLines.cbegin();
|
|
auto currentPattern = 0_st;
|
|
for (const auto &expectedPattern : expectedStatusPatterns) {
|
|
bool patternFound = false;
|
|
while (currentStatusLine != statusLines.cend()) {
|
|
patternFound = regex_search(*currentStatusLine, expectedPattern);
|
|
++currentStatusLine;
|
|
if (patternFound) {
|
|
break;
|
|
}
|
|
}
|
|
if (!patternFound) {
|
|
CPPUNIT_FAIL(argsToString("Line ", expectedStatusLines[currentPattern], " could not be found in output."));
|
|
}
|
|
++currentPattern;
|
|
}
|
|
|
|
// test log
|
|
const char *const logArgs[] = { "syncthingctl", "log", "--api-key", apiKey.data(), "--url", url.data(), nullptr };
|
|
TESTUTILS_ASSERT_EXEC(logArgs);
|
|
cout << stdout;
|
|
CPPUNIT_ASSERT(stdout.find("My ID") != string::npos || stdout.find("My name") != string::npos);
|
|
CPPUNIT_ASSERT(stdout.find("Startup complete") != string::npos);
|
|
CPPUNIT_ASSERT(stdout.find("Access the GUI via the following URL") != string::npos);
|
|
|
|
// use environment variables to specify API-key and URL
|
|
qputenv("SYNCTHING_CTL_API_KEY", apiKey);
|
|
#if QT_VERSION >= QT_VERSION_CHECK(6, 5, 0)
|
|
qputenv("SYNCTHING_CTL_URL", url);
|
|
#else
|
|
qputenv("SYNCTHING_CTL_URL", QByteArray(url.data(), static_cast<int>(url.size())));
|
|
#endif
|
|
|
|
// test resume, verify via status for dirs only
|
|
const char *const resumeArgs[] = { "syncthingctl", "resume", "--dir", "test2", nullptr };
|
|
const char *const statusDirsOnlyArgs[] = { "syncthingctl", "status", "--all-dirs", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(resumeArgs);
|
|
TESTUTILS_ASSERT_EXEC(statusDirsOnlyArgs);
|
|
CPPUNIT_ASSERT(stdout.find(" - Test dir 2") != string::npos);
|
|
CPPUNIT_ASSERT(stdout.find("paused") == string::npos);
|
|
|
|
// test pause, verify via status on specific dir
|
|
const char *const pauseArgs[] = { "syncthingctl", "pause", "--dir", "test2", nullptr };
|
|
const char *const statusTest2Args[] = { "syncthingctl", "status", "--dir", "test2", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(pauseArgs);
|
|
cout << stdout;
|
|
TESTUTILS_ASSERT_EXEC(statusTest2Args);
|
|
cout << stdout;
|
|
CPPUNIT_ASSERT(stdout.find(" - test1") == string::npos);
|
|
CPPUNIT_ASSERT(stdout.find(" - Test dir 2") != string::npos);
|
|
CPPUNIT_ASSERT(stdout.find("paused") != string::npos);
|
|
|
|
// test cat
|
|
const char *const catArgs[] = { "syncthingctl", "cat", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(catArgs);
|
|
cout << stdout;
|
|
QJsonParseError error;
|
|
const auto doc(QJsonDocument::fromJson(QByteArray(stdout.data(), static_cast<QByteArray::size_type>(stdout.size())), &error));
|
|
CPPUNIT_ASSERT_EQUAL(QJsonParseError::NoError, error.error);
|
|
const auto object(doc.object());
|
|
CPPUNIT_ASSERT(object.value(QLatin1String("options")).isObject());
|
|
CPPUNIT_ASSERT(object.value(QLatin1String("devices")).isArray());
|
|
CPPUNIT_ASSERT(object.value(QLatin1String("folders")).isArray());
|
|
|
|
// test edit
|
|
const char *const statusTest1Args[] = { "syncthingctl", "status", "--dir", "test1", nullptr };
|
|
#if defined(SYNCTHINGCTL_USE_JSENGINE) || defined(SYNCTHINGCTL_USE_SCRIPT)
|
|
const char *const editArgs[] = { "syncthingctl", "edit", "--js-lines", "assignIfPresent(findFolder('test1'), 'rescanIntervalS', 0);", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(editArgs);
|
|
cout << stdout;
|
|
TESTUTILS_ASSERT_EXEC(statusTest1Args);
|
|
cout << stdout;
|
|
CPPUNIT_ASSERT(stdout.find(" - test1") != string::npos);
|
|
CPPUNIT_ASSERT(stdout.find(" - Test dir 2") == string::npos);
|
|
CPPUNIT_ASSERT(stdout.find("Rescan interval file system watcher and periodic rescan disabled") != string::npos);
|
|
#endif
|
|
|
|
// test rescan: create new file, trigger rescan, check status
|
|
CPPUNIT_ASSERT(std::ofstream(m_tempPath / "some/path/1/new-file.txt") << "foo");
|
|
const char *const rescanArgs[] = { "syncthingctl", "rescan", "test1", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(rescanArgs);
|
|
cout << stdout;
|
|
TESTUTILS_ASSERT_EXEC(statusTest1Args);
|
|
cout << stdout;
|
|
CPPUNIT_ASSERT(stdout.find(" - test1") != string::npos);
|
|
CPPUNIT_ASSERT(stdout.find("Local 1 file(s), 0 dir(s), 3 bytes") != string::npos);
|
|
|
|
// test pwd
|
|
// -> create and enter new dir, also create a 2nd file in it
|
|
std::filesystem::current_path(m_tempPath / "some/path/1");
|
|
std::filesystem::create_directory("newdir");
|
|
std::filesystem::current_path("newdir");
|
|
CPPUNIT_ASSERT(ofstream("yet-another-file.txt") << "bar");
|
|
// -> change LLVM_PROFILE_FILE to prevent default.profraw file being created in the new directory
|
|
const char *const llvmProfileFile(getenv("LLVM_PROFILE_FILE"));
|
|
qputenv("LLVM_PROFILE_FILE", "/tmp/syncthingctl-%p.profraw");
|
|
// -> do actual test
|
|
const char *const pwdRescanArgs[] = { "syncthingctl", "pwd", "rescan", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(pwdRescanArgs);
|
|
cout << stdout;
|
|
// -> restore LLVM_PROFILE_FILE
|
|
if (llvmProfileFile) {
|
|
qputenv("LLVM_PROFILE_FILE", llvmProfileFile);
|
|
} else {
|
|
qunsetenv("LLVM_PROFILE_FILE");
|
|
}
|
|
// -> verify result
|
|
const char *const pwdStatusArgs[] = { "syncthingctl", "pwd", "status", nullptr };
|
|
TESTUTILS_ASSERT_EXEC(pwdStatusArgs);
|
|
cout << stdout;
|
|
CPPUNIT_ASSERT(stdout.find(" - test1") != string::npos);
|
|
CPPUNIT_ASSERT(stdout.find("Local 2 file(s), 1 dir(s)") != string::npos);
|
|
}
|
|
#endif
|