libreoffice-online/test/UnitWOPI.cpp
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

136 lines
4.2 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/.
*/
#include <config.h>
#include <WopiTestServer.hpp>
#include <Log.hpp>
#include <Unit.hpp>
#include <UnitHTTP.hpp>
#include <helpers.hpp>
#include <Poco/Net/HTTPRequest.h>
#include <Poco/Util/LayeredConfiguration.h>
class UnitWOPI : public WopiTestServer
{
enum class Phase
{
LoadAndSave,
Modify,
SaveModified,
Polling
} _phase;
enum class SavingPhase
{
Unmodified,
Modified
} _savingPhase;
bool _finishedSaveUnmodified;
bool _finishedSaveModified;
public:
UnitWOPI() :
_phase(Phase::LoadAndSave),
_finishedSaveUnmodified(false),
_finishedSaveModified(false)
{
}
bool isAutosave() override
{
// we fake autosave when saving the modified document
return _savingPhase == SavingPhase::Modified;
}
void assertPutFileRequest(const Poco::Net::HTTPRequest& request) override
{
if (_savingPhase == SavingPhase::Unmodified)
{
// the document is not modified
LOK_ASSERT_EQUAL(std::string("false"), request.get("X-LOOL-WOPI-IsModifiedByUser"));
// but the save action is an explicit user's request
LOK_ASSERT_EQUAL(std::string("false"), request.get("X-LOOL-WOPI-IsAutosave"));
_finishedSaveUnmodified = true;
}
else if (_savingPhase == SavingPhase::Modified)
{
// the document is modified
LOK_ASSERT_EQUAL(std::string("true"), request.get("X-LOOL-WOPI-IsModifiedByUser"));
// and this test fakes that it's an autosave
LOK_ASSERT_EQUAL(std::string("true"), request.get("X-LOOL-WOPI-IsAutosave"));
// Check that we get the extended data.
LOK_ASSERT_EQUAL(std::string("CustomFlag=Custom Value;AnotherFlag=AnotherValue"),
request.get("X-LOOL-WOPI-ExtendedData"));
_finishedSaveModified = true;
}
if (_finishedSaveUnmodified && _finishedSaveModified)
exitTest(TestResult::Ok);
}
void invokeTest() override
{
constexpr char testName[] = "UnitWOPI";
switch (_phase)
{
case Phase::LoadAndSave:
{
initWebsocket("/wopi/files/0?access_token=anything");
helpers::sendTextFrame(*getWs()->getLOOLWebSocket(), "load url=" + getWopiSrc(), testName);
helpers::sendTextFrame(*getWs()->getLOOLWebSocket(), "save dontTerminateEdit=1 dontSaveIfUnmodified=0", testName);
_phase = Phase::Modify;
_savingPhase = SavingPhase::Unmodified;
SocketPoll::wakeupWorld();
break;
}
case Phase::Modify:
{
helpers::sendTextFrame(*getWs()->getLOOLWebSocket(), "key type=input char=97 key=0", testName);
helpers::sendTextFrame(*getWs()->getLOOLWebSocket(), "key type=up char=0 key=512", testName);
_phase = Phase::SaveModified;
break;
}
case Phase::SaveModified:
{
helpers::sendTextFrame(*getWs()->getLOOLWebSocket(),
"save dontTerminateEdit=0 dontSaveIfUnmodified=0 "
"extendedData=CustomFlag%3DCustom%20Value%3BAnotherFlag%"
"3DAnotherValue",
testName);
_phase = Phase::Polling;
_savingPhase = SavingPhase::Modified;
break;
}
case Phase::Polling:
{
// just wait for the results
break;
}
}
}
};
UnitBase *unit_create_wsd(void)
{
return new UnitWOPI();
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */