typescript-closure-tools/index/closure-library/closure/goog/testing/testrunner.d.ts

Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files

/// <reference path="../../../globals.d.ts" />
/// <reference path="./testcase.d.ts" />

declare module goog.testing {

    class TestRunner extends TestRunner__Class { }
    /** Fake class which should be extended to avoid inheriting static properties */
    class TestRunner__Class  { 
    
            /**
             * Construct a test runner.
             *
             * NOTE(user): This is currently pretty weird, I'm essentially trying to
             * create a wrapper that the Selenium test can hook into to query the state of
             * the running test case, while making goog.testing.TestCase general.
             *
             * @constructor
             */
            constructor();
    
            /**
             * Errors that occurred in the window.
             * @type {Array.<string>}
             */
            errors: string[];
    
            /**
             * Reference to the active test case.
             * @type {goog.testing.TestCase?}
             */
            testCase: goog.testing.TestCase;
    
            /**
             * Whether the test runner has been initialized yet.
             * @type {boolean}
             */
            initialized: boolean;
    
            /**
             * Initializes the test runner.
             * @param {goog.testing.TestCase} testCase The test case to initialize with.
             */
            initialize(testCase: goog.testing.TestCase): void;
    
            /**
             * By default, the test runner is strict, and fails if it runs an empty
             * test case.
             * @param {boolean} strict Whether the test runner should fail on an empty
             *     test case.
             */
            setStrict(strict: boolean): void;
    
            /**
             * @return {boolean} Whether the test runner should fail on an empty
             *     test case.
             */
            isStrict(): boolean;
    
            /**
             * Returns true if the test runner is initialized.
             * Used by Selenium Hooks.
             * @return {boolean} Whether the test runner is active.
             */
            isInitialized(): boolean;
    
            /**
             * Returns true if the test runner is finished.
             * Used by Selenium Hooks.
             * @return {boolean} Whether the test runner is active.
             */
            isFinished(): boolean;
    
            /**
             * Returns true if the test case didn't fail.
             * Used by Selenium Hooks.
             * @return {boolean} Whether the current test returned successfully.
             */
            isSuccess(): boolean;
    
            /**
             * Returns true if the test case runner has errors that were caught outside of
             * the test case.
             * @return {boolean} Whether there were JS errors.
             */
            hasErrors(): boolean;
    
            /**
             * Logs an error that occurred.  Used in the case of environment setting up
             * an onerror handler.
             * @param {string} msg Error message.
             */
            logError(msg: string): void;
    
            /**
             * Log failure in current running test.
             * @param {Error} ex Exception.
             */
            logTestFailure(ex: Error): void;
    
            /**
             * Sets a function to use as a filter for errors.
             * @param {function(string)} fn Filter function.
             */
            setErrorFilter(fn: { (_0: string): any /*missing*/ }): void;
    
            /**
             * Returns a report of the test case that ran.
             * Used by Selenium Hooks.
             * @param {boolean=} opt_verbose If true results will include data about all
             *     tests, not just what failed.
             * @return {string} A report summary of the test.
             */
            getReport(opt_verbose?: boolean): string;
    
            /**
             * Returns the amount of time it took for the test to run.
             * Used by Selenium Hooks.
             * @return {number} The run time, in milliseconds.
             */
            getRunTime(): number;
    
            /**
             * Returns the number of script files that were loaded in order to run the test.
             * @return {number} The number of script files.
             */
            getNumFilesLoaded(): number;
    
            /**
             * Executes a test case and prints the results to the window.
             */
            execute(): void;
    
            /**
             * Writes a nicely formatted log out to the document.
             * @param {string} log The string to write.
             */
            writeLog(log: string): void;
    
            /**
             * Logs a message to the current test case.
             * @param {string} s The text to output to the log.
             */
            log(s: string): void;
    
            /**
             * @return {Object.<string, !Array.<string>>} A map of test names to a list of
             * test failures (if any) to provide formatted data for the test runner.
             */
            getTestResults(): { [key: string]: string[] };
    } 
    
}