awx/awx/ui/static/js/helpers/JobSubmission.js

/*********************************************
 *  Copyright (c) 2014 AnsibleWorks, Inc.
 *
 *  JobSubmission.js
 *
 */

'use strict';

angular.module('JobSubmissionHelper', [ 'RestServices', 'Utilities', 'CredentialFormDefinition', 'CredentialsListDefinition',
    'LookUpHelper', 'JobSubmissionHelper', 'JobTemplateFormDefinition', 'ModalDialog', 'FormGenerator', 'JobVarsPromptFormDefinition'])

.factory('LaunchJob', ['Rest', 'Wait', 'ProcessErrors', function(Rest, Wait, ProcessErrors) {
    return function(params) {
        var scope = params.scope,
            passwords = params.passwords || {},
            callback = params.callback || 'JobLaunched',
            url = params.url;

        Wait('start');
        Rest.setUrl(url);
        Rest.post(passwords)
            .success(function(data) {
                scope.$emit(callback, data);
            })
            .error(function (data, status) {
                ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                    msg: 'Attempt to start job at ' + url + ' failed. POST returned: ' + status });
            });
    };
}])

.factory('PromptForCredential', ['$location', 'Wait', 'GetBasePath', 'LookUpInit', 'JobTemplateForm', 'CredentialList', 'Rest', 'Prompt', 'ProcessErrors',
function($location, Wait, GetBasePath, LookUpInit, JobTemplateForm, CredentialList, Rest, Prompt, ProcessErrors) {
    return function(params) {

        var scope = params.scope,
            callback = params.callback || 'CredentialReady',
            selectionMade;

        Wait('stop');
        scope.credential = '';

        if (scope.removeShowLookupDialog) {
            scope.removeShowLookupDialog();
        }
        scope.removeShowLookupDialog = scope.$on('ShowLookupDialog', function() {
            selectionMade = function () {
                scope.$emit(callback, scope.credential);
            };

            LookUpInit({
                url: GetBasePath('credentials') + '?kind=ssh',
                scope: scope,
                form: JobTemplateForm(),
                current_item: null,
                list: CredentialList,
                field: 'credential',
                hdr: 'Credential Required',
                instructions: "Launching this job requires a machine credential. Please select your machine credential now or Cancel to quit.",
                postAction: selectionMade
            });
            scope.lookUpCredential();
        });

        if (scope.removeAlertNoCredentials) {
            scope.removeAlertNoCredentials();
        }
        scope.removeAlertNoCredentials = scope.$on('AlertNoCredentials', function() {
            var action = function () {
                $('#prompt-modal').modal('hide');
                $location.url('/credentials/add');
            };

            Prompt({
                hdr: 'Machine Credential Required',
                body: "<div class=\"alert alert-info\">There are no machine credentials defined in Tower. Launching this job requires a machine credential. " +
                    "Create one now?",
                action: action
            });
        });

        Rest.setUrl(GetBasePath('credentials') + '?kind=ssh');
        Rest.get()
            .success(function(data) {
                if (data.results.length > 0) {
                    scope.$emit('ShowLookupDialog');
                }
                else {
                    scope.$emit('AlertNoCredentials');
                }
            })
            .error(function(data,status) {
                ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                    msg: 'Checking for machine credentials failed. GET returned: ' + status });
            });
    };
}])

