Class: AnsibleSpecPlus

Inherits:
Object
  • Object
show all
Includes:
Helpers::Log
Defined in:
lib/ansible_spec_plus.rb

Constant Summary collapse

BASE_DIR = 
'./'

Instance Method Summary collapse

Methods included from Helpers::Log

#debug?, debug?, included, last_messages, #last_messages, log, #log, #log=, log=, set_debug, #set_debug

Instance Method Details

#analyze_resources(resources) ⇒ Object 



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
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ansible_spec_plus.rb', line 46

def analyze_resources(resources)
  analyzed_resources = []

  resources.each do |resource|
    resource_type = nil

    resource.keys.each do |key|
      resource_type = key if KNOWN_RESOURCES.include?(key)
    end

    if resource_type.nil?
      log.warn "Unknown resource: #{resource}"
      next
    end

    skip = false

    if resource.values[1].respond_to?(:each)
      resource.values[1].each do |key, value|
        skip = true if value =~ /\{\{/
      end
    else
      skip = true if resource.values[1] =~ /\{\{/
    end

    if skip == true
      log.warn "Don't know how to deal with '{{ }}' syntax: #{resource}"
      next
    end

    if resource_type == 'file' || resource_type == 'template'
      resource_type = 'File'
      if resource.values[1].respond_to?(:each)
        target = resource.values[1].select { |i| i =~ /path|dest/ }
        resource_name = target.values[0]
      else
        target = resource.values[1].split(" ").select { |i| i =~ /path|dest/ }
        resource_name = target.first.gsub(/.*=/,'')
      end
    elsif resource_type == 'docker_container'
      resource_type = 'Docker container'
      resource_name = resource.values[1]['name']
    elsif resource_type == 'docker_image'
      resource_type = 'Docker image'
      resource_name = resource.values[1]['name']
    elsif resource_type == 'service'
      resource_type = 'Service'
      if resource.values[1].respond_to?(:each)
        resource_name = resource.values[1]['name']
      else
        resource_name = resource.values[1].split(" ")[0].gsub(/.*=/,'')
      end
    elsif resource_type =~ /apt|pip|gem/
      if (resource_type == 'apt') && (! resource['apt'].include?('name'))
        log.warn "Unknown resource: #{resource}"
        next
      end

      resource_type = 'Package'
      resource.each do |item|
        next unless item[0] =~ /apt|pip|gem/

        resource_name = item[1]['name']
      end
    else
      next
    end

    analyzed_resources << "#{resource_type} \"#{resource_name}\""
  end

  return analyzed_resources
end

#calculate_coverage(type, name) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
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
205
206
 
# File 'lib/ansible_spec_plus.rb', line 165

def calculate_coverage(type, name)
  Dir.chdir(BASE_DIR) do
    json_report = File.read('report.json')
    parsed_report = JSON.parse(json_report)

    case type
    when 'role'
      all_known_resources = analyze_resources(load_role_resources(name))
    when 'host'
      all_known_resources = analyze_resources(load_host_resources(name))
    when 'playbook'
      all_known_resources = analyze_resources(load_playbook_resources(name))
    else
      raise "Unknow type '#{type}'. Should be either role, host or playbook."
    end

    tested_resources = []

    parsed_report['examples'].each do |example|
      tested_resources << example['full_description'].gsub(/"\s{1}.*/,'"')
    end

    tested_resources = tested_resources.uniq

    differences = []

    all_known_resources.each do |resource|
      differences << resource if ! tested_resources.include?(resource)
    end

    puts "Total resources: #{all_known_resources.count}"
    puts "Touched resources: #{(all_known_resources - differences).count}"
    puts "Resource coverage: #{print_rounded_role_coverage(all_known_resources, differences)}"

    if differences.count > 0
      puts "\nUncovered resources:"
      differences.each do |item|
        puts "- #{item}"
      end
    end
  end
end

#check_for_existing_playbook(host) ⇒ Object 



608
609
610
611
612
613
614
615
616
 
# File 'lib/ansible_spec_plus.rb', line 608

def check_for_existing_playbook(host)
  Dir.chdir(BASE_DIR) do
    if File.exists?("#{host}.yml")
      return true
    else
      return false
    end
  end
end

#check_for_host_specs(host) ⇒ Object 



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/ansible_spec_plus.rb', line 490

def check_for_host_specs(host)
  Dir.chdir(BASE_DIR) do
    if File.directory?("./spec/#{host}")
      Dir.glob("./spec/#{host}/*_spec.rb").each do |file|
        if check_for_specs_in_file(file)
          return true
        else
          return false
        end
      end
    else
      return false
    end
  end
end

#check_for_specs_in_file(file) ⇒ Object 



42
43
44
 
# File 'lib/ansible_spec_plus.rb', line 42

def check_for_specs_in_file(file)
  File.readlines(file).grep(/describe\s{1}/).any?
end

#check_role_directory_available(role) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ansible_spec_plus.rb', line 267

def check_role_directory_available(role)
  Dir.chdir(BASE_DIR) do
    if ! Dir.exists?("roles/#{role}")
      log.error "Directory 'roles/#{role}' does not exist. That's strange, isn't it?"
      return false
    end
  end

  return true
end

#check_role_specs_available(role) ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/ansible_spec_plus.rb', line 278

def check_role_specs_available(role)
  Dir.chdir(BASE_DIR) do
    successes = 0

    Dir.glob("roles/#{role}/spec/*_spec.rb").each do |file|
      successes =+ 1 if File.size(file) > 1
    end

    if successes == 0
      # log.error "'#{role}' does not have specs but you requested me to run specs. Huu?"
      return false
    end
  end

  return true
end

#create_host_rake_task(host) ⇒ Object 



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
422
423
 
# File 'lib/ansible_spec_plus.rb', line 387

def create_host_rake_task(host)
  Dir.chdir(BASE_DIR) do
    properties = AnsibleSpecHelper.get_properties
    cfg = AnsibleSpec::AnsibleCfg.new

    properties.each do |property|
      next unless property['name'] == host

      if property['hosts'].empty?
        get_hosts_from_vai_host_file.each do |host, values|
          values.each do |property|
            RSpec::Core::RakeTask.new(host.to_sym) do |t|
              log.info "Run host tests for #{host}"

              ENV['TARGET_HOST'] = property["ansible_ssh_host"]
              ENV['TARGET_PORT'] = property["ansible_ssh_port"].to_s
              ENV['TARGET_PRIVATE_KEY'] = property["ansible_ssh_private_key_file"]
              ENV['TARGET_USER'] = property["ansible_ssh_user"]

              t.pattern = "spec/#{host}/*_spec.rb"
            end
          end
        end
      else
        property['hosts'].each do |host|
          RSpec::Core::RakeTask.new(property["name"].to_sym) do |t|
            log.info "Run host tests for #{property["name"]}"

            ENV['TARGET_HOST'] = host['uri']

            t.pattern = "spec/#{property["name"]}/*_spec.rb"
          end
        end
      end
    end
  end
end

#create_playbook_rake_task(playbook) ⇒ Object 



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/ansible_spec_plus.rb', line 551

def create_playbook_rake_task(playbook)
  ansiblespec_roles = []

  hostname = playbook.gsub(/\.yml|\.yaml/,'')

  get_roles_of_host(hostname).each do |role|
    ansiblespec_roles << role if check_role_specs_available(role)
  end

  Dir.chdir(BASE_DIR) do
    properties = AnsibleSpecHelper.get_properties
    cfg = AnsibleSpec::AnsibleCfg.new

    if properties.select { |item| item['name'] == hostname}[0]['hosts'].empty?
      get_hosts_from_vai_host_file.select { |name,_| name == hostname }.each do |item|
        ENV['TARGET_HOST'] = item.flatten.last['ansible_ssh_host']
        ENV['TARGET_PORT'] = item.flatten.last['ansible_ssh_port']
        ENV['TARGET_PRIVATE_KEY'] = item.flatten.last['ansible_ssh_private_key_file']
        ENV['TARGET_USER'] = item.flatten.last['ansible_ssh_user']
      end
    else
      ENV['TARGET_HOST'] = properties.select { |item| item['name'] == hostname}[0]['hosts'][0]['uri']
    end

    RSpec::Core::RakeTask.new("#{hostname}".to_sym) do |t|
      log.info "Run playbook tests for #{hostname}"

      roles_pattern = ansiblespec_roles.nil? ? '' : ",{#{cfg.roles_path.join(',')}}/{#{ansiblespec_roles.uniq.join(',')}}/spec/*_spec.rb"
      host_pattern = check_for_host_specs(hostname) ? ",spec/#{hostname}/*_spec.rb" : ''

      t.pattern = roles_pattern + host_pattern
    end
  end
end

#create_role_rake_task(role) ⇒ Object 



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
368
369
370
371
372
 
# File 'lib/ansible_spec_plus.rb', line 329

def create_role_rake_task(role)
  Dir.chdir(BASE_DIR) do
    properties = AnsibleSpecHelper.get_properties
    cfg = AnsibleSpec::AnsibleCfg.new
    get_hosts_where_role_is_used = get_hosts_where_role_is_used(role)

    properties.each do |property|
      next unless property['name'] == get_hosts_where_role_is_used.first

      if property['hosts'].empty?
        if ! get_hosts_from_vai_host_file.keys.include?(get_hosts_where_role_is_used.first)
          raise "Uuups. I cannot find '#{get_hosts_where_role_is_used.first}' in your hosts file. 'vagrant up #{get_hosts_where_role_is_used.first}' may help."
        end

        get_hosts_from_vai_host_file.each do |host, values|
          values.each do |property|
            next unless property['name'] == get_hosts_where_role_is_used.first

            RSpec::Core::RakeTask.new(role.to_sym) do |t|
              log.info "Run role tests for #{role} on #{get_hosts_where_role_is_used.first} (#{property["ansible_ssh_host"]}:#{property["ansible_ssh_port"]})"

              ENV['TARGET_HOST'] = property["ansible_ssh_host"]
              ENV['TARGET_PORT'] = property["ansible_ssh_port"].to_s
              ENV['TARGET_PRIVATE_KEY'] = property["ansible_ssh_private_key_file"]
              ENV['TARGET_USER'] = property["ansible_ssh_user"]

              t.pattern = '{' + cfg.roles_path.join(',') + '}/{' + role + '}/spec/*_spec.rb'
            end
          end
        end
      else
        property['hosts'].each do |host|
          RSpec::Core::RakeTask.new(role.to_sym) do |t|
            log.info "Run role tests for #{role} on #{get_hosts_where_role_is_used.first} (#{host['uri']})"

            ENV['TARGET_HOST'] = host['uri']

            t.pattern = '{' + cfg.roles_path.join(',') + '}/{' + role + '}/spec/*_spec.rb'
          end
        end
      end
    end
  end
end

#get_all_roles ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/ansible_spec_plus.rb', line 233

def get_all_roles
  all_roles = []

  Dir.chdir(BASE_DIR) do
    Dir.glob("roles/*").each do |role|
      all_roles << File.basename(role)
    end
  end

  return all_roles
end

#get_hosts_from_vai_host_file ⇒ Object 



120
121
122
123
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
 
# File 'lib/ansible_spec_plus.rb', line 120

def get_hosts_from_vai_host_file
  inventory_hosts = []
  hosts_with_vagrant_vars = {}

  Dir.chdir(BASE_DIR) do
    begin
      File.open('hosts', 'r') do |file|
        file.each_line do |line|
          pattern = /^#.*|^$\n|^\[.*|^\r\n?/
          next if line =~ pattern
          inventory_hosts << line
        end
      end
    rescue => e
      log.error "hosts file doesn't exist: #{e}"
    end
  end

  inventory_hosts.each do |line|
    hostname = line.split(' ').first

    parts = line.match(/\s.*/).to_s.split(' ')

    vars = {}
    vars['name'] = hostname
    parts.each do |part|
      key = part.gsub(/=.*/,'')
      value = part.gsub(/.*=/,'').gsub(/'|"/,'')
      vars["#{key}"] = value
    end

    hosts_with_vagrant_vars[hostname] = [vars]
  end

  return hosts_with_vagrant_vars
end

#get_hosts_where_role_is_used(role) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ansible_spec_plus.rb', line 295

def get_hosts_where_role_is_used(role)
  role_used_in_hosts = []

  Dir.chdir(BASE_DIR) do
    YAML.load_file("site.yml").each do |playbook|
      YAML.load_file(playbook['include'].to_s).each do |site|
        site['roles'].each do |playbook_role|
          if playbook_role.respond_to?(:each)
            role_used_in_hosts << site['name'].to_s if playbook_role['role'].include?(role)
          else
            role_used_in_hosts << site['name'].to_s if playbook_role.include?(role)
          end
        end
      end
    end
  end

  return role_used_in_hosts
end

#get_hosts_with_specs ⇒ Object 



455
456
457
458
459
460
461
462
463
 
# File 'lib/ansible_spec_plus.rb', line 455

def get_hosts_with_specs
  hosts_with_specs = []

  get_vagrant_or_regular_ansible_hosts.each do |host|
    hosts_with_specs << host if check_for_host_specs(host)
  end

  return hosts_with_specs.uniq
end

#get_playbooks_host_spec_summary ⇒ Object 



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/ansible_spec_plus.rb', line 618

def get_playbooks_host_spec_summary
  playbooks = []

  Dir.chdir(BASE_DIR) do
    YAML.load_file('./site.yml').each do |site|
      Dir.glob(site.values[0]).each do |playbook|
        playbook = File.basename(playbook)
        host = playbook.gsub(/\.yml|\.yaml/,'')

        playbooks << { playbook => check_for_host_specs(host) }
      end
    end
  end

  return playbooks.uniq
end

#get_playbooks_with_host_and_or_role_specs ⇒ Object 



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/ansible_spec_plus.rb', line 635

def get_playbooks_with_host_and_or_role_specs
  playbooks = []

  get_playbooks_host_spec_summary.each do |entry|
    host = entry.keys[0].gsub(/\.yml|\.yaml/,'')
    has_specs = entry.values[0]

    if has_specs
      playbooks << host
    else
      get_roles_of_host(host).each do |role|
        playbooks << host if check_role_specs_available(role)
      end
    end
  end

  return playbooks.uniq
end

#get_roles_of_host(host) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/ansible_spec_plus.rb', line 506

def get_roles_of_host(host)
  roles_with_specs = []

  Dir.chdir(BASE_DIR) do
    playbook_path = ''

    YAML.load_file('./site.yml').each do |site|
      next unless site.values[0] =~ /#{host}\.(yml|yaml)/

      playbook_path = site.values[0]
    end

    YAML.load_file(playbook_path).each do |playbook|
      playbook['roles'].each do |role|
        roles_with_specs << role if check_role_specs_available(role)
      end
    end
  end

  return roles_with_specs.uniq
end

#get_roles_with_specs ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/ansible_spec_plus.rb', line 245

def get_roles_with_specs
  roles_with_specs = []

  Dir.chdir(BASE_DIR) do
    get_all_roles.each do |role|
      successes = 0

      Dir.glob("roles/#{role}/spec/*_spec.rb").each do |file|
        successes =+ 1 if File.size(file) > 1
      end

      roles_with_specs << File.basename(role) if successes > 0
    end
  end

  return roles_with_specs
end

#get_roles_without_specs ⇒ Object 



263
264
265
 
# File 'lib/ansible_spec_plus.rb', line 263

def get_roles_without_specs
  get_all_roles - get_roles_with_specs
end

#get_vagrant_or_regular_ansible_hosts ⇒ Object 



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/ansible_spec_plus.rb', line 465

def get_vagrant_or_regular_ansible_hosts
  hosts = []

  Dir.chdir(BASE_DIR) do
    properties = AnsibleSpecHelper.get_properties
    cfg = AnsibleSpec::AnsibleCfg.new

    properties.each do |property|
      if property['hosts'].empty?
        get_hosts_from_vai_host_file.each do |host, values|
          values.each do |property|
            hosts << property['name'] if check_for_existing_playbook(property['name'])
          end
        end
      else
        property['hosts'].each do |host|
          hosts << property['name'] if check_for_existing_playbook(property['name'])
        end
      end
    end
  end

  return hosts
end

#list_all_specs ⇒ Object 



36
37
38
39
40
 
# File 'lib/ansible_spec_plus.rb', line 36

def list_all_specs
  list_role_specs
  list_host_specs
  list_playbook_specs
end

#list_host_specs ⇒ Object

HOST METHODS #



378
379
380
381
382
383
384
385
 
# File 'lib/ansible_spec_plus.rb', line 378

def list_host_specs
  get_hosts_with_specs.each do |host|
    command = "asp hostspec #{host}"
    description = "# run host specs for #{host}"

    puts "#{command} #{description.rjust(40)}"
  end
end

#list_playbook_specs ⇒ Object

PLAYBOOK METHODS #



532
533
534
535
536
537
538
539
 
# File 'lib/ansible_spec_plus.rb', line 532

def list_playbook_specs
  get_playbooks_with_host_and_or_role_specs.each do |playbook|
    command = "asp playbookspec #{playbook}"
    description = "# run playbook specs (host specs and role specs) for #{playbook} playbook"

    puts "#{command} #{description.rjust(77)}"
  end
end

#list_role_specs ⇒ Object

ROLE METHODS #



212
213
214
215
216
217
218
219
 
# File 'lib/ansible_spec_plus.rb', line 212

def list_role_specs
  get_roles_with_specs.each do |role|
    command = "asp rolespec #{role}"
    description = "# run role specs for #{role}"

    puts "#{command} #{description.rjust(40)}"
  end
end

#load_host_resources(name) ⇒ Object 



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/ansible_spec_plus.rb', line 435

def load_host_resources(name)
  resources = []

  Dir.chdir(BASE_DIR) do
    YAML.load_file('./site.yml').each do |site|
      next unless site.values[0] =~ /#{name}\.(yml|yaml)/

      playbook_path = site.values[0]

      AnsibleSpec.load_playbook(playbook_path).each do |playbook|
        next if playbook['tasks'].nil?

        playbook['tasks'].map { |task| resources << task }
      end
    end
  end

  return resources.flatten
end

#load_playbook_resources(name) ⇒ Object 



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/ansible_spec_plus.rb', line 586

def load_playbook_resources(name)
  resources = []

  # collect role resources
  Dir.chdir(BASE_DIR) do
    YAML.load_file('./site.yml').each do |site|
      next unless site.values[0] =~ /#{name}\.(yml|yaml)/

      playbook_path = site.values[0]

      AnsibleSpec.load_playbook(playbook_path).each do |playbook|
        playbook['roles'].map { |role| resources << load_role_resources(role) }
      end
    end
  end

  # collect host resources
  resources = resources.flatten + load_host_resources(name)

  return resources
end

#load_role_resources(name) ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/ansible_spec_plus.rb', line 315

def load_role_resources(name)
  resources = []

  Dir.chdir("#{BASE_DIR}/roles/#{name}/tasks") do
    Dir.glob("*.yml").each do |file|
      AnsibleSpec.load_playbook(file).each do |resource|
        resources << resource
      end
    end
  end

  return resources
end

#print_rounded_role_coverage(all_resources, differences) ⇒ Object 



157
158
159
160
161
162
163
 
# File 'lib/ansible_spec_plus.rb', line 157

def print_rounded_role_coverage(all_resources, differences)
  if all_resources.count == 0
    return "0%"
  else
    "#{((all_resources - differences).count.to_f / all_resources.count.to_f * 100.0).round}%"
  end
end

#run(options) ⇒ Object

COMMON METHODS #



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/ansible_spec_plus.rb', line 24

def run(options)
  list_all_specs if options[:list] == true

  list_role_specs if options[:list_rolespec] == true
  list_host_specs if options[:list_hostspec] == true
  list_playbook_specs if options[:list_playbookspec] == true

  run_role_spec(options[:run_rolespec]) if options[:run_rolespec]
  run_host_spec(options[:run_hostspec]) if options[:run_hostspec]
  run_playbook_spec(options[:run_playbookspec]) if options[:run_playbookspec]
end

#run_host_spec(host) ⇒ Object 



425
426
427
428
429
430
431
432
433
 
# File 'lib/ansible_spec_plus.rb', line 425

def run_host_spec(host)
  create_host_rake_task(host)

  Dir.chdir(BASE_DIR) do
    Rake.application.invoke_task("#{host}")
  end

  calculate_coverage('host', host)
end

#run_playbook_spec(playbook) ⇒ Object 



541
542
543
544
545
546
547
548
549
 
# File 'lib/ansible_spec_plus.rb', line 541

def run_playbook_spec(playbook)
  create_playbook_rake_task(playbook)

  Dir.chdir(BASE_DIR) do
    Rake.application.invoke_task("#{playbook}")
  end

  calculate_coverage('playbook', playbook)
end

#run_role_spec(role) ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/ansible_spec_plus.rb', line 221

def run_role_spec(role)
  if check_role_directory_available(role) && check_role_specs_available(role)
    create_role_rake_task(role)

    Dir.chdir(BASE_DIR) do
      Rake.application["#{role}"].invoke()
    end

    calculate_coverage('role', role)
  end
end