sfdx-ftw-assertions/src/index.ts

Typings for implementing sfdx-ftw assertions.

export interface Assertion{
    /**
     * The logic that the assertion will attempt to validate (displayed to the user via stdout). 
     */
    description: string;
    /**
     * Callback function to handle failed assertions. 
     * @param result The failure response. 
     */
    failureCallback(result: string): void; // TODO result as complex type
}

/**
 * Instances of this class represent the simplest type of assertion, which provide for a 
 * simple list of Apex Sytem.assert... family of statements. 
 */
export interface SimpleAssertion extends Assertion{ 
    /**
     * Implementing classes must provide a list of valid Apex System.assert... method variants. 
     * These statements will be run via anonymous Apex in the target org, with any failures being returned to the 
     * failureCallback() method. 
     */
    apexAssertion: string; 
}

/**
 * Abstract class which all assertion suites must extend. 
 */
export abstract class AssertionSuite{
    /**
     * Array of metadata dependencies that will be deployed prior to running assertions. 
     */
    abstract dependencies: string[];
    /**
     * The array of assertions to be run. Must be instances of a type that extends the abstract Assertion class.
     */
    abstract getAssertions(): Assertion[]; 

    /**
     * User-defined typeguard for runtime check of a putative assertion, to determine if it is simple. 
     * @param assertion The assertion to check as simple
     */
    public static isSimpleAssertion(assertion: Assertion): assertion is SimpleAssertion{
        let casted = assertion as SimpleAssertion; 
        return casted.apexAssertion !== undefined && typeof casted.apexAssertion === 'string'; 
    }
}