strepsirrhini/libreoffice-online
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
libreoffice-online/test/UnitCopyPaste.cpp
Ashod Nakashian 6e88701702 wsd: test: assert when failing copy-paste test 
The assertion will include much more info than
simply flagging for failure, which helps in
troubleshooting failures.

Change-Id: I6bd649e5334a90e9feaf0d72347790088f70c1b3
Signed-off-by: Ashod Nakashian <ashod.nakashian@collabora.co.uk>
2021-03-01 21:50:18 -05:00

325 lines
12 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* 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/.
*/
// Test various copy/paste pieces ...
#include "lokassert.hpp"
#include <config.h>
#include <Unit.hpp>
#include <UnitHTTP.hpp>
#include <helpers.hpp>
#include <wsd/LOOLWSD.hpp>
#include <common/Clipboard.hpp>
#include <wsd/ClientSession.hpp>
#include <Poco/Net/HTTPResponse.h>
#include <Poco/Net/HTTPServerRequest.h>
#include <Poco/Net/HTMLForm.h>
#include <Poco/Net/StringPartSource.h>
#include <Poco/Util/LayeredConfiguration.h>
#include <test.hpp>
using namespace Poco::Net;
// Inside the WSD process
class UnitCopyPaste : public UnitWSD
{
public:
UnitCopyPaste()
{
}
void configure(Poco::Util::LayeredConfiguration& config) override
{
UnitWSD::configure(config);
// force HTTPS - to test harder
config.setBool("ssl.enable", true);
}
std::string getRawClipboard(const std::string &clipURIstr)
{
Poco::URI clipURI(clipURIstr);
HTTPResponse response;
HTTPRequest request(HTTPRequest::HTTP_GET, clipURI.getPathAndQuery());
std::unique_ptr<HTTPClientSession> session(helpers::createSession(clipURI));
session->setTimeout(Poco::Timespan(10, 0)); // 10 seconds.
session->sendRequest(request);
std::istream& responseStream = session->receiveResponse(response);
return std::string(std::istreambuf_iterator<char>(responseStream), {});
}
std::shared_ptr<ClipboardData> getClipboard(const std::string &clipURIstr,
HTTPResponse::HTTPStatus expected)
{
LOG_TST("connect to " << clipURIstr);
Poco::URI clipURI(clipURIstr);
HTTPResponse response;
HTTPRequest request(HTTPRequest::HTTP_GET, clipURI.getPathAndQuery());
std::unique_ptr<HTTPClientSession> session(helpers::createSession(clipURI));
session->setTimeout(Poco::Timespan(10, 0)); // 10 seconds.
session->sendRequest(request);
LOG_TST("sent request.");
try {
std::istream& responseStream = session->receiveResponse(response);
LOG_TST("HTTP get request returned reason: " << response.getReason());
if (response.getStatus() != expected)
{
LOK_ASSERT_EQUAL_MESSAGE("clipboard status mismatches expected", expected,
response.getStatus());
exitTest(TestResult::Failed);
return std::shared_ptr<ClipboardData>();
}
LOK_ASSERT_EQUAL_MESSAGE("clipboard content-type mismatches expected",
std::string("application/octet-stream"),
response.getContentType());
auto clipboard = std::make_shared<ClipboardData>();
clipboard->read(responseStream);
clipboard->dumpState(std::cerr);
LOG_TST("got response");
return clipboard;
} catch (Poco::Exception &e) {
LOG_TST("Poco exception: " << e.message());
exitTest(TestResult::Failed);
return std::shared_ptr<ClipboardData>();
}
}
bool assertClipboard(const std::shared_ptr<ClipboardData> &clipboard,
const std::string &mimeType, const std::string &content)
{
bool failed = false;
std::string value;
// allow empty clipboards
if (clipboard && mimeType.empty() && content.empty())
return true;
if (!clipboard || !clipboard->findType(mimeType, value))
{
LOG_TST("Error: missing clipboard or missing clipboard mime type '" << mimeType
<< '\'');
LOK_ASSERT_FAIL("Missing clipboard mime type");
failed = true;
}
else if (value != content)
{
LOG_TST("Error: clipboard content mismatch " << value.length() << " vs. "
<< content.length());
sleep (1); // output settle.
Util::dumpHex(std::cerr, "\tclipboard:\n", "", value);
Util::dumpHex(std::cerr, "\tshould be:\n", "", content);
LOK_ASSERT_EQUAL_MESSAGE("Clipboard content mismatch", value.size(), content.size());
failed = true;
}
if (failed)
{
exitTest(TestResult::Failed);
return false;
}
return true;
}
bool fetchClipboardAssert(const std::string &clipURI,
const std::string &mimeType,
const std::string &content,
HTTPResponse::HTTPStatus expected = HTTPResponse::HTTP_OK)
{
std::shared_ptr<ClipboardData> clipboard;
try {
clipboard = getClipboard(clipURI, expected);
} catch (ParseError &err) {
LOG_TST("Error: parse error " << err.toString());
exitTest(TestResult::Failed);
return false;
} catch (...) {
LOG_TST("Error: unknown exception during read / parse");
exitTest(TestResult::Failed);
return false;
}
if (!assertClipboard(clipboard, mimeType, content))
return false;
return true;
}
bool setClipboard(const std::string &clipURIstr, const std::string &rawData,
HTTPResponse::HTTPStatus expected)
{
LOG_TST("connect to " << clipURIstr);
Poco::URI clipURI(clipURIstr);
std::unique_ptr<HTTPClientSession> session(helpers::createSession(clipURI));
Poco::URI clipURIPoco(clipURI);
HTTPRequest request(HTTPRequest::HTTP_POST, clipURIPoco.getPathAndQuery());
HTMLForm form;
form.setEncoding(HTMLForm::ENCODING_MULTIPART);
form.set("format", "txt");
form.addPart("data", new StringPartSource(rawData, "application/octet-stream", "clipboard"));
form.prepareSubmit(request);
form.write(session->sendRequest(request));
HTTPResponse response;
std::stringstream actualStream;
try {
session->receiveResponse(response);
} catch (NoMessageException &) {
LOG_TST("Error: No response from setting clipboard.");
exitTest(TestResult::Failed);
return false;
}
if (response.getStatus() != expected)
{
LOG_TST("Error: response for clipboard " << response.getStatus() << " != expected "
<< expected);
exitTest(TestResult::Failed);
return false;
}
return true;
}
std::string getSessionClipboardURI(size_t session)
{
std::shared_ptr<DocumentBroker> broker;
std::shared_ptr<ClientSession> clientSession;
std::vector<std::shared_ptr<DocumentBroker>> brokers = LOOLWSD::getBrokersTestOnly();
assert(brokers.size() > 0);
broker = brokers[0];
auto sessions = broker->getSessionsTestOnlyUnsafe();
assert(sessions.size() > 0 && session < sessions.size());
clientSession = sessions[session];
std::string tag = clientSession->getClipboardURI(false); // nominally thread unsafe
LOG_TST("Got tag '" << tag << "' for session " << session);
return tag;
}
std::string buildClipboardText(const std::string &text)
{
std::stringstream clipData;
clipData << "text/plain;charset=utf-8\n"
<< std::hex << text.length() << '\n'
<< text << '\n';
return clipData.str();
}
void invokeWSDTest() override
{
std::string testname = "copypaste";
try {
// Load a doc with the cursor saved at a top row.
std::string documentPath, documentURL;
helpers::getDocumentPathAndURL("empty.ods", documentPath, documentURL, testname);
std::shared_ptr<LOOLWebSocket> socket =
helpers::loadDocAndGetSocket(Poco::URI(helpers::getTestServerURI()), documentURL, testname);
std::string clipURI = getSessionClipboardURI(0);
LOG_TST("Fetch empty clipboard content");
if (!fetchClipboardAssert(clipURI, "", ""))
return;
// Check existing content
LOG_TST("Fetch pristine content");
helpers::sendTextFrame(socket, "uno .uno:SelectAll", testname);
helpers::sendTextFrame(socket, "uno .uno:Copy", testname);
std::string oneColumn = "2\n3\n5\n";
if (!fetchClipboardAssert(clipURI, "text/plain;charset=utf-8", oneColumn))
return;
LOG_TST("Open second connection");
std::shared_ptr<LOOLWebSocket> socket2 =
helpers::loadDocAndGetSocket(Poco::URI(helpers::getTestServerURI()), documentURL, testname);
std::string clipURI2 = getSessionClipboardURI(1);
LOG_TST("Check no clipboard content");
if (!fetchClipboardAssert(clipURI2, "", ""))
return;
LOG_TST("Inject content");
helpers::sendTextFrame(socket, "uno .uno:Deselect", testname);
std::string text = "This is some content?&*/\\!!";
helpers::sendTextFrame(socket, "paste mimetype=text/plain;charset=utf-8\n" + text, testname);
helpers::sendTextFrame(socket, "uno .uno:SelectAll", testname);
helpers::sendTextFrame(socket, "uno .uno:Copy", testname);
std::string existing = "2\t\n3\t\n5\t";
if (!fetchClipboardAssert(clipURI, "text/plain;charset=utf-8", existing + text + '\n'))
return;
LOG_TST("re-check no clipboard content");
if (!fetchClipboardAssert(clipURI2, "", ""))
return;
LOG_TST("Push new clipboard content");
std::string newcontent = "1234567890";
helpers::sendTextFrame(socket, "uno .uno:Deselect", testname);
if (!setClipboard(clipURI, buildClipboardText(newcontent), HTTPResponse::HTTP_OK))
return;
helpers::sendTextFrame(socket, "uno .uno:Paste", testname);
if (!fetchClipboardAssert(clipURI, "text/plain;charset=utf-8", newcontent))
return;
LOG_TST("Check the result.");
helpers::sendTextFrame(socket, "uno .uno:SelectAll", testname);
helpers::sendTextFrame(socket, "uno .uno:Copy", testname);
if (!fetchClipboardAssert(clipURI, "text/plain;charset=utf-8", existing + newcontent + '\n'))
return;
LOG_TST("Setup clipboards:");
if (!setClipboard(clipURI2, buildClipboardText("kippers"), HTTPResponse::HTTP_OK))
return;
if (!setClipboard(clipURI, buildClipboardText("herring"), HTTPResponse::HTTP_OK))
return;
LOG_TST("Fetch clipboards:");
if (!fetchClipboardAssert(clipURI2, "text/plain;charset=utf-8", "kippers"))
return;
if (!fetchClipboardAssert(clipURI, "text/plain;charset=utf-8", "herring"))
return;
LOG_TST("Close sockets:");
socket->shutdown();
socket2->shutdown();
sleep(1); // paranoia.
LOG_TST("Fetch clipboards after shutdown:");
if (!fetchClipboardAssert(clipURI2, "text/plain;charset=utf-8", "kippers"))
return;
if (!fetchClipboardAssert(clipURI, "text/plain;charset=utf-8", "herring"))
return;
LOG_TST("Clipboard tests succeeded");
exitTest(TestResult::Ok);
} catch (...) {
LOG_TST("Error: exception failure during tests");
exitTest(TestResult::Failed);
}
}
};
UnitBase *unit_create_wsd(void)
{
return new UnitCopyPaste();
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in a new issue View git blame Copy permalink