Module: TorqueVPCToolkit

Includes:
ChefVPCToolkit
Defined in:
lib/torque-vpc-toolkit.rb

Constant Summary collapse

TORQUE_VPC_TOOLKIT_ROOT = 
File.dirname(File.expand_path("./", File.dirname(__FILE__)))

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.get_jobs(ip, configs) ⇒ Object 



181
182
183
184
185
186
187
188
 
# File 'lib/torque-vpc-toolkit.rb', line 181

def self.get_jobs(ip, configs)
      xml=HttpUtil.get(
                       "https://#{ip}/jobs.xml",
                       configs["torque_job_control_username"],
                       configs["torque_job_control_password"]
                       )
     return TorqueVPCToolkit.jobs_list(xml)
end

.job_control_credentials(ip_addr) ⇒ Object

parse the torque_server role for job_control credentials



240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/torque-vpc-toolkit.rb', line 240

def self.job_control_credentials(ip_addr)
	role_text=%x{ssh root@#{ip_addr} /usr/bin/knife role show torque_server}
	json=JSON.parse(role_text.gsub(/\"json_class\"[^,]*,/, ''))
	username=json["override_attributes"]["job_control"]["auth_username"]
	password=json["override_attributes"]["job_control"]["auth_password"]
	if block_given?
		yield username, password
	else
		{
		"torque_job_control_username" => username,
		"torque_job_control_password"=> password
		}
	end
end

.job_hash(vpn_gateway, job_id, configs = Util.load_configs) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/torque-vpc-toolkit.rb', line 168

def self.job_hash(vpn_gateway, job_id, configs=Util.load_configs)
	if job_id.nil? or job_id.empty? then
		raise "A valid job_id is required."
	end
	xml=HttpUtil.get(
		"https://#{vpn_gateway}/jobs/#{job_id}.xml",
		configs["torque_job_control_username"],
		configs["torque_job_control_password"]
	)
	TorqueVPCToolkit.jobs_list(xml)[0]

end

.jobs_list(xml) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/torque-vpc-toolkit.rb', line 13

def self.jobs_list(xml)
	list=[]
	dom = REXML::Document.new(xml)

	REXML::XPath.each(dom, "//job") do |job|
		job_attrs = {
			"id" => job.elements["id"].text,
			"description" => job.elements["description"].text,
			"queue-job-id" => job.elements["queue-job-id"].text,
			"resources" => job.elements["resources"].text,
			"additional-attrs" => job.elements["additional-attrs"].text,
			"status" => job.elements["status"].text
		}

		stdout=job.elements["stdout"]
		job_attrs.store("stdout", stdout.text) if stdout

		stderr=job.elements["stderr"]
		job_attrs.store("stderr", stderr.text) if stderr

		list << job_attrs
	end

	list

end

.node_states(xml) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/torque-vpc-toolkit.rb', line 70

def self.node_states(xml)

	node_states={}
	dom = REXML::Document.new(xml)

	REXML::XPath.each(dom, "//Node") do |job|
		node_states.store(job.elements["name"].text, job.elements["state"].text)
	end

	node_states

end

.poll_until_job_range_finished(ip, from_id, to_id, timeout = 1200, configs = Util.load_configs) ⇒ Object 



190
191
192
193
194
195
196
197
198
 
# File 'lib/torque-vpc-toolkit.rb', line 190

def self.poll_until_job_range_finished(ip, from_id, to_id, timeout=1200, configs=Util.load_configs)

        def gen_filter(from_id, to_id)
          return Proc.new { |i| from_id <= i and i <= to_id }
        end

        criteria = gen_filter(from_id, to_id)
        poll_until_jobs_finished(ip, timeout, configs, criteria)
end

.poll_until_jobs_finished(ip, timeout = 1200, configs = Util.load_configs, criteria = nil) ⇒ Object

default timeout of 20 minutes



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/torque-vpc-toolkit.rb', line 201

def self.poll_until_jobs_finished(ip, timeout=1200, configs=Util.load_configs, criteria=nil)
	count=0
	until (count*20) >= timeout.to_i do
		count+=1
		jobs = nil
		begin
			jobs=TorqueVPCToolkit.get_jobs(ip, configs)
		rescue
			sleep 20
			next
		end

		all_jobs_finished = true
		jobs.each do |job|	
                               id = Integer(job['id'])
                               if criteria != nil and not criteria.call(id) then
                                 next
                               end

			if job["status"] == "Failed" then
				raise "Job ID #{job['id']} failed."
			elsif job["status"] != "Completed" then
				all_jobs_finished = false
			end
		end
		if all_jobs_finished then
			break
		else
			yield jobs if block_given?
			sleep 20
		end
	end
	if (count*20) >= timeout.to_i then
		raise "Timeout waiting for jobs to finish."
	end

end

.poll_until_online(ip, timeout = 1200, configs = Util.load_configs) ⇒ Object

default timeout of 20 minutes



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/torque-vpc-toolkit.rb', line 84

def self.poll_until_online(ip, timeout=1200, configs=Util.load_configs)

	online = false
	count=0
	until online or (count*20) >= timeout.to_i do
		count+=1
		xml=""
		begin
			xml=HttpUtil.get(
				"https://#{ip}/nodes",
				configs["torque_job_control_username"],
				configs["torque_job_control_password"]
			)
		rescue
			sleep 20
			next
		end

		jobs=TorqueVPCToolkit.node_states(xml)

		online=true
		jobs.each_pair do |name, state|
			if state != "free" then
				online=false
			end
		end
		if not online
			yield jobs if block_given?
			sleep 20
		end
	end
	if (count*20) >= timeout.to_i then
		raise "Timeout waiting for job control to come online."
	end

end

.print_job(hash) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/torque-vpc-toolkit.rb', line 121

def self.print_job(hash)

	puts "Job ID: #{hash["id"]}"
	puts "description: #{hash["description"]}"
	puts "Queue job ID: #{hash["queue-job-id"]}"
	puts "Resources: #{hash["resources"]}"
	puts "Additional Attrs: #{hash["additional-attrs"]}"
	puts "Status: #{hash["status"]}"
	puts "--"

end

.submit_all(configs, config_file = CHEF_VPC_PROJECT + File::SEPARATOR + "config" + File::SEPARATOR + "jobs.json") ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/torque-vpc-toolkit.rb', line 133

def self.submit_all(configs, config_file=CHEF_VPC_PROJECT + File::SEPARATOR + "config" + File::SEPARATOR + "jobs.json")

	if not File.exists?(config_file) then
		puts "The jobs.json config file is missing. No jobs scheduled."
		return
	end

	json_hash=JSON.parse(IO.read(config_file))

	# hash for job_name/job_id's (used for variable substitution)
	jobid_vars={}
	jobs_dir=CHEF_VPC_PROJECT + File::SEPARATOR + "jobs" + File::SEPARATOR

	json_hash.each do |job|
		script=job["script"]
		name=job["name"]
		if File.exists?(jobs_dir+script) then
			resources=self.replace_jobid_vars(job["resources"], jobid_vars)
			additional_attrs=self.replace_jobid_vars(job["additional_attrs"], jobid_vars)
			xml=self.submit_job(configs, jobs_dir+script, name, resources, additional_attrs)
			job_hash=TorqueVPCToolkit.jobs_list(xml)[0]
			if jobid_vars.has_key?(name) then
				raise "A unique job name must be specified in jobs.json"
			else
				jobid_vars.store(name, job_hash["queue-job-id"])
			end
			puts "\tJob ID "+job_hash["id"]+ " submitted."
			
		else
                              raise "Job script '#{script}' does not exist."
		end
	end

end

.submit_job(configs, script, description, resources, additional_attrs = "") ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/torque-vpc-toolkit.rb', line 40

def self.submit_job(configs, script, description, resources, additional_attrs="")

	Util.raise_if_nil_or_empty(configs, "ssh_gateway_ip")
	Util.raise_if_nil_or_empty(configs, "torque_job_control_username")
	Util.raise_if_nil_or_empty(configs, "torque_job_control_password")

	post_data={
		"job[description]" => description
	}
	if not resources.nil? and not resources.empty? then
		post_data.store("job[resources]", resources)
	end
	if not additional_attrs.nil? and not additional_attrs.empty? then
		post_data.store("job[additional_attrs]", additional_attrs)
	end

	file_data={
		"job[script_file_upload]" => script
	}

	resp=HttpUtil.file_upload(
           "https://"+configs["ssh_gateway_ip"]+"/jobs.xml",
           file_data,
           post_data,
           configs["torque_job_control_username"],
           configs["torque_job_control_password"]
       )

end

Instance Method Details

#gen_filter(from_id, to_id) ⇒ Object 



192
193
194
 
# File 'lib/torque-vpc-toolkit.rb', line 192

def gen_filter(from_id, to_id)
  return Proc.new { |i| from_id <= i and i <= to_id }
end