Module: Deprec2

Defined in:
lib/deprec/capistrano_extensions.rb

Constant Summary collapse

DEPREC_TEMPLATES_BASE = 
File.join(File.dirname(__FILE__), 'templates')

Instance Method Summary collapse

Instance Method Details

#add_user_to_group(user, group) ⇒ Object

add group to the list of groups this user belongs to



278
279
280
281
 
# File 'lib/deprec/capistrano_extensions.rb', line 278

def add_user_to_group(user, group)
  invoke_command "groups #{user} | grep ' #{group} ' || #{sudo} /usr/sbin/usermod -G #{group} -a #{user}",
  :via => run_method
end

#append_to_file_if_missing(filename, value, options = {}) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/deprec/capistrano_extensions.rb', line 238

def append_to_file_if_missing(filename, value, options={})
  # XXX sort out single quotes in 'value' - they'l break command!
  # XXX if options[:requires_sudo] and :use_sudo then use sudo
  sudo <<-END
  sh -c '
  grep -F "#{value}" #{filename} > /dev/null 2>&1 || 
  echo "#{value}" >> #{filename}
  '
  END
end

#compare_files(app, local_file, remote_file) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/deprec/capistrano_extensions.rb', line 36

def compare_files(app, local_file, remote_file)
  stage = exists?(:stage) ? fetch(:stage).to_s : ''
  tmpdir = "/tmp/#{Time.now.strftime("%Y%m%d%H%M%S")}.deprec"
  
  FileUtils.mkdir_p(tmpdir)
  begin
    download(remote_file, File.join(tmpdir, "$CAPISTRANO:HOST$#{remote_file.gsub(/[\/\.]/, '_')}.tmp"), { :via => :scp, :silent => true })
  rescue Exception
    # ignore errors, it just means the file doesn't exist on a specific server. This can be the case if the file only
    # gets uploaded to servers with a specific role for example.
  end
  Dir.new(tmpdir).entries.collect { |e| File.file?(File.join(tmpdir, e)) ? File.join(tmpdir, e) : nil }.compact.each do |tmp_file|
    hostname = File.basename(tmp_file).split(/_/).first
    local_file_full_path = (File.exists?(File.join('config', stage, hostname, app.to_s, local_file)) ?
                            File.join('config', stage, hostname, app.to_s, local_file) :
                            File.join('config', stage, app.to_s, local_file))
    puts `diff -u #{local_file_full_path} #{tmp_file}` if File.exists?(local_file_full_path)
    FileUtils.rm_f(tmp_file)
  end
  FileUtils.rmdir(tmpdir)
end

#create_src_dir ⇒ Object 



297
298
299
 
# File 'lib/deprec/capistrano_extensions.rb', line 297

def create_src_dir
  mkdir(src_dir, :mode => 0775, :group => group_src, :via => :sudo)
end

#download_src(src_package, src_dir) ⇒ Object

download source package if we don’t already have it



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
 
# File 'lib/deprec/capistrano_extensions.rb', line 302

def download_src(src_package, src_dir)
  set_package_defaults(src_package)
  create_src_dir
  # check if file exists and if we have an MD5 hash or bytecount to compare 
  # against if so, compare and decide if we need to download again
  if defined?(src_package[:md5sum])
    md5_clause = " && echo '#{src_package[:md5sum]}' | md5sum -c - "
  end
  case src_package[:download_method]
    # when getting source with git
    when :git
      # ensure git is installed
      apt.install( {:base => %w(git-core)}, :stable) #TODO fix this to test ubuntu version <hardy might need specific git version for full git submodules support
      package_dir = File.join(src_dir, src_package[:dir])
      run "if [ -d #{package_dir} ]; then cd #{package_dir} && #{sudo} git checkout master && #{sudo} git pull && #{sudo} git submodule init && #{sudo} git submodule update; else #{sudo} git clone #{src_package[:url]} #{package_dir} && cd #{package_dir} && #{sudo} git submodule init && #{sudo} git submodule update ; fi"
    	# Checkout the revision wanted if defined
    	if src_package[:version]
    	  run "cd #{package_dir} && git branch | grep '#{src_package[:version]}$' && #{sudo} git branch -D '#{src_package[:version]}'; exit 0"
    	  run "cd #{package_dir} && #{sudo} git checkout -b #{src_package[:version]} #{src_package[:version]}" 
      end
	
    # when getting source with wget    
    when :http
      # ensure wget is installed
      apt.install( {:base => %w(wget)}, :stable )
      # XXX replace with invoke_command
      run "cd #{src_dir} && test -f #{src_package[:filename]} #{md5_clause} || #{sudo} wget --quiet --timestamping #{src_package[:url]}"
    else
      puts "DOWNLOAD SRC: Download method not recognised. src_package[:download_method]: #{src_package[:download_method]}"
  end
end

#filter_hosts(hostfilter) ⇒ Object 



16
17
18
19
20
21
 
# File 'lib/deprec/capistrano_extensions.rb', line 16

def filter_hosts(hostfilter)
  old_hostfilter = ENV['HOSTFILTER']
  ENV['HOSTFILTER'] = hostfilter.to_s
  yield
  ENV['HOSTFILTER'] = old_hostfilter.to_s
end

#for_roles(roles) ⇒ Object

Temporarily modify ROLES if HOSTS not set Capistrano’s default behaviour is for HOSTS to override ROLES



9
10
11
12
13
14
 
# File 'lib/deprec/capistrano_extensions.rb', line 9

def for_roles(roles)
  old_roles = ENV['ROLES']
  ENV['ROLES'] = roles.to_s unless ENV['HOSTS']
  yield
  ENV['ROLES'] = old_roles.to_s unless ENV['HOSTS']
end

#groupadd(group, options = {}) ⇒ Object

create a new group on target system



271
272
273
274
275
 
# File 'lib/deprec/capistrano_extensions.rb', line 271

def groupadd(group, options={})
  via = options.delete(:via) || run_method
  # XXX I don't like specifying the path to groupadd - need to sort out paths before long
  invoke_command "grep '#{group}:' /etc/group || #{sudo} /usr/sbin/groupadd #{group}", :via => via
end

#ignoring_roles_and_hosts ⇒ Object

Temporarily ignore ROLES and HOSTS



24
25
26
27
28
29
30
31
32
 
# File 'lib/deprec/capistrano_extensions.rb', line 24

def ignoring_roles_and_hosts
  old_roles = ENV['ROLES']
  old_hosts = ENV['HOSTS']
  ENV['ROLES'] = nil
  ENV['HOSTS'] = nil
  yield
  ENV['ROLES'] = old_roles
  ENV['HOSTS'] = old_hosts
end

#install_from_src(src_package, src_dir) ⇒ Object

install package from source



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/deprec/capistrano_extensions.rb', line 374

def install_from_src(src_package, src_dir)
  set_package_defaults(src_package)
  package_dir = File.join(src_dir, src_package[:dir])
  unpack_src(src_package, src_dir)
  apt.install( {:base => %w(build-essential)}, :stable )
  sudo <<-SUDO
  sh -c '
  cd #{package_dir};
  #{src_package[:configure]}
  #{src_package[:make]}
  #{src_package[:install]}
  #{src_package[:post_install]}
  '
  SUDO
end

#invoke_with_input(shell_command, input_query = /^Password/, response = nil) ⇒ Object 



425
426
427
 
# File 'lib/deprec/capistrano_extensions.rb', line 425

def invoke_with_input(shell_command, input_query=/^Password/, response=nil)
  handle_command_with_input(run_method, shell_command, input_query, response)
end

#mkdir(path, options = {}) ⇒ Object

create directory if it doesn’t already exist set permissions and ownership XXX move mode, path and



286
287
288
289
290
291
292
293
294
295
 
# File 'lib/deprec/capistrano_extensions.rb', line 286

