Class: Inspec::Resources::Cmd

Inherits:
Object
  • Object
show all
Defined in:
lib/resources/command.rb

Direct Known Subclasses

Bash, Ksh, PowershellScript

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cmd, options = {}) ⇒ Cmd

Returns a new instance of Cmd.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/resources/command.rb', line 25

def initialize(cmd, options = {})
  if cmd.nil?
    raise 'InSpec `command` was called with `nil` as the argument. This is not supported. Please provide a valid command instead.'
  end

  @command = cmd

  if options[:redact_regex]
    unless options[:redact_regex].is_a?(Regexp)
      # Make sure command is replaced so sensitive output isn't shown
      @command = 'ERROR'
      raise Inspec::Exceptions::ResourceFailed,
            'The `redact_regex` option must be a regular expression'
    end
    @redact_regex = options[:redact_regex]
  end
end

Instance Attribute Details

#command ⇒ Object (readonly)

Returns the value of attribute command.



23
24
25
 
# File 'lib/resources/command.rb', line 23

def command
  @command
end

Instance Method Details

#exist? ⇒ Boolean

rubocop:disable Metrics/AbcSize

Returns:

  • (Boolean) 


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/resources/command.rb', line 59

def exist? # rubocop:disable Metrics/AbcSize
  # silent for mock resources
  return false if inspec.os.name.nil? || inspec.os.name == 'mock'

  if inspec.os.linux?
    res = if inspec.platform.name == 'alpine'
            inspec.backend.run_command("which \"#{@command}\"")
          else
            inspec.backend.run_command("bash -c 'type \"#{@command}\"'")
          end
  elsif inspec.os.windows?
    res = inspec.backend.run_command("Get-Command \"#{@command}\"")
  elsif inspec.os.unix?
    res = inspec.backend.run_command("type \"#{@command}\"")
  else
    warn "`command(#{@command}).exist?` is not supported on your OS: #{inspec.os[:name]}"
    return false
  end
  res.exit_status.to_i == 0
end

#exit_status ⇒ Object 



55
56
57
 
# File 'lib/resources/command.rb', line 55

def exit_status
  result.exit_status.to_i
end

#result ⇒ Object 



43
44
45
 
# File 'lib/resources/command.rb', line 43

def result
  @result ||= inspec.backend.run_command(@command)
end

#stderr ⇒ Object 



51
52
53
 
# File 'lib/resources/command.rb', line 51

def stderr
  result.stderr
end

#stdout ⇒ Object 



47
48
49
 
# File 'lib/resources/command.rb', line 47

def stdout
  result.stdout
end

#to_s ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/resources/command.rb', line 80

def to_s
  output = "Command: `#{@command}`"
  # Redact output if the `redact_regex` option is passed
  # If no capture groups are passed then `\1` and `\2` are ignored
  output.gsub!(@redact_regex, '\1REDACTED\2') unless @redact_regex.nil?
  output
end