Class: DPL::Provider

Inherits:
Object
  • Object
show all
Includes:
FileUtils
Defined in:
lib/dpl/provider.rb,
lib/dpl/provider/s3.rb,
lib/dpl/provider/gae.rb,
lib/dpl/provider/gcs.rb,
lib/dpl/provider/npm.rb,
lib/dpl/provider/deis.rb,
lib/dpl/provider/pypi.rb,
lib/dpl/provider/appfog.rb,
lib/dpl/provider/heroku.rb,
lib/dpl/provider/biicode.rb,
lib/dpl/provider/cloud66.rb,
lib/dpl/provider/divshot.rb,
lib/dpl/provider/hackage.rb,
lib/dpl/provider/modulus.rb,
lib/dpl/provider/ninefold.rb,
lib/dpl/provider/releases.rb,
lib/dpl/provider/rubygems.rb,
lib/dpl/provider/dot_cloud.rb,
lib/dpl/provider/nodejitsu.rb,
lib/dpl/provider/openshift.rb,
lib/dpl/provider/ops_works.rb,
lib/dpl/provider/bitballoon.rb,
lib/dpl/provider/heroku/api.rb,
lib/dpl/provider/heroku/git.rb,
lib/dpl/provider/cloud_files.rb,
lib/dpl/provider/code_deploy.rb,
lib/dpl/provider/engine_yard.rb,
lib/dpl/provider/cloudcontrol.rb,
lib/dpl/provider/heroku/anvil.rb,
lib/dpl/provider/puppet_forge.rb,
lib/dpl/provider/cloud_foundry.rb,
lib/dpl/provider/heroku/generic.rb,
lib/dpl/provider/heroku/git_ssh.rb,
lib/dpl/provider/elastic_beanstalk.rb,
lib/dpl/provider/heroku/git_deploy_key.rb

Defined Under Namespace

Modules: Heroku Classes: Appfog, Biicode, BitBalloon, Cloud66, CloudControl, CloudFiles, CloudFoundry, CodeDeploy, Deis, Divshot, DotCloud, ElasticBeanstalk, EngineYard, GAE, GCS, Hackage, Modulus, NPM, Ninefold, Nodejitsu, Openshift, OpsWorks, PuppetForge, PyPI, Releases, RubyGems, S3

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context, options) ⇒ Provider

Returns a new instance of Provider.



86
87
88
89
 
# File 'lib/dpl/provider.rb', line 86

def initialize(context, options)
  @context, @options = context, options
  context.env['GIT_HTTP_USER_AGENT'] = user_agent(git: `git --version`[/[\d\.]+/])
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



84
85
86
 
# File 'lib/dpl/provider.rb', line 84

def context
  @context
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



84
85
86
 
# File 'lib/dpl/provider.rb', line 84

def options
  @options
end

Class Method Details

.apt_get(name, command = name) ⇒ Object 



72
73
74
 
# File 'lib/dpl/provider.rb', line 72

def self.apt_get(name, command = name)
  context.shell("sudo apt-get -qq install #{name}", retry: true) if `which #{command}`.chop.empty?
end

.context ⇒ Object 



64
65
66
 
# File 'lib/dpl/provider.rb', line 64

def self.context
  self
end

.experimental(name) ⇒ Object 



49
50
51
 
# File 'lib/dpl/provider.rb', line 49

def self.experimental(name)
  puts "", "!!! #{name} support is experimental !!!", ""
end

.new(context, options) ⇒ Object 



39
40
41
42
43
44
45
46
47
 
# File 'lib/dpl/provider.rb', line 39

def self.new(context, options)
  return super if self < Provider

  context.fold("Installing deploy dependencies") do
    name = super.option(:provider).to_s.downcase.gsub(/[^a-z0-9]/, '')
    raise Error, 'could not find provider %p' % options[:provider] unless name = constants.detect { |c| c.to_s.downcase == name }
    const_get(name).new(context, options)
  end
end

.npm_g(name, command = name) ⇒ Object 



80
81
82
 
# File 'lib/dpl/provider.rb', line 80

def self.npm_g(name, command = name)
  context.shell("npm install -g #{name}", retry: true) if `which #{command}`.chop.empty?
end

.pip(name, command = name) ⇒ Object 



76
77
78
 
# File 'lib/dpl/provider.rb', line 76

def self.pip(name, command = name)
  context.shell("sudo pip install #{name}", retry: true) if `which #{command}`.chop.empty?
end

.requires(name, options = {}) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/dpl/provider.rb', line 53

def self.requires(name, options = {})
  version = options[:version] || '> 0'
  load    = options[:load]    || name
  gem(name, version)
rescue LoadError
  context.shell("gem install %s -v %p --no-ri --no-rdoc #{'--pre' if options[:pre]}" % [name, version], retry: true)
  Gem.clear_paths
ensure
  require load
end

.shell(command, options = {}) ⇒ Object 



68
69
70
 
# File 'lib/dpl/provider.rb', line 68

def self.shell(command, options = {})
  system(command)
end

Instance Method Details

#check_app ⇒ Object 