def mkdir(path, options={})
  via = options.delete(:via) || :run
  # XXX need to make sudo commands wrap the whole command (sh -c ?)
  # XXX removed the extra 'sudo' from after the '||' - need something else
  invoke_command "test -d #{path} || #{sudo if via == :sudo} mkdir -p #{path}"
  invoke_command "chmod #{sprintf("%3o",options[:mode]||0755)} #{path}", :via => via if options[:mode]
  invoke_command "chown -R #{options[:owner]} #{path}", :via => via if options[:owner]
  groupadd(options[:group], :via => via) if options[:group]
  invoke_command "chgrp -R #{options[:group]} #{path}", :via => via if options[:group]
end

#overwrite?(full_path, rendered_template) ⇒ Boolean

Returns:

  • (Boolean) 


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
182
 
# File 'lib/deprec/capistrano_extensions.rb', line 142

def overwrite?(full_path, rendered_template)
  if defined?(overwrite_all)      
    if overwrite_all == true
      return true
    else
      return false
    end
  end
  
  # XXX add :always and :never later - not sure how to set persistent value from here
  # response = Capistrano::CLI.ui.ask "File exists. Overwrite? ([y]es, [n]o, [a]lways, n[e]ver)" do |q|
  puts
  response = Capistrano::CLI.ui.ask "File exists (#{full_path}). 
  Overwrite? ([y]es, [n]o, [d]iff)" do |q|
    q.default = 'n'
  end
  
  case response
  when 'y'
    return true
  when 'n'
    return false
  when 'd'
    require 'tempfile'
    tf = Tempfile.new("deprec_diff") 
    tf.puts(rendered_template)
    tf.close
    puts
    puts "Running diff -u current_file new_file_if_you_overwrite"
    puts
    system "diff -u #{full_path} #{tf.path} | less"
    puts
    overwrite?(full_path, rendered_template)
  # XXX add :always and :never later - not sure how to set persistent value from here  
  # when 'a'
  #   set :overwrite_all, true
  # when 'e'
  #   set :overwrite_all, false
  end
  
end

#push_configs(app, files) ⇒ Object

Copy configs to server(s). Note there is no :pull task. No changes should be made to configs on the servers so why would you need to pull them back?



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/deprec/capistrano_extensions.rb', line 206

def push_configs(app, files)   
  app = app.to_s
  stage = exists?(:stage) ? fetch(:stage).to_s : ''
  
  files.each do |file|
    full_local_paths = find_servers.collect { |server| File.join('config', stage, server.host, app, file[:path]) }
    if full_local_paths.all? { |full_local_path| File.exists?(full_local_path) }
      full_local_path_with_parameter = File.join('config', stage, '%{host}', app, file[:path])
      # If the file path is relative we will prepend a path to this projects
      # own config directory for this service.
      if file[:path][0,1] != '/'
        full_remote_path = File.join(deploy_to, app, file[:path]) 
      else
        full_remote_path = file[:path]
      end
      sudo "test -d #{File.dirname(full_remote_path)} || #{sudo} mkdir -p #{File.dirname(full_remote_path)}"
      std.su_put full_local_path_with_parameter, full_remote_path, '/tmp/', :mode=>file[:mode]
      sudo "chown #{file[:owner]} #{full_remote_path}"
    else
      # Render directly to remote host.
      render_template(app, file.merge(:remote => true))
    end
  end
end

#read_database_yml ⇒ Object 



390
391
392
393
394
395
396
 
# File 'lib/deprec/capistrano_extensions.rb', line 390

def read_database_yml
  stage = exists?(:stage) ? fetch(:stage).to_s : ''
  db_config = YAML.load_file(File.join('config', stage, 'database.yml'))
  set :db_user, db_config[rails_env]["username"]
  set :db_password, db_config[rails_env]["password"] 
  set :db_name, db_config[rails_env]["database"]
end

#render_template(app, options = {}) ⇒ Object

Render template (usually a config file)

Usually we render it to a file on the local filesystem. This way, we keep a copy of the config file under source control. We can make manual changes if required and push to new hosts.

If the options hash contains :path then it’s written to that path. If it contains :remote => true, the file will instead be written to remote targets If options and options are missing, it just returns the rendered template as a string (good for debugging).

XXX I would like to get rid of :render_template_to_file
XXX Perhaps pass an option to this function to write to remote



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/deprec/capistrano_extensions.rb', line 72

