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.



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

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



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

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 



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

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

#active_revision ⇒ Object 



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

def active_revision
  paths.active_revision.read.strip
end

#append_config_source(config_source) ⇒ Object 



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

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

#check_database_adapter? ⇒ Boolean

Returns:

  • (Boolean) 


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

def check_database_adapter?
  !ignore_database_adapter_warning? && has_database?
end

#configuration ⇒ Object Also known as: c 



138
139
140
 
# File 'lib/engineyard-serverside/configuration.rb', line 138

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

#configured_services ⇒ Object 



350
351
352
353
354
355
 
# File 'lib/engineyard-serverside/configuration.rb', line 350

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 



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

def current_role
  current_roles.to_a.first
end

#extra_bundle_install_options ⇒ Object 



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

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



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

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 



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

def framework_env_names
  %w[RAILS_ENV RACK_ENV NODE_ENV MERB_ENV]
end

#framework_envs ⇒ Object 



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

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) 


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

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

#has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#latest_revision ⇒ Object Also known as: revision 



281
282
283
 
# File 'lib/engineyard-serverside/configuration.rb', line 281

def latest_revision
  paths.latest_revision.read.strip
end

#load_ey_yml_data(data, shell) ⇒ Object 



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

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 



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/engineyard-serverside/configuration.rb', line 233

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) 


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

def migrate?
  !!migration_command
end

#node ⇒ Object 



211
212
213
 
# File 'lib/engineyard-serverside/configuration.rb', line 211

def node
  EY::Serverside.node
end

#paths ⇒ Object

Use [] to access attributes instead of calling methods so that we get nils instead of NoMethodError.

Rollback doesn't know about the repository location (nor should it need to), but it would like to use #short_log_message.



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

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) 


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

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

#precompile_assets_inferred? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#previous_revision ⇒ Object 



286
287
288
289
 
# File 'lib/engineyard-serverside/configuration.rb', line 286

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

#reload_configuration! ⇒ Object

reset cached configuration hash



145
146
147
 
# File 'lib/engineyard-serverside/configuration.rb', line 145

def reload_configuration!
  @configuration = nil
end

#required_downtime_stack? ⇒ Boolean

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

Returns:

  • (Boolean) 


346
347
348
 
# File 'lib/engineyard-serverside/configuration.rb', line 346

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

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

Returns:

  • (Boolean) 


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

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

#role ⇒ Object 



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

def role
  node['instance_role']
end

#rollback_paths! ⇒ Object 



259
260
261
262
263
264
265
266
267
 
# File 'lib/engineyard-serverside/configuration.rb', line 259

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

#ruby_version_command ⇒ Object 



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

def ruby_version_command
  "ruby -v"
end

#set_framework_envs ⇒ Object 



322
323
324
 
# File 'lib/engineyard-serverside/configuration.rb', line 322

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

#skip_precompile_assets? ⇒ Boolean

Returns:

  • (Boolean) 


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

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.



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/engineyard-serverside/configuration.rb', line 219

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 



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

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

#system_version_command ⇒ Object 



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

def system_version_command
  "uname -m"
end

#to_json ⇒ Object 



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

def to_json
  MultiJson.dump(configuration)
end