libreoffice-online/test/UnitWOPIAsyncUpload_Modify.cpp

/* -*- 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/.
 */

#include <config.h>

#include "HttpRequest.hpp"
#include "Util.hpp"
#include "lokassert.hpp"

#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>

/// Test Async uploading with simulated failing.
/// We modify the document, save, and attempt to upload,
/// which fails. We then modify the document again
/// and save. We expect another upload attemp,
/// which will succeed.
/// Modify, Save, Upload fails, Modify, Save -> Upload.
class UnitWOPIAsyncUpload_Modify : public WopiTestServer
{
    enum class Phase
    {
        Load,
        WaitLoadStatus,
        Modify,
        WaitModifiedStatus,
        WaitFirstPutFile,
        Close,
        WaitSecondPutFile,
        Polling
    } _phase;

public:
    UnitWOPIAsyncUpload_Modify()
        : WopiTestServer("UnitWOPIAsyncUpload_Modify")
        , _phase(Phase::Load)
    {
    }

    std::unique_ptr<http::Response>
    assertPutFileRequest(const Poco::Net::HTTPRequest& request) override
    {
        // We save twice. First right after loading, unmodified.
        if (_phase == Phase::WaitFirstPutFile)
        {
            LOG_TST("assertPutFileRequest: First PutFile, which will fail");

            LOG_TST("WaitFirstPutFile => Close");
            _phase = Phase::Close;

            LOK_ASSERT_EQUAL(std::string("true"), request.get("X-LOOL-WOPI-IsModifiedByUser"));

            // We requested the save.
            LOK_ASSERT_EQUAL(std::string("false"), request.get("X-LOOL-WOPI-IsAutosave"));

            // Fail with error.
            LOG_TST("assertPutFileRequest: returning 404 to simulate PutFile failure");
            return Util::make_unique<http::Response>(http::StatusLine(404));
        }
        else if (_phase == Phase::WaitSecondPutFile)
        {
            // This during closing the document.
            LOG_TST("assertPutFileRequest: Second PutFile, which will succeed");
            LOK_ASSERT_MESSAGE("Expected to be in Phase::WaitSecondPutFile",
                               _phase == Phase::WaitSecondPutFile);

            // the document is modified
            LOK_ASSERT_EQUAL(std::string("true"), request.get("X-LOOL-WOPI-IsModifiedByUser"));

            // Triggered while closing.
            LOK_ASSERT_EQUAL(std::string("false"), request.get("X-LOOL-WOPI-IsAutosave"));

            passTest("Document uploaded on closing as expected.");

            LOG_TST("WaitSecondPutFile => Polling");
            _phase = Phase::Polling; // To detect multiple uploads after the last successful one.

            // Success.
            return Util::make_unique<http::Response>(http::StatusLine(200));
        }

        failTest("Unexpected Phase in PutFile: " + std::to_string(static_cast<int>(_phase)));
        return nullptr;
    }

    /// The document is loaded.
    bool onDocumentLoaded(const std::string& message) override
    {
        LOG_TST("onDocumentLoaded: [" << message << ']');
        LOK_ASSERT_MESSAGE("Expected to be in Phase::WaitLoadStatus",
                           _phase == Phase::WaitLoadStatus);

        LOG_TST("onDocumentModified: Switching to Phase::Modify");
        _phase = Phase::Modify;

        SocketPoll::wakeupWorld();
        return true;
    }

    /// The document is modified. Save it.
    bool onDocumentModified(const std::string& message) override
    {
        LOG_TST("onDocumentModified: Doc (WaitModifiedStatus): [" << message << ']');
        LOK_ASSERT_MESSAGE("Expected to be in Phase::WaitModified",
                           _phase == Phase::WaitModifiedStatus);
        {
            LOG_TST("onDocumentModified: Switching to Phase::WaitFirstPutFile");
            _phase = Phase::WaitFirstPutFile;

            WSD_CMD("save dontTerminateEdit=0 dontSaveIfUnmodified=0 "
                    "extendedData=CustomFlag%3DCustom%20Value%3BAnotherFlag%3DAnotherValue");

            SocketPoll::wakeupWorld();
        }

        return true;
    }

    void invokeWSDTest() override
    {
        switch (_phase)
        {
            case Phase::Load:
            {
                LOG_TST("Load => WaitLoadStatus");
                _phase = Phase::WaitLoadStatus;

                LOG_TST("Load: initWebsocket.");
                initWebsocket("/wopi/files/0?access_token=anything");

                WSD_CMD("load url=" + getWopiSrc());
                break;
            }
            case Phase::WaitLoadStatus:
                break;
            case Phase::Modify:
            {
                LOG_TST("Modify => WaitModified");
                _phase = Phase::WaitModifiedStatus;

                WSD_CMD("key type=input char=97 key=0");
                WSD_CMD("key type=up char=0 key=512");
                break;
            }
            case Phase::WaitModifiedStatus:
                break;
            case Phase::WaitFirstPutFile:
                break;
            case Phase::Close:
            {
                LOG_TST("Close => WaitSecondPutFile");
                _phase = Phase::WaitSecondPutFile;

                WSD_CMD("closedocument");
                break;
            }
            case Phase::WaitSecondPutFile:
                break;
            case Phase::Polling:
            {
                // just wait for the results
                break;
            }
        }
    }
};

UnitBase* unit_create_wsd(void) { return new UnitWOPIAsyncUpload_Modify(); }

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */