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.



89
90
91
92
93
94
 
# File 'lib/engineyard-serverside/configuration.rb', line 89

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



167
168
169
 
# File 'lib/engineyard-serverside/configuration.rb', line 167

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



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/engineyard-serverside/configuration.rb', line 25

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.



15
16
17
18
19
20
21
22
 
# File 'lib/engineyard-serverside/configuration.rb', line 15

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.



43
44
45
46
47
48
 
# File 'lib/engineyard-serverside/configuration.rb', line 43

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 



154
155
156
157
158
159
160
 
# File 'lib/engineyard-serverside/configuration.rb', line 154

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

#active_revision ⇒ Object 



215
216
217
 
# File 'lib/engineyard-serverside/configuration.rb', line 215

def active_revision
  paths.active_revision.read.strip
end

#append_config_source(config_source) ⇒ Object 



100
101
102
103
104
 
# File 'lib/engineyard-serverside/configuration.rb', line 100

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

#check_database_adapter? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/engineyard-serverside/configuration.rb', line 236

def check_database_adapter?
  !ignore_database_adapter_warning? && has_database?
end

#configuration ⇒ Object Also known as: c 



106
107
108
 
# File 'lib/engineyard-serverside/configuration.rb', line 106

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

#configured_services ⇒ Object 



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

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 



248
249
250
 
# File 'lib/engineyard-serverside/configuration.rb', line 248

def current_role
  current_roles.to_a.first
end

#disable_maintenance_page? ⇒ Boolean

We disable the maintenance page if we would have enabled.

Returns:

  • (Boolean) 


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

def disable_maintenance_page?
  enable_maintenance_page?
end

#enable_maintenance_page? ⇒ Boolean

Enable if stack requires it or if overridden in the ey.yml config.

Returns:

  • (Boolean) 


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

def enable_maintenance_page?
  maintenance_on_restart? || (migrate? && maintenance_on_migrate?)
end

#extra_bundle_install_options ⇒ Object 



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

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



150
151
152
 
# File 'lib/engineyard-serverside/configuration.rb', line 150

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

#framework_env_names ⇒ Object 



252
253
254
 
# File 'lib/engineyard-serverside/configuration.rb', line 252

def framework_env_names
  %w[RAILS_ENV RACK_ENV NODE_ENV MERB_ENV]
end

#framework_envs ⇒ Object 



256
257
258
 
# File 'lib/engineyard-serverside/configuration.rb', line 256

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) 


231
232
233
234
 
# File 'lib/engineyard-serverside/configuration.rb', line 231

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

#has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
 
# File 'lib/engineyard-serverside/configuration.rb', line 162

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

#latest_revision ⇒ Object Also known as: revision 



219
220
221
 
# File 'lib/engineyard-serverside/configuration.rb', line 219

def latest_revision
  paths.latest_revision.read.strip
end

#load_ey_yml_data(data, shell) ⇒ Object 



117
118
119
120
121
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
 
# File 'lib/engineyard-serverside/configuration.rb', line 117

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

#migrate? ⇒ Boolean

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/engineyard-serverside/configuration.rb', line 240

def migrate?
  !!migration_command
end

#node ⇒ Object 



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

def node
  EY::Serverside.node
end

#paths ⇒ Object 



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

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) 


275
276
277
 
# File 'lib/engineyard-serverside/configuration.rb', line 275

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

#precompile_assets_inferred? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#previous_revision ⇒ Object 



224
225
226
227
 
# File 'lib/engineyard-serverside/configuration.rb', line 224

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

#reload_configuration! ⇒ Object

reset cached configuration hash



113
114
115
 
# File 'lib/engineyard-serverside/configuration.rb', line 113

def reload_configuration!
  @configuration = nil
end

#required_downtime_stack? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

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

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/engineyard-serverside/configuration.rb', line 171

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

#role ⇒ Object 



244
245
246
 
# File 'lib/engineyard-serverside/configuration.rb', line 244

def role
  node['instance_role']
end

#rollback_paths! ⇒ Object 



197
198
199
200
201
202
203
204
205
 
# File 'lib/engineyard-serverside/configuration.rb', line 197

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

#ruby_version_command ⇒ Object 



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

def ruby_version_command
  "ruby -v"
end

#set_framework_envs ⇒ Object 



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

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

#skip_precompile_assets? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#strategy_class ⇒ Object 



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

def strategy_class
  EY::Serverside::Strategies.const_get(strategy)
end

#string_keys(hsh) ⇒ Object 



96
97
98
 
# File 'lib/engineyard-serverside/configuration.rb', line 96

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

#system_version_command ⇒ Object 



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

def system_version_command
  "uname -m"
end

#to_json ⇒ Object 



175
176
177
 
# File 'lib/engineyard-serverside/configuration.rb', line 175

def to_json
  MultiJson.dump(configuration)
end