libreoffice-online/test/countloolkits.hpp
Ashod Nakashian 82560d9657 wsd: test assertion macros
Because the new-style tests are intrustive,
the exception that CppUnit throws on assertion
failures is caught and processed with the
application logic, which is far from ideal,
because it's very difficult to find the
cause of failure.

What we'd like is a way to control what happens
when an test assertion fails, such that we can
properly log/print the failure, and even break
in the debugger.

The new macros allow us to control the behavior
at compile-time and have added flexibility.
For now, they log an assertion failure before
invoking the CPPUNIT macro, and support a
compile-time directive to assert, which is
useful for breaking in the debugger.

Change-Id: If464ba246e3ec747f31496a4215cb73ef735dfaf
Reviewed-on: https://gerrit.libreoffice.org/c/online/+/87625
Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com>
Reviewed-by: Michael Meeks <michael.meeks@collabora.com>
2020-03-14 15:45:00 +01:00

116 lines
3.5 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDED_COUNTLOOLKITPROCESSES_HPP
#define INCLUDED_COUNTLOOLKITPROCESSES_HPP
#include <iostream>
#include <thread>
#include <cppunit/extensions/HelperMacros.h>
#include <Poco/DirectoryIterator.h>
#include <Poco/FileStream.h>
#include <Poco/StreamCopier.h>
#include <Common.hpp>
#include "test.hpp"
#include "helpers.hpp"
static int countLoolKitProcesses(const int expected)
{
const auto testname = "countLoolKitProcesses ";
TST_LOG_BEGIN("Waiting until loolkit processes are exactly " << expected << ". Loolkits: ");
// This does not need to depend on any constant from Common.hpp.
// The shorter the better (the quicker the test runs).
const int sleepMs = 50;
// This has to cause waiting for at least COMMAND_TIMEOUT_MS. Add one second for safety.
const size_t repeat = ((COMMAND_TIMEOUT_MS + 1000) / sleepMs);
int count = getLoolKitProcessCount();
for (size_t i = 0; i < repeat; ++i)
{
TST_LOG_APPEND(count << ' ');
if (count == expected)
{
break;
}
// Give polls in the lool processes time to time out etc
std::this_thread::sleep_for(std::chrono::milliseconds(sleepMs));
const int newCount = getLoolKitProcessCount();
if (count != newCount)
{
// Allow more time until the number settles.
i = 0;
count = newCount;
}
}
TST_LOG_END;
if (expected != count)
{
TST_LOG_BEGIN("Found " << count << " LoKit processes but was expecting " << expected << ": [");
for (int i : getKitPids())
{
TST_LOG_APPEND(i << ' ');
}
TST_LOG_APPEND(']');
TST_LOG_END;
}
std::vector<int> pids = getKitPids();
std::ostringstream oss;
oss << "Test kit pids are ";
for (auto i : pids)
oss << i << " ";
TST_LOG(oss.str());
return count;
}
// FIXME: we probably should make this extern
// and reuse it. As it stands now, it is per
// translation unit, which isn't desirable if
// (in the non-ideal event that) it's not 1,
// it will cause testNoExtraLoolKitsLeft to
// wait unnecessarily and fail.
static int InitialLoolKitCount = 1;
static std::chrono::steady_clock::time_point TestStartTime;
static void testCountHowManyLoolkits()
{
const char testname[] = "countHowManyLoolkits ";
TestStartTime = std::chrono::steady_clock::now();
InitialLoolKitCount = countLoolKitProcesses(InitialLoolKitCount);
TST_LOG("Initial loolkit count is " << InitialLoolKitCount);
LOK_ASSERT(InitialLoolKitCount > 0);
TestStartTime = std::chrono::steady_clock::now();
}
static void testNoExtraLoolKitsLeft()
{
const char testname[] = "noExtraLoolKitsLeft ";
const int countNow = countLoolKitProcesses(InitialLoolKitCount);
LOK_ASSERT_EQUAL(InitialLoolKitCount, countNow);
const auto duration = (std::chrono::steady_clock::now() - TestStartTime);
const std::chrono::milliseconds::rep durationMs = std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
TST_LOG(" (" << durationMs << " ms)");
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */