Class: CFoundry::V1::App

Inherits:
Object
  • Object
show all
Defined in:
lib/cfoundry/v1/app.rb

Overview

Class for representing a user’s application on a given target (via Client).

Does not guarantee that the app exists; used for both app creation and retrieval, as the attributes are all lazily retrieved. Setting attributes does not perform any requests; use #update! to commit your changes.

Defined Under Namespace

Classes: Instance

Constant Summary collapse

UPLOAD_EXCLUDE =

Default paths to exclude from upload payload.

%w{.git _darcs .svn}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, client, manifest = nil) ⇒ App

Create an App object.

You’ll usually call Client#app instead



61
62
63
64
65
 
# File 'lib/cfoundry/v1/app.rb', line 61

def initialize(name, client, manifest = nil)
  @name = name
  @client = client
  @manifest = manifest
end

Instance Attribute Details

#command ⇒ Object

Application startup command.

Used for standalone apps.



44
45
46
 
# File 'lib/cfoundry/v1/app.rb', line 44

def command
  @command
end

#debug_mode ⇒ Object

Application debug mode.



47
48
49
 
# File 'lib/cfoundry/v1/app.rb', line 47

def debug_mode
  @debug_mode
end

#env ⇒ Object

Application environment variables.



30
31
32
 
# File 'lib/cfoundry/v1/app.rb', line 30

def env
  @env
end

#framework ⇒ Object

Application framework.



36
37
38
 
# File 'lib/cfoundry/v1/app.rb', line 36

def framework
  @framework
end

#memory ⇒ Object

Application memory.



33
34
35
 
# File 'lib/cfoundry/v1/app.rb', line 33

def memory
  @memory
end

#name ⇒ Object

Application name.



21
22
23
 
# File 'lib/cfoundry/v1/app.rb', line 21

def name
  @name
end

#runtime ⇒ Object

Application runtime.



39
40
41
 
# File 'lib/cfoundry/v1/app.rb', line 39

def runtime
  @runtime
end

#services ⇒ Object

Services bound to the application.



27
28
29
 
# File 'lib/cfoundry/v1/app.rb', line 27

def services
  @services
end

#state ⇒ Object Also known as: status

Application state.



50
51
52
 
# File 'lib/cfoundry/v1/app.rb', line 50

def state
  @state
end

#total_instances ⇒ Object

Application instance count.



24
25
26
 
# File 'lib/cfoundry/v1/app.rb', line 24

def total_instances
  @total_instances
end

#uris ⇒ Object Also known as: urls

URIs mapped to the application.



54
55
56
 
# File 'lib/cfoundry/v1/app.rb', line 54

def uris
  @uris
end

Instance Method Details

#bind(*service_names) ⇒ Object

Bind services to application.



316
317
318
 
# File 'lib/cfoundry/v1/app.rb', line 316

def bind(*service_names)
  update!(:services => services + service_names)
end

#create! ⇒ Object

Create the application on the target.

Call this after setting the various attributes.



88
89
90
91
 
# File 'lib/cfoundry/v1/app.rb', line 88

def create!
  @client.base.create_app(@manifest.merge(:name => @name))
  @manifest = nil
end

#delete! ⇒ Object

Delete the application from the target.

Keeps the metadata, but clears target-specific state from it.



75
76
77
78
79
80
81
82
83
 
# File 'lib/cfoundry/v1/app.rb', line 75

def delete!
  @client.base.delete_app(@name)

  if @manifest
    @manifest.delete :meta
    @manifest.delete :version
    @manifest.delete :state
  end
end

#exists? ⇒ Boolean

Check if the application exists on the target.

Returns:

  • (Boolean) 


94
95
96
97
98
99
 
# File 'lib/cfoundry/v1/app.rb', line 94

def exists?
  @client.base.app(@name)
  true
rescue CFoundry::NotFound
  false
end

#file(*path) ⇒ Object

Retrieve file contents for the first instance of the application.

path

A sequence of strings representing path segments.

For example, files("foo", "bar") for foo/bar.



344
345
346
 
# File 'lib/cfoundry/v1/app.rb', line 344

def file(*path)
  Instance.new(@name, 0, @client).file(*path)
end

#files(*path) ⇒ Object

Retrieve file listing under path for the first instance of the application.

path

A sequence of strings representing path segments.

For example, files("foo", "bar") for foo/bar.



334
335
336
 
# File 'lib/cfoundry/v1/app.rb', line 334

def files(*path)
  Instance.new(@name, 0, @client).files(*path)
end

#health ⇒ Object

Determine application health.

If all instances are running, returns “RUNNING”. If only some are started, returns the precentage of them that are healthy.

Otherwise, returns application’s status.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/cfoundry/v1/app.rb', line 146

