Class: EY::Serverside::Deploy::Configuration

Inherits:
Object
  • Object
show all
Includes:
Paths::LegacyHelpers
Defined in:
lib/engineyard-serverside/configuration.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths::LegacyHelpers

#all_releases, legacy_path_helper

Constructor Details

#initialize(options) ⇒ Configuration

Returns a new instance of Configuration.



117
118
119
120
121
122
 
# File 'lib/engineyard-serverside/configuration.rb', line 117

def initialize(options)
  opts = string_keys(options)
  config = MultiJson.load(opts.delete("config") || "{}")
  append_config_source opts # high priority
  append_config_source config # lower priority
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args, &blk) ⇒ Object

Delegate to the configuration objects



195
196
197
 
# File 'lib/engineyard-serverside/configuration.rb', line 195

def method_missing(meth, *args, &blk)
  configuration.key?(meth.to_s) ? configuration.fetch(meth.to_s) : super
end

Class Method Details

.def_boolean_option(name, default = nil, &block) ⇒ Object

Calls def_option and adds a name? predicate method



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/engineyard-serverside/configuration.rb', line 28

def self.def_boolean_option(name, default=nil, &block)
  key ||= name.to_s

  define_method(name) do
    if block
      val = fetch(key) {instance_eval(&block)}
    else
      val = fetch(key, default)
    end
    not [false,nil,'false','nil'].include?(val) # deal with command line options turning booleans into strings
  end
  alias_method(:"#{name}?", name)
end

.def_option(name, default = nil, key = nil, &block) ⇒ Object

Defines a fetch method for the specified key. If no default and no block is specified, it means the key is required and if it's accessed without a value, it should raise.



18
19
20
21
22
23
24
25
 
# File 'lib/engineyard-serverside/configuration.rb', line 18

def self.def_option(name, default=nil, key=nil, &block)
  key ||= name.to_s
  if block_given?
    define_method(name) { fetch(key) {instance_eval(&block)} }
  else
    define_method(name) { fetch(key, default) }
  end
end

.def_required_option(name, key = nil) ⇒ Object

Required options do not have a default value. An option being required does not mean that it is always supplied, it just means that if it is accessed and it does not exist, an error will be raised instead of returning a nil default value.



46
47
48
49
50
51
 
# File 'lib/engineyard-serverside/configuration.rb', line 46

def self.def_required_option(name, key=nil)
  key ||= name.to_s
  define_method(name) do
    fetch(key) { raise "Required configuration option not found: #{key.inspect}" }
  end
end

Instance Method Details

#[](key) ⇒ Object 



182
183
184
185
186
187
188
 
# File 'lib/engineyard-serverside/configuration.rb', line 182

def [](key)
  if respond_to?(key.to_sym)
    send(key.to_sym)
  else
    configuration[key]
  end
end

#active_revision ⇒ Object 



268
269
270
 
# File 'lib/engineyard-serverside/configuration.rb', line 268

def active_revision
  paths.active_revision.read.strip
end

#append_config_source(config_source) ⇒ Object 



128
129
130
131
132
 
# File 'lib/engineyard-serverside/configuration.rb', line 128

def append_config_source(config_source)
  @config_sources ||= []
  @config_sources.unshift(config_source.dup)
  reload_configuration!
end

#check_database_adapter? ⇒ Boolean

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/engineyard-serverside/configuration.rb', line 289

def check_database_adapter?
  !ignore_database_adapter_warning? && has_database?
end

#configuration ⇒ Object Also known as: c 



134
135
136
 
# File 'lib/engineyard-serverside/configuration.rb', line 134

def configuration
  @configuration ||= @config_sources.inject({}) {|low,high| low.merge(high)}
end

#configured_services ⇒ Object 



341
342
343
344
345
346
 
# File 'lib/engineyard-serverside/configuration.rb', line 341

def configured_services
  services = YAML.load_file(paths.shared_services_yml.to_s)
  services.respond_to?(:keys) && !services.empty? ? services.keys : nil
rescue
  nil
end

#current_role ⇒ Object 



301
302
303
 
# File 'lib/engineyard-serverside/configuration.rb', line 301

def current_role
  current_roles.to_a.first
end

#extra_bundle_install_options ⇒ Object 



