summaryrefslogtreecommitdiff
path: root/lib/chef/provider/service.rb
blob: af96e08b20d7d2ded198294685ad7db027a15948 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
#
# Author:: AJ Christensen (<aj@hjksolutions.com>)
# Author:: Davide Cavalca (<dcavalca@fb.com>)
# Copyright:: Copyright 2008-2017, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require_relative "../provider"

class Chef
  class Provider
    class Service < Chef::Provider

      def supports
        @supports ||= new_resource.supports.dup
      end

      def initialize(new_resource, run_context)
        super
        @enabled = nil
      end

      def load_current_resource
        supports[:status] = false if supports[:status].nil?
        supports[:reload] = false if supports[:reload].nil?
        supports[:restart] = false if supports[:restart].nil?
      end

      # the new_resource#enabled and #running variables are not user input, but when we
      # do (e.g.) action_enable we want to set new_resource.enabled so that the comparison
      # between desired and current state produces the correct change in reporting.
      # XXX?: the #nil? check below will likely fail if this is a cloned resource or if
      # we just run multiple actions.
      def load_new_resource_state
        if new_resource.enabled.nil?
          new_resource.enabled(current_resource.enabled)
        end
        if new_resource.running.nil?
          new_resource.running(current_resource.running)
        end
        if new_resource.masked.nil?
          new_resource.masked(current_resource.masked)
        end
      end

      # subclasses should override this if they do implement user services
      def user_services_requirements
        requirements.assert(:all_actions) do |a|
          a.assertion { new_resource.user.nil? }
          a.failure_message Chef::Exceptions::UnsupportedAction, "#{self} does not support user services"
        end
      end

      def shared_resource_requirements
        user_services_requirements
      end

      def define_resource_requirements
        requirements.assert(:reload) do |a|
          a.assertion { supports[:reload] || new_resource.reload_command }
          a.failure_message Chef::Exceptions::UnsupportedAction, "#{self} does not support :reload"
          # if a service is not declared to support reload, that won't
          # typically change during the course of a run - so no whyrun
          # alternative here.
        end
      end

      def action_enable
        if current_resource.enabled
          logger.trace("#{new_resource} already enabled - nothing to do")
        else
          converge_by("enable service #{new_resource}") do
            enable_service
            logger.info("#{new_resource} enabled")
          end
        end
        load_new_resource_state
        new_resource.enabled(true)
      end

      def action_disable
        if current_resource.enabled
          converge_by("disable service #{new_resource}") do
            disable_service
            logger.info("#{new_resource} disabled")
          end
        else
          logger.trace("#{new_resource} already disabled - nothing to do")
        end
        load_new_resource_state
        new_resource.enabled(false)
      end

      def action_mask
        if current_resource.masked
          logger.trace("#{new_resource} already masked - nothing to do")
        else
          converge_by("mask service #{new_resource}") do
            mask_service
            logger.info("#{new_resource} masked")
          end
        end
        load_new_resource_state
        new_resource.masked(true)
      end

      def action_unmask
        if current_resource.masked
          converge_by("unmask service #{new_resource}") do
            unmask_service
            logger.info("#{new_resource} unmasked")
          end
        else
          logger.trace("#{new_resource} already unmasked - nothing to do")
        end
        load_new_resource_state
        new_resource.masked(false)
      end

      def action_start
        unless current_resource.running
          converge_by("start service #{new_resource}") do
            start_service
            logger.info("#{new_resource} started")
          end
        else
          logger.trace("#{new_resource} already running - nothing to do")
        end
        load_new_resource_state
        new_resource.running(true)
      end

      def action_stop
        if current_resource.running
          converge_by("stop service #{new_resource}") do
            stop_service
            logger.info("#{new_resource} stopped")
          end
        else
          logger.trace("#{new_resource} already stopped - nothing to do")
        end
        load_new_resource_state
        new_resource.running(false)
      end

      def action_restart
        converge_by("restart service #{new_resource}") do
          restart_service
          logger.info("#{new_resource} restarted")
        end
        load_new_resource_state
        new_resource.running(true)
      end

      def action_reload
        if current_resource.running
          converge_by("reload service #{new_resource}") do
            reload_service
            logger.info("#{new_resource} reloaded")
          end
        end
        load_new_resource_state
      end

      def enable_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :enable"
      end

      def disable_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :disable"
      end

      def mask_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :mask"
      end

      def unmask_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :unmask"
      end

      def start_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :start"
      end

      def stop_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :stop"
      end

      def restart_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :restart"
      end

      def reload_service
        raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :reload"
      end

      protected

      def default_init_command
        if new_resource.init_command
          new_resource.init_command
        elsif instance_variable_defined?(:@init_command)
          @init_command
        end
      end

      def custom_command_for_action?(action)
        method_name = "#{action}_command".to_sym
        new_resource.respond_to?(method_name) &&
          !!new_resource.send(method_name)
      end

      module ServicePriorityInit

        #
        # Platform-specific versions
        #

        #
        # Linux
        #

        require_relative "../chef_class"
        require_relative "service/systemd"
        require_relative "service/insserv"
        require_relative "service/redhat"
        require_relative "service/arch"
        require_relative "service/gentoo"
        require_relative "service/upstart"
        require_relative "service/debian"
        require_relative "service/invokercd"

        Chef.set_provider_priority_array :service, [ Systemd, Arch ], platform_family: "arch"
        Chef.set_provider_priority_array :service, [ Systemd, Gentoo ], platform_family: "gentoo"
        Chef.set_provider_priority_array :service, [ Systemd, Upstart, Insserv, Debian, Invokercd ], platform_family: "debian"
        Chef.set_provider_priority_array :service, [ Systemd, Insserv, Redhat ], platform_family: %w{rhel fedora suse amazon}
      end
    end
  end
end