Class: Kontena::Command

Inherits:

Clamp::Command

Object
Clamp::Command
Kontena::Command

show all

Defined in:: lib/kontena/command.rb

Direct Known Subclasses

Defined Under Namespace

Modules: Finalizer

Instance Attribute Summary collapse

#arguments ⇒ Object
Returns the value of attribute arguments.
#exit_code ⇒ Object readonly
Returns the value of attribute exit_code.
#result ⇒ Object readonly
Returns the value of attribute result.

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#arguments ⇒ `Object`

Returns the value of attribute arguments.



15
16
17

# File 'lib/kontena/command.rb', line 15

def arguments
  @arguments
end

#exit_code ⇒ `Object` (readonly)

Returns the value of attribute exit_code.



17
18
19

# File 'lib/kontena/command.rb', line 17

def exit_code
  @exit_code
end

#result ⇒ `Object` (readonly)

Returns the value of attribute result.



16
17
18

# File 'lib/kontena/command.rb', line 16

def result
  @result
end

Class Method Details

Overwrite Clamp's banner command. Calling banner multiple times will now add lines to the banner message instead of overwriting the whole message. This is useful if callbacks add banner messages.

Parameters:

message (String)



103
104
105

# File 'lib/kontena/command.rb', line 103

def self.banner(msg, extra_feed = true)
  self.description = [self.description, extra_feed ? "\n#{msg}" : msg].compact.join("\n")
end

.callback_matcher(cmd_class = nil, cmd_type = nil) ⇒ `Object`

# File 'lib/kontena/command.rb', line 79

def self.callback_matcher(cmd_class = nil, cmd_type = nil)
  unless cmd_class
    if @command_class.nil?
      return nil
    else
      return [@command_class, @command_type]
    end
  end
  @command_class = cmd_class.to_sym
  @command_type = cmd_type.to_sym
  [@command_class, @command_type]
end

.inherited(where) ⇒ `Object`



75
76
77

# File 'lib/kontena/command.rb', line 75

def self.inherited(where)
  where.extend Finalizer
end

.load_subcommand(path) ⇒ `Object`



71
72
73

# File 'lib/kontena/command.rb', line 71

def self.load_subcommand(path)
  Kontena::Cli::SubcommandLoader.new(path)
end

.requires_current_account_token ⇒ `Object`

# File 'lib/kontena/command.rb', line 121

def self.requires_current_account_token
  unless Kontena::Cli::Config.current_account && Kontena::Cli::Config.current_account.token && Kontena::Cli::Config.current_account.token.access_token
    banner "#{Kontena.pastel.green("Requires account authentication")}: This command requires that you have authenticated to Kontena Cloud using 'kontena cloud auth'"
  end
  @requires_current_account_token = true
end

.requires_current_account_token? ⇒ `Boolean`

Returns:

(Boolean)



145
146
147

# File 'lib/kontena/command.rb', line 145

def self.requires_current_account_token?
  @requires_current_account_token ||= false
end

.requires_current_grid ⇒ `Object`

# File 'lib/kontena/command.rb', line 114

def self.requires_current_grid
  unless Kontena::Cli::Config.current_grid
    banner "#{Kontena.pastel.green("Requires current grid")}: This command requires that you have selected a grid as the current grid using 'kontena grid use' or by setting KONTENA_GRID environment variable."
  end
  @requires_current_grid = true
end

.requires_current_grid? ⇒ `Boolean`

Returns:

(Boolean)



137
138
139

# File 'lib/kontena/command.rb', line 137

def self.requires_current_grid?
  @requires_current_grid ||= false
end

.requires_current_master ⇒ `Object`

# File 'lib/kontena/command.rb', line 107

def self.requires_current_master
  unless Kontena::Cli::Config.current_master
    banner "#{Kontena.pastel.green("Requires current master")}: This command requires that you have selected a current master using 'kontena master login' or 'kontena master use'. You can also use the environment variable KONTENA_URL to specify the master address or KONTENA_MASTER=master_name to override the current_master setting."
  end
  @requires_current_master = true
end

.requires_current_master? ⇒ `Boolean`

Returns:

(Boolean)



129
130
131

# File 'lib/kontena/command.rb', line 129

def self.requires_current_master?
  @requires_current_master ||= false
end

.requires_current_master_token ⇒ `Object`



154
155
156

# File 'lib/kontena/command.rb', line 154

def self.requires_current_master_token
  @requires_current_master_token = true
end

.requires_current_master_token? ⇒ `Boolean`

Returns:

(Boolean)



158
159
160

# File 'lib/kontena/command.rb', line 158

def self.requires_current_master_token?
  @requires_current_master_token ||= false
end

Instance Method Details

#help_requested? ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/kontena/command.rb', line 179

def help_requested?
  return true if @arguments.include?('--help')
  return true if @arguments.include?('-h')
  false
end

#run(arguments) ⇒ `Object`

# File 'lib/kontena/command.rb', line 185

def run(arguments)
  Kontena.logger.debug { "Running #{self.class.name} with #{arguments.inspect} -- callback matcher = '#{self.class.callback_matcher.nil? ? "nil" : self.class.callback_matcher.map(&:to_s).join(' ')}'" }
  @arguments = arguments

  run_callbacks :before_parse unless help_requested?

  parse @arguments

  unless help_requested?
    verify_current_master
    verify_current_master_token
    verify_current_grid
    run_callbacks :before
  end

  begin
    @result = execute
    @exit_code = @result.kind_of?(FalseClass) ? 1 : 0
  rescue SystemExit => exc
    @result = exc.status == 0
    @exit_code = exc.status
  end
  run_callbacks :after unless help_requested?
  exit(@exit_code) if @exit_code.to_i > 0
  @result