.factory('PromptForPasswords', ['$compile', 'Wait', 'Alert', 'CredentialForm', 'CreateDialog',
    function($compile, Wait, Alert, CredentialForm, CreateDialog) {
        return function(params) {
            var parent_scope = params.scope,
                passwords = params.passwords,
                callback = params.callback || 'PasswordsAccepted',
                form = CredentialForm,
                acceptedPasswords = {},
                scope = parent_scope.$new(),
                e, buttons;

            Wait('stop');

            function buildHtml() {
                var fld, field, html;
                html = "";
                html += "<div class=\"alert alert-info\">Launching this job requires the passwords listed below. Enter and confirm each password before continuing.</div>\n";
                html += "<form name=\"password_form\" novalidate>\n";

                passwords.forEach(function(password) {
                    // Prompt for password
                    field = form.fields[password];
                    fld = password;
                    scope[fld] = '';
                    html += "<div class=\"form-group\">\n";
                    html += "<label for=\"" + fld + "\">* " + field.label + "</label>\n";
                    html += "<input type=\"password\" ";
                    html += "ng-model=\"" + fld + '" ';
                    html += 'name="' + fld + '" ';
                    html += "class=\"password-field form-control input-sm\" ";
                    html += (field.associated) ? "ng-change=\"clearPWConfirm('" + field.associated + "')\" " : "";
                    html += "required ";
                    html += " >";
                    // Add error messages
                    html += "<div class=\"error\" ng-show=\"password_form." + fld + ".$dirty && " +
                        "password_form." + fld + ".$error.required\">A value is required!</div>\n";
                    html += "<div class=\"error api-error\" ng-bind=\"" + fld + "_api_error\"></div>\n";
                    html += "</div>\n";

                    // Add the related confirm field
                    if (field.associated) {
                        fld = field.associated;
                        field = form.fields[field.associated];
                        scope[fld] = '';
                        html += "<div class=\"form-group\">\n";
                        html += "<label for=\"" + fld + "\">* " + field.label + "</label>\n";
                        html += "<input type=\"password\" ";
                        html += "ng-model=\"" + fld + '" ';
                        html += 'name="' + fld + '" ';
                        html += "class=\"form-control input-sm\" ";
                        html += "ng-change=\"checkStatus()\" ";
                        html += "required ";
                        html += (field.awPassMatch) ? "awpassmatch=\"" + field.associated + "\" " : "";
                        html += "/>";
                        // Add error messages
                        html += "<div class=\"error\" ng-show=\"password_form." + fld + ".$dirty && " +
                            "password_form." + fld + ".$error.required\">A value is required!</span>\n";
                        html += (field.awPassMatch) ? "<span class=\"error\" ng-show=\"password_form." + fld +
                            ".$error.awpassmatch\">Must match Password value</div>\n" : "";
                        html += "<div class=\"error api-error\" ng-bind=\"" + fld + "_api_error\"></div>\n";
                        html += "</div>\n";
                    }
                });
                html += "</form>\n";
                return html;
            }

            $('#password-modal').empty().html(buildHtml);
            e = angular.element(document.getElementById('password-modal'));
            $compile(e)(scope);

            buttons = [{
                label: "Cancel",
                onClick: function() {
                    scope.passwordCancel();
                },
                icon: "fa-times",
                "class": "btn btn-default",
                "id": "password-cancel-button"
            },{
                label: "Continue",
                onClick: function() {
                    scope.passwordAccept();
                },
                icon: "fa-check",
                "class": "btn btn-primary",
                "id": "password-accept-button"
            }];

            CreateDialog({
                id: 'password-modal',
                scope: scope,
                buttons: buttons,
                width: 600,
                height: (passwords.length > 1) ? 700 : 500,
                minWidth: 500,
                title: 'Passwords Required',
                callback: 'DialogReady'
            });

            if (scope.removeDialogReady) {
                scope.removeDialogReady();
            }
            scope.removeDialogReady = scope.$on('DialogReady', function() {
                $('#password-modal').dialog('open');
                $('#password-accept-button').attr({ "disabled": "disabled" });
            });

            scope.passwordAccept = function() {
                if (!scope.password_form.$invalid) {
                    passwords.forEach(function(password) {
                        acceptedPasswords[password] = scope[password];
                    });
                    $('#password-modal').dialog('close');
                    parent_scope.$emit(callback, acceptedPasswords);
                }
            };

            scope.passwordCancel = function() {
                $('#password-modal').dialog('close');
                parent_scope.$emit('CancelJob');
                scope.$destroy();
            };

            // Password change
            scope.clearPWConfirm = function (fld) {
                // If password value changes, make sure password_confirm must be re-entered
                scope[fld] = '';
                scope.password_form[fld].$setValidity('awpassmatch', false);
                scope.checkStatus();
            };

            scope.checkStatus = function() {
                if (!scope.password_form.$invalid) {
                    $('#password-accept-button').removeAttr('disabled');
                }
                else {
                    $('#password-accept-button').attr({ "disabled": "disabled" });
                }
            };
        };
    }])

