Module: Shell

Defined in:
lib/chef/shell.rb,
lib/chef/shell/ext.rb,
lib/chef/shell/model_wrapper.rb,
lib/chef/shell/shell_session.rb

Overview

= Shell Shell is Chef in an IRB session. Shell can interact with a Chef server via the REST API, and run and debug recipes interactively.

Defined Under Namespace

Modules: Extensions Classes: ClientSession, DoppelGangerClient, DoppelGangerSession, ModelWrapper, NamedDataBagWrapper, Options, ShellSession, SoloLegacySession, SoloSession, StandAloneSession

Constant Summary collapse

LEADERS =
Hash.new("")

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.editorObject


203
204
205
# File 'lib/chef/shell.rb', line 203

def self.editor
  @editor || Chef::Config[:editor] || ENV["EDITOR"]
end

.envObject

Returns the value of attribute env


46
47
48
# File 'lib/chef/shell.rb', line 46

def env
  @env
end

.optionsObject

Returns the value of attribute options


45
46
47
# File 'lib/chef/shell.rb', line 45

def options
  @options
end

Class Method Details

.client_typeObject


189
190
191
192
193
194
195
196
# File 'lib/chef/shell.rb', line 189

def self.client_type
  type = Shell::StandAloneSession
  type = Shell::SoloSession         if solo_mode?
  type = Shell::SoloLegacySession   if Chef::Config[:solo_legacy_shell]
  type = Shell::ClientSession       if Chef::Config[:client]
  type = Shell::DoppelGangerSession if Chef::Config[:doppelganger]
  type
end

.configure_irbObject


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/chef/shell.rb', line 122

def self.configure_irb
  irb_conf[:HISTORY_FILE] = Chef::Util::PathHelper.home(".chef", "chef_shell_history")
  irb_conf[:SAVE_HISTORY] = 1000

  irb_conf[:IRB_RC] = lambda do |conf|
    m = conf.main

    conf.prompt_c       = "#{Chef::Dist::EXEC}#{leader(m)} > "
    conf.return_format  = " => %s \n"
    conf.prompt_i       = "#{Chef::Dist::EXEC}#{leader(m)} (#{Chef::VERSION})> "
    conf.prompt_n       = "#{Chef::Dist::EXEC}#{leader(m)} ?> "
    conf.prompt_s       = "#{Chef::Dist::EXEC}#{leader(m)}%l> "
    conf.use_tracer     = false
    conf.instance_variable_set(:@use_multiline, false)
    conf.instance_variable_set(:@use_singleline, false)
  end
end

.fatal!(message, exit_status) ⇒ Object


184
185
186
187
# File 'lib/chef/shell.rb', line 184

def self.fatal!(message, exit_status)
  Chef::Log.fatal(message)
  exit exit_status
end

.greetingObject


171
172
173
174
175
# File 'lib/chef/shell.rb', line 171

def self.greeting
  "#{Etc.getlogin}@#{Shell.session.node["fqdn"]}"
rescue NameError, ArgumentError
  ""
end

.init(main) ⇒ Object


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/chef/shell.rb', line 154

def self.init(main)
  parse_json
  configure_irb

  session # trigger ohai run + session load

  session.node.consume_attributes(@json_attribs)

  Extensions.extend_context_object(main)

  main.version
  puts

  puts "run `help' for help, `exit' or ^D to quit."
  puts
end

.irb_confObject


118
119
120
# File 'lib/chef/shell.rb', line 118

def self.irb_conf
  @irb_conf || IRB.conf
end

.irb_conf=(conf_hash) ⇒ Object

Set the irb_conf object to something other than IRB.conf useful for testing.


114
115
116
# File 'lib/chef/shell.rb', line 114

def self.irb_conf=(conf_hash)
  @irb_conf = conf_hash
end

.leader(main_object) ⇒ Object


140
141
142
143
# File 'lib/chef/shell.rb', line 140

def self.leader(main_object)
  env_string = Shell.env ? " (#{Shell.env})" : ""
  LEADERS[main_object.class] + env_string
end

.parse_jsonObject


177
178
179
180
181
182
# File 'lib/chef/shell.rb', line 177

def self.parse_json
  if Chef::Config[:json_attribs]
    config_fetcher = Chef::ConfigFetcher.new(Chef::Config[:json_attribs])
    @json_attribs = config_fetcher.fetch_json
  end
end

.parse_optsObject


198
199
200
201
# File 'lib/chef/shell.rb', line 198

def self.parse_opts
  @options = Options.new
  @options.parse_opts
end

.running?Boolean

Shell assumes it's running whenever it is defined

Returns:

  • (Boolean)

108
109
110
# File 'lib/chef/shell.rb', line 108

def self.running?
  true
end

.sessionObject


145
146
147
148
149
150
151
152
# File 'lib/chef/shell.rb', line 145

def self.session
  unless client_type.instance.node_built?
    puts "Session type: #{client_type.session_type}"
    client_type.instance.json_configuration = @json_attribs
    client_type.instance.reset!
  end
  client_type.instance
end

.setup_loggerObject


98
99
100
101
102
103
104
105
# File 'lib/chef/shell.rb', line 98

def self.setup_logger
  Chef::Config[:log_level] ||= :warn
  # If log_level is auto, change it to warn
  Chef::Config[:log_level] = :warn if Chef::Config[:log_level] == :auto
  Chef::Log.init(STDERR)
  Mixlib::Authentication::Log.logger = Ohai::Log.logger = Chef::Log.logger
  Chef::Log.level = Chef::Config[:log_level] || :warn
end

.solo_mode?Boolean

Returns:

  • (Boolean)

94
95
96
# File 'lib/chef/shell.rb', line 94

def self.solo_mode?
  Chef::Config[:solo]
end

.startObject

Start the irb REPL with chef-shell's customizations


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/chef/shell.rb', line 51

def self.start
  setup_logger
  # FUGLY HACK: irb gives us no other choice.
  irb_help = [:help, :irb_help, IRB::ExtendCommandBundle::NO_OVERRIDE]
  IRB::ExtendCommandBundle.instance_variable_get(:@ALIASES).delete(irb_help)

  parse_opts
  Chef::Config[:shell_config] = options.config

  # HACK: this duplicates the functions of IRB.start, but we have to do it
  # to get access to the main object before irb starts.
  ::IRB.setup(nil)

  irb_conf[:USE_COLORIZE] = options.config[:use_colorize]
  irb_conf[:USE_SINGLELINE] = options.config[:use_singleline]
  irb_conf[:USE_MULTILINE] = options.config[:use_multiline]
  pp irb_conf[:USE_MULTILINE]

  irb = IRB::Irb.new

  if solo_mode?
    # Setup the mocked ChefServer
    Chef::Config.local_mode = true
    Chef::LocalMode.setup_server_connectivity
  end

  init(irb.context.main)

  irb_conf[:IRB_RC].call(irb.context) if irb_conf[:IRB_RC]
  irb_conf[:MAIN_CONTEXT] = irb.context

  trap("SIGINT") do
    irb.signal_handle
  end

  catch(:IRB_EXIT) do
    irb.eval_input
  end
ensure
  # We destroy the mocked ChefServer
  Chef::LocalMode.destroy_server_connectivity if solo_mode?
end