Module: CORL::Vagrant::Config

Defined in:
lib/core/vagrant/config.rb

Constant Summary collapse

@@logger = 
Util::Logger.new('vagrant')
@@network =

Vagrant node network container

nil
@@rerender =

Whether or not we are re-rendering this configuration

false

Class Method Summary collapse

Class Method Details

.check_numeric(string) ⇒ Object 



540
541
542
543
544
545
546
547
548
 
# File 'lib/core/vagrant/config.rb', line 540

def self.check_numeric(string)
  return true if string =~ /^\d+$/
  begin
    Float(string)
    return true
  rescue
    return false
  end
end

.configure_provider_overrides(provider, machine, config, data, already_processed, parents = [], indent = '') ⇒ Object 



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/core/vagrant/config.rb', line 442

def self.configure_provider_overrides(provider, machine, config, data, already_processed, parents = [], indent = '')
  data.each do |name, info|
    label = (parents.empty? ? name : "#{parents.join('.')}.#{name}")

    if info.is_a?(Hash)
      configure_provider_overrides(provider, machine.send(name), config.send(name), info, already_processed, [ parents, name].flatten, indent)
    else
      if machine.respond_to?("#{name}=")
        render("#{indent}override.#{label} = %property", { :property => info }) unless already_processed
        config.send("#{name}=", info)
      else
        params = parse_params(info)
        render("#{indent}override.#{label} %params", { :params => params }) unless already_processed
        config.send(name, params)
      end
    end
  end
end

.configure_provisioner(network, node, machine, &code) ⇒ Object 



425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/core/vagrant/config.rb', line 425

def self.configure_provisioner(network, node, machine, &code)
  success = true

  unless node[:docker_host]
    # CORL provisioning
    machine.vm.provision :corl do |provisioner|
      provisioner.network = network
      provisioner.node    = node

      code.call(node, machine, provisioner) if code
    end
  end
  success
end

.configure_shares(node, provider, machine, already_processed, indent = '') ⇒ Object 



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/core/vagrant/config.rb', line 371