def health
  s = state
  if s == "STARTED"
    healthy_count = manifest[:runningInstances]
    expected = manifest[:instances]
    if healthy_count && expected > 0
      ratio = healthy_count / expected.to_f
      if ratio == 1.0
        "RUNNING"
      else
        "#{(ratio * 100).to_i}%"
      end
    else
      "N/A"
    end
  else
    s
  end
end

#healthy? ⇒ Boolean Also known as: running?

Check that all application instances are running.

Returns:

  • (Boolean) 


167
168
169
170
171
 
# File 'lib/cfoundry/v1/app.rb', line 167

def healthy?
  # invalidate cache so the check is fresh
  @manifest = nil
  health == "RUNNING"
end

#inspect ⇒ Object

Show string representing the application.



68
69
70
 
# File 'lib/cfoundry/v1/app.rb', line 68

def inspect
  "#<App '#@name'>"
end

#instances ⇒ Object

Retrieve all of the instances of the app, as Instance objects.



102
103
104
105
106
 
# File 'lib/cfoundry/v1/app.rb', line 102

def instances
  @client.base.instances(@name).collect do |m|
    Instance.new(@name, m[:index], @client, m)
  end
end

#restart! ⇒ Object

Restart the application.



135
136
137
138
 
# File 'lib/cfoundry/v1/app.rb', line 135

def restart!
  stop!
  start!
end

#start! ⇒ Object

Start the application.



130
131
132
 
# File 'lib/cfoundry/v1/app.rb', line 130

def start!
  update! :state => "STARTED"
end

#started? ⇒ Boolean

Is the application started?

Note that this does not imply that all instances are running. See #healthy?

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/cfoundry/v1/app.rb', line 183

def started?
  state == "STARTED"
end

#stats ⇒ Object

Retrieve application statistics, e.g. CPU load and memory usage.



109
110
111
 
# File 'lib/cfoundry/v1/app.rb', line 109

def stats
  @client.base.stats(@name)
end

#stop! ⇒ Object

Stop the application.



125
126
127
 
# File 'lib/cfoundry/v1/app.rb', line 125

def stop!
  update! :state => "STOPPED"
end

#stopped? ⇒ Boolean

Is the application stopped?

Returns:

  • (Boolean) 


175
176
177
 
# File 'lib/cfoundry/v1/app.rb', line 175

def stopped?
  state == "STOPPED"
end

#unbind(*service_names) ⇒ Object

Unbind services from application.



321
322
323
324
325
326
 
# File 'lib/cfoundry/v1/app.rb', line 321

def unbind(*service_names)
  update!(:services =>
            services.reject { |s|
              service_names.include?(s)
            })
end

#update!(what = {}) ⇒ Object

Update application attributes. Does not restart the application.



114
115
116
117
118
119
120
121
122
 
# File 'lib/cfoundry/v1/app.rb', line 114

def update!(what = {})
  # bleh. have to set these here (normally in :meta) or they'll get lost.
  what[:debug] = debug_mode
  what[:staging] = (what[:staging] || {}).merge(manifest[:staging])
  what[:staging][:command] = command if command

  @client.base.update_app(@name, manifest.merge(what))
  @manifest = nil
end

#upload(path, check_resources = true) ⇒ Object

Upload application’s code to target. Do this after #create! and before #start!

path

A path pointing to either a directory, or a .jar, .war, or .zip file.

If a .vmcignore file is detected under the given path, it will be used to exclude paths from the payload, similar to a .gitignore.

check_resources

If set to ‘false`, the entire payload will be uploaded without checking the resource cache.

Only do this if you know what you’re doing.



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/cfoundry/v1/app.rb', line 366

def upload(path, check_resources = true)
  unless File.exist? path
    raise "invalid application path '#{path}'"
  end

  zipfile = "#{Dir.tmpdir}/#{@name}.zip"
  tmpdir = "#{Dir.tmpdir}/.vmc_#{@name}_files"

  FileUtils.rm_f(zipfile)
  FileUtils.rm_rf(tmpdir)

  prepare_package(path, tmpdir)

  resources = determine_resources(tmpdir) if check_resources

  packed = CFoundry::Zip.pack(tmpdir, zipfile)

  @client.base.upload_app(@name, packed && zipfile, resources || [])
ensure
  FileUtils.rm_f(zipfile) if zipfile
  FileUtils.rm_rf(tmpdir) if tmpdir
end

#uri ⇒ Object Also known as: url

Shortcut for uris



222
223
224
 
# File 'lib/cfoundry/v1/app.rb', line 222

def uri
  uris[0]
end

#uri=(x) ⇒ Object Also known as: url=

Shortcut for uris = [x]



227
228
229
 
# File 'lib/cfoundry/v1/app.rb', line 227

def uri=(x)
  self.uris = [x]
end