317
318
319
320
321
322
 
# File 'lib/engineyard-serverside/configuration.rb', line 317

def extra_bundle_install_options
  opts = []
  opts += ["--without", bundle_without] if bundle_without
  opts += [bundle_options] if bundle_options
  opts.flatten
end

#fetch(key, *args, &block) ⇒ Object

Fetch a key from the config. You must supply either a default second argument, or a default block



178
179
180
 
# File 'lib/engineyard-serverside/configuration.rb', line 178

def fetch(key, *args, &block)
  configuration.fetch(key.to_s, *args, &block)
end

#fetch_deprecated(attr, replacement, default) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/engineyard-serverside/configuration.rb', line 53

def fetch_deprecated(attr, replacement, default)
  called = false
  result = fetch(attr) { called = true; default }
  if !called # deprecated attr was found
    @deprecation_warning ||= {}
    @deprecation_warning[attr] ||= begin
                                     EY::Serverside.deprecation_warning "The configuration key '#{attr}' is deprecated in favor of '#{replacement}'."
                                     true
                                   end
  end
  result
end

#framework_env_names ⇒ Object 



305
306
307
 
# File 'lib/engineyard-serverside/configuration.rb', line 305

def framework_env_names
  %w[RAILS_ENV RACK_ENV NODE_ENV MERB_ENV]
end

#framework_envs ⇒ Object 



309
310
311
 
# File 'lib/engineyard-serverside/configuration.rb', line 309

def framework_envs
  framework_env_names.map { |e| "#{e}=#{framework_env}" }.join(' ')
end

#has_database? ⇒ Boolean

The nodatabase.yml file is dropped by server configuration when there is no database in the cluster.

Returns:

  • (Boolean) 


284
285
286
287
 
# File 'lib/engineyard-serverside/configuration.rb', line 284

def has_database?
  paths.shared_config.join('database.yml').exist? &&
    !paths.shared_config.join('nodatabase.yml').exist?
end

#has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
 
# File 'lib/engineyard-serverside/configuration.rb', line 190

def has_key?(key)
  respond_to?(key.to_sym) || configuration.has_key?(key)
end

#latest_revision ⇒ Object Also known as: revision 



272
273
274
 
# File 'lib/engineyard-serverside/configuration.rb', line 272

def latest_revision
  paths.latest_revision.read.strip
end

#load_ey_yml_data(data, shell) ⇒ Object 



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
 
# File 'lib/engineyard-serverside/configuration.rb', line 145

def load_ey_yml_data(data, shell)
  loaded = false

  environments = data['environments']
  if environments && environments[environment_name]
    shell.substatus "ey.yml configuration loaded for environment #{environment_name.inspect}."

    env_data = string_keys(environments[environment_name])
    shell.debug "#{environment_name}:\n#{env_data.pretty_inspect}"

    append_config_source(env_data) # insert at higher priority than defaults
    loaded = true
  end

  defaults = data['defaults']
  if defaults
    shell.substatus "ey.yml configuration loaded."
    append_config_source(string_keys(defaults)) # insert at lowest priority so as not to disturb important config
    shell.debug "defaults:\n#{defaults.pretty_inspect}"
    loaded = true
  end

  if loaded
    true
  else
    shell.info "No matching ey.yml configuration found for environment #{environment_name.inspect}."
    shell.debug "ey.yml:\n#{data.pretty_inspect}"
    false
  end
end

#load_source(klass, shell, uri) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/engineyard-serverside/configuration.rb', line 229

def load_source(klass, shell, uri)
  klass.new(
    shell,
    :verbose          => verbose,
    :repository_cache => paths.repository_cache,
    :app              => app,
    :uri              => uri,
    :ref              => branch
  )
end

#migrate? ⇒ Boolean

Returns:

  • (Boolean) 


293
294
295
 
# File 'lib/engineyard-serverside/configuration.rb', line 293

def migrate?
  !!migration_command
end

#node ⇒ Object 



207
208
209
 
# File 'lib/engineyard-serverside/configuration.rb', line 207

def node
  EY::Serverside.node
end

#paths ⇒ Object 



240
241
242
243
244
245
246
247
248
 
# File 'lib/engineyard-serverside/configuration.rb', line 240

