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
|
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Christopher Walters (<cw@chef.io>)
# Author:: Daniel DeLeo (<dan@chef.io>)
# Copyright:: Copyright (c) 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 "../resource"
require_relative "../resource_resolver"
require_relative "../node"
require_relative "../log"
require_relative "../exceptions"
require_relative "../mixin/convert_to_class_name"
require_relative "../mixin/from_file"
require_relative "../mixin/params_validate" # for DelayedEvaluator
require_relative "../version"
class Chef
class Resource
# == Chef::Resource::LWRPBase
# Base class for LWRP resources. Adds DSL sugar on top of Chef::Resource,
# so attributes, default action, etc. can be defined with pleasing syntax.
class LWRPBase < Resource
# Class methods
class <<self
include Chef::Mixin::ConvertToClassName
include Chef::Mixin::FromFile
def build_from_file(cookbook_name, filename, run_context)
if LWRPBase.loaded_lwrps[filename]
Chef::Log.trace("Custom resource #{filename} from cookbook #{cookbook_name} has already been loaded! Skipping the reload.")
return loaded_lwrps[filename]
end
resource_name = filename_to_qualified_string(cookbook_name, filename)
resource_class = Class.new(self)
resource_class.run_context = run_context
resource_class.class_from_file(filename)
if !resource_class.unified_mode && !deprecated_class(resource_class)
Chef.deprecated :unified_mode, "The #{resource_class.resource_name} resource in the #{cookbook_name} cookbook should declare `unified_mode true`", filename
end
# Make a useful string for the class (rather than <Class:312894723894>)
resource_class.instance_eval do
define_singleton_method(:to_s) do
"Custom resource #{resource_name} from cookbook #{cookbook_name}"
end
define_singleton_method(:inspect) { to_s }
end
Chef::Log.trace("Loaded contents of #{filename} into resource #{resource_name} (#{resource_class})")
# wire up the default resource name after the class is parsed only if we haven't declared one.
# (this ordering is important for MapCollision deprecation warnings)
resource_class.provides resource_name.to_sym unless Chef::ResourceResolver.includes_handler?(resource_name.to_sym, self)
LWRPBase.loaded_lwrps[filename] = resource_class
resource_class
end
# Adds +action_names+ to the list of valid actions for this resource.
# Does not include superclass's action list when appending.
def actions(*action_names)
action_names = action_names.flatten
if !action_names.empty? && !@allowed_actions
self.allowed_actions = ([ :nothing ] + action_names).uniq
else
allowed_actions(*action_names)
end
end
alias :actions= :allowed_actions=
# @deprecated
def valid_actions(*args)
Chef::Log.warn("`valid_actions` is deprecated, please use `allowed_actions` instead!")
allowed_actions(*args)
end
# Set the run context on the class. Used to provide access to the node
# during class definition.
attr_accessor :run_context
def node
run_context ? run_context.node : nil
end
protected
attr_writer :loaded_lwrps
def loaded_lwrps
@loaded_lwrps ||= {}
end
private
# Get the value from the superclass, if it responds, otherwise return
# +nil+. Since class instance variables are **not** inherited upon
# subclassing, this is a required check to ensure Chef pulls the
# +default_action+ and other DSL-y methods when extending LWRP::Base.
def from_superclass(m, default = nil)
return default if superclass == Chef::Resource::LWRPBase
superclass.respond_to?(m) ? superclass.send(m) : default
end
# Return true if the resource has been deprecated on this version.
#
# XXX: for now we only look at chef_version_for_provides, reversing the
# resource node_map to determine if the resource provides anything which is
# wired up is difficult.
#
def deprecated_class(resource_class)
if resource_class.chef_version_for_provides && Chef::VERSION !~ resource_class.chef_version_for_provides
return true
end
false
end
end
end
end
end
|
