Class: Utils

Inherits:
Object
  • Object
show all
Defined in:
lib/vmfloaty/utils.rb

Class Method Summary collapse

Class Method Details

.format_host_output(hosts) ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/vmfloaty/utils.rb', line 77

def self.format_host_output(hosts)
  hosts.flat_map do |os, names|
    # Assume hosts are stored in Arrays and ignore everything else
    names.map { |name| "- #{name} (#{os})" } if names.is_a? Array
  end.join("\n")
end

.generate_os_hash(os_args) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/vmfloaty/utils.rb', line 84

def self.generate_os_hash(os_args)
  # expects args to look like:
  # ["centos", "debian=5", "windows=1"]

  # Build vm hash where
  #
  #  [operating_system_type1 -> total,
  #   operating_system_type2 -> total,
  #   ...]
  os_types = {}
  os_args.each do |arg|
    os_arr = arg.split('=')
    os_types[os_arr[0]] = os_arr.size == 1 ? 1 : os_arr[1].to_i
  end
  os_types
end

.get_host_data(verbose, service, hostnames = []) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/vmfloaty/utils.rb', line 178

def self.get_host_data(verbose, service, hostnames = [])
  result = {}
  hostnames = [hostnames] unless hostnames.is_a? Array
  hostnames.each do |hostname|
    response = service.query(verbose, hostname)
    host_data = response[hostname]
    if block_given?
      yield host_data result
    else
      case service.type
      when 'ABS'
        # For ABS, 'hostname' variable is the jobID
        result[hostname] = host_data if host_data['state'] == 'allocated' || host_data['state'] == 'filled'
      when 'Pooler'
        result[hostname] = host_data
      when 'NonstandardPooler'
        result[hostname] = host_data
      else
        raise "Invalid service type #{service.type}"
      end
    end
  rescue StandardError => e
    FloatyLogger.error("Something went wrong while trying to gather information on #{hostname}:")
    FloatyLogger.error(e)
  end
  result
end

.get_service_config(config, options) ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/vmfloaty/utils.rb', line 274

def self.get_service_config(config, options)
  # The top-level url, user, and token values in the config file are treated as defaults
  service_config = {
    'url' => config['url'],
    'user' => config['user'],
    'token' => config['token'],
    'vmpooler_fallback' => config['vmpooler_fallback'],
    'type' => config['type'] || 'vmpooler'
  }

  if config['services']
    if options.service.nil?
      # If the user did not specify a service name at the command line, but configured services do exist,
      # use the first configured service in the list by default.
      _, values = config['services'].first
      service_config.merge! values
    else
      # If the user provided a service name at the command line, use that service if posible, or fail
      unless config['services'][options.service]
        raise ArgumentError,
              "Could not find a configured service named '#{options.service}' in ~/.vmfloaty.yml"
      end

      # If the service is configured but some values are missing, use the top-level defaults to fill them in
      service_config.merge! config['services'][options.service]
    end
  # No config file but service is declared on command line
  elsif !config['services'] && options.service
    service_config['type'] = options.service
  end

  # Prioritize an explicitly specified url, user, or token if the user provided one
  service_config['priority'] = options.priority unless options.priority.nil?
  service_config['url'] = options.url unless options.url.nil?
  service_config['token'] = options.token unless options.token.nil?
  service_config['user'] = options.user unless options.user.nil?

  service_config
end

.get_service_object(type = '') ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/vmfloaty/utils.rb', line 259

def self.get_service_object(type = '')
  abs_strings = %w[abs alwaysbescheduling always_be_scheduling]
  nspooler_strings = %w[ns nspooler nonstandard nonstandard_pooler]
  vmpooler_strings = %w[vmpooler]
  if abs_strings.include? type.downcase
    ABS
  elsif nspooler_strings.include? type.downcase
    NonstandardPooler
  elsif vmpooler_strings.include? type.downcase
    Pooler
  else
    Pooler
  end
end

.get_vmpooler_service_config(vmpooler_fallback) ⇒ Object

This method gets the vmpooler service configured in ~/.vmfloaty



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/vmfloaty/utils.rb', line 315

