Class: Oxidized::Model

Inherits:
Object
  • Object
show all
Includes:
Config::Vars
Defined in:
lib/oxidized/model/model.rb,
lib/oxidized/model/outputs.rb

Defined Under Namespace

Classes: Outputs

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Config::Vars

#vars

Class Attribute Details

.procs ⇒ Hash (readonly)

Returns hash proc procs :pre+:post to be prepended/postfixed to output.

Returns:

  • (Hash) —

    hash proc procs :pre+:post to be prepended/postfixed to output

Author:

Since:

  • 0.0.39



84
85
86
 
# File 'lib/oxidized/model/model.rb', line 84

def procs
  @procs
end

Instance Attribute Details

#input ⇒ Object

Returns the value of attribute input.



98
99
100
 
# File 'lib/oxidized/model/model.rb', line 98

def input
  @input
end

#node ⇒ Object

Returns the value of attribute node.



98
99
100
 
# File 'lib/oxidized/model/model.rb', line 98

def node
  @node
end

Class Method Details

.cfg(*methods, **args, &block) ⇒ Object 



28
29
30
31
32
 
# File 'lib/oxidized/model/model.rb', line 28

def cfg(*methods, **args, &block)
  [methods].flatten.each do |method|
    process_args_block(@cfg[method.to_s], args, block)
  end
end

.cfgs ⇒ Object 



34
35
36
 
# File 'lib/oxidized/model/model.rb', line 34

def cfgs
  @cfg
end

.cmd(cmd_arg = nil, **args, &block) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/oxidized/model/model.rb', line 38

def cmd(cmd_arg = nil, **args, &block)
  if cmd_arg.class == Symbol
    process_args_block(@cmd[cmd_arg], args, block)
  else
    process_args_block(@cmd[:cmd], args, [cmd_arg, block])
  end
  Oxidized.logger.debug "lib/oxidized/model/model.rb Added #{cmd_arg} to the commands list"
end

.cmds ⇒ Object 



47
48
49
 
# File 'lib/oxidized/model/model.rb', line 47

def cmds
  @cmd
end

.comment(str = '# ') ⇒ Object 



18
19
20
21
22
 
# File 'lib/oxidized/model/model.rb', line 18

def comment(str = '# ')
  return @comment if @comment

  @comment = block_given? ? yield : str
end

.expect(regex, **args, &block) ⇒ Object 



51
52
53
 
# File 'lib/oxidized/model/model.rb', line 51

def expect(regex, **args, &block)
  process_args_block(@expect, args, [regex, block])
end

.expects ⇒ Object 



55
56
57
 
# File 'lib/oxidized/model/model.rb', line 55

def expects
  @expect
end

.inherited(klass) ⇒ Object 



9
10
11
12
13
14
15
16
 
# File 'lib/oxidized/model/model.rb', line 9

def inherited(klass)
  klass.instance_variable_set '@cmd',     (Hash.new { |h, k| h[k] = [] })
  klass.instance_variable_set '@cfg',     (Hash.new { |h, k| h[k] = [] })
  klass.instance_variable_set '@procs',   (Hash.new { |h, k| h[k] = [] })
  klass.instance_variable_set '@expect',  []
  klass.instance_variable_set '@comment', nil
  klass.instance_variable_set '@prompt',  nil
end

.post(**args) { ... } ⇒ void

This method returns an undefined value.

calls the block at the end of the model, adding the output of the block to the output string

Yields:

  • expects block which should return [String]

Author:

Since:

  • 0.0.39



77
78
79
 
# File 'lib/oxidized/model/model.rb', line 77

def post(**args, &block)
  process_args_block(@procs[:post], args, block)
end

.pre(**args) { ... } ⇒ void

This method returns an undefined value.

calls the block at the end of the model, prepending the output of the block to the output string

Yields:

  • expects block which should return [String]

Author:

Since:

  • 0.0.39



66
67
68
 
# File 'lib/oxidized/model/model.rb', line 66

def pre(**args, &block)
  process_args_block(@procs[:pre], args, block)
end

.prompt(regex = nil) ⇒ Object 



24
25
26
 
# File 'lib/oxidized/model/model.rb', line 24

def prompt(regex = nil)
  @prompt || (@prompt = regex)
end

Instance Method Details

#cfg ⇒ Object 



130
131
132
 
# File 'lib/oxidized/model/model.rb', line 130

def cfg
  self.class.cfgs
end

#cmd(string, &block) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oxidized/model/model.rb', line 100

def cmd(string, &block)
  Oxidized.logger.debug "lib/oxidized/model/model.rb Executing #{string}"
  out = @input.cmd(string)
  return false unless out

  out = out.b unless Oxidized.config.input.utf8_encoded?
  self.class.cmds[:all].each do |all_block|
    out = instance_exec Oxidized::String.new(out), string, &all_block
  end
  if vars :remove_secret
    self.class.cmds[:secret].each do |all_block|
      out = instance_exec Oxidized::String.new(out), string, &all_block
    end
  end
  out = instance_exec Oxidized::String.new(out), &block if block
  process_cmd_output out, string
end

#comment(str) ⇒ Object 



166
167
168
169
170
171
172
 
# File 'lib/oxidized/model/model.rb', line 166

def comment(str)
  data = ''
  str.each_line do |line|
    data << self.class.comment << line
  end
  data
end

#expect(regex, &block) ⇒ Object 



126
127
128
 
# File 'lib/oxidized/model/model.rb', line 126

def expect(regex, &block)
  self.class.expect regex, &block
end

#expects(data) ⇒ Object 



138
139
140
141
142
143
144
145
 
# File 'lib/oxidized/model/model.rb', line 138

def expects(data)
  self.class.expects.each do |re, cb|
    if data.match re
      data = cb.arity == 2 ? instance_exec([data, re], &cb) : instance_exec(data, &cb)
    end
  end
  data
end

#get ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oxidized/model/model.rb', line 147

def get
  Oxidized.logger.debug 'lib/oxidized/model/model.rb Collecting commands\' outputs'
  outputs = Outputs.new
  procs = self.class.procs
  self.class.cmds[:cmd].each do |command, block|
    out = cmd command, &block
    return false unless out

    outputs << out
  end
  procs[:pre].each do |pre_proc|
    outputs.unshift process_cmd_output(instance_eval(&pre_proc), '')
  end
  procs[:post].each do |post_proc|
    outputs << process_cmd_output(instance_eval(&post_proc), '')
  end
  outputs
end

#output ⇒ Object 



118
119
120
 
# File 'lib/oxidized/model/model.rb', line 118

def output
  @input.output
end

#prompt ⇒ Object 



134
135
136
 
# File 'lib/oxidized/model/model.rb', line 134

def prompt
  self.class.prompt
end

#screenscrape ⇒ Object 



174
175
176
 
# File 'lib/oxidized/model/model.rb', line 174

def screenscrape
  @input.class.to_s.match(/Telnet/) || vars(:ssh_no_exec)
end

#send(data) ⇒ Object 



122
123
124
 
# File 'lib/oxidized/model/model.rb', line 122

def send(data)
  @input.send data
end