Module: CfnDsl::Types

Included in:
AWS::Types
Defined in:
lib/cfndsl/types.rb

Overview

Types helper rubocop:disable Metrics/ModuleLength

Class Method Summary collapse

Class Method Details

.define_array_method(klass, singular_method, type, variable) ⇒ Object 



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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/cfndsl/types.rb', line 216

def self.define_array_method(klass, singular_method, type, variable)
  type.class_eval do
    CfnDsl.method_names(singular_method).each do |method_name|
      define_method(method_name) do |value = nil, *rest, fn_if: nil, &block|
        existing = instance_variable_get(variable)
        # For no-op invocations, get out now
        return existing if value.nil? && rest.empty? && !block

        # We are going to modify the value in some
        # way, make sure that we have an array to mess
        # with if we start with nothing
        existing ||= instance_variable_set(variable, [])

        # special case for just a block, no args
        if value.nil? && rest.empty? && block
          val = klass.new
          existing.push(fn_if ? FnIf(fn_if, val, Ref('AWS::NoValue')) : val)
          val.instance_eval(&block)
          return existing
        end

        # Glue all of our parameters together into
        # a giant array - flattening one level deep, if needed
        array_params = []
        if value.is_a?(Array)
          array_params.concat(value)
        else
          array_params.push value
        end

        rest.each do |v|
          if v.is_a?(Array)
            array_params.concat(rest)
          else
            array_params.push v
          end
        end
        # Here, if we were given multiple arguments either
        # as method [a,b,c], method(a,b,c), or even
        # method( a, [b], c) we end up with
        # array_params = [a,b,c]
        #
        # array_params will have at least one item
        # unless the user did something like pass in
        # a bunch of empty arrays.
        if block
          array_params.each do |array_params_value|
            value = klass.new
            existing.push(fn_if ? FnIf(fn_if, value, Ref('AWS::NoValue')) : value)
            # This line never worked before, the useful thing to do is pass the array value to the block
            value.instance_exec(array_params_value, &block)
          end
        else
          # List of parameters with no block -
          # hope that the user knows what he is
          # doing and stuff them into our existing
          # array
          array_params.each do |v|
            existing.push v
          end
        end
        existing
      end
    end
  end
end

.extract_from_resource_spec(fail_patches: false) ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/cfndsl/types.rb', line 27

def self.extract_from_resource_spec(fail_patches: false)
  spec = Specification.load_file(fail_patches: fail_patches)
  resources = extract_resources spec.resources
  types = extract_types spec.types
  { 'Resources' => resources, 'Types' => types, 'Version' => spec.version, 'File' => spec.file }
end

.extract_list_type(root_name, property_info) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/cfndsl/types.rb', line 12

def self.extract_list_type(root_name, property_info)
  # Tag is a reused type, but not quite primitive
  # and not all resources use the general form
  if property_info['ItemType'] == 'Tag'
    ['Tag']
  elsif (property_info['Type'] == 'List') && %w[Json List].include?(property_info['ItemType'])
    # List of arbitrary json
    # or List of list eg - AWS::Rekognition::StreamProcessor.PolygonRegionsOfInterest
    #   which is actually List of List of embedded type 'Point', but this is not properly represented in the schema
    ['Json']
  else
    Array(root_name + property_info['ItemType'])
  end
end

.extract_resources(spec) ⇒ Object

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



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
 
# File 'lib/cfndsl/types.rb', line 35

def self.extract_resources(spec)
  spec.each_with_object({}) do |(resource_name, resource_info), resources|
    properties = resource_info['Properties'].each_with_object({}) do |(property_name, property_info), extracted|
      # some json incorrectly labelled as Type -> Json instead of PrimitiveType
      # also, AWS now has the concept of Map which cfndsl had never defined
      property_type =
        if property_info['Type'] == 'Map' || property_info['Type'] == 'Json'
          'Json'
        elsif property_info['PrimitiveType']
          property_info['PrimitiveType']
        elsif property_info['PrimitiveItemType']
          Array(property_info['PrimitiveItemType'])
        elsif property_info['PrimitiveTypes']
          property_info['PrimitiveTypes'][0]
        elsif property_info['ItemType']
          extract_list_type(resource_name.split('::').join, property_info)
        elsif property_info['Type']
          # Special types (defined below) are joined with their parent
          # resource name for uniqueness and connection
          resource_name.split('::').join + property_info['Type']
        else
          warn "could not extract resource type for property #{property_name} from #{resource_name}, assuming Json"
          'Json'
        end
      extracted[property_name] = property_type
      extracted
    end
    resources[resource_name] = { 'Properties' => properties }
    resources
  end
end

.extract_types(spec) ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



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
 
# File 'lib/cfndsl/types.rb', line 68

