/*

 * Copyright (C) 2010 Google 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:

 *

 *     * Redistributions of source code must retain the above copyright

 * notice, this list of conditions and the following disclaimer.

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

 *     * Neither the name of Google Inc. nor the names of its

 * contributors may be used to endorse or promote products derived from

 * this software without specific prior written permission.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT

 * OWNER OR 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.

 */

/**

 * @fileoverview This file contains small testing framework along with the

 * test suite for the frontend. These tests are a part of the continues build

 * and are executed by the devtools_sanity_unittest.cc as a part of the

 * Interactive UI Test suite.

 * FIXME: change field naming style to use trailing underscore.

 */

if (window.domAutomationController) {

var ___interactiveUiTestsMode = true;

/**

 * Test suite for interactive UI tests.

 * @constructor

 */

TestSuite = function()

{

    this.controlTaken_ = false;

    this.timerId_ = -1;

};

/**

 * Reports test failure.

 * @param {string} message Failure description.

 */

TestSuite.prototype.fail = function(message)

{

    if (this.controlTaken_)

        this.reportFailure_(message);

    else

        throw message;

};

/**

 * Equals assertion tests that expected === actual.

 * @param {Object} expected Expected object.

 * @param {Object} actual Actual object.

 * @param {string} opt_message User message to print if the test fails.

 */

TestSuite.prototype.assertEquals = function(expected, actual, opt_message)

{

    if (expected !== actual) {

        var message = "Expected: '" + expected + "', but was '" + actual + "'";

        if (opt_message)

            message = opt_message + "(" + message + ")";

        this.fail(message);

    }

};

/**

 * True assertion tests that value == true.

 * @param {Object} value Actual object.

 * @param {string} opt_message User message to print if the test fails.

 */

TestSuite.prototype.assertTrue = function(value, opt_message)

{

    this.assertEquals(true, !!value, opt_message);

};

/**

 * Contains assertion tests that string contains substring.

 * @param {string} string Outer.

 * @param {string} substring Inner.

 */

TestSuite.prototype.assertContains = function(string, substring)

{

    if (string.indexOf(substring) === -1)

        this.fail("Expected to: '" + string + "' to contain '" + substring + "'");

};

/**

 * Takes control over execution.

 */

TestSuite.prototype.takeControl = function()

{

    this.controlTaken_ = true;

    // Set up guard timer.

    var self = this;

    this.timerId_ = setTimeout(function() {

        self.reportFailure_("Timeout exceeded: 20 sec");

    }, 20000);

};

/**

 * Releases control over execution.

 */

TestSuite.prototype.releaseControl = function()

{

    if (this.timerId_ !== -1) {

        clearTimeout(this.timerId_);

        this.timerId_ = -1;

    }

    this.reportOk_();

};

/**

 * Async tests use this one to report that they are completed.

 */

TestSuite.prototype.reportOk_ = function()

{

    window.domAutomationController.send("[OK]");

};

/**

 * Async tests use this one to report failures.

 */

TestSuite.prototype.reportFailure_ = function(error)

{

    if (this.timerId_ !== -1) {

        clearTimeout(this.timerId_);

        this.timerId_ = -1;

    }

    window.domAutomationController.send("[FAILED] " + error);

};

/**

 * Runs all global functions starting with "test" as unit tests.

 */

TestSuite.prototype.runTest = function(testName)

{

    try {

        this[testName]();

        if (!this.controlTaken_)

            this.reportOk_();

    } catch (e) {

        this.reportFailure_(e);

    }

};

/**

 * @param {string} panelName Name of the panel to show.

 */

TestSuite.prototype.showPanel = function(panelName)

{

    // Open Scripts panel.

    var toolbar = document.getElementById("toolbar");

    var button = toolbar.getElementsByClassName(panelName)[0];

    button.click();

    this.assertEquals(WebInspector.panels[panelName], WebInspector.currentPanel);

};

/**

 * Overrides the method with specified name until it's called first time.

 * @param {Object} receiver An object whose method to override.

 * @param {string} methodName Name of the method to override.

 * @param {Function} override A function that should be called right after the

 *     overriden method returns.

 * @param {boolean} opt_sticky Whether restore original method after first run

 *     or not.

 */

TestSuite.prototype.addSniffer = function(receiver, methodName, override, opt_sticky)

{

    var orig = receiver[methodName];

    if (typeof orig !== "function")

        this.fail("Cannot find method to override: " + methodName);

    var test = this;

    receiver[methodName] = function(var_args) {

        try {

            var result = orig.apply(this, arguments);

        } finally {

            if (!opt_sticky)

                receiver[methodName] = orig;

        }

        // In case of exception the override won't be called.

        try {

            override.apply(this, arguments);

        } catch (e) {

            test.fail("Exception in overriden method '" + methodName + "': " + e);

        }

        return result;

    };

};

// UI Tests

/**

 * Tests that the real injected host is present in the context.

 */

TestSuite.prototype.testHostIsPresent = function()

{

    this.assertTrue(typeof InspectorFrontendHost === "object" && !InspectorFrontendHost.isStub);

};

/**

 * Tests elements tree has an "HTML" root.

 */

TestSuite.prototype.testElementsTreeRoot = function()

{

    var doc = WebInspector.domAgent.document;

    this.assertEquals("HTML", doc.documentElement.nodeName);

    this.assertTrue(doc.documentElement.hasChildNodes());

};

/**

 * Tests that main resource is present in the system and that it is

 * the only resource.

 */

TestSuite.prototype.testMainResource = function()

{

    var tokens = [];

    var resources = WebInspector.resources;

    for (var id in resources)

        tokens.push(resources[id].lastPathComponent);

    this.assertEquals("simple_page.html", tokens.join(","));

};

/**

 * Tests that resources tab is enabled when corresponding item is selected.

 */

TestSuite.prototype.testEnableResourcesTab = function()

{

    this.showPanel("resources");

    var test = this;

    this.addSniffer(WebInspector, "updateResource",

        function(identifier, payload) {

            test.assertEquals("simple_page.html", payload.lastPathComponent);

            WebInspector.panels.resources.refresh();

            WebInspector.panels.resources.revealAndSelectItem(WebInspector.resources[identifier]);

            test.releaseControl();

        });

    // Following call should lead to reload that we capture in the

    // addResource override.

    WebInspector.panels.resources._enableResourceTracking();

    // We now have some time to report results to controller.

    this.takeControl();

};

/**

 * Tests that correct content length is reported for resources.

 */

TestSuite.prototype.testResourceContentLength = function()

{

    this.showPanel("resources");

    var test = this;

    var png = false;

    var html = false;

    this.addSniffer(WebInspector, "updateResource",

        function(identifier, payload) {

            if (!payload.didLengthChange)

                return;

            var resource = WebInspector.resources[identifier];

            if (!resource || !resource.url)

                return;

            if (resource.url.search("image.html") !== -1) {

              var expectedLength = 87;

              test.assertTrue(

                  resource.resourceSize <= expectedLength,

                  "image.html content length is greater thatn expected.");

              if (expectedLength === resource.resourceSize)

                  html = true;

            } else if (resource.url.search("image.png") !== -1) {

              var expectedLength = 257796;

              test.assertTrue(

                  resource.resourceSize <= expectedLength,

                  "image.png content length is greater than expected.");

              if (expectedLength === resource.resourceSize)

                  png = true;

            }

            if (html && png) {

              // Wait 1 second before releasing control to check that the content

              // lengths are not updated anymore.

              setTimeout(function() {

                  test.releaseControl();

              }, 1000);

            }

        }, true);

    // Make sure resource tracking is on.

    WebInspector.panels.resources._enableResourceTracking();

    // Reload inspected page to update all resources.

    test.evaluateInConsole_(

        "window.location.reload(true);",

         function(resultText) {

             test.assertEquals("undefined", resultText, "Unexpected result of reload().");

         });

    // We now have some time to report results to controller.

    this.takeControl();

};

/**

 * Tests resource headers.

 */

TestSuite.prototype.testResourceHeaders = function()

{

    this.showPanel("resources");

    var test = this;

    var responseOk = false;

    var timingOk = false;

    this.addSniffer(WebInspector, "updateResource",

        function(identifier, payload) {

            var resource = this.resources[identifier];

            if (!resource || resource.mainResource) {

                // We are only interested in secondary resources in this test.

                return;

            }

            var requestHeaders = JSON.stringify(resource.requestHeaders);

            test.assertContains(requestHeaders, "Accept");

            if (payload.didResponseChange) {

                var responseHeaders = JSON.stringify(resource.responseHeaders);

                test.assertContains(responseHeaders, "Content-type");

                test.assertContains(responseHeaders, "Content-Length");

                test.assertTrue(typeof resource.responseReceivedTime !== "undefined");

                responseOk = true;

            }

            if (payload.didTimingChange) {

                test.assertTrue(typeof resource.startTime !== "undefined");

                timingOk = true;

            }

            if (payload.didCompletionChange) {

                test.assertTrue(responseOk);

                test.assertTrue(timingOk);

                test.assertTrue(typeof resource.endTime !== "undefined");

                test.releaseControl();

            }

        }, true);

    WebInspector.panels.resources._enableResourceTracking();

    this.takeControl();

};

/**

 * Tests the mime type of a cached (HTTP 304) resource.

 */

TestSuite.prototype.testCachedResourceMimeType = function()

{

    this.showPanel("resources");

    var test = this;

    var hasReloaded = false;

    this.addSniffer(WebInspector, "updateResource",

        function(identifier, payload) {

            var resource = this.resources[identifier];

            if (!resource || resource.mainResource) {

                // We are only interested in secondary resources in this test.

                return;

            }

            if (payload.didResponseChange) {

                // Test server uses a default mime type for JavaScript files.

                test.assertEquals("text/html", payload.mimeType);

                if (!hasReloaded) {

                    hasReloaded = true;

                    // Reload inspected page to update all resources.

                    test.evaluateInConsole_("window.location.reload(true);", function() {});

                } else

                    test.releaseControl();

            }

        }, true);

    WebInspector.panels.resources._enableResourceTracking();

    this.takeControl();

};

/**

 * Tests that profiler works.

 */

TestSuite.prototype.testProfilerTab = function()

{

    this.showPanel("profiles");

    var panel = WebInspector.panels.profiles;

    var test = this;

    function findDisplayedNode() {

        var node = panel.visibleView.profileDataGridTree.children[0];

        if (!node) {

            // Profile hadn't been queried yet, re-schedule.

            window.setTimeout(findDisplayedNode, 100);

            return;

        }

        // Iterate over displayed functions and search for a function

        // that is called "fib" or "eternal_fib". If found, this will mean

        // that we actually have profiled page's code.

        while (node) {

            if (node.functionName.indexOf("fib") !== -1)

                test.releaseControl();

            node = node.traverseNextNode(true, null, true);

        }

        test.fail();

    }

    function findVisibleView() {

        if (!panel.visibleView) {

            setTimeout(findVisibleView, 0);

            return;

        }

        setTimeout(findDisplayedNode, 0);

    }

    findVisibleView();

    this.takeControl();

};

/**

 * Tests that heap profiler works.

 */

TestSuite.prototype.testHeapProfiler = function()

{

    this.showPanel("profiles");

    var panel = WebInspector.panels.profiles;

    var test = this;

    function findDisplayedNode() {

        var node = panel.visibleView.dataGrid.children[0];

        if (!node) {

            // Profile hadn't been queried yet, re-schedule.

            window.setTimeout(findDisplayedNode, 100);

            return;

        }

        // Iterate over displayed functions and find node called "A"

        // If found, this will mean that we actually have taken heap snapshot.

        while (node) {

            if (node.constructorName.indexOf("A") !== -1) {

                test.releaseControl();

                return;

            }

            node = node.traverseNextNode(false, null, true);

        }

        test.fail();

    }

    function findVisibleView() {

        if (!panel.visibleView) {

            setTimeout(findVisibleView, 0);

            return;

        }

        setTimeout(findDisplayedNode, 0);

    }

    WebInspector.HeapSnapshotProfileType.prototype.buttonClicked();

    findVisibleView();

    this.takeControl();

};

/**

 * Tests that scripts tab can be open and populated with inspected scripts.

 */

TestSuite.prototype.testShowScriptsTab = function()

{

    this.showPanel("scripts");

    var test = this;

    // There should be at least main page script.

    this._waitUntilScriptsAreParsed(["debugger_test_page.html"],

        function() {

            test.releaseControl();

        });

    // Wait until all scripts are added to the debugger.

    this.takeControl();

};

/**

 * Tests that scripts tab is populated with inspected scripts even if it

 * hadn't been shown by the moment inspected paged refreshed.