162
163
 
# File 'lib/dpl/provider.rb', line 162

def check_app
end

#cleanup ⇒ Object 



146
147
148
149
150
151
 
# File 'lib/dpl/provider.rb', line 146

def cleanup
  return if options[:skip_cleanup]
  context.shell "mv .dpl ~/dpl"
  context.shell "git stash --all"
  context.shell "mv ~/dpl .dpl"
end

#commit_msg ⇒ Object 



142
143
144
 
# File 'lib/dpl/provider.rb', line 142

def commit_msg
  @commit_msg ||= %x{git log #{sha} -n 1 --pretty=%B}.strip
end

#create_key(file) ⇒ Object 



165
166
167
 
# File 'lib/dpl/provider.rb', line 165

def create_key(file)
  context.shell "ssh-keygen -t rsa -N \"\" -C #{option(:key_name)} -f #{file}"
end

#deploy ⇒ Object 



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
 
# File 'lib/dpl/provider.rb', line 104

def deploy
  setup_git_credentials
  rm_rf ".dpl"
  mkdir_p ".dpl"

  context.fold("Preparing deploy") do
    check_auth
    check_app

    if needs_key?
      create_key(".dpl/id_rsa")
      setup_key(".dpl/id_rsa.pub")
      setup_git_ssh(".dpl/git-ssh", ".dpl/id_rsa")
    end

    cleanup
  end

  context.fold("Deploying application") { push_app }

  Array(options[:run]).each do |command|
    if command == 'restart'
      context.fold("Restarting application") { restart }
    else
      context.fold("Running %p" % command) { run(command) }
    end
  end
ensure
  if needs_key?
    remove_key rescue nil
  end
  uncleanup
end

#detect_encoding? ⇒ Boolean

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/dpl/provider.rb', line 187

def detect_encoding?
  options[:detect_encoding]
end

#encoding_for(path) ⇒ Object 



191
192
193
194
195
196
197
198
199
 
# File 'lib/dpl/provider.rb', line 191

def encoding_for(path)
  file_cmd_output = `file #{path}`
  case file_cmd_output
  when /gzip compressed/
    'gzip'
  when /compress'd/
    'compress'
  end
end

#error(message) ⇒ Object

Raises:



213
214
215
 
# File 'lib/dpl/provider.rb', line 213

def error(message)
  raise Error, message
end

#log(message) ⇒ Object 



201
202
203
 
# File 'lib/dpl/provider.rb', line 201

def log(message)
  $stderr.puts(message)
end

#needs_key? ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
 
# File 'lib/dpl/provider.rb', line 158

def needs_key?
  true
end

#option(name, *alternatives) ⇒ Object 



98
99
100
101
102
 
# File 'lib/dpl/provider.rb', line 98

def option(name, *alternatives)
  options.fetch(name) do
    alternatives.any? ? option(*alternatives) : raise(Error, "missing #{name}")
  end
end

#run(command) ⇒ Object 



209
210
211
 
# File 'lib/dpl/provider.rb', line 209

def run(command)
  error "running commands not supported"
end

#setup_git_credentials ⇒ Object 



169
170
171
172
 
# File 'lib/dpl/provider.rb', line 169

def setup_git_credentials
  context.shell "git config user.email >/dev/null 2>/dev/null || git config user.email `whoami`@localhost"
  context.shell "git config user.name >/dev/null 2>/dev/null || git config user.name `whoami`@localhost"
end

#setup_git_ssh(path, key_path) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/dpl/provider.rb', line 174

def setup_git_ssh(path, key_path)
  key_path = File.expand_path(key_path)
  path     = File.expand_path(path)

  File.open(path, 'w') do |file|
    file.write "#!/bin/sh\n"
    file.write "exec ssh -o StrictHostKeychecking=no -o CheckHostIP=no -o UserKnownHostsFile=/dev/null -i #{key_path} -- \"$@\"\n"
  end

  chmod(0740, path)
  context.env['GIT_SSH'] = path
end

#sha ⇒ Object 



138
139
140
 
# File 'lib/dpl/provider.rb', line 138

def sha
  @sha ||= context.env['TRAVIS_COMMIT'] || `git rev-parse HEAD`.strip
end

#uncleanup ⇒ Object 



153
154
155
156
 
# File 'lib/dpl/provider.rb', line 153

def uncleanup
  return if options[:skip_cleanup]
  context.shell "git stash pop"
end

#user_agent(*strings) ⇒ Object 



91
92
93
94
95
96
 
# File 'lib/dpl/provider.rb', line 91

def user_agent(*strings)
  strings.unshift "dpl/#{DPL::VERSION}"
  strings.unshift "travis/0.1.0" if context.env['TRAVIS']
  strings = strings.flat_map { |e| Hash === e ? e.map { |k,v| "#{k}/#{v}" } : e }
  strings.join(" ").gsub(/\s+/, " ").strip
end

#warn(message) ⇒ Object 



205
206
207
 
# File 'lib/dpl/provider.rb', line 205

def warn(message)
  log "\e[31;1m#{message}\e[0m"
end