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
|
#
# Author:: Adam Jacob (<adam@opscode.com>)
# Author:: Christopher Walters (<cw@opscode.com>)
# Copyright:: Copyright (c) 2008, 2009 Opscode, 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 'chef/mixin/from_file'
require 'chef/mixin/convert_to_class_name'
require 'chef/mixin/enforce_ownership_and_permissions'
require 'chef/mixin/why_run'
require 'chef/mixin/shell_out'
class Chef
class Provider
include Chef::Mixin::WhyRun
include Chef::Mixin::ShellOut
attr_accessor :new_resource
attr_accessor :current_resource
attr_accessor :run_context
attr_reader :recipe_name
attr_reader :cookbook_name
attr_reader :action
# @TODO Chef 13: Make action a required parameter.
# action is an optional parameter for Chef 12 so custom provider
# classes can be updated.
def initialize(new_resource, run_context, action=nil)
@new_resource = new_resource
@current_resource = nil
@run_context = run_context
@converge_actions = nil
if action.nil?
Chef::Log.warn("Initializing a provider without an action parameter is deprecated" +
" in Chef 12 and will be removed in Chef 13. It is recommended that you update" +
" custom providers to reflect these changes.")
end
@action = action
@recipe_name = nil
@cookbook_name = nil
end
def whyrun_mode?
Chef::Config[:why_run]
end
def whyrun_supported?
false
end
def node
run_context && run_context.node
end
# Used by providers supporting embedded recipes
def resource_collection
run_context && run_context.resource_collection
end
def cookbook_name
new_resource.cookbook_name
end
def load_current_resource
raise Chef::Exceptions::Override, "You must override load_current_resource in #{self.to_s}"
end
def define_resource_requirements
end
def cleanup_after_converge
end
def action_nothing
Chef::Log.debug("Doing nothing for #{@new_resource.to_s}")
true
end
def events
run_context.events
end
# @TODO Chef 13: Remove optional parameter action.
def run_action(action=nil)
unless action.nil?
Chef::Log.warn("Specifying an action to #run_action is deprecated in" +
" Chef 12 and will be removed in Chef 13. An action should be supplied" +
" to the provider constructor.")
@action = action
end
# user-defined LWRPs may include unsafe load_current_resource methods that cannot be run in whyrun mode
if !whyrun_mode? || whyrun_supported?
load_current_resource
events.resource_current_state_loaded(@new_resource, @action, @current_resource)
elsif whyrun_mode? && !whyrun_supported?
events.resource_current_state_load_bypassed(@new_resource, @action, @current_resource)
end
define_resource_requirements
process_resource_requirements
# user-defined providers including LWRPs may
# not include whyrun support - if they don't support it
# we can't execute any actions while we're running in
# whyrun mode. Instead we 'fake' whyrun by documenting that
# we can't execute the action.
# in non-whyrun mode, this will still cause the action to be
# executed normally.
if whyrun_supported? && !requirements.action_blocked?(@action)
send("action_#{@action}")
elsif whyrun_mode?
events.resource_bypassed(@new_resource, @action, self)
else
send("action_#{@action}")
end
set_updated_status
cleanup_after_converge
end
def process_resource_requirements
requirements.run(:all_actions) unless @action == :nothing
requirements.run(@action)
end
def resource_updated?
!converge_actions.empty? || @new_resource.updated_by_last_action?
end
def set_updated_status
if !resource_updated?
events.resource_up_to_date(@new_resource, @action)
else
events.resource_updated(@new_resource, @action)
new_resource.updated_by_last_action(true)
end
end
def requirements
@requirements ||= ResourceRequirements.new(@new_resource, run_context)
end
def converge_by(descriptions, &block)
converge_actions.add_action(descriptions, &block)
end
protected
def converge_actions
@converge_actions ||= ConvergeActions.new(@new_resource, run_context, @action)
end
def recipe_eval(&block)
# This block has new resource definitions within it, which
# essentially makes it an in-line Chef run. Save our current
# run_context and create one anew, so the new Chef run only
# executes the embedded resources.
#
# TODO: timh,cw: 2010-5-14: This means that the resources within
# this block cannot interact with resources outside, e.g.,
# manipulating notifies.
converge_by ("evaluate block and run any associated actions") do
saved_run_context = @run_context
@run_context = @run_context.dup
@run_context.resource_collection = Chef::ResourceCollection.new
instance_eval(&block)
Chef::Runner.new(@run_context).converge
@run_context = saved_run_context
end
end
end
end
|
