Class: Serverspec::Setup

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

Class Method Summary collapse

Class Method Details

.ask_os_typeObject


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/serverspec/setup.rb', line 44

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


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/serverspec/setup.rb', line 61

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


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/serverspec/setup.rb', line 77

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


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

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 = /([a-z_-]+[\s]+)(created|not created|poweroff|running|saved)[\s](\(virtualbox\)|\(vmware\))/.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


178
179
180
181
182
183
184
# File 'lib/serverspec/setup.rb', line 178

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
# 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
  else
    @hostname = 'localhost'
  end

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

.safe_create_rakefileObject


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/serverspec/setup.rb', line 156

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

RSpec::Core::RakeTask.new(:spec) do |t|
  t.pattern = 'spec/*/*_spec.rb'
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


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
119
120
121
122
123
124
125
126
127
# File 'lib/serverspec/setup.rb', line 93

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

describe package('httpd') do
  it { should be_installed }
end

describe service('httpd') do
  it { should be_enabled   }
  it { should be_running   }
end

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

describe file('/etc/httpd/conf/httpd.conf') do
  it { should be_file }
  it { should contain "ServerName #{@hostname}" }
end
EOF

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

.safe_create_spec_helperObject


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

def self.safe_create_spec_helper
  requirements = []
  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


129
130
131
132
133
134
135
136
137
138
# File 'lib/serverspec/setup.rb', line 129

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


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

def self.spec_helper_template
  template = <<-EOF
require 'serverspec'
<% if @os_type == 'UN*X' && @backend_type == 'Ssh' -%>
require 'pathname'
<% end -%>
<% if @backend_type == 'Ssh' -%>
require 'net/ssh'
<% end -%>
<% if @backend_type == 'WinRM' -%>
require 'winrm'
<% end -%>

include SpecInfra::Helper::<%= @backend_type %>
<% if @os_type == 'UN*X' -%>
include SpecInfra::Helper::DetectOS
<% else  -%>
include SpecInfra::Helper::Windows
<% end -%>

<% if @os_type == 'UN*X' -%>
RSpec.configure do |c|
  if ENV['ASK_SUDO_PASSWORD']
require 'highline/import'
c.sudo_password = ask("Enter sudo password: ") { |q| q.echo = false }
  else
c.sudo_password = ENV['SUDO_PASSWORD']
  end
  <%- if @backend_type == 'Ssh' -%>
  c.before :all do
block = self.class.metadata[:example_group_block]
if RUBY_VERSION.start_with?('1.8')
  file = block.to_s.match(/.*@(.*):[0-9]+>/)[1]
else
  file = block.source_location.first
end
host  = File.basename(Pathname.new(file).dirname)
if c.host != host
  c.ssh.close if c.ssh
  c.host  = host
  options = Net::SSH::Config.for(c.host)
  user    = options[:user] || Etc.getlogin
<%- if @vagrant -%>
  vagrant_up = `vagrant up #{@hostname}`
  config = `vagrant ssh-config #{@hostname}`
  if config != ''
    config.each_line do |line|
      if match = /HostName (.*)/.match(line)
        host = match[1]
      elsif  match = /User (.*)/.match(line)
        user = match[1]
      elsif match = /IdentityFile (.*)/.match(line)
        options[:keys] =  [match[1].gsub(/\"/,'')]
      elsif match = /Port (.*)/.match(line)
        options[:port] = match[1]
      end
    end
  end
<%- end -%>
  c.ssh   = Net::SSH.start(host, user, options)
end
  end
  <%- end -%>
end
<% end -%>
<% if @backend_type == 'WinRM'-%>
RSpec.configure do |c|
  user = <username>
  pass = <password>
  endpoint = "http://<hostname>:5985/wsman"

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