const ssh2_exec = require('../ssh/ssh2_exec'); const scp2_exec = require('../scp/scp_exec'); const config = require('../../config/environment'); const util = require('util'); const Q = require("q"); const all_commands = require('../../config/commands'); const logger = require('../logger/logger'); const local_logPath = 'logs/ansible/execute/'; /** * Get Logs * @param logfilename * @param successCallback * @param errorCallback */ exports.getLogs = function(logfilename,successCallback,errorCallback){ let logFile = local_logPath + logfilename; logger.log('info', 'Get Logs - %s', logFile); const fs = require('fs'); fs.readFile(logFile, function(err, data){ if(err){ errorCallback(err); }else{ successCallback(data); } }); }; /** * Get Modules including any custom modules for this project. * Set ANSIBLE_LIBRARY path to custom modules path for this purpose * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.getModules = function(dataCallback, successCallback,errorCallback, ansibleEngine){ var command = all_commands.ansible.doc; if(ansibleEngine.customModules){ command = util.format(all_commands.ansible.export_ansible_library, ansibleEngine.customModules) + command; } ssh2_exec.executeCommand(command, null, function(data){ successCallback(data); }, function(data){ errorCallback(data) }, ansibleEngine ) }; /** * Get Ansible Version from Ansible Engine * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.getAnsibleVersion = function(successCallback,errorCallback, ansibleEngine){ var command = all_commands.ansible.version; var ansibleVersionResult = ""; ssh2_exec.executeCommand(command, null, function(data){ ansibleVersionResult=data; logger.info('Ansible Verison = %s', ansibleVersionResult); ansibleVersionResult = "" + ansibleVersionResult; var version = ansibleVersionResult.replace(/ansible (.*)[^]+/,"$1"); logger.info("Version=" + version); successCallback(version || ansibleVersionResult); }, function(data){ errorCallback(data) }, ansibleEngine ) }; /** * Get/generate Ansible Command * @param project_folder * @param playbook_name * @param inventory_file_name * @param tags_joined * @param limit_to_hosts_joined * @param verbose * @param check_mode * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine * @returns {string} */ exports.getAnsibleCommand = function(project_folder, playbook_name, inventory_file_name, tags_joined, limit_to_hosts_joined, verbose,check_mode,dataCallback, successCallback,errorCallback,ansibleEngine){ var command = util.format(all_commands.ansible.export_force_color + all_commands.ansible.export_host_key_check + 'cd %s; ' + all_commands.ansible.playbook , 'true', 'False', project_folder, playbook_name, inventory_file_name) if(ansibleEngine.customModules){ command = 'export ANSIBLE_LIBRARY="' + ansibleEngine.customModules + '"; ' + command; } // Add options to command as necessary if(tags_joined) command += ' --tags "' + tags_joined + '"'; if(limit_to_hosts_joined) command += ' --limit "' + limit_to_hosts_joined + '"'; if(verbose === 'verbose_detail'){ command += ' -vvv '; } else if(verbose === 'verbose'){ command += ' -v '; } if(check_mode !== 'No_Check'){ command += ' --check '; } logger.info('command = %s', command); return command; }; /** * Execute Ansible Playbook * @param logfilename * @param project_folder * @param playbook_name * @param inventory_file_name * @param tags_joined * @param limit_to_hosts_joined * @param verbose * @param check_mode * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.executeAnsible = function(logfilename, project_folder, playbook_name, inventory_file_name, tags_joined, limit_to_hosts_joined, verbose,check_mode,dataCallback, successCallback,errorCallback,ansibleEngine){ var fs = require('filendir'); var time = new Date().getTime(); var logFile = local_logPath + logfilename; // Capture output of execution in a separate log file // TODO: Improve fs.writeFileSync(logFile,"Executing Ansible Playbook \n\n",{'flag':'a'}); fs.writeFileSync(logFile," Completed \n",{'flag':'a'}); var command = exports.getAnsibleCommand(project_folder, playbook_name, inventory_file_name, tags_joined, limit_to_hosts_joined, verbose,check_mode,dataCallback, successCallback,errorCallback,ansibleEngine); fs.writeFile(logFile,"\n Executing Command =" + command + "\n"); ssh2_exec.executeCommand(command,function(response){ //Calling datacallbcak back as the call is Asynchronous //Logs are queried to check status dataCallback(response); logger.info('%s', response); //fs.writeFile(logFile,response,{'flag':'a'}); fs.writeFile(logFile,"\n Executing Command =" + command + "\n" + response); },function(response){ successCallback(response); logger.info('%s', response); //fs.writeFile(logFile,response,{'flag':'a'}); },function(response){ errorCallback(response); logger.error('Ansible Execution error = %s', response); fs.writeFile(logFile,response,{'flag':'a'}); },ansibleEngine, true //addScriptEndString ) }; /** * Get Vars * @param project_folder * @param inventory_file_name * @param host_name * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.getVars = function(project_folder, inventory_file_name, host_name, dataCallback, successCallback,errorCallback,ansibleEngine){ var fs = require('filendir'); var AnsibleAPILocation = config.paths.ansible_custom_api_remote; var command = util.format(all_commands.ansible.get_vars, project_folder, AnsibleAPILocation, inventory_file_name); if(host_name){ command += ' --host_name ' + host_name; } if(ansibleEngine.customModules){ command = 'export ANSIBLE_LIBRARY="' + ansibleEngine.customModules + '"; ' + command; } logger.info('Command= %s', command); // Copy helper script to Ansible Engine scp2_exec.copyFileToScriptEngine(config.paths.ansible_custom_api_local,AnsibleAPILocation,ansibleEngine,function(){ ssh2_exec.executeCommand(command,null,successCallback,errorCallback,ansibleEngine); }, errorCallback); }; /** * Get Role Vars * @param project_folder * @param role_name * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.getRolesVars = function(project_folder, role_name, dataCallback, successCallback,errorCallback,ansibleEngine){ var AnsibleAPILocation = + config.paths.ansible_custom_api_remote; var project_roles_folder = project_folder + config.paths.ansible_project_roles; var playbook_path = role_name + '/tests/test.yml'; var command = util.format(all_commands.ansible.get_role_vars,project_roles_folder, AnsibleAPILocation, playbook_path); if(ansibleEngine.customModules){ command = 'export ANSIBLE_LIBRARY="' + ansibleEngine.customModules + '"; ' + command; } logger.info('Command= %s', command); scp2_exec.copyFileToScriptEngine(config.paths.ansible_custom_api_local,AnsibleAPILocation,ansibleEngine,function(){ ssh2_exec.executeCommand(command,null,successCallback,errorCallback,ansibleEngine); }, errorCallback); }; /** * Write File * @param file_path * @param file_contents * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.writeFile = function(file_path,file_contents, successCallback,errorCallback,ansibleEngine){ scp2_exec.createFileOnScriptEngine(file_contents, file_path, function(){ successCallback('file written'); },function(err){ errorCallback(err); },ansibleEngine); }; /** * Delete File * @param file_path * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.deleteFile = function(file_path,successCallback,errorCallback,ansibleEngine){ var command = util.format(all_commands.general.remove_file, file_path); ssh2_exec.executeCommand(command,null,successCallback,errorCallback,ansibleEngine) }; /** * Read Contents of a file * @param file_path * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.readFile = function(file_path, dataCallback, successCallback,errorCallback,ansibleEngine){ var command = util.format(all_commands.general.read_file, file_path); ssh2_exec.executeCommand(command,null,successCallback,errorCallback,ansibleEngine) }; /** * Write to a Playbook file * @param project_folder * @param playbook_file_name * @param playbook_file_contents * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.writePlaybook = function(project_folder,playbook_file_name,playbook_file_contents, successCallback,errorCallback,ansibleEngine){ var playbook_file_path = '' + project_folder + '/' + playbook_file_name + ''; logger.info('playbook_file_path= %s', playbook_file_path); scp2_exec.createFileOnScriptEngine(playbook_file_contents, playbook_file_path, function(){ console.log('playbook_file written'); successCallback('playbook_file written'); },function(err){ errorCallback(err); },ansibleEngine); }; /** * Read Playbook file contents * @param project_folder * @param playbook_file_name * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.readPlaybook = function(project_folder,playbook_file_name, dataCallback, successCallback,errorCallback,ansibleEngine){ var playbook_file_path = project_folder + '/' + playbook_file_name; var command = util.format(all_commands.general.read_file, playbook_file_path); ssh2_exec.executeCommand(command,null,successCallback,errorCallback,ansibleEngine) }; /** * Delete Playbook * @param project_folder * @param playbook_file_name * @param dataCallback * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.deletePlaybook = function(project_folder,playbook_file_name, dataCallback, successCallback,errorCallback,ansibleEngine){ var playbook_file_path = project_folder + '/' + playbook_file_name; var command = util.format(all_commands.general.remove_file, playbook_file_path); ssh2_exec.executeCommand(command,null,successCallback,errorCallback,ansibleEngine) }; /** * Get Playbook List * List all files with .yml extension in the folder and return list of files as array * @param project_folder * @param successCallback * @param errorCallback * @param ansibleEngine */ exports.getPlaybookList = function(project_folder, successCallback, errorCallback, ansibleEngine){ var playbook_file_path = project_folder + '/'; var command = util.format(all_commands.ansible.get_playbook_list, playbook_file_path); var ansiblePlaybookListResults = ""; ssh2_exec.executeCommand(command, null, function(data){ ansiblePlaybookListResults=data; var files = []; if(ansiblePlaybookListResults) files = ansiblePlaybookListResults.trim().split('\n'); successCallback(files); }, errorCallback, ansibleEngine ) }; /** * Get list of roles from project * @param project_folder - Project root folder * @param successCallback - Success Callback method * @param errorCallback - Error Callback method * @param ansibleEngine - Remote Ansible Engine details */ exports.getRolesList = function(project_folder, successCallback, errorCallback, ansibleEngine){ var playbook_file_path = project_folder + config.paths.ansible_project_roles; var command = util.format(all_commands.general.list_folder_contents, playbook_file_path); var ansibleRolesListResults = ""; ssh2_exec.executeCommand(command, null, function(data){ ansibleRolesListResults=data; var roles = []; if(ansibleRolesListResults) roles = ansibleRolesListResults.trim().split('\n'); successCallback(roles); }, errorCallback, ansibleEngine ) }; /** * Create Project Folder * @param project_folder - Project folder to create * @param successCallback * @param errorCallback * @param ansibleEngine - Remote Ansible Engine details */ exports.createProjectFolder = function(project_folder, successCallback, errorCallback, ansibleEngine){ var librarypath = project_folder + config.paths.ansible_project_library; var rolespath = project_folder + config.paths.ansible_project_roles; var command = util.format(all_commands.ansible.create_ansible_project_folder, librarypath, rolespath); var check_dir_command = util.format(all_commands.general.check_dir_not_exists, project_folder); ssh2_exec.executeCommand(check_dir_command,null,function(data){ ssh2_exec.executeCommand(command,null,successCallback,errorCallback,ansibleEngine); },function(){ errorCallback("Directory - " + project_folder +" already exists. Try a different Project Folder path.") },ansibleEngine); }; /** * Delete Project Folder * @param project */ exports.deleteProjectFolder = function(project){ var deferred = Q.defer(); if(!project){ deferred.reject(new Error("Project not found ")); return deferred.promise; } var ansibleEngine = project.ansibleEngine; var project_folder = ansibleEngine.projectFolder; var archive_folder = config.paths.ansible_projects + config.paths.ansible_projects_arhive; var command = util.format(all_commands.general.archive_folder, archive_folder, archive_folder, ansibleEngine.projectFolderName, project_folder, project_folder); var check_dir_command = util.format(all_commands.general.check_dir_exists, project_folder); ssh2_exec.executeCommand(check_dir_command,null,(data) => { ssh2_exec.executeCommand(command,null, (success_response) => { deferred.resolve(project); },(error_response) => { deferred.reject(new Error(error_response)); },ansibleEngine); },() => { deferred.reject(new Error("Directory - " + project_folder +" does not exist.")); },ansibleEngine); return deferred.promise; }; /** * Search roles in ansible-galaxy * Use ansible-galaxy search command * @param searchText - Text to search * @param successCallback * @param errorCallback * @param ansibleEngine - Remote Ansible Engine details */ exports.searchRolesGalaxy = function(searchText, successCallback, errorCallback, ansibleEngine){ var command = util.format(all_commands.ansible.ansible_galaxy_search, searchText); ssh2_exec.executeCommand(command,null,function(response){ if(response.indexOf('No roles match your search.') > -1){ return errorCallback('No roles match your search.') }else{ var str = response.replace(/[^]+--\n([^]+)/g,'$1'); var re = /\s+(.*?)\s+(.*)/gm; var m; var results = []; while ((m = re.exec(str)) !== null) { if (m.index === re.lastIndex) { re.lastIndex++; } // View your result using the m-variable. // eg m[0] etc. results.push({'name':m[1],'description':m[2],'type':'galaxy'}) } successCallback(results); } }, errorCallback,ansibleEngine); }; /** * Search Roles in GitHub * Uses uri https://api.github.com/search/repositories?q=ansible-role- * @param searchText * @param successCallback * @param errorCallback */ exports.searchRolesGithub = function(searchText, successCallback, errorCallback){ var https = require('https'); var options = all_commands.ansible.github_search_api_options; options.path = util.format(options.path, searchText); var req = https.get(options, function(res) { logger.info('STATUS: ' + res.statusCode); logger.info('HEADERS: ' + JSON.stringify(res.headers)); logger.info('DATA: ' + JSON.stringify(res.data)); // Buffer the body entirely for processing as a whole. var bodyChunks = []; res.on('data', function(chunk) { // You can process streamed parts here... bodyChunks.push(chunk); }).on('end', function() { var body = Buffer.concat(bodyChunks); logger.info('BODY: ' + body); var json_results = JSON.parse(body); var results = []; logger.info("Search Results = " + json_results.total_count); for(var i=0;i