mobilize-ssh 1.298 → 1.299

data/README.md

@@ -215,14 +215,21 @@ Start
 ### Create Job
 
 * For mobilize-ssh, the following task is available:
-  * ssh.run `node: <node_alias>, cmd: <command>, user: user, sources:[*<source_paths>]`, which reads sources, copies them to a temporary folder on the selected node, and runs the command inside that folder. 
-  * user, sources, and node are optional; cmd is required. 
+  * ssh.run `node: <node_alias>, cmd: <command>, user: user, sources:[*<source_paths>], params:[{<key,value pairs>}]`, which reads sources, copies them to a temporary folder on the selected node, and runs the command inside that folder. 
+  * user, sources, node, and params are optional; cmd is required. 
   * specifying user will cause the command to be prefixed with sudo su <user> -c. 
     * non-google sources will also be read as the specified user.
   * git sources can be specified with syntax `git://<domain>/<repo_owner>/<repo_name>/<file_path>`. 
     * Accessing private repos requires that you add the Mobilize public key to the repository as a deploy key.
       * there is no user-level access control for git repositories at this time.
     * domain defaults to the first one listed, if not included.
+  * params are also optional for all of the below. They replace tokens in sources and the command.
+    * params are passed as a YML or JSON, as in:
+      * `ssh.run source:<source_path>, params:{'date':'2013-03-01', 'unit':'widgets'}`
+        * this example replaces all the keys, preceded by '@' in all source hqls with the value.
+          * The preceding '@' is used to keep from replacing instances
+            of "date" and "unit" in the command/source file; you should have `@date` and `@unit` in your actual HQL 
+            if you'd like to replace those tokens.
   * not specifying node will cause the command to be run on the default node.
   * ssh sources can be specified with syntax
 `ssh://<node><file_full_path>`. If node is omitted, default node will be used.

data/lib/mobilize-ssh/handlers/ssh.rb

@@ -67,22 +67,21 @@ module Mobilize
       return true
     end
 
-    def Ssh.run(node,command,user,file_hash={},params={})
-      default_user = Ssh.host(node)['user']
+    def Ssh.run(node,command,user_name,file_hash={},run_params=nil)
+      default_user_name = Ssh.host(node)['user']
       file_hash ||= {}
+      run_params ||={}
       #make sure the dir for this command is clear
-      comm_md5 = [user,node,command,file_hash.keys.to_s,Time.now.to_f.to_s].join.to_md5
+      comm_md5 = [user_name,node,command,file_hash.keys.to_s,Time.now.to_f.to_s].join.to_md5
       comm_dir = Dir.mktmpdir
-      #add in default methods to the params
-      params.merge(Ssh.default_params)
       #replace any params in the file_hash and command
-      params.each do |k,v|
-        command.gsub!(k,v)
+      run_params.each do |k,v|
+        command.gsub!("@#{k}",v)
         file_hash.each do |name,data|
-          data.gsub!(k,v)
+          data.gsub!("@#{k}",v)
         end
       end
-      #populate comm dir with any files
+     #populate comm dir with any files
       Ssh.pop_comm_dir(comm_dir,file_hash)
       #make sure user starts in rem_dir
       rem_dir = "#{comm_md5}/"
@@ -103,9 +102,9 @@ module Mobilize
       Ssh.write(node,command,cmd_path)
       full_cmd = "(cd #{rem_dir} && sh #{cmd_file})"
       #fire_cmd runs sh on cmd_path, optionally with sudo su
-      if user != default_user
+      if user_name != default_user_name
         #make sure user owns the folder and all files