.factory('PromptForVars', ['$compile', 'Rest', 'GetBasePath', 'TextareaResize', 'CreateDialog', 'GenerateForm', 'JobVarsPromptForm', 'Wait',
    'ParseVariableString', 'ToJSON', 'ProcessErrors',
    function($compile, Rest, GetBasePath, TextareaResize,CreateDialog, GenerateForm, JobVarsPromptForm, Wait, ParseVariableString, ToJSON,
        ProcessErrors) {
    return function(params) {
        var buttons,
            parent_scope = params.scope,
            scope = parent_scope.$new(),
            callback = params.callback,
            job = params.job,
            e, helpContainer, html;

        html = GenerateForm.buildHTML(JobVarsPromptForm, { mode: 'edit', modal: true, scope: scope });
        helpContainer = "<div style=\"display:inline-block; font-size: 12px; margin-top: 6px;\" class=\"help-container pull-right\">\n" +
            "<a href=\"\" id=\"awp-promote\" href=\"\" aw-pop-over=\"{{ helpText }}\" aw-tool-tip=\"Click for help\" aw-pop-over-watch=\"helpText\" " +
            "aw-tip-placement=\"top\" data-placement=\"bottom\" data-container=\"body\" data-title=\"Help\" class=\"help-link\"><i class=\"fa fa-question-circle\">" +
            "</i> click for help</a></div>\n";

        scope.helpText = "<p>After defining any extra variables, click Continue to start the job. Otherwise, click cancel to abort.</p>" +
                    "<p>Extra variables are passed as command line variables to the playbook run. It is equivalent to the -e or --extra-vars " +
                    "command line parameter for ansible-playbook. Provide key/value pairs using either YAML or JSON.</p>" +
                    "JSON:<br />\n" +
                    "<blockquote>{<br />\"somevar\": \"somevalue\",<br />\"password\": \"magic\"<br /> }</blockquote>\n" +
                    "YAML:<br />\n" +
                    "<blockquote>---<br />somevar: somevalue<br />password: magic<br /></blockquote>\n" +
                    "<div class=\"popover-footer\"><span class=\"key\">esc</span> or click to close</div>\n";

        scope.variables = ParseVariableString(params.variables);
        scope.parseType = 'yaml';

        // Reuse password modal
        $('#password-modal').empty().html(html);
        $('#password-modal').find('textarea').before(helpContainer);
        e = angular.element(document.getElementById('password-modal'));
        $compile(e)(scope);

        buttons = [{
            label: "Cancel",
            onClick: function() {
                scope.varsCancel();
            },
            icon: "fa-times",
            "class": "btn btn-default",
            "id": "vars-cancel-button"
        },{
            label: "Continue",
            onClick: function() {
                scope.varsAccept();
            },
            icon: "fa-check",
            "class": "btn btn-primary",
            "id": "vars-accept-button"
        }];

        if (scope.removeDialogReady) {
            scope.removeDialogReady();
        }
        scope.removeDialogReady = scope.$on('DialogReady', function() {
            Wait('stop');
            $('#password-modal').dialog('open');
            setTimeout(function() {
                TextareaResize({
                    scope: scope,
                    textareaId: 'job_variables',
                    modalId: 'password-modal',
                    formId: 'job_form',
                    parse: true
                });
            }, 300);
        });

        CreateDialog({
            id: 'password-modal',
            scope: scope,
            buttons: buttons,
            width: 575,
            height: 530,
            minWidth: 450,
            title: 'Extra Variables',
            onResizeStop: function() {
                TextareaResize({
                    scope: scope,
                    textareaId: 'job_variables',
                    modalId: 'password-modal',
                    formId: 'job_form',
                    parse: true
                });
            },
            beforeDestroy: function() {
                if (scope.codeMirror) {
                    scope.codeMirror.destroy();
                }
                $('#password-modal').empty();
            },
            onOpen: function() {
                $('#job_variables').focus();
            },
            callback: 'DialogReady'
        });

        scope.varsCancel = function() {
            $('#password-modal').dialog('close');
            parent_scope.$emit('CancelJob');
            scope.$destroy();
        };

        scope.varsAccept = function() {
            job.extra_vars = ToJSON(scope.parseType, scope.variables, true);
            Wait('start');
            Rest.setUrl(GetBasePath('jobs') + job.id + '/');
            Rest.put(job)
                .success(function() {
                    Wait('stop');
                    $('#password-modal').dialog('close');
                    parent_scope.$emit(callback);
                    scope.$destroy();
                })
                .error(function(data, status) {
                    ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                        msg: 'Failed updating job ' + job.id + ' with variables. PUT returned: ' + status });
                });
        };

    };
}])

