Plugin API: Two new APIs: test_monitor_plugin, and test_scheduler_plugin.

- These APIs care called from the Edit Plugin page, and can test monitor/schedule plugins on demand, reporting results back to the client.

Author: jhuckaby

lib/api/plugins.js

@@ -172,6 +172,129 @@ class Plugins {
 		} ); // loadSession
 	}
 
+	api_test_monitor_plugin(args, callback) {
+		// test existing monitor plugin
+		var self = this;
+		var params = args.params;
+		if (!this.requireMaster(args, callback)) return;
+		
+		if (!this.requireParams(params, {
+			id: /^\w+$/,
+			server: /^\w+$/
+		}, callback)) return;
+		
+		this.loadSession(args, function(err, session, user) {
+			if (err) return self.doError('session', err.message, callback);
+			if (!self.requireValidUser(session, user, callback)) return;
+			if (!self.requirePrivilege(user, 'edit_plugins', callback)) return;
+			
+			args.user = user;
+			args.session = session;
+			
+			var plugin = Tools.findObject( self.plugins, { id: params.id, type: 'monitor' } );
+			if (!plugin) return self.doError('api', "Monitor Plugin not found: " + params.id, callback);
+			
+			var server = self.servers[ params.server ];
+			if (!server) return self.doError('api', "Server not found: " + params.server, callback);
+			
+			if (!server.info.features || !server.info.features.testMonitorPlugin) {
+				return self.doError('api', "Server does not support testing monitor plugins (please upgrade xySat)", callback);
+			}
+			
+			self.logDebug(5, "Testing remote monitor plugin", params);
+			
+			args._xy_remote_timer = setTimeout( function() {
+				if (!callback) return; // sanity
+				callback({ code: 0, result: "Error: Remote plugin test has timed out (10 seconds)." });
+				callback = null;
+				delete args._xy_remote_timer;
+				delete args._xy_finish;
+			}, 10 * 1000 );
+			
+			args._xy_finish = function(data) {
+				// called by handleMonitorPluginTestResult in comm.js
+				if (!callback) return; // sanity
+				if (args._xy_remote_timer) { 
+					clearTimeout(args._xy_remote_timer); 
+					delete args._xy_remote_timer; 
+				}
+				callback({ code: 0, ...data });
+				callback = null;
+				delete args._xy_finish;
+			};
+			
+			self.doServerBroadcast( server.id, 'testMonitorPlugin', { plugin_id: plugin.id, request_id: args.id } );
+		} ); // loadSession
+	}
+	
+	api_test_scheduler_plugin(args, callback) {
+		// test existing scheduler plugin
+		var self = this;
+		var params = args.params;
+		if (!this.requireMaster(args, callback)) return;
+		
+		if (!this.requireParams(params, {
+			id: /^\w+$/
+		}, callback)) return;
+		
+		this.loadSession(args, function(err, session, user) {
+			if (err) return self.doError('session', err.message, callback);
+			if (!self.requireValidUser(session, user, callback)) return;
+			if (!self.requirePrivilege(user, 'edit_plugins', callback)) return;
+			
+			args.user = user;
+			args.session = session;
+			
+			var plugin = Tools.findObject( self.plugins, { id: params.id, type: 'scheduler' } );
+			if (!plugin) return self.doError('api', "Scheduler Plugin not found: " + params.id, callback);
+			
+			self.logDebug(5, "Testing scheduler plugin", params);
+			
+			// prep timezone and time stuff
+			var now = Tools.normalizeTime( params.epoch || Tools.timeNow(true), { sec: 0 } );
+			var date = new Date( now * 1000 );
+			var tz = params.timezone || self.config.get('tz') || Intl.DateTimeFormat().resolvedOptions().timeZone;
+			var days = { Sunday: 0, Monday: 1, Tuesday: 2, Wednesday: 3, Thursday: 4, Friday: 5, Saturday: 6 };
+			var formatter = new Intl.DateTimeFormat('en-US', 
+				{ year: 'numeric', month: '2-digit', day: 'numeric', weekday: 'long', hour: 'numeric', minute: '2-digit', hourCycle: 'h23', timeZone: tz }
+			);
+			
+			var tzargs = {};
+			formatter.formatToParts(date).forEach( function(part) {
+				if (part.type == 'literal') return;
+				if (part.type == 'weekday') tzargs[ part.type ] = days[ part.value ];
+				else tzargs[ part.type ] = parseInt( part.value );
+			} );
+			
+			// include reverse-month-day (rday): -1 is last day of month, -2 is 2nd-to-last day, etc.
+			tzargs.rday = (tzargs.day - self.getLastDayInMonth( tzargs.year, tzargs.month )) - 1;
+			
+			// items: [{ plugin_id, params, timezone, dargs, now, job }]
+			var items = [
+				{
+					plugin_id: plugin.id,
+					params: params.params || {},
+					timezone: tz,
+					dargs: tzargs,
+					now: now,
+					job: {
+						id: "1234567890",
+						label: "Test"
+					}
+				}
+			];
+			
+			self.execSchedulerPlugin(plugin, items, false, function(resp) {
+				// massage results for test API
+				// resp: { code, description? data?, stdout?, stderr?, child_cmd? }
+				if (resp.code) resp.err = true;
+				resp.code = 0;
+				callback(resp);
+			});
+			
+		} ); // loadSession
+	}
+	
 	api_delete_plugin(args, callback) {
 		// delete existing plugin
 		var self = this;