def render_template(app, options={})
  template = options[:template]
  path = options[:path] || nil
  remote = options[:remote] || false
  mode = options[:mode] || 0755
  owner = options[:owner] || nil
  stage = exists?(:stage) ? fetch(:stage).to_s : ''
  # replace this with a check for the file
  if ! template
    puts "render_template() requires a value for the template!"
    return false 
  end

  # If local copies of deprec templates exist they will be used 
  # If you don't specify the location with the local_template_dir option
  # it defaults to config/templates.
  # e.g. config/templates/nginx/nginx.conf.erb
  local_template = File.join(local_template_dir, app.to_s, template)
  if File.exists?(local_template)
    puts
    puts "Using local template (#{local_template})"
    template = ERB.new(IO.read(local_template), nil, '-')
  else
    template = ERB.new(IO.read(File.join(DEPREC_TEMPLATES_BASE, app.to_s, template)), nil, '-')
  end
  rendered_templates = {}
  find_servers.collect { |server| server.host }.each do |host|
    scope host do
      rendered_templates[host] = template.result(binding)
    end
  end

  if remote 
    # render to remote machine
    puts 'You need to specify a path to render the template to!' unless path
    exit unless path
    sudo "test -d #{File.dirname(path)} || #{sudo} mkdir -p #{File.dirname(path)}"
    # First argument is empty string, since to be uploaded data is given by the Proc
    std.su_put "", path, '/tmp/', :mode => mode, :proc => Proc.new { |from, host|
      rendered_templates[host]
    }
    sudo "chown #{owner} #{path}" if defined?(owner)
  elsif path 
    # render to local file
    find_servers.collect { |server| server.host }.each do |host|
      full_path = File.join('config', stage, host, app.to_s, path)
      path_dir = File.dirname(full_path)
      if File.exists?(full_path)
        if IO.read(full_path) == rendered_templates[host]
          puts "[skip] File exists and is identical (#{full_path})."
          next
        elsif overwrite?(full_path, rendered_templates[host])
          File.delete(full_path)
        else
          puts "[skip] Not overwriting #{full_path}"
          next
        end
      end
      FileUtils.mkdir_p "#{path_dir}" if ! File.directory?(path_dir)
      # added line above to make windows compatible
      # system "mkdir -p #{path_dir}" if ! File.directory?(path_dir) 
      File.open(full_path, 'w'){|f| f.write rendered_templates[host] }
      puts "[done] #{full_path} written"
    end
  else
    # render to string
    return rendered_templates
  end
end

#render_template_to_file(template_name, destination_file_name, templates_dir = DEPREC_TEMPLATES_BASE) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/deprec/capistrano_extensions.rb', line 184

def render_template_to_file(template_name, destination_file_name, templates_dir = DEPREC_TEMPLATES_BASE)
  template_name += '.conf' if File.extname(template_name) == '' # XXX this to be removed

  file = File.join(templates_dir, template_name)
  buffers = {}
  find_servers.collect { |server| server.host }.each do |host|
    scope host do
      buffers[host] = render :template => File.read(file)
    end
  end

  temporary_location = "/tmp/#{template_name}"
  # First argument is empty string, since to be uploaded data is given by the Proc
  put "", temporary_location, :proc => Proc.new { |from, host|
    buffers[host]
  }
  sudo "cp #{temporary_location} #{destination_file_name}"
  delete temporary_location
end

#run_with_input(shell_command, input_query = /^Password/, response = nil) ⇒ Object

Run a command and ask for input when input_query is seen. Sends the response back to the server.

input_query is a regular expression that defaults to /^Password/.

Can be used where run would otherwise be used.

run_with_input 'ssh-keygen ...', /^Are you sure you want to overwrite\?/



409
410
411
 
# File 'lib/deprec/capistrano_extensions.rb', line 409

def run_with_input(shell_command, input_query=/^Password/, response=nil)
  handle_command_with_input(:run, shell_command, input_query, response)
end

#set_package_defaults(pkg) ⇒ Object 



363
364
365
366
367
368
369
370
371
 