def self.extract_types(spec)
  primitive_types = {
    'String' => 'String',
    'Boolean' => 'Boolean',
    'Json' => 'Json',
    'S3Event' => 'S3Event',
    'Integer' => 'Integer',
    'Number' => 'Number',
    'Double' => 'Double',
    'Timestamp' => 'Timestamp',
    'Map' => 'Map',
    'Long' => 'Long'
  }
  spec.each_with_object(primitive_types) do |(property_name, property_info), types|
    # In order to name things uniquely and allow for connections
    # we extract the resource name from the property
    # AWS::IAM::User.Policy becomes AWSIAMUserPolicy
    root_resource = property_name.match(/(.*)\./)
    root_resource_name = root_resource ? root_resource[1].gsub(/::/, '') : property_name
    property_name = property_name.gsub(/::|\./, '')

    properties =
      if property_info.key?('PrimitiveType')
        property_info['PrimitiveType']
      elsif property_info.key?('ItemType')
        extract_list_type(root_resource_name, property_info)
      elsif property_info.key?('Type')
        property_info['Type']
      elsif property_info.key?('Properties')
        property_info['Properties'].each_with_object({}) do |(nested_prop_name, nested_prop_info), extracted|
          nested_prop_type =
            if nested_prop_info['Type'] == 'Map' || nested_prop_info['Type'] == 'Json'
              # The Map type and the incorrectly labelled Json type
              'Json'
            elsif nested_prop_info['PrimitiveType']
              nested_prop_info['PrimitiveType']
            elsif nested_prop_info['PrimitiveItemType']
              Array(nested_prop_info['PrimitiveItemType'])
            elsif nested_prop_info['PrimitiveItemTypes']
              Array(nested_prop_info['PrimitiveItemTypes'])
            elsif nested_prop_info['Types']
              Array(nested_prop_info['Types'])
            elsif nested_prop_info['ItemType']
              extract_list_type(root_resource_name, nested_prop_info)
            elsif nested_prop_info['Type']
              root_resource_name + nested_prop_info['Type']
            else
              warn "could not extract property type for #{nested_prop_name} from #{property_name}, assuming Json\n#{nested_prop_info}"
              'Json'
            end
          extracted[nested_prop_name] = nested_prop_type
          extracted
        end
      else
        # No Type information typically just a plain JSON object
        'Json'
      end
    types[property_name] = properties
    types
  end
end

.included(type_def) ⇒ Object

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



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
 
# File 'lib/cfndsl/types.rb', line 132

def self.included(type_def)
  types_list = extract_from_resource_spec
  type_def.const_set('Types_Internal', types_list)
  # Do a little sanity checking - all of the types referenced in Resources
  # should be represented in Types
  types_list['Resources'].each_key do |resource_name|
    resource = types_list['Resources'][resource_name]
    resource.each_value do |thing|
      thing.each_value do |type|
        if type.is_a?(Array)
          type.each do |inner_type|
            warn "unknown type #{inner_type}" unless types_list['Types'].key?(inner_type)
          end
        else
          warn "unknown type #{type}" unless types_list['Types'].key?(type)
        end
      end
    end
  end

  # All of the type values should also be references
  types_list['Types'].values do |type|
    if type.respond_to?(:values)
      type.each_value do |tv|
        warn "unknown type #{tv}" unless types_list['Types'].key?(tv)
      end
    end
  end

  classes = {}

  # Go through and declare all of the types first
  types_list['Types'].each_pair do |typename, type_val|
    unless type_def.const_defined?(typename)
      if type_val.is_a?(Array)
        type_def.const_set(typename, type_val)
      else
        classes[typename] = type_def.const_set(typename, Class.new(type_def::Type))
      end
    end
  end

  # Now go through them again and define attribute setter methods
  classes.each_pair do |typename, klass|
    typeval = types_list['Types'][typename]
    next unless typeval.respond_to?(:each_pair)

    typeval.each_pair do |attr_name, attr_type|
      attr_method = attr_name
      variable = "@#{attr_name}".to_sym

      # handle bogus List defined as Type
      unless attr_type.is_a?(Array)
        attr_class = type_def.const_get(attr_type)
        attr_type = attr_class if attr_class.is_a?(Array)
      end

      if attr_type.is_a?(Array)
        attr_class = type_def.const_get(attr_type[0])
        singular_method = CfnDsl::Plurals.singularize(attr_name)

        if singular_method == attr_name
          # see if plural is different to singular
          attr_method = CfnDsl::Plurals.pluralize(attr_name)
        end

        define_array_method(attr_class, singular_method, klass, variable) if singular_method != attr_method
      end

      klass.class_eval do
        CfnDsl.method_names(attr_method) do |inner_method|
          define_method(inner_method) do |value = nil, *_rest, &block|
            # noinspection RubyScope
            value ||= attr_class.new
            instance_variable_set(variable, value)
            value.instance_eval(&block) if block
            value
          end
        end
      end
    end
  end
end