name: Trigger Execution of associated Squish tests + PLANS AND RUNS
description: Triggers execution of Squish tests for a run, test plan, suite or single case
author: froglogic GmbH
version: 1.0
includes: ^(suites/view|cases/view|plans|runs)
excludes: ^(runs/overview)

js:
$(document).ready( function() {
    /* Create the button. */
    var button = $( [
        '<div class="toolbar content-header-toolbar">',
        '<a class="toolbar-button toolbar-button-last toolbar-button-first content-header-button button-start" href="javascript:void(0)">',
        'Execute Associated Squish Test(s)',
        '</a>',
        '</div>'
    ].join('') );
    /* Add it to the toolbar. */
    $('#content-header .content-header-inner').prepend(button);
    /* Bind the click event to trigger the associated Squish tests. */
    $('a', button).click( function() {
        // find out which page we are on (suite/case or plan or run)
        // NOTE: a case always has suite context, but runs are not necessarily part of a plan, thus not always having a plan context
        if ( uiscripts.context.run ) {
            // run view page
            fetchExecutionFromRun(
                // on success
                function( execution ) {
                    triggerSquishTestExecutions( [ execution ] );
                },
                // on failure
                function( errormsg ) {
                    App.Dialogs.error( errormsg );
                }
            );
        } else if ( uiscripts.context.plan ) {
            // plan view page
            fetchExecutionListFromPlan(
                // on success
                function( executionlist ) {
                    triggerSquishTestExecutions( executionlist );
                },
                // on failure
                function( errormsg ) {
                    App.Dialogs.error( errormsg );
                }
            );
        } else if ( uiscripts.context.case ) {
            // case view page
            var execution = {};
            execution['user'] = uiscripts.context.user.email;
            execution['tests'] = [ uiscripts.context.case.id ];
            triggerSquishTestExecutions( [ execution ] );
        } else if ( uiscripts.context.suite ) {
            // suite view page
            fetchExecutionFromSuite(
                // on success
                function( execution ) {
                    triggerSquishTestExecutions( [ execution ] );
                },
                // on failure
                function( errormsg ) {
                    App.Dialogs.error( errormsg );
                }
            );
        } else {
            App.Dialogs.error( 'Could not find any context to execute a test in.' );
        }

    } );
} );

function fetchExecutionFromRun( onSuccess, onFailure )
{
    get( 'get_run/' + uiscripts.context.run.id,
        function( run ) {
            get( 'get_tests/' + uiscripts.context.run.id,
                function( tests ) {
                    get( 'get_configs/' + uiscripts.context.project.id,
                        function( configs ) {
                            var execution = {};
                            execution['user'] = uiscripts.context.user.email;
                            execution['tests'] = tests.map( function( item ) { return item.case_id; } );
                            execution['labels'] = [ { 'key': '.testrail.run', 'value': 'R' + uiscripts.context.run.id.toString() } ];
                            // if the run is part of a plan, attach a batch name and - if available - configurations
                            if ( uiscripts.context.plan ) {
                                execution['batch'] = createPlanBatchName();
                                execution['labels'] = execution['labels'].concat( createLabelsFromConfigIds( configs, run.config_ids ) );
                            }
                            onSuccess( execution );
                        },
                        function() {
                            onFailure( 'An error occurred while fetching run configurations for this project.' );
                        }
                    );
                },
                function() {
                    onFailure( 'An error occurred while fetching the test cases for this run.' );
                }
            );
        },
        function() {
            onFailure( 'An error occurred while fetching the run.' );
        }
    );
}

function fetchExecutionListFromPlan( onSuccess, onFailure )
{
    get( 'get_plan/' + uiscripts.context.plan.id,
        function( plan ) {
            get( 'get_configs/' + uiscripts.context.project.id,
                function( configs ) {
                    var run_ids = [];
                    plan.entries.forEach( function( entry ) { run_ids = run_ids.concat( entry.runs.map( function( run ) { return run.id; } ) ) } );
                    if ( run_ids.length == 0 ) {
                        onFailure( 'Selected test plan does not contain any runs.' );
                        return;
                    }
                    var executionlist = [];
                    var batchName = createPlanBatchName();
                    var collectTests = function( runIds ) {
                        get( 'get_tests/' + runIds[0],
                            function( tests ) {
                                var execution = {};
                                execution['user'] = uiscripts.context.user.email;
                                execution['tests'] = tests.map( function( item ) { return item.case_id; } );
                                execution['labels'] = [ { 'key': '.testrail.run', 'value': 'R' + runIds[0].toString() } ];
                                execution['batch'] = batchName;
                                // get run and add configuration labels
                                plan.entries.forEach(
                                    function( entry ) {
                                        entry.runs.forEach(
                                            function( run ) {
                                                if ( run.id == runIds[0] ) {
                                                    execution['labels'] = execution['labels'].concat( createLabelsFromConfigIds( configs, run.config_ids ) );
                                                }
                                            }
                                        );
                                    }
                                );
                                executionlist.push( execution );
                                if ( runIds.length == 1 ) {
                                    onSuccess( executionlist );
                                } else {
                                    collectTests( runIds.slice( 1, runIds.length ) );
                                }
                            },
                            function() {
                                onFailure( 'An error occurred while fetching tests.' );
                            }
                        );
                    };
                    collectTests( run_ids );
                },
                function() {
                    onFailure( 'An error occurred while fetching run configurations for this project.' );
                }
            );
        },
        function() {
            onFailure( 'An error occurred while fetching the test plan.' );
        }
    );
}

function fetchExecutionFromSuite( onSuccess, onFailure )
{
    get( 'get_cases/' + uiscripts.context.project.id + '&suite_id=' + uiscripts.context.suite.id,
        function( cases ) {
            var execution = {};
            execution['user'] = uiscripts.context.user.email;
            execution['tests'] = cases.map( function( item ) { return item.id; } );
            onSuccess( execution );
        },
        function() {
            onFailure( 'An error occurred while fetching the list cases for this suite.' );
        }
    );
}

function triggerSquishTestExecutions( executions )
{
    $.ajax( {
        url: 'squishtestcenterintegration.php',
        dataType: 'json',
        contentType: 'application/json',
        data: JSON.stringify( executions ),
        type: 'POST',
        success: function()
        {
            location.reload();
        },
        error: function( data )
        {
            App.Dialogs.error(
                'An error occurred while trying to trigger the associated Squish tests:\n' +
                JSON.stringify( data )
            );
        }
    } );
    App.Dialogs.message(
        'Sending test execution(s) to Squish TestCenter...\n' +
        'The page will reload once the Squish test executions have been scheduled.',
        'Confirmation'
    );
}

function get( apiCall, onSuccess, onFailure ) {
    $.ajax( {
        url: 'index.php?/api/v2/' + apiCall,
        dataType: 'json',
        contentType: 'application/json',
        type: 'GET',
        success: function( data ) {
            onSuccess( data );
        },
        error: function( data ) {
            onFailure( data );
        }
    } );
}

function createLabelsFromConfigIds( configData, configIds ) {
    var groupTable = {};
    var configTable = {};
    configData.forEach(
        function( configGroup ) {
            groupTable[configGroup.id] = configGroup.name;
            configGroup.configs.forEach(
                function( config ) {
                    configTable[config.id] = { name: config.name, groupId: config.group_id };
                }
            );
        }
    );
    var labels = configIds.map(
        function( id ) {
            var config = configTable[id];
            return { key: groupTable[config.groupId], value: config.name };
        }
    );
    return labels;
}

function createPlanBatchName() {
    return uiscripts.context.plan.name + '-' + Date.now();
}