Class: Serverspec::Setup

Inherits:
Object
  • Object
show all
Defined in:
lib/serverspec/setup.rb

Class Method Summary collapse

Class Method Details

.ask_os_typeObject


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/serverspec/setup.rb', line 48

def self.ask_os_type
  prompt = <<-EOF
Select OS type:

  1) UN*X
  2) Windows

Select number: 
EOF

  print prompt.chop
  num = $stdin.gets.to_i - 1
  puts

  @os_type = ['UN*X', 'Windows'][num] || 'UN*X'
end

.ask_unix_backendObject


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/serverspec/setup.rb', line 65

def self.ask_unix_backend
  prompt = <<-EOF
Select a backend type:

  1) SSH
  2) Exec (local)

Select number: 
EOF
  print prompt.chop
  num = $stdin.gets.to_i - 1
  puts

  @backend_type = ['ssh', 'exec'][num] || 'exec'
end

.ask_windows_backendObject


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/serverspec/setup.rb', line 81

def self.ask_windows_backend
  prompt = <<-EOF
Select a backend type:

  1) WinRM
  2) Cmd (local)

Select number: 
EOF
  print prompt.chop
  num = $stdin.gets.to_i - 1
  puts

  @backend_type = ['winrm', 'cmd'][num] || 'exec'
end

.auto_vagrant_configurationObject


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
# File 'lib/serverspec/setup.rb', line 216

def self.auto_vagrant_configuration
  if find_vagrantfile
    vagrant_list = `vagrant status`
    list_of_vms = []
    if vagrant_list != ''
      vagrant_list.each_line do |line|
        if match = /([\w-]+[\s]+)(created|aborted|not created|poweroff|running|saved)[\s](\(virtualbox\)|\(vmware\)|\(vmware_fusion\))/.match(line)
          list_of_vms << match[1].strip!
        end
      end
      if list_of_vms.length == 1
        @hostname = list_of_vms[0]
      else
        list_of_vms.each_with_index { |vm, index | puts "#{index}) #{vm}\n" }
        print 'Choose a VM from the Vagrantfile: '
        chosen_vm = $stdin.gets.chomp
        @hostname = list_of_vms[chosen_vm.to_i]
      end
    else
      $stderr.puts 'Vagrant status error - Check your Vagrantfile or .vagrant'
      exit 1
    end
  else
    $stderr.puts 'Vagrantfile not found in directory!'
    exit 1
  end
end

.find_vagrantfileObject


208
209
210
211
212
213
214
# File 'lib/serverspec/setup.rb', line 208

def self.find_vagrantfile
  Pathname.new(Dir.pwd).ascend do |dir|
    path = File.expand_path('Vagrantfile', dir)
    return path if File.exists?(path)
  end
  nil
end

.runObject


6
7
8
9
10
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
# File 'lib/serverspec/setup.rb', line 6

def self.run

  ask_os_type

  if @os_type == 'UN*X'
    ask_unix_backend
  else
    ask_windows_backend
  end

  if @backend_type == 'ssh'
    print 'Vagrant instance y/n: '
    @vagrant = $stdin.gets.chomp
    if @vagrant =~ (/(true|t|yes|y|1)$/i)
      @vagrant = true
      print 'Auto-configure Vagrant from Vagrantfile? y/n: '
      auto_config = $stdin.gets.chomp
      if auto_config =~ (/(true|t|yes|y|1)$/i)
        auto_vagrant_configuration
      else
        print('Input vagrant instance name: ')
        @hostname = $stdin.gets.chomp
      end
    else
      @vagrant = false
      print('Input target host name: ')
      @hostname = $stdin.gets.chomp
    end
  elsif @backend_type == 'winrm'
    print('Input target host name: ')
    @hostname = $stdin.gets.chomp
  else
    @hostname = 'localhost'
  end

  ['spec', "spec/#{@hostname}"].each { |dir| safe_mkdir(dir) }
  safe_create_spec
  safe_create_spec_helper
  safe_create_rakefile
  safe_create_dotrspec
end

.safe_create_dotrspecObject


314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/serverspec/setup.rb', line 314

def self.safe_create_dotrspec
  content = <<-'EOF'
--color
--format documentation
  EOF
  if File.exists? '.rspec'
    old_content = File.read('.rspec')
    if old_content != content
      $stderr.puts '!! .rspec already exists and differs from template'
    end
  else
    File.open('.rspec', 'w') do |f|
      f.puts content
    end
    puts ' + .rspec'
  end
end

.safe_create_rakefileObject


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/serverspec/setup.rb', line 168

def self.safe_create_rakefile
  content = <<-'EOF'
require 'rake'
require 'rspec/core/rake_task'

task :spec    => 'spec:all'
task :default => :spec

namespace :spec do
  targets = []
  Dir.glob('./spec/*').each do |dir|
