Module: Shell

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

Overview

–

Author

Daniel DeLeo (<[email protected]>)

Copyright

Copyright © 2010 Opscode, Inc.

License

Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defined Under Namespace

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

Constant Summary collapse

LEADERS = 
Hash.new("")

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.client_type ⇒ Object

Returns the value of attribute client_type.



41
42
43
 
# File 'lib/chef/shell.rb', line 41

def client_type
  @client_type
end

.editor ⇒ Object 



195
196
197
 
# File 'lib/chef/shell.rb', line 195

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

.env ⇒ Object

Returns the value of attribute env.



43
44
45
 
# File 'lib/chef/shell.rb', line 43

def env
  @env
end

.options ⇒ Object

Returns the value of attribute options.



42
43
44
 
# File 'lib/chef/shell.rb', line 42

def options
  @options
end

Class Method Details

.configure_irb ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/chef/shell.rb', line 101

def self.configure_irb
  irb_conf[:HISTORY_FILE] = "~/.chef/chef_shell_history"
  irb_conf[:SAVE_HISTORY] = 1000

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

    conf.prompt_c       = "chef#{leader(m)} > "
    conf.return_format  = " => %s \n"
    conf.prompt_i       = "chef#{leader(m)} > "
    conf.prompt_n       = "chef#{leader(m)} ?> "
    conf.prompt_s       = "chef#{leader(m)}%l> "
  end
end

.fatal!(message, exit_status) ⇒ Object 



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

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

.greeting ⇒ Object 



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

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

.init(main) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/chef/shell.rb', line 129

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
  puts "Ohai2u#{greeting}!"
end

.irb_conf ⇒ Object 



97
98
99
 
# File 'lib/chef/shell.rb', line 97

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 usful for testing.



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

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

.leader(main_object) ⇒ Object 



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

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

.parse_json ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/chef/shell.rb', line 153

def self.parse_json
  # HACK: copied verbatim from chef/application/client, because it's not
  # reusable as written there :(
  if Chef::Config[:json_attribs]
    begin
      json_io = open(Chef::Config[:json_attribs])
    rescue SocketError => error
      fatal!("I cannot connect to #{Chef::Config[:json_attribs]}", 2)
    rescue Errno::ENOENT => error
      fatal!("I cannot find #{Chef::Config[:json_attribs]}", 2)
    rescue Errno::EACCES => error
      fatal!("Permissions are incorrect on #{Chef::Config[:json_attribs]}. Please chmod a+r #{Chef::Config[:json_attribs]}", 2)
    rescue Exception => error
      fatal!("Got an unexpected error reading #{Chef::Config[:json_attribs]}: #{error.message}", 2)
    end

    begin
      @json_attribs = Chef::JSONCompat.from_json(json_io.read)
    rescue JSON::ParserError => error
      fatal!("Could not parse the provided JSON file (#{Chef::Config[:json_attribs]})!: " + error.message, 2)
    end
  end
end

.parse_opts ⇒ Object 



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

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

.running? ⇒ Boolean

Shell assumes it’s running whenever it is defined

Returns:

  • (Boolean) 


87
88
89
 
# File 'lib/chef/shell.rb', line 87

def self.running?
  true
end

.session ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/chef/shell.rb', line 121

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

.setup_logger ⇒ Object 



77
78
79
80
81
82
83
84
 
# File 'lib/chef/shell.rb', line 77

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

.start ⇒ Object

Start the irb REPL with chef-shell’s customizations



48
49
50
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
 
# File 'lib/chef/shell.rb', line 48

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

  # 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 = IRB::Irb.new

  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
end