symphony-ssh 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 051cdb537eac2fcc9d75f9f3c710a698e9aa719488cf70eb08754700bd76bb96
-  data.tar.gz: d3e9a47c6af77ac7b537f5ca3ef1927f786c1dc191e048716f641e78e546c8b4
+  metadata.gz: f30fb65c28ed9ed46e7e4778e1a53ddc6a62e56c2d966ec51a7bf386bf111fb2
+  data.tar.gz: 8fb32494e41a1836deade9158906a803f16afa1b65baa350cf46936cec49525e
 SHA512:
-  metadata.gz: 45fc21828ed7e87666a90ca5c8cbd43ef145b0fe4d213d130cf3f804da85029aff96677a588994f1c6966b6718e5e3b59a30af816d1b49a18516b25dcab56482
-  data.tar.gz: d8129926634371f20491d07b28e3ff8d426d60c1e89aeea7d5ddc991eb9ea6d5d435be1643254025ec6ed756414e224bd8089c53b0fc0a994b97c486513d1612
+  metadata.gz: 73e175a3c18dfdcfd473d36ec4d2b8e47c4b613d7ceee7ef42dda2652a14f41c2fdc6e2c000fe13255115cb56cab582b235b30a4e5b780eae47fcf59b3304888
+  data.tar.gz: b2cbc3bbb891de3bc13d1623b2658b7dc6a0d7712135a11826a04a307d530e78d42ab751872e3c32647e4daec9a1629d7254a95aac517c733432b39168b94c3b

data/lib/symphony/tasks/sshscript.rb

@@ -27,7 +27,9 @@ require 'symphony/tasks/ssh'
 ###    key:        (optional) The path to an SSH private key
 ###    attributes: (optional) Additional data to attach to the template
 ###    nocleanup:  (optional) Leave the remote script after execution? (default to false)
-###    tempdir:    (optional) The destination temp directory.  (defaults to /tmp)
+###    delete_cmd: (optional) The command to delete the remote script.  (default to 'rm')
+###    run_binary: (optional) Windows doesn't allow direct execution of scripts, this is prefixed to the remote command if present.
+###    tempdir:    (optional) The destination temp directory.  (defaults to /tmp/, needs to include the separator character)
 ###
 ###
 ### Additionally, this class responds to the 'symphony.ssh' configurability
@@ -79,11 +81,9 @@ class Symphony::Task::SSHScript < Symphony::Task
 	def work( payload, metadata )
 		template   = payload[ 'template' ]
 		attributes = payload[ 'attributes' ] || {}
-		port       = payload[ 'port' ]    || 22
 		user       = payload[ 'user' ]    || Symphony::Task::SSH.user
 		key        = payload[ 'key'  ]    || Symphony::Task::SSH.key
-		nocleanup  = payload[ 'nocleanup' ]
-		tempdir    = payload[ 'tempdir' ] || '/tmp'
+		tempdir    = payload[ 'tempdir' ] || '/tmp/'
 
 		raise ArgumentError, "Missing required option 'template'" unless template
 		raise ArgumentError, "Missing required option 'host'"     unless payload[ 'host' ]
@@ -91,7 +91,17 @@ class Symphony::Task::SSHScript < Symphony::Task
 		remote_filename = self.make_remote_filename( template, tempdir )
 		source = self.generate_script( template, attributes )
 