-        fire_cmd = %{sudo chown -R #{user} #{rem_dir}; sudo su #{user} -c "#{full_cmd}"}
+        fire_cmd = %{sudo chown -R #{user_name} #{rem_dir}; sudo su #{user_name} -c "#{full_cmd}"}
         rm_cmd = %{sudo rm -rf #{rem_dir}}
       else
         fire_cmd = full_cmd
@@ -216,7 +215,8 @@ module Mobilize
       user_name = Ssh.user_name_by_stage_path(stage_path)
       file_hash = Ssh.file_hash_by_stage_path(stage_path,gdrive_slot)
       Gdrive.unslot_worker_by_path(stage_path)
-      result = Ssh.run(node,command,user_name,file_hash)
+      run_params = params['params']
+      result = Ssh.run(node,command,user_name,file_hash,run_params)
       #use Gridfs to cache result
       response = {}
       response['out_url'] = Dataset.write_by_url("gridfs://#{s.path}/out",result['stdout'].to_s,Gdrive.owner_name)

data/lib/mobilize-ssh/helpers/ssh_helper.rb

@@ -33,13 +33,5 @@ module Mobilize
       host_domain_name = self.host(node)['name'].split(".")[-2..-1].join(".")
       return true if self.gateway(node) and Socket.domain_name != host_domain_name
     end
-
-    def self.default_params
-      time = Time.now.utc
-      {
-       '$utc_date'=>time.strftime("%Y-%m-%d"),
-       '$utc_time'=>time.strftime("%H:%M"),
-      }
-    end
   end
 end

data/lib/mobilize-ssh/version.rb

@@ -1,5 +1,5 @@
 module Mobilize
   module Ssh
-    VERSION = "1.298"
+    VERSION = "1.299"
   end
 end

data/test/code2.sh

@@ -1 +1 @@
-tail syslog
+tail @file

data/test/ssh_job_rows.yml

@@ -3,23 +3,23 @@
   active: true
   trigger: once
   status: ""
-  stage1: 'ssh.run node:"test_node", cmd:"ruby code.rb", user:"root", sources:["code.rb", "code.sh"]'
-  stage2: 'gsheet.write source:"stage1", target:"test_ssh_1.out"'
+  stage1: ssh.run node:"test_node", cmd:"ruby code.rb", user:"root", sources:["code.rb", "code.sh"]
+  stage2: gsheet.write source:"stage1", target:"test_ssh_1.out"
 - name: test_ssh_2
   active: true
   trigger: "after test_ssh_1"
   status: ""
-  stage1: 'ssh.run cmd:"sh code2.sh", user:"root", sources:["code2.sh","test_node/var/log/syslog"]'
-  stage2: 'gsheet.write source:"stage1", target:"test_ssh_2.out"'
+  stage1: ssh.run cmd:"sh code2.sh", user:"root", sources:["code2.sh","test_node/var/log/syslog"], params:{file:"syslog"}
+  stage2: gsheet.write source:"stage1", target:"test_ssh_2.out"
 - name: test_ssh_3
   active: true
   trigger: "after test_ssh_2"
   status: ""
-  stage1: 'ssh.run cmd:"whoami"'
-  stage2: 'gsheet.write source:"stage1", target:"test_ssh_3.out"'
+  stage1: ssh.run cmd:"echo '@test_param'", params:{test_param:"test param successful"}
+  stage2: gsheet.write source:"stage1", target:"test_ssh_3.out"
 - name: test_ssh_4
   active: true
   trigger: "after test_ssh_3"
   status: ""
-  stage1: 'ssh.run node:"test_node", user:root, sources:["git://DeNA/mobilize-ssh/test/code.rb","git://DeNA/mobilize-ssh/test/code.sh"], cmd:"ruby code.rb"'
-  stage2: 'gsheet.write source:stage1, target:"test_ssh_4.out"'
+  stage1: ssh.run node:"test_node", user:root, sources:["git://DeNA/mobilize-ssh/test/code.rb","git://DeNA/mobilize-ssh/test/code.sh"], cmd:"ruby code.rb"
+  stage2: gsheet.write source:stage1, target:"test_ssh_4.out"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobilize-ssh
 version: !ruby/object:Gem::Version
-  version: '1.298'
+  version: '1.299'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mobilize-base
@@ -119,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2943604812785338750
+      hash: 1792150884808390636
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2943604812785338750
+      hash: 1792150884808390636
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25