/* -*- 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 #include #include #include #include #include #include #include #include #include #include #include #include using Poco::StringTokenizer; /// Tests the HTTP WebSocket API of loolwsd. The server has to be started manually before running this test. class HTTPWSTest : public CPPUNIT_NS::TestFixture { const Poco::URI _uri; Poco::Net::HTTPClientSession _session; Poco::Net::HTTPRequest _request; Poco::Net::HTTPResponse _response; CPPUNIT_TEST_SUITE(HTTPWSTest); CPPUNIT_TEST(testPaste); CPPUNIT_TEST(testLargePaste); CPPUNIT_TEST(testRenderingOptions); CPPUNIT_TEST(testPasswordProtectedDocument); CPPUNIT_TEST_SUITE_END(); void testPaste(); void testLargePaste(); void testRenderingOptions(); void testPasswordProtectedDocument(); static void sendTextFrame(Poco::Net::WebSocket& socket, const std::string& string); static bool isDocumentLoaded(Poco::Net::WebSocket& socket); public: HTTPWSTest() : _uri("http://127.0.0.1:" + std::to_string(ClientPortNumber)), _session(_uri.getHost(), _uri.getPort()), _request(Poco::Net::HTTPRequest::HTTP_GET, "/ws") { } void setUp() { } void tearDown() { } }; void HTTPWSTest::testPaste() { try { Poco::Net::WebSocket socket(_session, _request, _response); // Load a document and make it empty. const std::string documentPath = TDOC "/hello.odt"; const std::string documentURL = "file://" + Poco::Path(documentPath).makeAbsolute().toString(); sendTextFrame(socket, "load url=" + documentURL); sendTextFrame(socket, "status"); CPPUNIT_ASSERT_MESSAGE("cannot load the document " + documentURL, isDocumentLoaded(socket)); sendTextFrame(socket, "uno .uno:SelectAll"); sendTextFrame(socket, "uno .uno:Delete"); // Paste some text into it. sendTextFrame(socket, "paste mimetype=text/plain;charset=utf-8\naaa bbb ccc"); // Check if the document contains the pasted text. sendTextFrame(socket, "uno .uno:SelectAll"); sendTextFrame(socket, "gettextselection mimetype=text/plain;charset=utf-8"); std::string selection; int flags; int n; do { char buffer[READ_BUFFER_SIZE]; n = socket.receiveFrame(buffer, sizeof(buffer), flags); if (n > 0) { const std::string line = LOOLProtocol::getFirstLine(buffer, n); const std::string prefix = "textselectioncontent: "; if (line.find(prefix) == 0) { selection = line.substr(prefix.length()); break; } } } while (n > 0 && (flags & Poco::Net::WebSocket::FRAME_OP_BITMASK) != Poco::Net::WebSocket::FRAME_OP_CLOSE); sendTextFrame(socket, "disconnect"); socket.shutdown(); CPPUNIT_ASSERT_EQUAL(std::string("aaa bbb ccc"), selection); } catch (const Poco::Exception& exc) { CPPUNIT_ASSERT_MESSAGE(exc.displayText(), false); } } void HTTPWSTest::testLargePaste() { try { Poco::Net::WebSocket socket(_session, _request, _response); // Load a document and make it empty. std::string documentPath = TDOC "/hello.odt"; std::string documentURL = "file://" + Poco::Path(documentPath).makeAbsolute().toString(); sendTextFrame(socket, "load url=" + documentURL); sendTextFrame(socket, "status"); CPPUNIT_ASSERT_MESSAGE("cannot load the document " + documentURL, isDocumentLoaded(socket)); sendTextFrame(socket, "uno .uno:SelectAll"); sendTextFrame(socket, "uno .uno:Delete"); // Paste some text into it. std::ifstream documentStream(documentPath); std::string documentContents((std::istreambuf_iterator(documentStream)), std::istreambuf_iterator()); sendTextFrame(socket, "paste mimetype=text/html\n" + documentContents); // Check if the server is still alive. // This resulted first in a hang, as respose for the message never arrived, then a bit later in a Poco::TimeoutException. sendTextFrame(socket, "gettextselection mimetype=text/plain;charset=utf-8"); std::string selection; int flags; int n; do { char buffer[READ_BUFFER_SIZE]; n = socket.receiveFrame(buffer, sizeof(buffer), flags); if (n > 0) { std::string line = LOOLProtocol::getFirstLine(buffer, n); std::string prefix = "textselectioncontent: "; if (line.find(prefix) == 0) break; } } while (n > 0 && (flags & Poco::Net::WebSocket::FRAME_OP_BITMASK) != Poco::Net::WebSocket::FRAME_OP_CLOSE); sendTextFrame(socket, "disconnect"); socket.shutdown(); } catch (const Poco::Exception& exc) { CPPUNIT_ASSERT_MESSAGE(exc.displayText(), false); } } void HTTPWSTest::testRenderingOptions() { try { Poco::Net::WebSocket socket(_session, _request, _response); // Load a document and get its size. const std::string documentPath = TDOC "/hide-whitespace.odt"; const std::string documentURL = "file://" + Poco::Path(documentPath).makeAbsolute().toString(); const std::string options = "{\"rendering\":{\".uno:HideWhitespace\":{\"type\":\"boolean\",\"value\":\"true\"}}}"; sendTextFrame(socket, "load url=" + documentURL + " options=" + options); sendTextFrame(socket, "status"); std::string status; int flags; int n; do { char buffer[READ_BUFFER_SIZE]; n = socket.receiveFrame(buffer, sizeof(buffer), flags); if (n > 0) { std::string line = LOOLProtocol::getFirstLine(buffer, n); std::string prefix = "status: "; if (line.find(prefix) == 0) { status = line.substr(prefix.length()); break; } } } while (n > 0 && (flags & Poco::Net::WebSocket::FRAME_OP_BITMASK) != Poco::Net::WebSocket::FRAME_OP_CLOSE); sendTextFrame(socket, "disconnect"); socket.shutdown(); // Expected format is something like 'type=text parts=2 current=0 width=12808 height=1142'. Poco::StringTokenizer tokens(status, " ", Poco::StringTokenizer::TOK_IGNORE_EMPTY | Poco::StringTokenizer::TOK_TRIM); CPPUNIT_ASSERT_EQUAL(static_cast(5), tokens.count()); const std::string token = tokens[4]; const std::string prefix = "height="; CPPUNIT_ASSERT_EQUAL(static_cast(0), token.find(prefix)); const int height = std::stoi(token.substr(prefix.size())); // HideWhitespace was ignored, this was 32532, should be around 16706. CPPUNIT_ASSERT(height < 20000); } catch (const Poco::Exception& exc) { CPPUNIT_ASSERT_MESSAGE(exc.displayText(), false); } } void HTTPWSTest::testPasswordProtectedDocument() { try { Poco::Net::WebSocket socket(_session, _request, _response); // Load a password protected document const std::string documentPath = TDOC "/password-protected.ods"; const std::string documentURL = "file://" + Poco::Path(documentPath).makeAbsolute().toString(); // Send a load request without password first sendTextFrame(socket, "load url=" + documentURL); int flags; int n; int counter = 0; do { char buffer[READ_BUFFER_SIZE]; n = socket.receiveFrame(buffer, sizeof(buffer), flags); if (n > 0) { std::string line = LOOLProtocol::getFirstLine(buffer, n); StringTokenizer tokens(line, " ", StringTokenizer::TOK_IGNORE_EMPTY | StringTokenizer::TOK_TRIM); std::string errorCommand; std::string errorKind; if (counter == 0 && tokens[0] == "error:" && LOOLProtocol::getTokenString(tokens[1], "cmd", errorCommand) && LOOLProtocol::getTokenString(tokens[2], "kind", errorKind) ) { CPPUNIT_ASSERT_EQUAL(std::string("load"), errorCommand); // TODO: Do a test for document requiring password to edit CPPUNIT_ASSERT_EQUAL(std::string("passwordrequired:to-view"), errorKind); // Send another load request with incorrect password sendTextFrame(socket, "load url=" + documentURL + " password=2"); counter++; } else if (counter == 1 && tokens[0] == "error:" && LOOLProtocol::getTokenString(tokens[1], "cmd", errorCommand) && LOOLProtocol::getTokenString(tokens[2], "kind", errorKind) ) { CPPUNIT_ASSERT_EQUAL(std::string("load"), errorCommand); CPPUNIT_ASSERT_EQUAL(std::string("wrongpassword"), errorKind); // Send another load request with correct password sendTextFrame(socket, "load url=" + documentURL + " password=1"); counter++; } else if (counter == 2 && tokens[0] == "status:") { // Entering correct password opened the document break; } } } while (n > 0 && (flags & Poco::Net::WebSocket::FRAME_OP_BITMASK) != Poco::Net::WebSocket::FRAME_OP_CLOSE); } catch (const Poco::Exception& exc) { CPPUNIT_ASSERT_MESSAGE(exc.displayText(), false); } } void HTTPWSTest::sendTextFrame(Poco::Net::WebSocket& socket, const std::string& string) { socket.sendFrame(string.data(), string.size()); } bool HTTPWSTest::isDocumentLoaded(Poco::Net::WebSocket& ws) { bool isLoaded = false; try { int flags; int bytes; int retries = 5; const Poco::Timespan waitTime(1000000); ws.setReceiveTimeout(0); do { char buffer[READ_BUFFER_SIZE]; if (ws.poll(waitTime, Poco::Net::Socket::SELECT_READ)) { bytes = ws.receiveFrame(buffer, sizeof(buffer), flags); if (bytes > 0) { const std::string line = LOOLProtocol::getFirstLine(buffer, bytes); const std::string prefixIndicator = "statusindicatorfinish:"; const std::string prefixStatus = "status:"; std::cout << line << std::endl; if (line.find(prefixIndicator) == 0 || line.find(prefixStatus) == 0) { isLoaded = true; break; } } retries = 5; } else { --retries; } } while (retries > 0 && (flags & Poco::Net::WebSocket::FRAME_OP_BITMASK) != Poco::Net::WebSocket::FRAME_OP_CLOSE); } catch (const Poco::Net::WebSocketException& exc) { std::cout << exc.message(); } return isLoaded; } CPPUNIT_TEST_SUITE_REGISTRATION(HTTPWSTest); /* vim:set shiftwidth=4 softtabstop=4 expandtab: */