Class: SpecHelper

Inherits:
Object
  • Object
show all
Includes:
ExampleHelper
Defined in:
lib/serverspec_launcher/spec_helper.rb

Overview

Does all the setup fo r the serverspec tests

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ExampleHelper

#load_bundled_examples, #load_examples_from_gem, #load_shared_examples, #shared_examples

Constructor Details

#initialize(host = ENV['TARGET_HOST'], target = ENV['TARGET'], properties = nil) ⇒ SpecHelper

Returns a new instance of SpecHelper.



22
23
24
25
26
27
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 22

def initialize(host = ENV['TARGET_HOST'], target = ENV['TARGET'], properties = nil)
  @host = host
  @target = target

  load_properties properties
end

Instance Attribute Details

#properties ⇒ Object (readonly)

Returns the value of attribute properties.



21
22
23
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 21

def properties
  @properties
end

Class Method Details

.load(host = , target = , properties = nil) ⇒ Object 



136
137
138
139
140
141
142
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 136

def self.load(host = ENV['TARGET_HOST'], target = ENV['TARGET'], properties = nil)
  helper = SpecHelper.new host, target, properties
  props = helper.properties[:shared_example_gems] || []
  helper.load_shared_examples props
  helper.setup_backend
  helper
end

Instance Method Details

#docker_backend ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 108

def docker_backend
  set :backend, :docker

  set_docker_image
  set_docker_container
  set :docker_url, @target_properties[:docker_url] if @target_properties[:docker_url]
end

#load_properties(properties = nil) ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 29

def load_properties(properties = nil)
  @properties = properties ? properties : YAML.load_file('properties.yml')
  @target_properties = @properties[:targets][@target]
  @backend = @target_properties[:backend] || 'ssh'
  @target_properties[:target] = ENV['TASK_NAME']
  set_property @target_properties
end

#set_docker_container ⇒ Object 



116
117
118
119
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 116

def set_docker_container
  set :docker_container, @target_properties[:docker_container] if @target_properties[:docker_container]
  set :docker_container_create_options, @target_properties[:docker_options] if @target_properties[:docker_options]
end

#set_docker_image ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 121

def set_docker_image
  if @target_properties[:dockerfile]
    puts "Building Docker Image from #{@target_properties[:dockerfile]}"
    commands = File.read(@target_properties[:dockerfile])
    image = Docker::Image.build(commands)
    set :docker_image, image.id
  elsif @target_properties[:docker_build_dir]
    puts "Building Docker Image in dir #{@target_properties[:docker_build_dir]}"
    image = Docker::Image.build_from_dir(@target_properties[:docker_build_dir])
    set :docker_image, image.id
  else
    set :docker_image, @target_properties[:docker_image] if @target_properties[:docker_image]
  end
end

#setup_backend ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 37

def setup_backend
  if @backend == 'exec'
    set :backend, :exec
  elsif @backend == 'docker'
    docker_backend
  else
    ssh_backend
  end
end

#ssh_backend ⇒ Object 



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
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 47

def ssh_backend
  set :backend, :ssh

  sudo_checks

  ssh_user = @target_properties[:user] || Etc.getlogin

  options = if @backend == 'vagrant'
              vagrant_backend
            else
              Net::SSH::Config.for(@host)
            end

  options[:user] ||= ssh_user

  set :host, options[:host_name] || @host
  set :ssh_options, options

  # Disable sudo
  # set :disable_sudo, true

  # Set environment variables
  return unless @target_properties[:environment]

  env = @target_properties[:environment].map do |en|
    variable, value = en.split('=')
    { variable.to_sym => value }
  end.reduce({}, :merge)
  set :env, env
  set :env, 'LEEK' => 'SHEEK'
  puts env
end

#sudo_checks ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 80

def sudo_checks
  if ENV['ASK_SUDO_PASSWORD']
    begin
      require 'highline/import'
    rescue LoadError
      raise 'highline is not available. Try installing it.'
    end
    set :sudo_password, ask('Enter sudo password: ') { |q| q.echo = false }
  else
    set :sudo_password, ENV['SUDO_PASSWORD']
  end
end

#vagrant_backend ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/serverspec_launcher/spec_helper.rb', line 93

def vagrant_backend
  @host = @target_properties[:vagrant_host] || 'default'
  vagrant_dir = @target_properties[:vagrant_dir]

  old_dir = Dir.pwd
  Dir.chdir(vagrant_dir) if vagrant_dir
  `vagrant up #{@host}`

  config = Tempfile.new('', Dir.tmpdir)
  config.write(`vagrant ssh-config #{@host}`)
  config.close
  Dir.chdir old_dir
  Net::SSH::Config.for(@host, [config.path])
end