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

.editor ⇒ Object 



223
224
225
 
# File 'lib/chef/shell.rb', line 223

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

.env ⇒ Object

Returns the value of attribute env.



52
53
54
 
# File 'lib/chef/shell.rb', line 52

def env
  @env
end

.options ⇒ Object

Returns the value of attribute options.



51
52
53
 
# File 'lib/chef/shell.rb', line 51

def options
  @options
end

Class Method Details

.client_type ⇒ Object 



209
210
211
212
213
214
215
216
 
# File 'lib/chef/shell.rb', line 209

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_irb ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/chef/shell.rb', line 133

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

    # remove this clause for any Chef version that has upgraded to ruby >= 3.3.0
    if RUBY_VERSION >= "3.3.0"
      conf.prompt_c       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} > "
      conf.prompt_n       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} ?> "
      conf.prompt_s       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)}%l> "
    else
      # there's a bug if you use a left arrow and the alternative prompts
      # ... looks like 3.1.0 < version < 3.3.0 have it, from my manual testing
      conf.prompt_c       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} (#{Chef::VERSION})> "
      conf.prompt_n       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)}(#{Chef::VERSION})?> "
      conf.prompt_s       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)}(#{Chef::VERSION})%l> "
    end
    conf.prompt_i       = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} (#{Chef::VERSION})> "
    conf.return_format  = " => %s \n"
    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 



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

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

.greeting ⇒ Object 



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

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

.init(main) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/chef/shell.rb', line 174

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_conf ⇒ Object 



129
130
131
 
# File 'lib/chef/shell.rb', line 129

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.



125
126
127
 
# File 'lib/chef/shell.rb', line 125

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

.leader(main_object) ⇒ Object 



160
161
162
163
 
# File 'lib/chef/shell.rb', line 160

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

.parse_json ⇒ Object 



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

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_opts ⇒ Object 



218
219
220
221
 
# File 'lib/chef/shell.rb', line 218

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

.running? ⇒ Boolean

Shell assumes it’s running whenever it is defined

Returns:

  • (Boolean) 


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

def self.running?
  true
end

.session ⇒ Object 



165
166
167
168
169
170
171
172
 
# File 'lib/chef/shell.rb', line 165

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_logger ⇒ Object 



109
110
111
112
113
114
115
116
 
# File 'lib/chef/shell.rb', line 109

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) 


105
106
107
 
# File 'lib/chef/shell.rb', line 105

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

.start ⇒ Object

Start the irb REPL with chef-shell’s customizations



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
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/chef/shell.rb', line 57

def self.start
  setup_logger

  # @ALIASES was removed from irb in v1.13.0, but chef-shell can still be run in contexts that
  # use the Ruby 3.1.x default of irb v1.4.1
  if IRB::ExtendCommandBundle.instance_variables.include? :@ALIASES
    # 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)
  end

  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