Top Level Namespace

Defined Under Namespace

Modules: Capistrano Classes: TeeIO

Instance Method Summary collapse

Instance Method Details

#_cset(name, *args, &block) ⇒ Object


6
7
8
9
10
# File 'lib/capistrano/recipes/deploy.rb', line 6

def _cset(name, *args, &block)
  unless exists?(name)
    set(name, *args, &block)
  end
end

#depend(location, type, *args) ⇒ Object

Auxiliary helper method for the `deploy:check' task. Lets you set up your own dependencies.


85
86
87
88
89
90
91
# File 'lib/capistrano/recipes/deploy.rb', line 85

def depend(location, type, *args)
  deps = fetch(:dependencies, {})
  deps[location] ||= {}
  deps[location][type] ||= []
  deps[location][type] << args
  set :dependencies, deps
end

#run_locally(cmd) ⇒ Object

logs the command then executes it locally. returns the command output as a string


104
105
106
107
108
109
110
111
# File 'lib/capistrano/recipes/deploy.rb', line 104

def run_locally(cmd)
  logger.trace "executing locally: #{cmd.inspect}" if logger
  output_on_stdout = `#{cmd}`
  if $?.to_i > 0 # $? is command exit code (posix style)
    raise Capistrano::LocalArgumentError, "Command #{cmd} returned status code #{$?}"
  end
  output_on_stdout
end

#try_runner(*args) ⇒ Object

Same as sudo, but tries sudo with :as set to the value of the :runner variable (which defaults to “app”).


147
148
149
150
151
# File 'lib/capistrano/recipes/deploy.rb', line 147

def try_runner(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  args << options.merge(:as => fetch(:runner, "app"))
  try_sudo(*args)
end

#try_sudo(*args) ⇒ Object

If a command is given, this will try to execute the given command, as described below. Otherwise, it will return a string for use in embedding in another command, for executing that command as described below.

If :run_method is :sudo (or :use_sudo is true), this executes the given command via sudo. Otherwise is uses run. If :as is given as a key, it will be passed as the user to sudo as, if using sudo. If the :as key is not given, it will default to whatever the value of the :admin_runner variable is, which (by default) is unset.

THUS, if you want to try to run something via sudo, and what to use the root user, you'd just to try_sudo('something'). If you wanted to try_sudo as someone else, you'd just do try_sudo('something', :as => “bob”). If you always wanted sudo to run as a particular user, you could do set(:admin_runner, “bob”).

Raises:

  • (ArgumentError)

129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/capistrano/recipes/deploy.rb', line 129

def try_sudo(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  command = args.shift
  raise ArgumentError, "too many arguments" if args.any?

  as = options.fetch(:as, fetch(:admin_runner, nil))
  via = fetch(:run_method, :sudo)
  if command
    invoke_command(command, :via => via, :as => as)
  elsif via == :sudo
    sudo(:as => as)
  else
    ""
  end
end

#with_env(name, value) ⇒ Object

Temporarily sets an environment variable, yields to a block, and restores the value when it is done.


95
96
97
98
99
100
# File 'lib/capistrano/recipes/deploy.rb', line 95

def with_env(name, value)
  saved, ENV[name] = ENV[name], value
  yield
ensure
  ENV[name] = saved
end