def self.get_vmpooler_service_config(vmpooler_fallback)
  config = Conf.read_config
  # The top-level url, user, and token values in the config file are treated as defaults
  service_config = {
    'url' => config['url'],
    'user' => config['user'],
    'token' => config['token'],
    'type' => 'vmpooler'
  }

  # at a minimum, the url needs to be configured
  if config['services'] && config['services'][vmpooler_fallback] && config['services'][vmpooler_fallback]['url']
    # If the service is configured but some values are missing, use the top-level defaults to fill them in
    service_config.merge! config['services'][vmpooler_fallback]
  elsif vmpooler_fallback.nil?
    raise ArgumentError,
          "The abs service should have a key named 'vmpooler_fallback' in ~/.vmfloaty.yml with a value that points to a vmpooler service name use this format:\nservices:\n  myabs:\n    url: 'http://abs.com'\n    user: 'superman'\n    token: 'kryptonite'\n    vmpooler_fallback: 'myvmpooler'\n  myvmpooler:\n    url: 'http://vmpooler.com'\n    user: 'superman'\n    token: 'kryptonite'"
  else
    raise ArgumentError,
          "Could not find a configured service named '#{vmpooler_fallback}' in ~/.vmfloaty.yml use this format:\nservices:\n  #{vmpooler_fallback}:\n    url: 'http://vmpooler.com'\n    user: 'superman'\n    token: 'kryptonite'"
  end

  service_config
end

.pretty_print_hosts(verbose, service, hostnames = [], print_to_stderr = false, indent = 0) ⇒ Object 



124
125
126
127
128
129
130
131
132
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
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/vmfloaty/utils.rb', line 124

def self.pretty_print_hosts(verbose, service, hostnames = [], print_to_stderr = false, indent = 0)
  output_target = print_to_stderr ? $stderr : $stdout

  fetched_data = get_host_data(verbose, service, hostnames)
  fetched_data.each do |hostname, host_data|
    case service.type
    when 'ABS'
      # For ABS, 'hostname' variable is the jobID
      #
      # Create a vmpooler service to query each hostname there so as to get the metadata too

      output_target.puts "- [JobID:#{host_data['request']['job']['id']}] <#{host_data['state']}>"
      host_data['allocated_resources'].each do |allocated_resources, _i|
        if (allocated_resources['engine'] == 'vmpooler' || allocated_resources['engine'] == 'ondemand') && service.config['vmpooler_fallback']
          vmpooler_service = service.clone
          vmpooler_service.silent = true
          vmpooler_service.maybe_use_vmpooler
          pretty_print_hosts(verbose, vmpooler_service, allocated_resources['hostname'].split('.')[0],
                             print_to_stderr, indent + 2)
        else
          # TODO: we could add more specific metadata for the other services, nspooler and aws
          output_target.puts "  - #{allocated_resources['hostname']} (#{allocated_resources['type']})"
        end
      end
    when 'Pooler'
      tag_pairs = []
      tag_pairs = host_data['tags'].map { |key, value| "#{key}: #{value}" } unless host_data['tags'].nil?
      duration = "#{host_data['running']}/#{host_data['lifetime']} hours"
      metadata = [host_data['state'], host_data['template'], duration, *tag_pairs]
      # For backwards compatibility with vmpooler api v1
      message =
        if host_data['domain']
          "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
        else
          "- #{host_data['fqdn']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
        end

      if host_data['state'] && host_data['state'] == 'destroyed'
        output_target.puts "- DESTROYED #{hostname}.#{host_data['domain']}".gsub(/^/, ' ' * indent)
      else
        output_target.puts message
      end
    when 'NonstandardPooler'
      line = "- #{host_data['fqdn']} (#{host_data['os_triple']}"
      line += ", #{host_data['hours_left_on_reservation']}h remaining"
      line += ", reason: #{host_data['reserved_for_reason']}" unless  host_data['reserved_for_reason'].nil? || host_data['reserved_for_reason'].empty?
      line += ')'
      output_target.puts line
    else
      raise "Invalid service type #{service.type}"
    end
  end
end

.pretty_print_status(verbose, service) ⇒ Object 



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
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/vmfloaty/utils.rb', line 206

def self.pretty_print_status(verbose, service)
  status_response = service.status(verbose)

  case service.type
  when 'Pooler'
    message = status_response['status']['message']
    pools = status_response['pools']
    pools.select! { |_, pool| pool['ready'] < pool['max'] } unless verbose

    width = pools.keys.map(&:length).max
    pools.each do |name, pool|
      max = pool['max']
      ready = pool['ready']
      pending = pool['pending']
      missing = max - ready - pending
      char = 'o'
      puts "#{name.ljust(width)} #{(char * ready)}#{(char * pending)}#{(char * missing)}"
    rescue StandardError => e
      FloatyLogger.error "#{name.ljust(width)} #{e}"
    end
    puts message
  when 'NonstandardPooler'
    pools = status_response
    pools.delete 'ok'
    pools.select! { |_, pool| pool['available_hosts'] < pool['total_hosts'] } unless verbose

    width = pools.keys.map(&:length).max
    pools.each do |name, pool|
      max = pool['total_hosts']
      ready = pool['available_hosts']
      pending = pool['pending'] || 0 # not available for nspooler
      missing = max - ready - pending
      char = 'o'
      puts "#{name.ljust(width)} #{(char * ready)}#{(char * pending)}#{(char * missing)}"
    rescue StandardError => e
      FloatyLogger.error "#{name.ljust(width)} #{e}"
    end
  when 'ABS'
    FloatyLogger.error 'ABS Not OK' unless status_response
    puts 'ABS is OK' if status_response
  else
    raise "Invalid service type #{service.type}"
  end