# File 'lib/deprec/capistrano_extensions.rb', line 363

def set_package_defaults(pkg)
  pkg[:filename] ||= File.basename(pkg[:url])
  pkg[:dir] ||= pkg[:filename].sub(/(\.tgz|\.tar\.gz)/,'')
  pkg[:download_method] ||= :http
  pkg[:unpack] ||= "tar zxf #{pkg[:filename]};"
  pkg[:configure] ||= './configure ;'
  pkg[:make] ||= 'make;'
  pkg[:install] ||= 'make install;'
end

#substitute_in_file(filename, old_value, new_value, sep_char = '/') ⇒ Object

allow string substitutions in files on the server



250
251
252
253
254
255
256
257
 
# File 'lib/deprec/capistrano_extensions.rb', line 250

def substitute_in_file(filename, old_value, new_value, sep_char='/')
  # XXX sort out single quotes in 'value' - they'l break command!
  sudo <<-END
  sh -c "
  perl -p -i -e 's#{sep_char}#{old_value}#{sep_char}#{new_value}#{sep_char}' #{filename}
  "
  END
end

#sudo_stream(command) ⇒ Object

Run a command using sudo and continuously pipe the results back to the console.

Similar to the built-in stream, but for privileged users.



434
435
436
437
438
439
440
441
442
 
# File 'lib/deprec/capistrano_extensions.rb', line 434

def sudo_stream(command)
  sudo(command) do |ch, stream, out|
    puts out if stream == :out
    if stream == :err
      puts "[err : #{ch[:host]}] #{out}"
      break
    end
  end
end

#sudo_with_input(shell_command, input_query = /^Password/, response = nil) ⇒ Object

Run a command using sudo and ask for input when a regular expression is seen. Sends the response back to the server.

See also run_with_input

input_query is a regular expression



421
422
423
 
# File 'lib/deprec/capistrano_extensions.rb', line 421

def sudo_with_input(shell_command, input_query=/^Password/, response=nil)
  handle_command_with_input(:sudo, shell_command, input_query, response)
end

#teardown_connections ⇒ Object 



231
232
233
234
235
236
 
# File 'lib/deprec/capistrano_extensions.rb', line 231

def teardown_connections
  sessions.keys.each do |server|
       sessions[server].close
       sessions.delete(server)
  end
end

#unpack_src(src_package, src_dir) ⇒ Object

unpack src and make it writable by the group



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
 
# File 'lib/deprec/capistrano_extensions.rb', line 335

def unpack_src(src_package, src_dir)
  set_package_defaults(src_package)
  package_dir = File.join(src_dir, src_package[:dir])
  case src_package[:download_method]
    # when unpacking git sources - nothing to do
    when :git
      puts "UNPACK SRC: nothing to do for git installs"
    when :http
      sudo <<-EOF
      bash -c '
      cd #{src_dir};
      test -d #{package_dir}.old && rm -fr #{package_dir}.old;
      test -d #{package_dir} && mv #{package_dir} #{package_dir}.old;
      #{src_package[:unpack]}
      '
      EOF
    else
      puts "UNPACK SRC: Download method not recognised. src_package[:download_method]: #{src_package[:download_method]} "
  end
  sudo <<-EOF
  bash -c '
  cd #{src_dir};
  chgrp -R #{group} #{package_dir};  
  chmod -R g+w #{package_dir};
  '
  EOF
end

#useradd(user, options = {}) ⇒ Object

create new user account on target system



260
261
262
263
264
265
266
267
268
 
# File 'lib/deprec/capistrano_extensions.rb', line 260

def useradd(user, options={})
  options[:shell] ||= '/bin/bash' # new accounts on ubuntu 6.06.1 have been getting /bin/sh
  switches = ''
  switches += " --shell=#{options[:shell]} " if options[:shell]
  switches += ' --create-home ' unless options[:homedir] == false
  switches += " --gid #{options[:group]} " unless options[:group].nil?
  invoke_command "grep '^#{user}:' /etc/passwd || #{sudo} /usr/sbin/useradd #{switches} #{user}", 
  :via => run_method
end