Module: Deprec2

Defined in:
lib/deprec-core/capistrano_extensions.rb

Constant Summary collapse

CLEAR =

Pretty coloured output in terminal

Embed in a String to clear all previous ANSI sequences.

"\e[0m"
BOLD = 
"\e[1m"
BLACK =

# Colors

"\e[30m"
RED = 
"\e[31m"
GREEN = 
"\e[32m"
YELLOW = 
"\e[33m"
BLUE = 
"\e[34m"
MAGENTA = 
"\e[35m"
CYAN = 
"\e[36m"
WHITE = 
"\e[37m"

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



234
235
236
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 234

def add_user_to_group(user, group)
  run "groups #{user} | grep ' #{group} ' || #{sudo} /usr/sbin/usermod -G #{group} -a #{user}"
end

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



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 207

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

#create_src_dir ⇒ Object 



256
257
258
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 256

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

#download_src(src_pkg, src_dir = src_dir) ⇒ Object

download source pkg if we don’t already have it



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

def download_src(src_pkg, src_dir=src_dir)
  set_pkg_defaults(src_pkg)
  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_pkg[:md5sum])
    md5_clause = " && echo '#{src_pkg[:md5sum]}' | md5sum -c - "
  end
  case src_pkg[: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
      pkg_dir = File.join(src_dir, src_pkg[:dir])
      run "if [ -d #{pkg_dir} ]; then cd #{pkg_dir} && #{sudo} git checkout master && #{sudo} git pull && #{sudo} git submodule init && #{sudo} git submodule update; else #{sudo} git clone #{src_pkg[:url]} #{pkg_dir} && cd #{pkg_dir} && #{sudo} git submodule init && #{sudo} git submodule update ; fi"
    	# Checkout the revision wanted if defined
    	if src_pkg[:version]
    	  run "cd #{pkg_dir} && git branch | grep '#{src_pkg[:version]}$' && #{sudo} git branch -D '#{src_pkg[:version]}'; exit 0"
    	  run "cd #{pkg_dir} && #{sudo} git checkout -b #{src_pkg[:version]} #{src_pkg[:version]}" 
      end
	
    # when getting source with wget    
    when :http
      # ensure wget is installed
      apt.install( {:base => %w(wget)}, :stable )
      run "cd #{src_dir} && test -f #{src_pkg[:filename]} #{md5_clause} || #{sudo} wget --quiet --timestamping #{src_pkg[:url]}"

    when :deb
      run "cd #{src_dir} && test -f #{src_pkg[:filename]} #{md5_clause} || #{sudo} wget --quiet --timestamping #{src_pkg[:url]}"

    else
      puts "DOWNLOAD SRC: Download method not recognised. src_pkg[:download_method]: #{src_pkg[:download_method]}"
  end
end

#for_roles(roles) ⇒ Object

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



30
31
32
33
34
35
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 30

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



229
230
231
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 229

def groupadd(group, options={})
  run "grep '#{group}:' /etc/group || #{sudo} /usr/sbin/groupadd #{group}"
end

#ignoring_roles_and_hosts ⇒ Object

Temporarily ignore ROLES and HOSTS



38
39
40
41
42
43
44
45
46
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 38

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_deps(packages = []) ⇒ Object 



350
351
352
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 350

def install_deps(packages=[])
  apt.install({:base => Array(packages)}, :stable)
end

#install_from_src(src_pkg, src_dir = src_dir) ⇒ Object

install pkg from source



338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 338

def install_from_src(src_pkg, src_dir=src_dir)
  install_deps(src_pkg[:deps])
  set_pkg_defaults(src_pkg)
  pkg_dir = File.join([src_dir, src_pkg[:dir]].compact)
  unpack_src(src_pkg, src_dir)
  apt.install( {:base => %w(build-essential)}, :stable )
  run "cd #{pkg_dir} && #{sudo} #{src_pkg[:configure]}" if src_pkg[:configure] != ''
  run "cd #{pkg_dir} && #{sudo} #{src_pkg[:make]}" if src_pkg[:make] != ''
  run "cd #{pkg_dir} && #{sudo} #{src_pkg[:install]}" if src_pkg[:install] != ''
  run "cd #{pkg_dir} && #{sudo} #{src_pkg[:post_install]}" if src_pkg[:post_install] != ''
end

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



389
390
391
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 389

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

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

create directory if it doesn’t already exist set permissions and ownership



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 240

def mkdir(path, options={})
  run "test -d #{path} || #{sudo} mkdir -p #{path}"
  if options[:mode]
    run "#{sudo} chmod #{sprintf("%3o",options[:mode]||0755)} #{path}" 
  end
  if options[:owner]
    run "#{sudo} chown -R #{options[:owner]} #{path}" 
  end
  if options[:group]
    groupadd(options[:group]) 
  end
  if options[:group]
    run "#{sudo} chgrp -R #{options[:group]} #{path}" 
  end
end

#overwrite?(full_path, rendered_template) ⇒ Boolean

Returns:

  • (Boolean) 


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
156
157
158
159
160
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 122

def overwrite?(full_path, rendered_template)
  if defined?(overwrite_all)      
    if overwrite_all == true
      return true
    else
      return false
    end
  end
  
  puts
  response = Capistrano::CLI.ui.ask "#{RED}     conflict#{CLEAR}  #{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?



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 176

def push_configs(app, files)   
  app = app.to_s
  stage = exists?(:stage) ? fetch(:stage).to_s : ''
  
  files.each do |file|
    full_local_path = File.join('config', stage, app, file[:path])
    if File.exists?(full_local_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 File.read(full_local_path), 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

#rake_remote(task_name) ⇒ Object

Run rake task on remote server(s)



24
25
26
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 24

def rake_remote(task_name)
    run "cd #{current_path} && RAILS_ENV=#{rails_env} #{rake} #{task_name}"
end

#read_database_yml ⇒ Object 



354
355
356
357
358
359
360
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 354

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



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
119
120
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 63

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
  template_path = ''
  TEMPLATE_LOAD_PATH.each do |dir|
    template_path = File.join(dir, app.to_s, template)
    if File.exists?(template_path)
      template = ERB.new(IO.read(template_path), nil, '-')
      break
    end
  end
  rendered_template = template.result(binding)
  # puts "Using #{template_path}" # work out which template is being used

  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)}"
    std.su_put rendered_template, path, '/tmp/', :mode => mode
    sudo "chown #{owner} #{path}" if defined?(owner)
  elsif path 
    # render to local file
    full_path = File.join('config', stage, app.to_s, path)
    path_dir = File.dirname(File.expand_path(full_path))
    if File.exists?(full_path)
      if IO.read(full_path) == rendered_template
        puts "#{BLUE}    identical#{CLEAR}  #{full_path}"
        return false
      elsif overwrite?(full_path, rendered_template)
        File.delete(full_path)
      else
        puts "#{YELLOW}         skip#{CLEAR}  #{full_path}"
        return false
      end
    end
    FileUtils.mkdir_p "#{path_dir}" if ! File.directory?(path_dir)
    File.open(File.expand_path(full_path), 'w'){|f| f.write rendered_template }
    puts "#{GREEN}       create#{CLEAR}  #{full_path}"
  else
    # render to string
    return rendered_template
  end
end

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



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 162

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)
  buffer = render :template => File.read(file)

  temporary_location = "/tmp/#{template_name}"
  put buffer, temporary_location
  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\?/



373
374
375
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 373

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

#set_pkg_defaults(pkg) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 317

def set_pkg_defaults(pkg)
  pkg[:filename] ||= File.basename(pkg[:url])
  pkg[:download_method] ||= :http
  pkg[:post_install] ||= ''
  case pkg[:download_method]
  when :http
    pkg[:dir] ||= pkg[:filename].sub(/(\.tgz|\.tar\.gz)/,'')
    pkg[:unpack] ||= "tar zxf #{pkg[:filename]};"
    pkg[:configure] ||= './configure ;'
    pkg[:make] ||= 'make;'
    pkg[:install] ||= 'make install;'
  when :deb
    pkg[:dir] ||= ''
    pkg[:unpack] ||= ''
    pkg[:configure] ||= ''
    pkg[:make] ||= ''
    pkg[:install] ||= "dpkg -i #{pkg[: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.



398
399
400
401
402
403
404
405
406
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 398

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



385
386
387
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 385

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 



200
201
202
203
204
205
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 200

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

#unpack_src(src_pkg, src_dir = src_dir) ⇒ Object

unpack src and make it writable by the group



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 297

def unpack_src(src_pkg, src_dir=src_dir)
  set_pkg_defaults(src_pkg)
  pkg_dir = File.join([src_dir, src_pkg[:dir]].compact)
  case src_pkg[:download_method]
    # when unpacking git sources - nothing to do
    when :deb
      puts "UNPACK SRC: nothing to do for deb installs"
    when :git
      puts "UNPACK SRC: nothing to do for git installs"
    when :http
      run "test -d #{pkg_dir}.old && #{sudo} rm -fr #{pkg_dir}.old; exit 0"
      run "test -d #{pkg_dir} && #{sudo} mv #{pkg_dir} #{pkg_dir}.old; exit 0"
      run "cd #{src_dir} && #{sudo} #{src_pkg[:unpack]}" if src_pkg[:unpack] != ''
      run "#{sudo} chgrp -R #{group} #{pkg_dir}"
      run "#{sudo} chmod -R g+w #{pkg_dir}"
    else
      puts "UNPACK SRC: Download method not recognised. src_pkg[:download_method]: #{src_pkg[:download_method]} "
  end
end

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

create new user account on target system



219
220
221
222
223
224
225
226
 
# File 'lib/deprec-core/capistrano_extensions.rb', line 219

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?
  run "grep '^#{user}:' /etc/passwd || #{sudo} /usr/sbin/useradd #{switches} #{user}" 
end