// Submit request to run a playbook
.factory('PlaybookRun', ['$location','$routeParams', 'LaunchJob', 'PromptForPasswords', 'Rest', 'GetBasePath', 'Alert', 'ProcessErrors', 'Wait', 'Empty', 'PromptForCredential', 'PromptForVars',
    function ($location, $routeParams, LaunchJob, PromptForPasswords, Rest, GetBasePath, Alert, ProcessErrors, Wait, Empty, PromptForCredential, PromptForVars) {
        return function (params) {
            var scope = params.scope,
                id = params.id,
                url,
                job_template,
                new_job_id,
                new_job,
                launch_url,
                prompt_for_vars = false,
                passwords;

            url = GetBasePath('jobs') + id + '/';

            if (scope.removePostTheJob) {
                scope.removePostTheJob();
            }
            scope.removePostTheJob = scope.$on('PostTheJob', function() {
                var url = (job_template.related.jobs) ? job_template.related.jobs : job_template.related.job_template + 'jobs/';
                Wait('start');
                Rest.setUrl(url);
                Rest.post(job_template)
                    .success(function (data) {
                        new_job_id = data.id;
                        launch_url = data.related.start;
                        prompt_for_vars = data.ask_variables_on_launch;
                        new_job = data;
                        if (data.passwords_needed_to_start.length > 0) {
                            scope.$emit('PromptForPasswords', data.passwords_needed_to_start);
                        }
                        else if (data.ask_variables_on_launch) {
                            scope.$emit('PromptForVars');
                        }
                        else {
                            scope.$emit('StartPlaybookRun');
                        }
                    })
                    .error(function (data, status) {
                        var key, html;
                        if (status === 400) {
                            // there's a data problem with the job template
                            html = "<ul style=\"list-style-type: none; margin: 15px 0;\">\n";
                            for (key in data) {
                                html += "<li><strong>" + key + "</strong>: " + data[key][0] + "</li>\n";
                            }
                            html += "</ul>\n";
                            Wait('stop');
                            Alert('Job Template Error', "<p>Fix the following issues before using the template:</p>" + html, 'alert-danger');
                        }
                        else {
                            ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                               msg: 'Failed to create job. POST returned status: ' + status });
                        }
                    });
            });

            if (scope.removeCancelJob) {
                scope.removeCancelJob();
            }
            scope.removeCancelJob = scope.$on('CancelJob', function() {
                // Delete the job
                Wait('start');
                Rest.setUrl(GetBasePath('jobs') + new_job_id + '/');
                Rest.destroy()
                    .success(function() {
                        Wait('stop');
                    })
                    .error(function (data, status) {
                        ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                            msg: 'Call to ' + url + ' failed. DELETE returned status: ' + status });
                    });
            });

            if (scope.removePlaybookLaunchFinished) {
                scope.removePlaybookLaunchFinished();
            }
            scope.removePlaybookLaunchFinished = scope.$on('PlaybookLaunchFinished', function() {
                //var base = $location.path().replace(/^\//, '').split('/')[0];
                $location.path('/jobs/' + new_job_id);
            });

            if (scope.removeStartPlaybookRun) {
                scope.removeStartPlaybookRun();
            }
            scope.removeStartPlaybookRun = scope.$on('StartPlaybookRun', function() {
                LaunchJob({
                    scope: scope,
                    url: launch_url,
                    callback: 'PlaybookLaunchFinished',
                    passwords: passwords
                });
            });

            if (scope.removePromptForPasswords) {
                scope.removePromptForPasswords();
            }
            scope.removePromptForPasswords = scope.$on('PromptForPasswords', function(e, passwords_needed_to_start) {
                PromptForPasswords({ scope: scope,
                    passwords: passwords_needed_to_start,
                    callback: 'PromptForVars'
                });
            });

            if (scope.removePromptForCredential) {
                scope.removePromptForCredential();
            }
            scope.removePromptForCredential = scope.$on('PromptForCredential', function(e, data) {
                PromptForCredential({ scope: scope, template: data });
            });

            if (scope.removePromptForVars) {
                scope.removePromptForVars();
            }
            scope.removePromptForVars = scope.$on('PromptForVars', function(e, pwds) {
                passwords = pwds;
                if (prompt_for_vars) {
                    // call prompt with callback of StartPlaybookRun, passwords
                    PromptForVars({
                        scope: scope,
                        job: new_job,
                        variables: job_template.extra_vars,
                        callback: 'StartPlaybookRun'
                    });
                }
                else {
                    scope.$emit('StartPlaybookRun');
                }
            });

            if (scope.removeCredentialReady) {
                scope.removeCredentialReady();
            }
            scope.removeCredentialReady = scope.$on('CredentialReady', function(e, credential) {
                if (!Empty(credential)) {
                    job_template.credential = credential;
                    scope.$emit('PostTheJob');
                }
            });

            // Get the job or job_template record
            Wait('start');
            Rest.setUrl(url);
            Rest.get()
                .success(function (data) {
                    delete data.id;
                    job_template = data;
                    if (Empty(data.credential)) {
                        scope.$emit('PromptForCredential');
                    } else {
                        // We have what we need, submit the job
                        scope.$emit('PostTheJob');
                    }
                })
                .error(function (data, status) {
                    ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                        msg: 'Failed to get job template details. GET returned status: ' + status });
                });
        };
    }
])

