Class: PuppetDebugger::Cli
- Inherits:
-
Object
- Object
- PuppetDebugger::Cli
- Extended by:
- Forwardable
- Includes:
- Support
- Defined in:
- lib/puppet-debugger/cli.rb
Instance Attribute Summary collapse
-
#bench ⇒ Object
Returns the value of attribute bench.
-
#extra_prompt ⇒ Object
Returns the value of attribute extra_prompt.
-
#hooks ⇒ Object
readonly
Returns the value of attribute hooks.
-
#html_mode ⇒ Object
Returns the value of attribute html_mode.
-
#in_buffer ⇒ Object
Returns the value of attribute in_buffer.
-
#log_level ⇒ Object
Returns the value of attribute log_level.
-
#out_buffer ⇒ Object
Returns the value of attribute out_buffer.
-
#settings ⇒ Object
Returns the value of attribute settings.
-
#source_file ⇒ Object
readonly
Returns the value of attribute source_file.
-
#source_line_num ⇒ Object
readonly
Returns the value of attribute source_line_num.
Class Method Summary collapse
- .print_repl_desc ⇒ Object
-
.start(options = { scope: nil }) ⇒ Object
start reads from stdin or from a file if from stdin, the repl will process the input and exit if from a file, the repl will process the file and continue to prompt.
-
.start_without_stdin(options = { scope: nil }) ⇒ Object
used to start a debugger session without attempting to read from stdin or this is primarily used by the debug::break() module function and the puppet debugger face.
Instance Method Summary collapse
-
#command_completion ⇒ Proc
if a plugin keyword is found lets return keywords using the plugin’s command completion otherwise return the default set of keywords and filter out based on input.
-
#expand_resource_type(types) ⇒ Object
returns a formatted array.
-
#handle_input(input) ⇒ Object
this method handles all input and expects a string of text.
-
#initialize(options = {}) ⇒ Cli
constructor
A new instance of Cli.
-
#key_words ⇒ Object
returns a cached list of key words.
-
#multiline_input?(e) ⇒ Boolean
tries to determine if the input is going to be a multiline input by reading the parser error message.
- #normalize_output(result) ⇒ Object
-
#read_loop ⇒ Object
reads input from stdin, since readline requires a tty we cannot read from other sources as readline requires a file object we parse the string after each input to determine if the input is a multiline_input entry.
- #responder_list ⇒ Object
-
#to_resource_declaration(type) ⇒ Object
looks up the type in the catalog by using the type and title and returns the resource in ral format.
Methods included from Support
#do_initialize, #generate_ast, #initialize_from_scope, #known_resource_types, #parse_error, #parser, #puppet_eval, #puppet_lib_dir, #puppet_repl_lib_dir, #static_responder_list
Methods included from Support::Loader
Methods included from Support::Node
#convert_remote_node, #create_node, #create_real_node, #get_remote_node, #node, #remote_node_name, #remote_node_name=, #set_node, #set_node_from_name, #set_remote_node_name
Methods included from Support::Functions
#data_type_files, #function_files, #function_map, #lib_dirs, #load_lib_dirs, #mod_finder
Methods included from Support::Scope
#create_scope, #scope, #scope_vars, #set_scope
Methods included from Support::Facts
#default_facter_version, #default_facterdb_filter, #default_facts, #dynamic_facterdb_filter, #facter_os_name, #facter_os_version, #facter_version, #node_facts, #server_facts, #set_facts
Methods included from Support::Environment
#create_environment, #create_node_environment, #default_manifests_dir, #default_modules_paths, #default_puppet_env_name, #default_site_manifest, #environment_loaders, #modules_paths, #puppet_env_name, #puppet_environment, #set_environment
Methods included from Support::Compilier
#compiler, #create_compiler, #set_compiler
Constructor Details
#initialize(options = {}) ⇒ Cli
Returns a new instance of Cli.
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/puppet-debugger/cli.rb', line 19 def initialize( = {}) do_initialize if Puppet[:codedir].nil? Puppet.settings[:name] = :debugger Puppet.settings[:trusted_server_facts] = true unless Puppet.settings[:trusted_server_facts].nil? Puppet[:static_catalogs] = false unless Puppet.settings[:static_catalogs].nil? set_remote_node_name([:node_name]) initialize_from_scope([:scope]) @log_level = 'notice' @out_buffer = [:out_buffer] || $stdout @html_mode = [:html_mode] || false @source_file = [:source_file] || nil @source_line_num = [:source_line] || nil @in_buffer = [:in_buffer] || $stdin Readline.completion_append_character = '' Readline.basic_word_break_characters = ' ' Readline.completion_proc = command_completion AwesomePrint.defaults = { html: @html_mode, sort_keys: true, indent: 2 } end |
Instance Attribute Details
#bench ⇒ Object
Returns the value of attribute bench.
15 16 17 |
# File 'lib/puppet-debugger/cli.rb', line 15 def bench @bench end |
#extra_prompt ⇒ Object
Returns the value of attribute extra_prompt.
15 16 17 |
# File 'lib/puppet-debugger/cli.rb', line 15 def extra_prompt @extra_prompt end |
#hooks ⇒ Object (readonly)
Returns the value of attribute hooks.
16 17 18 |
# File 'lib/puppet-debugger/cli.rb', line 16 def hooks @hooks end |
#html_mode ⇒ Object
Returns the value of attribute html_mode.
15 16 17 |
# File 'lib/puppet-debugger/cli.rb', line 15 def html_mode @html_mode end |
#in_buffer ⇒ Object
Returns the value of attribute in_buffer.
15 16 17 |
# File 'lib/puppet-debugger/cli.rb', line 15 def in_buffer @in_buffer end |
#log_level ⇒ Object
Returns the value of attribute log_level.
15 16 17 |
# File 'lib/puppet-debugger/cli.rb', line 15 def log_level @log_level end |
#out_buffer ⇒ Object
Returns the value of attribute out_buffer.
15 16 17 |
# File 'lib/puppet-debugger/cli.rb', line 15 def out_buffer @out_buffer end |
#settings ⇒ Object
Returns the value of attribute settings.
15 16 17 |
# File 'lib/puppet-debugger/cli.rb', line 15 def settings @settings end |
#source_file ⇒ Object (readonly)
Returns the value of attribute source_file.
16 17 18 |
# File 'lib/puppet-debugger/cli.rb', line 16 def source_file @source_file end |
#source_line_num ⇒ Object (readonly)
Returns the value of attribute source_line_num.
16 17 18 |
# File 'lib/puppet-debugger/cli.rb', line 16 def source_line_num @source_line_num end |
Class Method Details
.print_repl_desc ⇒ Object
173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/puppet-debugger/cli.rb', line 173 def self.print_repl_desc output = <<-EOT Ruby Version: #{RUBY_VERSION} Puppet Version: #{Puppet.version} Puppet Debugger Version: #{PuppetDebugger::VERSION} Created by: NWOps <[email protected]> Type "commands" for a list of debugger commands or "help" to show the help screen. EOT output end |
.start(options = { scope: nil }) ⇒ Object
start reads from stdin or from a file if from stdin, the repl will process the input and exit if from a file, the repl will process the file and continue to prompt
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/puppet-debugger/cli.rb', line 245 def self.start( = { scope: nil }) opts = Trollop. do opt :play, 'Url or file to load from', required: false, type: String opt :run_once, 'Evaluate and quit', required: false, default: false opt :node_name, 'Remote Node to grab facts from', required: false, type: String opt :quiet, 'Do not display banner', required: false, default: false end = opts.merge() puts print_repl_desc unless [:quiet] [:play] = [:play].path if [:play].respond_to?(:path) repl_obj = PuppetDebugger::Cli.new() if [:play] repl_obj.handle_input("play #{[:play]}") elsif ARGF.filename != '-' # when the user supplied a file name without using the args (stdin) path = File.(ARGF.filename) repl_obj.handle_input("play #{path}") elsif (ARGF.filename == '-') && (!STDIN.tty? && !STDIN.closed?) # when the user supplied a file content using stdin, aka. cat,pipe,echo or redirection input = ARGF.read repl_obj.handle_input(input) end # helper code to make tests exit the loop repl_obj.read_loop unless [:run_once] end |
.start_without_stdin(options = { scope: nil }) ⇒ Object
used to start a debugger session without attempting to read from stdin or this is primarily used by the debug::break() module function and the puppet debugger face
231 232 233 234 235 236 237 238 239 |
# File 'lib/puppet-debugger/cli.rb', line 231 def self.start_without_stdin( = { scope: nil }) puts print_repl_desc unless [:quiet] repl_obj = PuppetDebugger::Cli.new() [:play] = [:play].path if [:play].respond_to?(:path) # TODO: make the output optional so we can have different output destinations repl_obj.handle_input('whereami') if [:source_file] && [:source_line] repl_obj.handle_input("play #{[:play]}") if [:play] repl_obj.read_loop unless [:run_once] end |
Instance Method Details
#command_completion ⇒ Proc
if a plugin keyword is found lets return keywords using the plugin’s command completion otherwise return the default set of keywords and filter out based on input
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/puppet-debugger/cli.rb', line 45 def command_completion proc do |input| words = Readline.line_buffer.split(Readline.basic_word_break_characters) next key_words.grep(/^#{Regexp.escape(input)}/) if words.empty? first_word = words.shift plugins = PuppetDebugger::InputResponders::Commands.plugins.find_all do |p| p::COMMAND_WORDS.find { |word| word.start_with?(first_word)} end if plugins.count == 1 and /\A#{first_word}\s/.match(Readline.line_buffer) plugins.first.command_completion(words) else key_words.grep(/^#{Regexp.escape(input)}/) end end end |
#expand_resource_type(types) ⇒ Object
returns a formatted array
98 99 100 101 102 103 104 105 106 107 |
# File 'lib/puppet-debugger/cli.rb', line 98 def (types) output = [types].flatten.map do |t| if t.class.to_s =~ /Puppet::Pops::Types/ to_resource_declaration(t) else t end end output end |
#handle_input(input) ⇒ Object
this method handles all input and expects a string of text.
126 127 128 129 130 131 132 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 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/puppet-debugger/cli.rb', line 126 def handle_input(input) raise ArgumentError unless input.instance_of?(String) begin output = '' case input.strip when PuppetDebugger::InputResponders::Commands.command_list_regex args = input.split(' ') command = args.shift plugin = PuppetDebugger::InputResponders::Commands.plugin_from_command(command) output = plugin.execute(args, self) return out_buffer.puts output when '_' output = " => #{@last_item}" else result = puppet_eval(input) @last_item = result output = normalize_output(result) output = output.nil? ? '' : output.ai end rescue PuppetDebugger::Exception::InvalidCommand => e output = e..fatal rescue LoadError => e output = e..fatal rescue Errno::ETIMEDOUT => e output = e..fatal rescue ArgumentError => e output = e..fatal rescue Puppet::ResourceError => e output = e..fatal rescue Puppet::Error => e output = e..fatal rescue Puppet::ParseErrorWithIssue => e output = e..fatal rescue PuppetDebugger::Exception::FatalError => e output = e..fatal out_buffer.puts output exit 1 # this can sometimes causes tests to fail rescue PuppetDebugger::Exception::Error => e output = e..fatal end unless output.empty? out_buffer.print ' => ' out_buffer.puts output unless output.empty? exec_hook :after_output, out_buffer, self, self end end |
#key_words ⇒ Object
returns a cached list of key words
66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/puppet-debugger/cli.rb', line 66 def key_words # because dollar signs don't work we can't display a $ sign in the keyword # list so its not explicitly clear what the keyword variables = scope.to_hash.keys # prepend a :: to topscope variables scoped_vars = variables.map { |k, _v| scope.compiler.topscope.exist?(k) ? "$::#{k}" : "$#{k}" } # append a () to functions so we know they are functions funcs = function_map.keys.map { |k| "#{k.split('::').last}()" } PuppetDebugger::InputResponders::Datatypes.instance.debugger = self (scoped_vars + funcs + static_responder_list + PuppetDebugger::InputResponders::Datatypes.instance.all_data_types).uniq.sort end |
#multiline_input?(e) ⇒ Boolean
tries to determine if the input is going to be a multiline input by reading the parser error message
189 190 191 192 193 194 195 196 |
# File 'lib/puppet-debugger/cli.rb', line 189 def multiline_input?(e) case e. when /Syntax error at end of file/i true else false end end |
#normalize_output(result) ⇒ Object
109 110 111 112 113 114 115 116 117 118 |
# File 'lib/puppet-debugger/cli.rb', line 109 def normalize_output(result) if result.instance_of?(Array) output = (result) return output.first if output.count == 1 return output elsif result.class.to_s =~ /Puppet::Pops::Types/ return to_resource_declaration(result) end result end |
#read_loop ⇒ Object
reads input from stdin, since readline requires a tty we cannot read from other sources as readline requires a file object we parse the string after each input to determine if the input is a multiline_input entry. If it is multiline we run through the loop again and concatenate the input
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/puppet-debugger/cli.rb', line 203 def read_loop line_number = 1 full_buffer = '' while buf = Readline.readline("#{line_number}:#{extra_prompt}>> ", true) begin full_buffer += buf # unless this is puppet code, otherwise skip repl keywords unless PuppetDebugger::InputResponders::Commands.command_list_regex.match(buf) line_number = line_number.next parser.parse_string(full_buffer) end rescue Puppet::ParseErrorWithIssue => e if multiline_input?(e) out_buffer.print ' ' full_buffer += "\n" next end end handle_input(full_buffer) full_buffer = '' end end |
#responder_list ⇒ Object
120 121 122 |
# File 'lib/puppet-debugger/cli.rb', line 120 def responder_list plugins = Pluginator.find(PuppetDebugger) end |
#to_resource_declaration(type) ⇒ Object
looks up the type in the catalog by using the type and title and returns the resource in ral format
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/puppet-debugger/cli.rb', line 80 def to_resource_declaration(type) if type.respond_to?(:type_name) && type.respond_to?(:title) title = type.title type_name = type.type_name elsif type_result = /(\w+)\['?(\w+)'?\]/.match(type.to_s) # not all types have a type_name and title so we # output to a string and parse the results title = type_result[2] type_name = type_result[1] else return type end res = scope.catalog.resource(type_name, title) return res.to_ral if res # don't return anything or returns nil if item is not in the catalog end |