-		ssh_options = DEFAULT_SSH_OPTIONS.merge( port: port, keys: Array(key) )
+		# Map any configuration parameters in the payload to ssh
+		# options, for potential per-message behavior overrides.
+		ssh_opts_override = payload.
+			slice( *DEFAULT_SSH_OPTIONS.keys.map( &:to_s ) ).
+			transform_keys{|k| k.to_sym }
+
+		ssh_options = DEFAULT_SSH_OPTIONS.dup.merge!(
+			ssh_opts_override,
+			port: payload[ 'port' ] || 22,
+			keys: Array( key )
+		)
 		ssh_options.merge!(
 			logger: Loggability[ Net::SSH ],
 			verbose: :debug
@@ -103,7 +113,7 @@ class Symphony::Task::SSHScript < Symphony::Task
 			self.upload_script( conn, source, remote_filename )
 			self.log.debug "  done with the upload."
 
-			self.run_script( conn, remote_filename, nocleanup )
+			self.run_script( conn, remote_filename, payload )
 			self.log.debug "Output was:\n#{@output}"
 		end
 
@@ -118,9 +128,9 @@ class Symphony::Task::SSHScript < Symphony::Task
 	### Generate a unique filename for the script on the remote host,
 	### based on +template+ name.
 	###
-	def make_remote_filename( template, tempdir="/tmp" )
+	def make_remote_filename( template, tempdir="/tmp/" )
 		basename = File.basename( template, File.extname(template) )
-		tmpname  = "%s/%s-%s" % [
+		tmpname  = "%s%s-%s" % [
 			tempdir,
 			basename,
 			SecureRandom.hex( 6 )
@@ -153,11 +163,16 @@ class Symphony::Task::SSHScript < Symphony::Task
 
 
 	### Run the +remote_filename+ via the ssh +conn+.  The script
-	### will be deleted automatically unless +nocleanup+ is true.
+	### will be deleted automatically unless +nocleanup+ is set
+	### in the payload.
 	###
-	def run_script( conn, remote_filename, nocleanup=false )
-		@output = conn.exec!( remote_filename )
-		conn.exec!( "rm #{remote_filename}" ) unless nocleanup
+	def run_script( conn, remote_filename, payload )
+		delete_cmd = payload[ 'delete_cmd' ] || 'rm'
+		command    = remote_filename
+		command    = "%s %s" % [ payload['run_binary'], remote_filename ] if payload[ 'run_binary' ]
+
+		@output = conn.exec!( command )
+		conn.exec!( "#{delete_cmd} #{remote_filename}" ) unless payload[ 'nocleanup' ]
 	end
 
 end # Symphony::Task::SSHScript

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symphony-ssh
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mahlon E. Smith
@@ -11,9 +11,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQ8wDQYDVQQDDAZtYWhs
+  MIIDMDCCAhigAwIBAgIBAjANBgkqhkiG9w0BAQsFADA+MQ8wDQYDVQQDDAZtYWhs
   b24xFzAVBgoJkiaJk/IsZAEZFgdtYXJ0aW5pMRIwEAYKCZImiZPyLGQBGRYCbnUw
-  HhcNMTcxMTIyMjIyMTAyWhcNMTgxMTIyMjIyMTAyWjA+MQ8wDQYDVQQDDAZtYWhs
+  HhcNMjAwNzA5MjIxMzE4WhcNMjEwNzA5MjIxMzE4WjA+MQ8wDQYDVQQDDAZtYWhs
   b24xFzAVBgoJkiaJk/IsZAEZFgdtYXJ0aW5pMRIwEAYKCZImiZPyLGQBGRYCbnUw
   ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDpXGN0YbMVpYv4EoiCxpQw
   sxKdyhlkvpvENUkpEhbpnEuMKXgUfRHO4T/vBZf0h8eYgwnrHCRhAeIqesFKfoj9
@@ -21,17 +21,16 @@ cert_chain:
   Fht9ppCuNmxJNd+L3zAX8lD01RUWNRC+8L5QLCjViJtjFDDCFfh9NCirs+XnTCzo
   AJgFbsZIzFJtSiXUtFgscKr4Ik8ruhRbPbYbmx9rf6W74aTMPxggq/d3gj0Eh32y
   WsXsQ5giVnmkbsRkBNu3QyZ8Xr5+7mvy5AWyqXKOrcW7lnYaob6Z9x/MGXGNeD6j
-  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRY8ea6
-  +6kAaW7ukKph2/4MTAD8/TAcBgNVHREEFTATgRFtYWhsb25AbWFydGluaS5udTAc
-  BgNVHRIEFTATgRFtYWhsb25AbWFydGluaS5udTANBgkqhkiG9w0BAQUFAAOCAQEA
-  00FljTeSNaYUqJ59yLRA+i43wVNiO4ETQQu6fYQCPns12Sm90spOJb3SmTDkJ7CY
-  dixOQg5A3Et1LVS+Z/YfH1TAbb50oTWbZbTW2JknHS0hohq3UF1pvbkk1niZ26er
-  skJ352MUfcyaUkQyMmCjL/BpkDutYH5OCGh+FmK8+mH7SoC9Nr48WwH2prVdHs3y
-  OMWFgB33sXdj1XqOd2Rw1WPgAeMeDqWeIrRMpUhNZOwroaA1MAr60f9NIYxua/vx
-  n0YyneERGuHPSRZFgo72tGOqLpAlWnhPxRNqnayZmsg3hPPI87B6MTUI2UQ7VUdh
-  UrSf3b+cPoC8PNfjp8zsdw==
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRY8ea6
+  +6kAaW7ukKph2/4MTAD8/TANBgkqhkiG9w0BAQsFAAOCAQEAryZehbiEumHsUsce
+  FoBVuDoVdlJf8ae11G8IPXnEHCT8S5b+MBSYd55V3aGQm4bKoZA3GmmD8Y0a+oxt
+  l2kkTvE0r1bBb/qYQI97AjnqzHByseBRoaHtJ12JtrDEdi8y4jd5AJt4aW+G/roD
+  I2/ymUodKw9Cteom0RdJNzBUJ+Bq+qFOy7mVKNIfhXRRFYEy11y1712FsJXqUEku
+  qr3lnAEvEy9hQila4NoJT2+aQEKsjVON9D3a727naKDFUcKDg6P4KqS+yOKgR+QH
+  D8llK3JPaqKXuJkbd8jKchDk0Q+fA8Klan5SSnm7pMD51QM1mPsVPm5bEw5ib0bn
+  oR3hTQ==
   -----END CERTIFICATE-----
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configurability