@pixlcore/xyrun 1.0.2 → 1.0.4

package/README.md

@@ -8,7 +8,7 @@ To use xyRun in a xyOps Event Plugin, make sure you set the Plugin's `runner` pr
 
 ## Features
 
-- Handles monitoring procesess, network connections, CPU and memory usage of remote jobs, and passing those metrics back to xyOps.
+- Handles monitoring processes, network connections, CPU and memory usage of remote jobs, and passing those metrics back to xyOps.
 - Handles input files by creating a temporary directory for you job and pre-downloading all files from the xyOps master server.
 - Handles output files by intercepting the `files` message and uploading them directly to the xyOps master server.
 
@@ -53,6 +53,12 @@ Then wrap your remote command with a `xyrun` prefix:
 ssh user@target xyrun node /path/to/your-script.js
 ```
 
+# Script Mode
+
+When no sub-command is specified on the CLI, xyRun will look inside the job JSON data (passed in via STDIN) for a parameter named `script`.  If this is found, it is quickly written out to a temp file, made executable (775), and that is what it launches.  It is assumed that the provided `script` will contain a proper [Shebang](https://en.wikipedia.org/wiki/Shebang_%28Unix%29) line.
+
+This allows xyRun to act as a "Remote Shell Plugin" for certain xyOps jobs that require it.
+
 # Development
 
 You can install the source code by using [Git](https://en.wikipedia.org/wiki/Git) ([Node.js](https://nodejs.org/) is also required):

package/main.js

@@ -131,8 +131,30 @@ const app = {
 		var child = null;
 		var worker = {};
 		
+		// setup environment for child
 		var child_args = process.argv.slice(2);
 		var child_cmd = child_args.shift();
+		var child_opts = {
+			env: Object.assign( {}, process.env, job.secrets || {} )
+		};
+		
+		child_opts.env['XYOPS'] = 'runner-' + pkg.version;
+		child_opts.env['JOB_ID'] = job.id;
+		child_opts.env['JOB_NOW'] = job.now;
+		
+		if (!child_cmd && job.params && job.params.script) {
+			// no direct command specified, but user wants a "script" executed from the job params
+			var script_file = Path.join( job.cwd, 'xyops-script-temp-' + job.id + '.sh' );
+			child_cmd = Path.resolve(script_file);
+			child_args = [];
+			
+			// quickly write out script file and make it executable
+			Tools.mkdirpSync( job.cwd, { mode: 0o777 } );
+			fs.writeFileSync( script_file, job.params.script.replace(/\r\n/g, "\n"), { mode: 0o775 } );
+			
+			// set the cwd to the job cwd, as it's a more controlled environment
+			child_opts.cwd = job.cwd;
+		}
 		
 		if (!child_cmd) {
 			// no command!
@@ -157,11 +179,6 @@ const app = {
 		
 		console.log( "Running command: " + child_cmd, child_args );
 		
-		// setup environment for child
-		var child_opts = {
-			env: Object.assign( {}, process.env )
-		};
-		
 		// get uid / gid info for child env vars
 		if (!this.platform.windows) {
 			child_opts.uid = job.uid || process.getuid();
@@ -207,6 +224,16 @@ const app = {
 			child_opts.gid = parseInt( child_opts.gid );
 		}
 		
+		// add plugin params as env vars, expand $INLINE vars
+		if (job.params) {
+			for (var key in job.params) {
+				child_opts.env[ key.replace(/\W+/g, '_') ] = 
+					(''+job.params[key]).replace(/\$(\w+)/g, function(m_all, m_g1) {
+					return (m_g1 in child_opts.env) ? child_opts.env[m_g1] : '';
+				});
+			}
+		}
+		
 		// windows additions
 		if (this.platform.windows) {
 			child_opts.windowsHide = true;
@@ -337,7 +364,7 @@ const app = {
 			if (job.kill === 'none') {
 				// kill none, just unref and finish
 				worker.child.unref();
-				this.shutdown();
+				this.finishJob();
 				return;
 			}
 			
@@ -465,6 +492,15 @@ const app = {
 		
 		if (!job.files || !job.files.length || !Tools.isaArray(job.files)) return callback();
 		
+		if (!job.base_url) {
+			console.error("Error: Cannot upload files: Missing 'base_url' property in job data.");
+			return callback();
+		}
+		if (!job.auth_token) {
+			console.error("Error: Cannot upload files: Missing 'auth_token' property in job data.");
+			return callback();
+		}
+		
 		async.eachSeries( job.files,
 			function(file, callback) {
 				var filename = Path.basename(file.filename || file.path).replace(/[^\w\-\+\.\,\s\(\)\[\]\{\}\'\"\!\&\^\%\$\#\@\*\?\~]+/g, '_');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pixlcore/xyrun",
-	"version": "1.0.2",
+	"version": "1.0.4",
 	"description": "Remote job runner script for xyOps.",
 	"author": "Joseph Huckaby <jhuckaby@pixlcore.com>",
 	"homepage": "https://github.com/pixlcore/xyrun",