Module: Train::Platforms::Detect::Helpers::OSCommon

Includes:
Linux, Windows
Included in:
Scanner, UUID
Defined in:
lib/train/platforms/detect/helpers/os_common.rb

Instance Method Summary collapse

Methods included from Windows

#detect_windows, #read_wmic, #read_wmic_cpu, #windows_uuid, #windows_uuid_from_chef, #windows_uuid_from_machine_file, #windows_uuid_from_registry, #windows_uuid_from_wmic

Methods included from Linux

#linux_os_release, #lsb_config, #lsb_release, #parse_os_release_info, #read_linux_lsb, #redhatish_platform, #redhatish_version

Instance Method Details

#brocade_version ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 56

def brocade_version
  return @cache[:brocade] if @cache.key?(:brocade)
  res = command_output('version')

  m = res.match(/^Fabric OS:\s+v(\S+)$/)
  unless m.nil?
    return @cache[:brocade] = { version: m[1], type: 'fos' }
  end

  @cache[:brocade] = nil
end

#cisco_show_version ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 68

def cisco_show_version
  return @cache[:cisco] if @cache.key?(:cisco)
  res = command_output('show version')

  m = res.match(/Cisco IOS Software, [^,]+? \(([^,]+?)\), Version (\d+\.\d+)/)
  unless m.nil?
    return @cache[:cisco] = { version: m[2], model: m[1], type: 'ios' }
  end

  m = res.match(/Cisco IOS Software, IOS-XE Software, [^,]+? \(([^,]+?)\), Version (\d+\.\d+\.\d+[A-Z]*)/)
  unless m.nil?
    return @cache[:cisco] = { version: m[2], model: m[1], type: 'ios-xe' }
  end

  m = res.match(/Cisco Nexus Operating System \(NX-OS\) Software/)
  unless m.nil?
    v = res[/^\s*system:\s+version (\d+\.\d+)/, 1]
    return @cache[:cisco] = { version: v, type: 'nexus' }
  end

  @cache[:cisco] = nil
end

#command_output(cmd) ⇒ Object 



35
36
37
38
39
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 35

def command_output(cmd)
  res = @backend.run_command(cmd).stdout
  res.strip! unless res.nil?
  res
end

#ruby_host_os(regex) ⇒ Object 



12
13
14
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 12

def ruby_host_os(regex)
  ::RbConfig::CONFIG['host_os'] =~ regex
end

#unix_file_contents(path) ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 21

def unix_file_contents(path)
  # keep a log of files incase multiple checks call the same one
  return @files[path] if @files.key?(path)

  res = @backend.run_command("test -f #{path} && cat #{path}")
  # ignore files that can't be read
  @files[path] = res.exit_status.zero? ? res.stdout : nil
  @files[path]
end

#unix_file_exist?(path) ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 31

def unix_file_exist?(path)
  @backend.run_command("test -f #{path}").exit_status.zero?
end

#unix_uname_m ⇒ Object 



51
52
53
54
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 51

def unix_uname_m
  return @uname[:m] if @uname.key?(:m)
  @uname[:m] = command_output('uname -m')
end

#unix_uname_r ⇒ Object 



46
47
48
49
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 46

def unix_uname_r
  return @uname[:r] if @uname.key?(:r)
  @uname[:r] = command_output('uname -r')
end

#unix_uname_s ⇒ Object 



41
42
43
44
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 41

def unix_uname_s
  return @uname[:s] if @uname.key?(:s)
  @uname[:s] = command_output('uname -s')
end

#unix_uuid ⇒ Object

Raises:



91
92
93
94
95
96
97
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 91

def unix_uuid
  uuid = unix_uuid_from_chef
  uuid = unix_uuid_from_machine_file if uuid.nil?
  uuid = uuid_from_command if uuid.nil?
  raise Train::TransportError, 'Cannot find a UUID for your node.' if uuid.nil?
  uuid
end

#unix_uuid_from_chef ⇒ Object 



99
100
101
102
103
104
105
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 99

def unix_uuid_from_chef
  file = @backend.file('/var/chef/cache/data_collector_metadata.json')
  if file.exist? && !file.size.zero?
    json = ::JSON.parse(file.content)
    return json['node_uuid'] if json['node_uuid']
  end
end

#unix_uuid_from_machine_file ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 107

def unix_uuid_from_machine_file
  %W(
    /etc/chef/chef_guid
    #{ENV['HOME']}/.chef/chef_guid
    /etc/machine-id
    /var/lib/dbus/machine-id
    /var/db/dbus/machine-id
  ).each do |path|
    file = @backend.file(path)
    next unless file.exist? && !file.size.zero?
    return file.content.chomp if path =~ /guid/
    return uuid_from_string(file.content.chomp)
  end
  nil
end

#uuid_from_command ⇒ Object

This takes a command from the platform detect block to run. We expect the command to return a unique identifier which we turn into a UUID.



126
127
128
129
130
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 126

def uuid_from_command
  return unless @platform[:uuid_command]
  result = @backend.run_command(@platform[:uuid_command])
  uuid_from_string(result.stdout.chomp) if result.exit_status.zero? && !result.stdout.empty?
end

#uuid_from_string(string) ⇒ Object

This hashes the passed string into SHA1. Then it downgrades the 160bit SHA1 to a 128bit then we format it as a valid UUIDv5.



135
136
137
138
139
140
141
142
143
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 135

def uuid_from_string(string)
  hash = Digest::SHA1.new
  hash.update(string)
  ary = hash.digest.unpack('NnnnnN')
  ary[2] = (ary[2] & 0x0FFF) | (5 << 12)
  ary[3] = (ary[3] & 0x3FFF) | 0x8000
  # rubocop:disable Style/FormatString
  '%08x-%04x-%04x-%04x-%04x%08x' % ary
end

#winrm? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
19
 
# File 'lib/train/platforms/detect/helpers/os_common.rb', line 16

def winrm?
  Object.const_defined?('Train::Transports::WinRM::Connection') &&
    @backend.class == Train::Transports::WinRM::Connection
end