Class: Inspec::Resources::Service

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

Overview

We detect the init system for each operating system, based on the operating system.

Fedora 15 : systemd RedHat 7 : systemd Ubuntu 15.04 : systemd Ubuntu < 15.04 : upstart

TODO: extend the logic to detect the running init system, independently of OS

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_name, service_ctl = nil) ⇒ Service

Returns a new instance of Service.



93
94
95
96
97
98
99
100
101
 
# File 'lib/inspec/resources/service.rb', line 93

def initialize(service_name, service_ctl = nil)
  @service_name = service_name
  @service_mgmt = nil
  @service_ctl ||= service_ctl
  @cache = nil
  @service_mgmt = select_service_mgmt

  return skip_resource "The `service` resource is not supported on your OS yet." if @service_mgmt.nil?
end

Instance Attribute Details

#service_ctl ⇒ Object (readonly)

Returns the value of attribute service_ctl.



91
92
93
 
# File 'lib/inspec/resources/service.rb', line 91

def service_ctl
  @service_ctl
end

Instance Method Details

#description ⇒ Object

returns the service description from info



241
242
243
244
245
 
# File 'lib/inspec/resources/service.rb', line 241

def description
  return nil if info.nil?

  info[:description]
end

#enabled?(_level = nil) ⇒ Boolean

verifies if the service is enabled

Returns:

  • (Boolean) 


193
194
195
196
197
 
# File 'lib/inspec/resources/service.rb', line 193

def enabled?(_level = nil)
  return false if info.nil?

  info[:enabled]
end

#installed?(_name = nil, _version = nil) ⇒ Boolean

verifies the service is registered

Returns:

  • (Boolean) 


206
207
208
209
210
 
# File 'lib/inspec/resources/service.rb', line 206

def installed?(_name = nil, _version = nil)
  return false if info.nil?

  info[:installed]
end

#name ⇒ Object

returns the service name from info



234
235
236
237
238
 
# File 'lib/inspec/resources/service.rb', line 234

def name
  return @service_name if info.nil?

  info[:name]
end

#params ⇒ Object 



199
200
201
202
203
 
# File 'lib/inspec/resources/service.rb', line 199

def params
  return {} if info.nil?

  Hashie::Mash.new(info[:params] || {})
end

#runlevels(*args) ⇒ Object

get all runlevels that are available and their configuration



220
221
222
223
224
 
# File 'lib/inspec/resources/service.rb', line 220

def runlevels(*args)
  return Runlevels.new(self) if info.nil? || info[:runlevels].nil?

  Runlevels.from_hash(self, info[:runlevels], args)
end

#running?(_under = nil) ⇒ Boolean

verifies the service is currently running

Returns:

  • (Boolean) 


213
214
215
216
217
 
# File 'lib/inspec/resources/service.rb', line 213

def running?(_under = nil)
  return false if info.nil?

  info[:running]
end

#select_service_mgmt ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/inspec/resources/service.rb', line 103

def select_service_mgmt # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
  os = inspec.os
  platform = os[:name]

  return WindowsSrv.new(inspec) if os.windows?

  # Ubuntu
  # @see: https://wiki.ubuntu.com/SystemdForUpstartUsers
  # Ubuntu 15.04 : Systemd
  #   Systemd runs with PID 1 as /sbin/init.
  #   Upstart runs with PID 1 as /sbin/upstart.
  # Ubuntu < 15.04 : Upstart
  # Upstart runs with PID 1 as /sbin/init.
  # Systemd runs with PID 1 as /lib/systemd/systemd.

  case platform
  when "ubuntu"
    version = os[:release].to_f
    if version < 15.04
      Upstart.new(inspec, service_ctl)
    else
      Systemd.new(inspec, service_ctl)
    end
  when "linuxmint"
    version = os[:release].to_f
    if version < 18
      Upstart.new(inspec, service_ctl)
    else
      Systemd.new(inspec, service_ctl)
    end
  when "debian"
    if os[:release] == "buster/sid"
      version = 10
    else
      version = os[:release].to_i
    end
    if version > 7
      Systemd.new(inspec, service_ctl)
    elsif version > 0
      SysV.new(inspec, service_ctl || "/usr/sbin/service")
    end
  when "redhat", "fedora", "centos", "oracle", "cloudlinux", "scientific"
    version = os[:release].to_i

    systemd = ((platform != "fedora" && version >= 7) ||
               (platform == "fedora" && version >= 15))

    if systemd
      Systemd.new(inspec, service_ctl)
    else
      SysV.new(inspec, service_ctl || "/sbin/service")
    end
  when "wrlinux"
    SysV.new(inspec, service_ctl)
  when "mac_os_x", "darwin"
    LaunchCtl.new(inspec, service_ctl)
  when "freebsd"
    BSDInit.new(inspec, service_ctl)
  when "arch"
    Systemd.new(inspec, service_ctl)
  when "coreos"
    Systemd.new(inspec, service_ctl)
  when "suse", "opensuse"
    if os[:release].to_i >= 12
      Systemd.new(inspec, service_ctl)
    else
      SysV.new(inspec, service_ctl || "/sbin/service")
    end
  when "aix"
    SrcMstr.new(inspec)
  when "amazon"
    if os[:release] =~ /^20\d\d/
      Upstart.new(inspec, service_ctl)
    else
      Systemd.new(inspec, service_ctl)
    end
  when "solaris", "smartos", "omnios", "openindiana", "opensolaris", "nexentacore"
    Svcs.new(inspec)
  when "yocto"
    Systemd.new(inspec, service_ctl)
  end
end

#startmode ⇒ Object

returns the service start up mode from info



248
249
250
251
252
 
# File 'lib/inspec/resources/service.rb', line 248

def startmode
  return nil if info.nil?

  info[:startmode]
end

#startname ⇒ Object

returns the service’s user from info



255
256
257
258
259
 
# File 'lib/inspec/resources/service.rb', line 255

def startname
  return nil if info.nil?

  info[:startname]
end

#to_s ⇒ Object 



261
262
263
 
# File 'lib/inspec/resources/service.rb', line 261

def to_s
  "Service #{@service_name}"
end

#type ⇒ Object

returns the service type from info



227
228
229
230
231
 
# File 'lib/inspec/resources/service.rb', line 227

def type
  return nil if info.nil?

  info[:type]
end