end

.print_fqdn_for_host(service, hostname, host_data) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/vmfloaty/utils.rb', line 101

def self.print_fqdn_for_host(service, hostname, host_data)
  case service.type
  when 'ABS'
    abs_hostnames = []

    host_data['allocated_resources'].each do |vm_name, _i|
      abs_hostnames << vm_name['hostname']
    end

    puts abs_hostnames.join("\n")
  when 'Pooler'
    if host_data['domain'].nil?
      puts hostname
    else
      puts "#{hostname}.#{host_data['domain']}"
    end
  when 'NonstandardPooler'
    puts host_data['fqdn']
  else
    raise "Invalid service type #{service.type}"
  end
end

.standardize_hostnames(response_body) ⇒ Object

TODO: Takes the json response body from an HTTP GET request and “pretty prints” it



11
12
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
39
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
69
70
71
72
73
74
75
 
# File 'lib/vmfloaty/utils.rb', line 11

def self.standardize_hostnames(response_body)
  # vmpooler api v1 response body example when `floaty get` arguments are `ubuntu-1610-x86_64=2 centos-7-x86_64`:
  # {
  #   "ok": true,
  #   "domain": "delivery.mycompany.net",
  #   "ubuntu-1610-x86_64": {
  #     "hostname": ["gdoy8q3nckuob0i", "ctnktsd0u11p9tm"]
  #   },
  #   "centos-7-x86_64": {
  #     "hostname": "dlgietfmgeegry2"
  #   }
  # }

  # vmpooler api v2 response body example when `floaty get` arguments are `ubuntu-1610-x86_64=2 centos-7-x86_64`:
  # {
  #   "ok": true,
  #   "ubuntu-1610-x86_64": {
  #     "hostname": ["gdoy8q3nckuob0i.pooler.example.com", "ctnktsd0u11p9tm.pooler.example.com"]
  #   },
  #   "centos-7-x86_64": {
  #     "hostname": "dlgietfmgeegry2.pooler.example.com"
  #   }
  # }

  # nonstandard pooler response body example when `floaty get` arguments are `solaris-11-sparc=2 ubuntu-16.04-power8`:
  # {
  #   "ok": true,
  #   "solaris-10-sparc": {
  #     "hostname": ["sol10-10.delivery.mycompany.net", "sol10-11.delivery.mycompany.net"]
  #   },
  #   "ubuntu-16.04-power8": {
  #     "hostname": "power8-ubuntu1604-6.delivery.mycompany.net"
  #   }
  # }

  # abs pooler response body example when `floaty get` arguments are :
  # {
  #   "hostname"=>"thin-soutane.delivery.puppetlabs.net",
  #   "type"=>"centos-7.2-tmpfs-x86_64",
  #   "engine"=>"vmpooler"
  # }

  unless response_body.delete('ok')
    raise ArgumentError,
          "Bad GET response passed to format_hosts: #{response_body.to_json}"
  end

  # vmpooler reports the domain separately from the hostname
  domain = response_body.delete('domain')

  result = {}

  # ABS has a job_id associated with hosts so pass that along
  abs_job_id = response_body.delete('job_id')
  result['job_id'] = abs_job_id unless abs_job_id.nil?

  filtered_response_body = response_body.reject { |key, _| %w[request_id ready].include?(key) }
  filtered_response_body.each do |os, value|
    hostnames = Array(value['hostname'])
    hostnames.map! { |host| "#{host}.#{domain}" } if domain
    result[os] = hostnames
  end

  result
end

.strip_heredoc(str) ⇒ Object

Adapted from ActiveSupport



252
253
254
255
256
257
 
# File 'lib/vmfloaty/utils.rb', line 252

def self.strip_heredoc(str)
  min_indent = str.scan(/^[ \t]*(?=\S)/).min
  min_indent_size = min_indent.nil? ? 0 : min_indent.size

  str.gsub(/^[ \t]{#{min_indent_size}}/, '')
end