Class: DPL::Provider

Inherits:
Object
  • Object
show all
Includes:
FileUtils
Defined in:
lib/dpl/provider.rb,
lib/dpl/provider/s3.rb,
lib/dpl/provider/npm.rb,
lib/dpl/provider/pypi.rb,
lib/dpl/provider/appfog.rb,
lib/dpl/provider/heroku.rb,
lib/dpl/provider/divshot.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/heroku/git.rb,
lib/dpl/provider/cloud_files.rb,
lib/dpl/provider/engine_yard.rb,
lib/dpl/provider/cloudcontrol.rb,
lib/dpl/provider/heroku/anvil.rb,
lib/dpl/provider/cloud_foundry.rb

Defined Under Namespace

Modules: Heroku Classes: Appfog, CloudControl, CloudFiles, CloudFoundry, Divshot, DotCloud, EngineYard, NPM, Nodejitsu, Openshift, OpsWorks, PyPI, 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.



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

def initialize(context, options)
  @context, @options = context, options
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



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

def context
  @context
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

.context ⇒ Object 



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

def self.context
  self
end

.experimental(name) ⇒ Object 



34
35
36
 
# File 'lib/dpl/provider.rb', line 34

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

.new(context, options) ⇒ Object 



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

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 



61
62
63
 
# File 'lib/dpl/provider.rb', line 61

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 



57
58
59
 
# File 'lib/dpl/provider.rb', line 57

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

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



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

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" % [name, version], retry: true)
  Gem.clear_paths
ensure
  require load
end

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



53
54
55
 
# File 'lib/dpl/provider.rb', line 53

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

Instance Method Details

#check_app ⇒ Object 



130
131
 
# File 'lib/dpl/provider.rb', line 130

def check_app
end

#cleanup ⇒ Object 



114
115
116
117
118
119
 
# File 'lib/dpl/provider.rb', line 114

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

#create_key(file) ⇒ Object 



133
134
135
 
# File 'lib/dpl/provider.rb', line 133

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

#deploy ⇒ Object 



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

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
end

#error(message) ⇒ Object

Raises:



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

def error(message)
  raise Error, message
end

#log(message) ⇒ Object 



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

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

#needs_key? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/dpl/provider.rb', line 126

def needs_key?
  true
end

#option(name, *alternatives) ⇒ Object 



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

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

#run(command) ⇒ Object 



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

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

#setup_git_credentials ⇒ Object 



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

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 



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/dpl/provider.rb', line 142

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)
  ENV['GIT_SSH'] = path
end

#sha ⇒ Object 



110
111
112
 
# File 'lib/dpl/provider.rb', line 110

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

#uncleanup ⇒ Object 



121
122
123
124
 
# File 'lib/dpl/provider.rb', line 121

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