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
209
210
211
|
# File 'lib/chef/shell.rb', line 209
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
# File 'lib/chef/shell.rb', line 128
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 = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} > "
conf.return_format = " => %s \n"
conf.prompt_i = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} (#{Chef::VERSION})> "
conf.prompt_n = "#{ChefUtils::Dist::Infra::EXEC}#{leader(m)} ?> "
conf.prompt_s = "#{ChefUtils::Dist::Infra::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
190
191
192
193
|
# File 'lib/chef/shell.rb', line 190
def self.fatal!(message, exit_status)
Chef::Log.fatal(message)
exit exit_status
end
|
.greeting ⇒ Object
177
178
179
180
181
|
# File 'lib/chef/shell.rb', line 177
def self.greeting
"#{Etc.getlogin}@#{Shell.session.node["fqdn"]}"
rescue NameError, ArgumentError
""
end
|
.init(main) ⇒ Object
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
# File 'lib/chef/shell.rb', line 160
def self.init(main)
parse_json
configure_irb
session
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
124
125
126
|
# File 'lib/chef/shell.rb', line 124
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.
120
121
122
|
# File 'lib/chef/shell.rb', line 120
def self.irb_conf=(conf_hash)
@irb_conf = conf_hash
end
|
.leader(main_object) ⇒ Object
146
147
148
149
|
# File 'lib/chef/shell.rb', line 146
def self.leader(main_object)
env_string = Shell.env ? " (#{Shell.env})" : ""
LEADERS[main_object.class] + env_string
end
|
.parse_json ⇒ Object
183
184
185
186
187
188
|
# File 'lib/chef/shell.rb', line 183
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
204
205
206
207
|
# File 'lib/chef/shell.rb', line 204
def self.parse_opts
@options = Options.new
@options.parse_opts
end
|
.running? ⇒ Boolean
Shell assumes it’s running whenever it is defined
114
115
116
|
# File 'lib/chef/shell.rb', line 114
def self.running?
true
end
|
.session ⇒ Object
151
152
153
154
155
156
157
158
|
# File 'lib/chef/shell.rb', line 151
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
|
.solo_mode? ⇒ Boolean
100
101
102
|
# File 'lib/chef/shell.rb', line 100
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
|
# File 'lib/chef/shell.rb', line 57
def self.start
setup_logger
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
::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?
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
Chef::LocalMode.destroy_server_connectivity if solo_mode?
end
|