next unless File.directory?(dir)
targets << File.basename(dir)
  end

  task :all     => targets
  task :default => :all

  targets.each do |target|
desc "Run serverspec tests to #{target}"
RSpec::Core::RakeTask.new(target.to_sym) do |t|
  ENV['TARGET_HOST'] = target
  t.pattern = "spec/#{target}/*_spec.rb"
end
  end
end
  EOF
  if File.exists? 'Rakefile'
    old_content = File.read('Rakefile')
    if old_content != content
      $stderr.puts '!! Rakefile already exists and differs from template'
    end
  else
    File.open('Rakefile', 'w') do |f|
      f.puts content
    end
    puts ' + Rakefile'
  end
end

.safe_create_specObject


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/serverspec/setup.rb', line 97

def self.safe_create_spec
  content = <<-EOF
require 'spec_helper'

describe package('httpd'), :if => os[:family] == 'redhat' do
  it { should be_installed }
end

describe package('apache2'), :if => os[:family] == 'ubuntu' do
  it { should be_installed }
end

describe service('httpd'), :if => os[:family] == 'redhat' do
  it { should be_enabled }
  it { should be_running }
end

describe service('apache2'), :if => os[:family] == 'ubuntu' do
  it { should be_enabled }
  it { should be_running }
end

describe service('org.apache.httpd'), :if => os[:family] == 'darwin' do
  it { should be_enabled }
  it { should be_running }
end

describe port(80) do
  it { should be_listening }
end
EOF

  if File.exists? "spec/#{@hostname}/sample_spec.rb"
    old_content = File.read("spec/#{@hostname}/sample_spec.rb")
    if old_content != content
      $stderr.puts "!! spec/#{@hostname}/sample_spec.rb already exists and differs from template"
    end
  else
    File.open("spec/#{@hostname}/sample_spec.rb", 'w') do |f|
      f.puts content
    end
    puts " + spec/#{@hostname}/sample_spec.rb"
  end
end

.safe_create_spec_helperObject


153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/serverspec/setup.rb', line 153

def self.safe_create_spec_helper
  content = ERB.new(spec_helper_template, nil, '-').result(binding)
  if File.exists? 'spec/spec_helper.rb'
    old_content = File.read('spec/spec_helper.rb')
    if old_content != content
      $stderr.puts "!! spec/spec_helper.rb already exists and differs from template"
    end
  else
    File.open('spec/spec_helper.rb', 'w') do |f|
      f.puts content
    end
    puts ' + spec/spec_helper.rb'
  end
end

.safe_mkdir(dir) ⇒ Object


142
143
144
145
146
147
148
149
150
151
# File 'lib/serverspec/setup.rb', line 142

def self.safe_mkdir(dir)
  if File.exists? dir
    unless File.directory? dir
      $stderr.puts "!! #{dir} already exists and is not a directory"
    end
  else
    FileUtils.mkdir dir
    puts " + #{dir}/"
  end
end

.spec_helper_templateObject


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
# File 'lib/serverspec/setup.rb', line 244

def self.spec_helper_template
  template = <<-'EOF'
require 'serverspec'
<% if @backend_type == 'ssh' -%>
require 'net/ssh'
<% end -%>
<%- if @vagrant -%>
require 'tempfile'
<% end -%>
<% if @backend_type == 'winrm' -%>
require 'winrm'
<% end -%>

set :backend, :<%= @backend_type %>

<% if @os_type == 'UN*X' && @backend_type == 'ssh' -%>
if ENV['ASK_SUDO_PASSWORD']
  begin
require 'highline/import'
  rescue LoadError
fail "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

<%- if @backend_type == 'ssh' -%>
host = ENV['TARGET_HOST']

<%- if @vagrant -%>
`vagrant up #{host}`

config = Tempfile.new('', Dir.tmpdir)
`vagrant ssh-config #{host} > #{config.path}`

options = Net::SSH::Config.for(host, [config.path])
<%- else -%>
options = Net::SSH::Config.for(host)
<%- end -%>

options[:user] ||= Etc.getlogin

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

# Disable sudo
# set :disable_sudo, true
<%- end -%>


# Set environment variables
# set :env, :LANG => 'C', :LC_MESSAGES => 'C' 

# Set PATH
# set :path, '/sbin:/usr/local/sbin:$PATH'
<%- end -%>
<% if @backend_type == 'winrm'-%>
user = <username>
pass = <password>
endpoint = "http://#{ENV['TARGET_HOST']}:5985/wsman"

winrm = ::WinRM::WinRMWebService.new(endpoint, :ssl, :user => user, :pass => pass, :basic_auth_only => true)
winrm.set_timeout 300 # 5 minutes max timeout for any operation
Specinfra.configuration.winrm = winrm
<% end -%>
EOF
  template
end