Tools/TestWebKitAPI/InjectedBundleController.cpp

/*
 * Copyright (C) 2010 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"

#if WK_HAVE_C_SPI

#include "InjectedBundleController.h"

#include "InjectedBundleTest.h"
#include "PlatformUtilities.h"
#include <algorithm>
#include <assert.h>

namespace TestWebKitAPI {

InjectedBundleController& InjectedBundleController::singleton()
{
    static InjectedBundleController& shared = *new InjectedBundleController;
    return shared;
}

InjectedBundleController::InjectedBundleController()
    : m_bundle(0)
    , m_currentTest(0)
{
}

void InjectedBundleController::initialize(WKBundleRef bundle, WKTypeRef initializationUserData)
{
    platformInitialize();

    m_bundle = bundle;

    if (!initializationUserData)
        return;

    WKBundleClientV1 client = {
        { 0, this },
        didCreatePage,
        willDestroyPage,
        didInitializePageGroup,
        didReceiveMessage,
        didReceiveMessageToPage
    };
    WKBundleSetClient(m_bundle, &client.base);

    // Initialize the test from the "initializationUserData".

    assert(WKGetTypeID(initializationUserData) == WKDictionaryGetTypeID());
    WKDictionaryRef initializationDictionary = static_cast<WKDictionaryRef>(initializationUserData);

    WKRetainPtr<WKStringRef> testNameKey = adoptWK(WKStringCreateWithUTF8CString("TestName"));
    WKStringRef testName = static_cast<WKStringRef>(WKDictionaryGetItemForKey(initializationDictionary, testNameKey.get()));

    WKRetainPtr<WKStringRef> userDataKey = adoptWK(WKStringCreateWithUTF8CString("UserData"));
    WKTypeRef userData = WKDictionaryGetItemForKey(initializationDictionary, userDataKey.get());
    initializeTestNamed(bundle, Util::toSTD(testName), userData);
}

void InjectedBundleController::didCreatePage(WKBundleRef bundle, WKBundlePageRef page, const void* clientInfo)
{
    InjectedBundleController* self = static_cast<InjectedBundleController*>(const_cast<void*>(clientInfo));
    assert(self->m_currentTest);
    self->m_currentTest->didCreatePage(bundle, page);
}

void InjectedBundleController::willDestroyPage(WKBundleRef bundle, WKBundlePageRef page, const void* clientInfo)
{
    InjectedBundleController* self = static_cast<InjectedBundleController*>(const_cast<void*>(clientInfo));
    assert(self->m_currentTest);
    self->m_currentTest->willDestroyPage(bundle, page);
}

void InjectedBundleController::didInitializePageGroup(WKBundleRef bundle, WKBundlePageGroupRef pageGroup, const void* clientInfo)
{
    InjectedBundleController* self = static_cast<InjectedBundleController*>(const_cast<void*>(clientInfo));
    assert(self->m_currentTest);
    self->m_currentTest->didInitializePageGroup(bundle, pageGroup);
}

void InjectedBundleController::didReceiveMessage(WKBundleRef bundle, WKStringRef messageName, WKTypeRef messageBody, const void* clientInfo)
{
    InjectedBundleController* self = static_cast<InjectedBundleController*>(const_cast<void*>(clientInfo));
    assert(self->m_currentTest);
    self->m_currentTest->didReceiveMessage(bundle, messageName, messageBody);
}

void InjectedBundleController::didReceiveMessageToPage(WKBundleRef bundle, WKBundlePageRef page, WKStringRef messageName, WKTypeRef messageBody, const void* clientInfo)
{
    InjectedBundleController* self = static_cast<InjectedBundleController*>(const_cast<void*>(clientInfo));
    assert(self->m_currentTest);
    self->m_currentTest->didReceiveMessageToPage(bundle, page, messageName, messageBody);
}

void InjectedBundleController::dumpTestNames()
{
    std::map<std::string, CreateInjectedBundleTestFunction>::const_iterator it = m_createInjectedBundleTestFunctions.begin();
    std::map<std::string, CreateInjectedBundleTestFunction>::const_iterator end = m_createInjectedBundleTestFunctions.end();
    for (; it != end; ++it)
        printf("%s\n", (*it).first.c_str());
}

void InjectedBundleController::initializeTestNamed(WKBundleRef bundle, const std::string& identifier, WKTypeRef userData)
{
    CreateInjectedBundleTestFunction createTestFunction = m_createInjectedBundleTestFunctions[identifier];
    if (!createTestFunction) {
        printf("ERROR: InjectedBundle test not found - %s\n", identifier.c_str());
        exit(1);
    }

    m_currentTest = createTestFunction(identifier);
    m_currentTest->initialize(bundle, userData);
}

void InjectedBundleController::registerCreateInjectedBundleTestFunction(const std::string& identifier, CreateInjectedBundleTestFunction function)
{
    m_createInjectedBundleTestFunctions[identifier] = function;
}

#if !PLATFORM(COCOA)
void InjectedBundleController::platformInitialize()
{
}
#endif

} // namespace TestWebKitAPI

#endif