haraldwolff
/
collabora-online
mirror of https://github.com/CollaboraOnline/online.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
collabora-online/test/FileServeWhiteBoxTests.cpp

448 lines
21 KiB
C++
Raw Permalink Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* Copyright the Collabora Online contributors.
*
* SPDX-License-Identifier: MPL-2.0
*
* 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 <wsd/FileServer.hpp>
#include <common/FileUtil.hpp>
#include <test/lokassert.hpp>
#include <Poco/String.h>
#include <cppunit/TestAssert.h>
#include <cppunit/extensions/HelperMacros.h>
#include <cstddef>
#include <memory>
#include <unordered_map>
/// File-Serve White-Box unit-tests.
class FileServeTests : public CPPUNIT_NS::TestFixture
{
CPPUNIT_TEST_SUITE(FileServeTests);
CPPUNIT_TEST(testUIDefaults);
CPPUNIT_TEST(testCSSVars);
CPPUNIT_TEST(testPreProcessedFile);
CPPUNIT_TEST(testPreProcessedFileRoundtrip);
CPPUNIT_TEST(testPreProcessedFileSubstitution);
CPPUNIT_TEST_SUITE_END();
void testUIDefaults();
void testCSSVars();
void testPreProcessedFile();
void testPreProcessedFileRoundtrip();
void testPreProcessedFileSubstitution();
void preProcessedFileSubstitution(const std::string& testname,
std::unordered_map<std::string, std::string> variables);
};
void FileServeTests::testUIDefaults()
{
constexpr auto testname = __func__;
std::string uiMode;
std::string uiTheme;
std::string savedUIState;
LOK_ASSERT_EQUAL(
std::string("{\"uiMode\":\"classic\"}"),
FileServerRequestHandler::uiDefaultsToJSON("UIMode=classic;huh=bleh;", uiMode, uiTheme, savedUIState));
LOK_ASSERT_EQUAL(std::string("classic"), uiMode);
LOK_ASSERT_EQUAL(
std::string("{\"spreadsheet\":{\"ShowSidebar\":false},\"text\":{\"ShowRuler\":true}}"),
FileServerRequestHandler::uiDefaultsToJSON("TextRuler=true;SpreadsheetSidebar=false",
uiMode, uiTheme, savedUIState));
LOK_ASSERT_EQUAL(std::string(""), uiMode);
LOK_ASSERT_EQUAL(
std::string("{\"presentation\":{\"ShowStatusbar\":false},\"spreadsheet\":{\"ShowSidebar\":"
"false},\"text\":{\"ShowRuler\":true},\"uiMode\":\"notebookbar\"}"),
FileServerRequestHandler::uiDefaultsToJSON(
";;UIMode=notebookbar;;PresentationStatusbar=false;;TextRuler=true;;bah=ugh;;"
"SpreadsheetSidebar=false",
uiMode, uiTheme, savedUIState));
LOK_ASSERT_EQUAL(std::string("{\"drawing\":{\"ShowStatusbar\":true},\"presentation\":{"
"\"ShowStatusbar\":false},\"spreadsheet\":{\"ShowSidebar\":false},"
"\"text\":{\"ShowRuler\":true},\"uiMode\":\"notebookbar\"}"),
FileServerRequestHandler::uiDefaultsToJSON(
";;UIMode=notebookbar;;PresentationStatusbar=false;;TextRuler=true;;bah="
"ugh;;SpreadsheetSidebar=false;;DrawingStatusbar=true",
uiMode, uiTheme, savedUIState));
LOK_ASSERT_EQUAL(std::string("notebookbar"), uiMode);
}
void FileServeTests::testCSSVars()
{
constexpr auto testname = __func__;
LOK_ASSERT_EQUAL(
std::string("<style>:root {--co-somestyle-text:#123456;--co-somestyle-size:15px;}</style>"),
FileServerRequestHandler::cssVarsToStyle(
"--co-somestyle-text=#123456;--co-somestyle-size=15px;"));
LOK_ASSERT_EQUAL(
std::string("<style>:root {--co-somestyle-text:#123456;--co-somestyle-size:15px;}</style>"),
FileServerRequestHandler::cssVarsToStyle(
";;--co-somestyle-text=#123456;;--co-somestyle-size=15px;;;"));
LOK_ASSERT_EQUAL(
std::string("<style>:root {--co-somestyle-text:#123456;--co-somestyle-size:15px;}</style>"),
FileServerRequestHandler::cssVarsToStyle(
"--co-somestyle-text=#123456;;--co-somestyle-size=15px;--co-sometext#324;;"));
LOK_ASSERT_EQUAL(std::string("<style>:root {--co-somestyle-text:#123456;}</style>"),
FileServerRequestHandler::cssVarsToStyle(
"--co-somestyle-text=#123456;;--some-val=3453--some-other-val=4536;;"));
}
/// Tests file pre-processing through PreProcessedFile class.
void FileServeTests::testPreProcessedFile()
{
constexpr auto testname = __func__;
{
const std::string data = "Data %VAR% Data";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(3UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("Data "), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[1].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[2].first);
LOK_ASSERT_EQUAL(std::string(" Data"), ppf._segments[2].second);
}
{
const std::string data = "Data %VAR%";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(2UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("Data "), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[1].second);
}
{
const std::string data = "%VAR% Data";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(2UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string(" Data"), ppf._segments[1].second);
}
{
const std::string data = "%VAR%";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(1UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
}
{
const std::string data = "%VAR%Data1 %VAR% Data%VAR%";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(5UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("Data1 "), ppf._segments[1].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[2].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[2].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[3].first);
LOK_ASSERT_EQUAL(std::string(" Data"), ppf._segments[3].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[4].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[4].second);
}
{
const std::string data = "Data %VAR Data";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(1UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("Data %VAR Data"), ppf._segments[0].second);
}
{
const std::string data = "Data 5% Data 7%";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(1UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("Data 5% Data 7%"), ppf._segments[0].second);
}
{
const std::string data = "Data <!--%VAR%--> Data";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(3UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("Data "), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[1].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[2].first);
LOK_ASSERT_EQUAL(std::string(" Data"), ppf._segments[2].second);
}
{
const std::string data = "Data <!--%VAR%-->";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(2UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("Data "), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[1].second);
}
{
const std::string data = "<!--%VAR%--> Data";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(2UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string(" Data"), ppf._segments[1].second);
}
{
const std::string data = "<!--%VAR%-->";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(1UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
}
{
const std::string data = "<!--%VAR%-->Data1 <!--%VAR%--> Data2<!--%VAR%-->";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(5UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("Data1 "), ppf._segments[1].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[2].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[2].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[3].first);
LOK_ASSERT_EQUAL(std::string(" Data2"), ppf._segments[3].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[4].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[4].second);
}
{
const std::string data = "<!--%VARA% Data2 <!--%VARB%--> Data4<!--%VARC%-->";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(4UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("<!--%VARA% Data2 "), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("VARB"), ppf._segments[1].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[2].first);
LOK_ASSERT_EQUAL(std::string(" Data4"), ppf._segments[2].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[3].first);
LOK_ASSERT_EQUAL(std::string("VARC"), ppf._segments[3].second);
}
{
const std::string data = "<!--%VAR%-->Data1 <!--%VAR%--> Data2<!--%VAR%";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(4UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[0].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("Data1 "), ppf._segments[1].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::CommentedVariable, ppf._segments[2].first);
LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[2].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[3].first);
LOK_ASSERT_EQUAL(std::string(" Data2<!--%VAR%"), ppf._segments[3].second);
}
{
const std::string data = R"xxx(<!DOCTYPE html>
<!-- saved from url=(0054)http://leafletjs.com/examples/quick-start-example.html -->
<html %UI_RTL_SETTINGS% style="height:100%"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Online Editor</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0 minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
<script>
// FIXME: This is temporary and not what we actually eventually want.
// What we really want is not a separate HTML file (produced with M4 conditionals on the below
// ) for a "WASM app". What we want is that the same cool.html page adapts on demand to
// instead run locally using WASM, if the connection to the COOL server breaks. (And then
// re-connects to the COOL server when possible.)
window.welcomeUrl = '%WELCOME_URL%';
window.feedbackUrl = '%FEEDBACK_URL%';
window.buyProductUrl = '%BUYPRODUCT_URL%';
)xxx";
const PreProcessedFile ppf("filename", data);
LOK_ASSERT_EQUAL(ppf.filename(), std::string("filename"));
LOK_ASSERT_EQUAL(ppf.size(), data.size());
LOK_ASSERT_EQUAL(9UL, ppf._segments.size());
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[0].first);
// LOK_ASSERT_EQUAL(std::string("VAR"), ppf._segments[0].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[1].first);
LOK_ASSERT_EQUAL(std::string("UI_RTL_SETTINGS"), ppf._segments[1].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[2].first);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[3].first);
LOK_ASSERT_EQUAL(std::string("WELCOME_URL"), ppf._segments[3].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[4].first);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[5].first);
LOK_ASSERT_EQUAL(std::string("FEEDBACK_URL"), ppf._segments[5].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[6].first);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Variable, ppf._segments[7].first);
LOK_ASSERT_EQUAL(std::string("BUYPRODUCT_URL"), ppf._segments[7].second);
LOK_ASSERT_EQUAL(PreProcessedFile::SegmentType::Data, ppf._segments[8].first);
}
}
void FileServeTests::testPreProcessedFileRoundtrip()
{
constexpr auto testname = __func__;
const Poco::Path path(TDIST);
std::vector<std::string> files;
Poco::File(path).list(files);
for (const std::string& file : files)
{
std::unique_ptr<std::vector<char>> data =
FileUtil::readFile(Poco::Path(path, file).toString());
if (data)
{
const std::string orig(data->data(), data->size());
PreProcessedFile ppf(file, orig);
LOK_ASSERT_EQUAL(file, ppf.filename());
LOK_ASSERT_EQUAL(data->size(), ppf.size());
std::string recon = ppf.substitute({});
LOK_ASSERT_EQUAL(orig, recon);
}
}
}
void FileServeTests::preProcessedFileSubstitution(
const std::string& testname, std::unordered_map<std::string, std::string> variables)
{
const Poco::Path path(TDIST);
std::vector<std::string> files;
Poco::File(path).list(files);
for (const std::string& file : files)
{
std::unique_ptr<std::vector<char>> data =
FileUtil::readFile(Poco::Path(path, file).toString());
if (data)
{
std::string orig(data->data(), data->size());
PreProcessedFile ppf(file, orig);
LOK_ASSERT_EQUAL(file, ppf.filename());
LOK_ASSERT_EQUAL(data->size(), ppf.size());
const std::string recon = ppf.substitute(variables);
Poco::replaceInPlace(orig, std::string("%ACCESS_TOKEN%"), variables["ACCESS_TOKEN"]);
Poco::replaceInPlace(orig, std::string("%ACCESS_TOKEN_TTL%"),
variables["ACCESS_TOKEN_TTL"]);
Poco::replaceInPlace(orig, std::string("%ACCESS_HEADER%"), variables["ACCESS_HEADER"]);
Poco::replaceInPlace(orig, std::string("%UI_DEFAULTS%"), variables["UI_DEFAULTS"]);
Poco::replaceInPlace(orig, std::string("<!--%CSS_VARIABLES%-->"),
variables["CSS_VARIABLES"]);
Poco::replaceInPlace(orig, std::string("%POSTMESSAGE_ORIGIN%"),
variables["POSTMESSAGE_ORIGIN"]);
Poco::replaceInPlace(orig, std::string("%BRANDING_THEME%"),
variables["BRANDING_THEME"]);
Poco::replaceInPlace(orig, std::string("<!--%BRANDING_JS%-->"),
variables["BRANDING_JS"]);
Poco::replaceInPlace(orig, std::string("%FOOTER%"), variables["FOOTER"]);
Poco::replaceInPlace(orig, std::string("%CHECK_FILE_INFO_OVERRIDE%"),
variables["CHECK_FILE_INFO_OVERRIDE"]);
Poco::replaceInPlace(orig, std::string("%BUYPRODUCT_URL%"),
variables["BUYPRODUCT_URL"]);
LOK_ASSERT_EQUAL(orig, recon);
}
}
}
void FileServeTests::testPreProcessedFileSubstitution()
{
constexpr auto testname = __func__;
std::unordered_map<std::string, std::string> variables = {
{ "ACCESS_TOKEN", "alksjdfiwjksnsdkafnsdl" },
{ "ACCESS_TOKEN_TTL", "123" },
{ "ACCESS_HEADER", "8923rweyhjsnjfnwoejl" },
{ "UI_DEFAULTS",
"{\"presentation\":{\"ShowStatusbar\":false},\"spreadsheet\":{\"ShowSidebar\":"
"false},\"text\":{\"ShowRuler\":true},\"uiMode\":\"notebookbar\"}" },
{ "CSS_VARIABLES",
"<style>:root {--co-somestyle-text:#123456;--co-somestyle-size:15px;}</style>" },
{ "POSTMESSAGE_ORIGIN", "https://www.example.com:8080" },
{ "BRANDING_THEME", "cool_brand" },
{ "BRANDING_JS", "branding.js" },
{ "FOOTER", "<div><b>blah blah footer</b></div>" },
{ "CHECK_FILE_INFO_OVERRIDE", "DownloadAsPostMessage=true;blah=bleh" },
{ "BUYPRODUCT_URL", "https://buy.ourproduct.com/'" }
};
preProcessedFileSubstitution(testname, std::move(variables));
preProcessedFileSubstitution(std::string(testname) + "_empty",
std::unordered_map<std::string, std::string>());
}
CPPUNIT_TEST_SUITE_REGISTRATION(FileServeTests);
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink