Tools/TestWebKitAPI/Helpers/WebCoreTestUtilities.cpp

/*
 * Copyright (C) 2021 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"
#include "Helpers/WebCoreTestUtilities.h"

#include <wtf/MemoryFootprint.h>

#if PLATFORM(GTK) || PLATFORM(WPE)
#include <WebCore/PlatformDisplaySurfaceless.h>
#endif

namespace TestWebKitAPI {

#if PLATFORM(GTK) || PLATFORM(WPE)
class PlatformDisplayEnvironment : public testing::Environment {
public:
    void SetUp() override
    {
        if (WebCore::PlatformDisplay::sharedDisplayIfExists())
            return;
        auto display = WebCore::PlatformDisplaySurfaceless::create();
        RELEASE_ASSERT(display);
        WebCore::PlatformDisplay::setSharedDisplay(WTF::move(display));
    }
};

static testing::Environment* const platformDisplayEnvironment = testing::AddGlobalTestEnvironment(new PlatformDisplayEnvironment);
#endif // PLATFORM(GTK) || PLATFORM(WPE)

::testing::AssertionResult memoryFootprintChangedBy(size_t& lastFootprint, double expectedChange, double error)
{
    WTF::releaseFastMallocFreeMemory();
    size_t newFootprint = memoryFootprint();
    size_t oldFootprint = std::exchange(lastFootprint, newFootprint);
    double change = static_cast<double>(newFootprint) - oldFootprint;
    if (change - expectedChange > error)
        return ::testing::AssertionFailure() << "Footprint changed by " << change << ". Expected at most " << expectedChange << "+-" << error;
    return ::testing::AssertionSuccess();
}

}