/*
 * Copyright (C) 2018 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.
 */

 WI.AuditTestSuite = class AuditTestSuite extends WI.Object
{
    constructor(identifier, name)
    {
        super();
        this._id = Symbol(identifier);
        this._name = name;
        this._testCases = new Map;

        this._buildTestCasesFromDescriptors();
    }

    static testCaseDescriptors() { throw WI.NotImplementedError.subclassMustOverride(); }

    // Public

    get id() { return this._id; }
    get name() { return this._name; }
    get testCases() {
        return [...this._testCases.values()];
    }

    // Private

    _buildTestCasesFromDescriptors()
    {
        for (let descriptor of this.constructor.testCaseDescriptors()) {
            if (typeof(descriptor.name) !== "string" || !descriptor.name)
                throw new Error("Test name must be a valid string.");
            
            let {name, test, setup, tearDown, errorDetails} = descriptor;

            if (!test instanceof Function || test[Symbol.toStringTag] !== "AsyncFunction")
                throw new Error("Test function must be an async function.");

            let testCaseInstance = new WI.AuditTestCase(this, name, test, setup, tearDown, errorDetails);

            this._testCases.set(testCaseInstance.id, testCaseInstance);
        }
    }
}

WI.AuditTestSuite.Event = {
    NewAuditResultAvailable: Symbol("new-audit-result-available")
}   