def paths
  @paths ||= Paths.new({
    :home             => configuration['home_path'],
    :app_name         => app_name,
    :deploy_root      => configuration['deploy_to'],
    :active_release   => configuration['release_path'],
    :repository_cache => configuration['repository_cache'],
  })
end

#precompile_assets? ⇒ Boolean

Returns:

  • (Boolean) 


328
329
330
 
# File 'lib/engineyard-serverside/configuration.rb', line 328

def precompile_assets?
  precompile_assets == true || precompile_assets == "true"
end

#precompile_assets_inferred? ⇒ Boolean

Returns:

  • (Boolean) 


324
325
326
 
# File 'lib/engineyard-serverside/configuration.rb', line 324

def precompile_assets_inferred?
  precompile_assets.nil? || precompile_assets == "detect"
end

#previous_revision ⇒ Object 



277
278
279
280
 
# File 'lib/engineyard-serverside/configuration.rb', line 277

def previous_revision
  prev = paths.previous_revision
  prev && prev.readable? && prev.read.strip
end

#reload_configuration! ⇒ Object

reset cached configuration hash



141
142
143
 
# File 'lib/engineyard-serverside/configuration.rb', line 141

def reload_configuration!
  @configuration = nil
end

#required_downtime_stack? ⇒ Boolean

Assume downtime required if stack is not specified (nil) just in case.

Returns:

  • (Boolean) 


337
338
339
 
# File 'lib/engineyard-serverside/configuration.rb', line 337

def required_downtime_stack?
  [nil, 'nginx_mongrel', 'glassfish'].include? stack
end

#respond_to?(meth, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
 
# File 'lib/engineyard-serverside/configuration.rb', line 199

def respond_to?(meth, include_private=false)
  configuration.key?(meth.to_s) || super
end

#role ⇒ Object 



297
298
299
 
# File 'lib/engineyard-serverside/configuration.rb', line 297

def role
  node['instance_role']
end

#rollback_paths! ⇒ Object 



250
251
252
253
254
255
256
257
258
 
# File 'lib/engineyard-serverside/configuration.rb', line 250

def rollback_paths!
  rollback_paths = paths.rollback
  if rollback_paths
    @paths = rollback_paths
    true
  else
    false
  end
end

#ruby_version_command ⇒ Object 



260
261
262
 
# File 'lib/engineyard-serverside/configuration.rb', line 260

def ruby_version_command
  "ruby -v"
end

#set_framework_envs ⇒ Object 



313
314
315
 
# File 'lib/engineyard-serverside/configuration.rb', line 313

def set_framework_envs
  framework_env_names.each { |e| ENV[e] = environment }
end

#skip_precompile_assets? ⇒ Boolean

Returns:

  • (Boolean) 


332
333
334
 
# File 'lib/engineyard-serverside/configuration.rb', line 332

def skip_precompile_assets?
  precompile_assets == false || precompile_assets == "false"
end

#source(shell) ⇒ Object

Infer the deploy source strategy to use based on flag or default to specified strategy.

Returns a Source object.



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/engineyard-serverside/configuration.rb', line 215

def source(shell)
  if archive && git
    shell.fatal "Both --git and --archive specified. Precedence is not defined. Aborting"
    raise "Both --git and --archive specified. Precedence is not defined. Aborting"
  end
  if archive
    load_source(EY::Serverside::Source::Archive, shell, archive)
  elsif source_class
    load_source(EY::Serverside::Source.const_get(source_class), shell, git)
  else # git can be nil for integrate or rollback
    load_source(EY::Serverside::Source::Git, shell, git)
  end
end

#string_keys(hsh) ⇒ Object 



124
125
126
 
# File 'lib/engineyard-serverside/configuration.rb', line 124

def string_keys(hsh)
  hsh.inject({}) { |h,(k,v)| h[k.to_s] = v; h }
end

#system_version_command ⇒ Object 



264
265
266
 
# File 'lib/engineyard-serverside/configuration.rb', line 264

def system_version_command
  "uname -m"
end

#to_json ⇒ Object 



203
204
205
 
# File 'lib/engineyard-serverside/configuration.rb', line 203

def to_json
  MultiJson.dump(configuration)
end