rescue Excon::Errors::SocketError => ex
  if ex.message.include?('Unable to verify certificate')
    $stderr.puts " [#{Kontena.pastel.red('error')}] The server uses a certificate signed by an unknown authority."
    $stderr.puts "         You can trust this server by copying server CA pem file to: #{Kontena.pastel.yellow("~/.kontena/certs/<hostname>.pem")}"
    $stderr.puts "         If kontena cannot find your system ca bundle, you can set #{Kontena.pastel.yellow('SSL_CERT_DIR=/etc/ssl/certs')} env variable to load them from another location."
    $stderr.puts "         Protip: you can bypass the certificate check by setting #{Kontena.pastel.yellow('SSL_IGNORE_ERRORS=true')} env variable, but any data you send to the server could be intercepted by others."
    abort
  else
    abort(ex.message)
  end
rescue Kontena::Errors::StandardError => ex
  raise ex if ENV['DEBUG']
  Kontena.logger.error(ex)
  abort(" [#{Kontena.pastel.red('error')}] #{ex.status} : #{ex.message}")
rescue Errno::EPIPE
  # If user is piping the command outputs to some other command that might exit before CLI has outputted everything
  abort
rescue Clamp::HelpWanted, Clamp::UsageError
  raise
rescue => ex
  raise ex if ENV['DEBUG']
  Kontena.logger.error(ex)
  abort(" [#{Kontena.pastel.red('error')}] #{ex.class.name} : #{ex.message}\n         See #{Kontena.log_target} or run the command again with environment DEBUG=true set to see the full exception")
end

#run_callbacks(state) ⇒ `Object`

# File 'lib/kontena/command.rb', line 92

def run_callbacks(state)
  if self.class.respond_to?(:callback_matcher) && !self.class.callback_matcher.nil? && !self.class.callback_matcher.compact.empty?
    Kontena::Callback.run_callbacks(self.class.callback_matcher, state, self)
  end
end

#verify_current_account_token ⇒ `Object`

# File 'lib/kontena/command.rb', line 149

def verify_current_account_token
  retried ||= false
  Kontena::Cli::Config.instance.require_current_account_token if self.class.requires_current_account_token?
end

#verify_current_grid ⇒ `Object`



141
142
143

# File 'lib/kontena/command.rb', line 141

def verify_current_grid
  Kontena::Cli::Config.instance.require_current_grid if self.class.requires_current_grid?
end

#verify_current_master ⇒ `Object`



133
134
135

# File 'lib/kontena/command.rb', line 133

def verify_current_master
  Kontena::Cli::Config.instance.require_current_master if self.class.requires_current_master?
end

#verify_current_master_token ⇒ `Object`

# File 'lib/kontena/command.rb', line 162

def verify_current_master_token
  return nil unless self.class.requires_current_master_token?
  retried ||= false
  Kontena::Cli::Config.instance.require_current_master_token
rescue Kontena::Cli::Config::TokenExpiredError
  success = Kontena::Client.new(
    Kontena::Cli::Config.instance.current_master.url,
    Kontena::Cli::Config.instance.current_master.token
  ).refresh_token
  if success && !retried
    retried = true
    retry
  else
    raise Kontena::Cli::Config::TokenExpiredError, "The access token has expired and refresh failed. Try authenticating again, use: kontena master login"
  end
end

Class: Kontena::Command

Direct Known Subclasses

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#arguments ⇒ Object

#exit_code ⇒ Object (readonly)

#result ⇒ Object (readonly)

Class Method Details

.banner(msg, extra_feed = true) ⇒ Object

.callback_matcher(cmd_class = nil, cmd_type = nil) ⇒ Object

.inherited(where) ⇒ Object

.load_subcommand(path) ⇒ Object

.requires_current_account_token ⇒ Object

.requires_current_account_token? ⇒ Boolean

.requires_current_grid ⇒ Object

.requires_current_grid? ⇒ Boolean

.requires_current_master ⇒ Object

.requires_current_master? ⇒ Boolean

.requires_current_master_token ⇒ Object

.requires_current_master_token? ⇒ Boolean

Instance Method Details

#help_requested? ⇒ Boolean

#run(arguments) ⇒ Object

#run_callbacks(state) ⇒ Object

#verify_current_account_token ⇒ Object

#verify_current_grid ⇒ Object

#verify_current_master ⇒ Object

#verify_current_master_token ⇒ Object

#arguments ⇒ `Object`

#exit_code ⇒ `Object` (readonly)

#result ⇒ `Object` (readonly)

.banner(msg, extra_feed = true) ⇒ `Object`

.callback_matcher(cmd_class = nil, cmd_type = nil) ⇒ `Object`

.inherited(where) ⇒ `Object`

.load_subcommand(path) ⇒ `Object`

.requires_current_account_token ⇒ `Object`

.requires_current_account_token? ⇒ `Boolean`

.requires_current_grid ⇒ `Object`

.requires_current_grid? ⇒ `Boolean`

.requires_current_master ⇒ `Object`

.requires_current_master? ⇒ `Boolean`

.requires_current_master_token ⇒ `Object`

.requires_current_master_token? ⇒ `Boolean`

#help_requested? ⇒ `Boolean`

#run(arguments) ⇒ `Object`

#run_callbacks(state) ⇒ `Object`

#verify_current_account_token ⇒ `Object`

#verify_current_grid ⇒ `Object`

#verify_current_master ⇒ `Object`

#verify_current_master_token ⇒ `Object`