def self.configure_shares(node, provider, machine, already_processed, indent = '')
  use_nfs          = provider.to_sym != :docker
  bindfs_installed = Gems.exist?('vagrant-bindfs')
  success          = true

  if use_nfs && bindfs_installed
    machine.vm.synced_folder ".", "/vagrant", disabled: true

    unless ENV['CORL_NO_NETWORK_SHARE']
      machine.vm.synced_folder ".", "/tmp/vagrant", :type => "nfs"
      machine.bindfs.bind_folder "/tmp/vagrant", "/vagrant"
    end
  end

  render("\n") unless already_processed

  Util::Data.hash(node.shares).each do |name, options|
    config = CORL::Config.ensure(options)

    if config[:type].to_sym == :nfs && ! use_nfs
      config.delete(:type)
    end

    share_type = config.get(:type, nil)
    local_dir  = config.delete(:local, '')
    remote_dir = config.delete(:remote, '')

    config.init(:create, true)

    unless local_dir.empty? || remote_dir.empty?
      bindfs_options = config.delete(:bindfs, {})
      share_options  = {}

      config.keys.each do |key|
        share_options[key] = Util::Data.value(config[key])
      end

      if share_type && share_type.to_sym == :nfs && bindfs_installed
        final_dir  = remote_dir
        remote_dir = [ '/tmp', remote_dir.sub(/^\//, '') ].join('/')

        render("#{indent}override.bindfs.bind_folder '#{remote_dir}', '#{final_dir}', %params", { :params => bindfs_options }) unless already_processed
        machine.bindfs.bind_folder remote_dir, final_dir, bindfs_options
      end

      render("#{indent}override.vm.synced_folder '#{local_dir}', '#{remote_dir}', %params", { :params => share_options }) unless already_processed
      machine.vm.synced_folder local_dir, remote_dir, share_options
    end
  end
  success
end

.configure_ssh(node, machine) ⇒ Object 



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
177
178
179
180
181
 
# File 'lib/core/vagrant/config.rb', line 131

def self.configure_ssh(node, machine)
  success = true

  render("  node.ssh.username = %property", { :property => node.user })
  machine.ssh.username = node.user

  render("  node.ssh.guest_port = %property", { :property => node.ssh_port })
  machine.ssh.guest_port = node.ssh_port

  if node.cache_setting(:use_private_key, false)
    key_dir     = node.network.key_cache_directory
    key_name    = node.plugin_name

    ssh_config  = ::CORL::Config.new({
      :keypair  => node.keypair,
      :key_dir  => key_dir,
      :key_name => key_name
    })

    if keypair = Util::SSH.unlock_private_key(node.private_key, ssh_config)
      if keypair.is_a?(String)
        render("  node.ssh.private_key_path = %property", { :property => keypair })
        machine.ssh.private_key_path = keypair
      else
        private_key_file = keypair.private_key_file(key_dir, key_name)
        node.keypair     = keypair
        render("  node.ssh.private_key_path = %property", { :property => private_key_file })
        machine.ssh.private_key_path = private_key_file
      end
    end
    unless keypair && File.exists?(machine.ssh.private_key_path)
      render("  node.ssh.private_key_path = %property", { :property => node.private_key })
      machine.ssh.private_key_path = node.private_key
    end
  end

  render("\n")

  Util::Data.hash(node.ssh).each do |name, data|
    if machine.ssh.respond_to?("#{name}=")
      data = Util::Data.value(data)
      render("  node.ssh.#{name} = %property", { :property => data })
      machine.ssh.send("#{name}=", data)
    else
      params = parse_params(data)
      render("  node.ssh.#{name} %params", { :params => params })
      machine.ssh.send(name, params)
    end
  end
  success
end

.configure_vagrant(network, vagrant) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/core/vagrant/config.rb', line 113

def self.configure_vagrant(network, vagrant)
  success = true
  Util::Data.hash(network.settings(:vagrant_config)).each do |name, data|
    if vagrant.respond_to?("#{name}=")
      data = Util::Data.value(data)
      render("config.vagrant.#{name} = %property", { :property => data })
      vagrant.send("#{name}=", data)
    else
      params = parse_params(data)
      render("config.vagrant.#{name} %params", { :params => params })
      vagrant.send(name, params)
    end
  end
  success
end

.configure_vm(node, machine) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/core/vagrant/config.rb', line 185

def self.configure_vm(node, machine)
  vm_config = Util::Data.hash(Util::Data.clone(node.vm))
  success   = true

  render("  node.vm.hostname = %property", { :property => node.hostname })
  machine.vm.hostname = node.hostname

  box      = node.cache_setting(:box)
  box_url  = node.cache_setting(:box_url)
  box_file = nil

  if box_url
    box_file = box_url.gsub(/^file\:\/\//, '')
    unless File.exists?(box_file)
      box_url = nil
      node.clear_cache
    end
  end

  if vm_config.has_key?(:private_network)
    network_options = Util::Data.hash(vm_config[:private_network])

    if node[:public_ip]
      network_options[:ip] = node[:public_ip]
    end
    render("  node.vm.network :private_network, %params", { :params => network_options })
    machine.vm.network :private_network, network_options
    vm_config.delete(:private_network)
    render("\n")

  elsif vm_config.has_key?(:public_network)
    network_options = Util::Data.hash(vm_config[:public_network])

    render("  node.vm.network :public_network, %params", { :params => network_options })
    machine.vm.network :public_network, network_options
    vm_config.delete(:public_network)
    render("\n")
  end

  if vm_config.has_key?(:provision)
    Util::Data.array(vm_config[:provision]).each do |provisioner|
      if provisioner.is_a?(String)
        render("  node.vm.provision :#{provisioner}")
        machine.vm.provision provisioner
      else
        provision_options = Util::Data.symbol_map(provisioner)
        provision_type    = provision_options.delete(:type)

        if provision_type
          render("  node.vm.provision :#{provision_type}, %params", { :params => provision_options })
          machine.vm.provision provision_type, provision_options
        end
      end
    end
    vm_config.delete(:provision)
  end

  vm_config.each do |name, data|
    case name.to_sym
    # Network interfaces
    when :forwarded_ports
      data.each do |forward_name, info|
        forward_config = CORL::Config.new({ :auto_correct => true }).import(info)

        forward_config.keys do |key|
          forward_config[key] = Util::Data.value(forward_config[key])
        end
        forward_options = forward_config.export
        render("  node.vm.network :forwarded_port, %params", { :params => forward_options })
        machine.vm.network :forwarded_port, forward_options
      end
      render("\n")
    when :usable_port_range
      low, high = data.to_s.split(/\s*--?\s*/)
      render("  node.vm.usable_port_range = #{low}..#{high}")
      machine.vm.usable_port_range = Range.new(low, high)

    # Provider specific settings
    when :providers
      data.each do |provider, info|
        provider          = provider.to_sym
        info              = Util::Data.symbol_map(info)
        already_processed = {}

        machine.vm.provider provider do |interface, override|
          render("  node.vm.provider '#{provider}' do |provider, override|  # for #{node.hostname}") unless already_processed[provider]

          if info.has_key?(:private_network)
            network_options = info[:private_network].is_a?(Hash) ? info[:private_network] : { :ip => info[:private_network] }

            render("    node.vm.network :private_network, %params", { :params => network_options }) unless already_processed[provider]
            machine.vm.network :private_network, network_options
            info.delete(:private_network)

          elsif info.has_key?(:public_network)
            network_options = info[:public_network].is_a?(Hash) ? info[:public_network] : { :ip => info[:public_network] }

            render("    node.vm.network :public_network, %params", { :params => network_options })
            machine.vm.network :public_network, network_options
            info.delete(:public_network)
          end

          if info.has_key?(:override) && info[:override].has_key?(:provision)
            Util::Data.array(info[:override][:provision]).each do |provisioner|
              if provisioner.is_a?(String)
                render("    override.vm.provision :#{provisioner}")
                override.vm.provision provisioner
              else
                provision_options = Util::Data.symbol_map(provisioner)
                provision_type    = provision_options.delete(:type)

                if provision_type
                  render("    override.vm.provision :#{provision_type}, %params", { :params => provision_options })
                  override.vm.provision provision_type, provision_options
                end
              end
            end
            info[:override].delete(:provision)
          end

          info.each do |property, item|
            if property.to_sym == :override
              configure_provider_overrides(provider, machine, override, item, already_processed[provider], [], '    ')
            else
              if interface.respond_to?("#{property}=")
                render("    provider.#{property} = %property", { :property => item }) unless already_processed[provider]
                interface.send("#{property}=", item)
              else
                params = parse_params(item)
                render("    provider.#{property} %params", { :params => params }) unless already_processed[provider]
                interface.send(property, params)
              end
            end
          end

          if box || box_url
            if provider != :docker
              if box && box_url
                render("    override.vm.box = %property", { :property => box }) unless already_processed[provider]
                override.vm.box = box

                render("    override.vm.box_url = %property", { :property => box_url }) unless already_processed[provider]
                override.vm.box_url = box_url
              end
            else
              if box_file
                render("    provider.build_dir = %property", { :property => box_file }) unless already_processed[provider]
                interface.build_dir = box_file
              else
                render("    provider.image = %property", { :property => box }) unless already_processed[provider]
                interface.image = box
              end
            end
            render("\n")
          end

          # Server shares
          unless configure_shares(node, provider, override, already_processed[provider], '    ')
            raise "Configuration of Vagrant shares failed: #{node_name}"
          end

          unless already_processed[provider]
            render("  end")
            render("\n")
          end
          already_processed[provider] = 1
        end
      end
    # All other basic VM settings...
    else
      if machine.vm.respond_to?("#{name}=")
        render("  node.vm.#{name} = %property", { :property => data })
        machine.vm.send("#{name}=", data)
      else
        params = parse_params(data)
        render("  node.vm.#{name} %params", { :params => params })
        machine.vm.send(name, params)
      end
    end
    render("\n")
  end
  success
end

.load_network(directory) ⇒ Object 



106
107
108
109
 
# File 'lib/core/vagrant/config.rb', line 106

def self.load_network(directory)
  # Load network if it exists
  @@network = CORL.network(directory, CORL.config(:vagrant_network, { :directory => directory }))
end

.logger ⇒ Object 



42
43
44
 
# File 'lib/core/vagrant/config.rb', line 42

def self.logger
  @@logger
end

.network ⇒ Object 



55
56
57
 
# File 'lib/core/vagrant/config.rb', line 55

def self.network
  @@network
end

.network=(network) ⇒ Object 



51
52
53
 
# File 'lib/core/vagrant/config.rb', line 51

def self.network=network
  @@network = network
end

.parse_params(data) ⇒ Object 



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/core/vagrant/config.rb', line 463

def self.parse_params(data)
  params = data
  if data.is_a?(Hash)
    params = []
    data.each do |key, item|
      unless Util::Data.undef?(item)
        params << ( key.match(/^\:/) ? key.gsub(/^\:/, '').to_sym : key.to_s )
        unless Util::Data.empty?(item)
          value = item
          value = ((item.is_a?(String) && item.match(/^\:/)) ? item.gsub(/^\:/, '').to_sym : item)
          params << Util::Data.value(value)
        end
      end
    end
  end
  params
end

.register(directory, config, &code) ⇒ Object

Gateway CORL configurator for Vagrant.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/core/vagrant/config.rb', line 67

def self.register(directory, config, &code)
  ::Vagrant.require_version ">= 1.5.0"

  config_network = network
  config_network = load_network(directory) unless config_network

  if config_network
    # Vagrant settings
    unless configure_vagrant(config_network, config.vagrant)
      raise "Configuration of Vagrant general settings failed"
    end

    config_network.nodes(:vagrant, true).each do |node_name, node|
      config.vm.define node.id.to_sym do |machine|
        render("\n")
        render("config.vm.define '#{node.id}' do |node|")

        # SSH settings
        unless configure_ssh(node, machine)
          raise "Configuration of Vagrant VM SSH settings failed"
        end

        # VM settings
        unless configure_vm(node, machine)
          raise "Configuration of Vagrant VM failed: #{node_name}"
        end

        # Provisioner configuration
        unless configure_provisioner(network, node, machine, &code)
          raise "Configuration of Vagrant provisioner failed: #{node_name}"
        end
      end
    end
  end
  @@rerender = true
end

.render(statement, inputs = {}) ⇒ Object 



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/core/vagrant/config.rb', line 483

def self.render(statement, inputs = {})
  return unless [ :debug, :info, :warn, :error ].include?(Nucleon.log_level)

  if statement =~ /^\s+$/
    puts statement
  else
    Util::Data.clone(inputs).each do |name, data|
      rendered_data = render_value(data)

      if rendered_data.empty?
        statement.gsub!(/,\s*$/, '')
      end
      statement.gsub!("\%#{name}", rendered_data)
    end
    Core.ui_group('') do |ui|
      ui.success(statement, { :prefix => false })
    end
  end
end

.render_value(data) ⇒ Object 



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/core/vagrant/config.rb', line 505

def self.render_value(data)
  rendered_value = ''

  case data
  when Hash
    keypairs = []
    data.each do |name, value|
      keypairs << "#{name}: " + render_value(value)
    end
    rendered_value = keypairs.join(', ')
  when Array
    unless data.empty?
      data.collect! {|value| render_value(value) }
      rendered_value = '[' + data.join(', ') + ']'
    end
  when String
    if check_numeric(data) || data[0] == ':'
      rendered_value = data.to_s
    else
      if data =~ /\'/
        rendered_value = "\"#{data}\""
      else
        rendered_value = "'#{data}'"
      end
    end
  when Symbol
    rendered_value = ":#{data}"
  else
    rendered_value = data.to_s
  end
  rendered_value
end