// Submit SCM Update request
.factory('ProjectUpdate', ['PromptForPasswords', 'LaunchJob', 'Rest', '$location', 'GetBasePath', 'ProcessErrors', 'Alert',
    'ProjectsForm', 'Wait',
    function (PromptForPasswords, LaunchJob, Rest, $location, GetBasePath, ProcessErrors, Alert, ProjectsForm, Wait) {
        return function (params) {
            var scope = params.scope,
                project_id = params.project_id,
                url = GetBasePath('projects') + project_id + '/update/',
                project;

            if (scope.removeUpdateSubmitted) {
                scope.removeUpdateSubmitted();
            }
            scope.removeUpdateSubmitted = scope.$on('UpdateSubmitted', function() {
                // Refresh the project list after update request submitted
                if (scope.refreshJobs) {
                    Wait('stop');
                    Alert('Update Started', 'The request to start the SCM update process was submitted. ' +
                    'To monitor the update status, refresh the page by clicking the <i class="fa fa-refresh"></i> button.', 'alert-info');
                    scope.refreshJobs();
                }
                //else if (scope.refresh) {
                //    scope.refresh();
                //}
            });

            if (scope.removePromptForPasswords) {
                scope.removePromptForPasswords();
            }
            scope.removePromptForPasswords = scope.$on('PromptForPasswords', function() {
                PromptForPasswords({ scope: scope, passwords: project.passwords_needed_to_update, callback: 'StartTheUpdate' });
            });

            if (scope.removeStartTheUpdate) {
                scope.removeStartTheUpdate();
            }
            scope.removeStartTheUpdate = scope.$on('StartTheUpdate', function(e, passwords) {
                LaunchJob({ scope: scope, url: url, passwords: passwords, callback: 'UpdateSubmitted' });
            });

            // Check to see if we have permission to perform the update and if any passwords are needed
            Wait('start');
            Rest.setUrl(url);
            Rest.get()
                .success(function (data) {
                    project = data;
                    if (project.can_update) {
                        if (project.passwords_needed_to_updated) {
                            Wait('stop');
                            scope.$emit('PromptForPasswords');
                        }
                        else {
                            scope.$emit('StartTheUpdate', {});
                        }
                    }
                    else {
                        Alert('Permission Denied', 'You do not have access to update this project. Please contact your system administrator.',
                            'alert-danger');
                    }
                })
                .error(function (data, status) {
                    ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                        msg: 'Failed to lookup project ' + url + ' GET returned: ' + status });
                });
        };
    }
])


// Submit Inventory Update request
.factory('InventoryUpdate', ['PromptForPasswords', 'LaunchJob', 'Rest', '$location', 'GetBasePath', 'ProcessErrors', 'Alert', 'Wait',
    function (PromptForPasswords, LaunchJob, Rest, $location, GetBasePath, ProcessErrors, Alert, Wait) {
        return function (params) {

            var scope = params.scope,
                url = params.url,
                inventory_source;

            if (scope.removeUpdateSubmitted) {
                scope.removeUpdateSubmitted();
            }
            scope.removeUpdateSubmitted = scope.$on('UpdateSubmitted', function () {
                Wait('stop');
                // No need to do anything else. The caller should be connected to the socket server and
                // handling real-time updates
            });

            if (scope.removePromptForPasswords) {
                scope.removePromptForPasswords();
            }
            scope.removePromptForPasswords = scope.$on('PromptForPasswords', function() {
                PromptForPasswords({ scope: scope, passwords: inventory_source.passwords_needed_to_update, callback: 'StartTheUpdate' });
            });

            if (scope.removeStartTheUpdate) {
                scope.removeStartTheUpdate();
            }
            scope.removeStartTheUpdate = scope.$on('StartTheUpdate', function(e, passwords) {
                LaunchJob({ scope: scope, url: url, passwords: passwords, callback: 'UpdateSubmitted' });
            });

            // Check to see if we have permission to perform the update and if any passwords are needed
            Wait('start');
            Rest.setUrl(url);
            Rest.get()
                .success(function (data) {
                    inventory_source = data;
                    if (data.can_update) {
                        if (data.passwords_needed_to_update) {
                            Wait('stop');
                            scope.$emit('PromptForPasswords');
                        }
                        else {
                            scope.$emit('StartTheUpdate', {});
                        }
                    } else {
                        Wait('stop');
                        Alert('Permission Denied', 'You do not have access to run the inventory sync. Please contact your system administrator.',
                            'alert-danger');
                    }
                })
                .error(function (data, status) {
                    ProcessErrors(scope, data, status, null, { hdr: 'Error!',
                        msg: 'Failed to get inventory source ' + url + ' GET returned: ' + status });
                });
        };
    }
]);