Class: Inspec::Resources::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/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.



87
88
89
90
91
92
93
94
95
 
# File 'lib/resources/service.rb', line 87

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.



85
86
87
 
# File 'lib/resources/service.rb', line 85

def service_ctl
  @service_ctl
end

Instance Method Details

#enabled?(_level = nil) ⇒ Boolean

verifies if the service is enabled

Returns:

  • (Boolean) 


153
154
155
156
 
# File 'lib/resources/service.rb', line 153

def enabled?(_level = nil)
  return false if info.nil?
  info[:enabled]
end

#info ⇒ Object 



147
148
149
150
 
# File 'lib/resources/service.rb', line 147

def info
  return nil if @service_mgmt.nil?
  @cache ||= @service_mgmt.info(@service_name)
end

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

verifies the service is registered

Returns:

  • (Boolean) 


159
160
161
162
 
# File 'lib/resources/service.rb', line 159

def installed?(_name = nil, _version = nil)
  return false if info.nil?
  info[:installed]
end

#runlevels(*args) ⇒ Object

get all runlevels that are available and their configuration



171
172
173
174
 
# File 'lib/resources/service.rb', line 171

def runlevels(*args)
  return Runlevels.new(self) if info.nil? or info[:runlevels].nil?
  Runlevels.from_hash(self, info[:runlevels], args)
end

#running?(_under = nil) ⇒ Boolean

verifies the service is currently running

Returns:

  • (Boolean) 


165
166
167
168
 
# File 'lib/resources/service.rb', line 165

def running?(_under = nil)
  return false if info.nil?
  info[:running]
end

#select_service_mgmt ⇒ Object

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



97
98
99
100
101
102
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
 
# File 'lib/resources/service.rb', line 97

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

  # 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.
  if %w{ubuntu}.include?(family)
    version = inspec.os[:release].to_f
    if version < 15.04
      Upstart.new(inspec, service_ctl)
    else
      Systemd.new(inspec, service_ctl)
    end
  elsif %w{debian}.include?(family)
    version = inspec.os[:release].to_i
    if version > 7
      Systemd.new(inspec, service_ctl)
    else
      SysV.new(inspec, service_ctl || '/usr/sbin/service')
    end
  elsif %w{redhat fedora centos}.include?(family)
    version = inspec.os[:release].to_i
    if (%w{ redhat centos }.include?(family) && version >= 7) || (family == 'fedora' && version >= 15)
      Systemd.new(inspec, service_ctl)
    else
      SysV.new(inspec, service_ctl || '/sbin/service')
    end
  elsif %w{wrlinux}.include?(family)
    SysV.new(inspec, service_ctl)
  elsif %w{darwin}.include?(family)
    LaunchCtl.new(inspec, service_ctl)
  elsif os.windows?
    WindowsSrv.new(inspec)
  elsif %w{freebsd}.include?(family)
    BSDInit.new(inspec, service_ctl)
  elsif %w{arch opensuse}.include?(family)
    Systemd.new(inspec, service_ctl)
  elsif %w{aix}.include?(family)
    SrcMstr.new(inspec)
  elsif os.solaris?
    Svcs.new(inspec)
  end
end

#to_s ⇒ Object 



176
177
178
 
# File 'lib/resources/service.rb', line 176

def to_s
  "Service #{@service_name}"
end