summaryrefslogtreecommitdiff
path: root/lib/chef/resource_set.rb
blob: 45e69918cf595df0eb67f9549c3b525368a095d9 (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
#
# Author:: Tyler Ball (<tball@getchef.com>)
# Copyright:: Copyright (c) 2014 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 'chef/resource'

class Chef
  class ResourceSet

    # Matches a multiple resource lookup specification,
    # e.g., "service[nginx,unicorn]"
    MULTIPLE_RESOURCE_MATCH = /^(.+)\[(.+?),(.+)\]$/

    # Matches a single resource lookup specification,
    # e.g., "service[nginx]"
    SINGLE_RESOURCE_MATCH = /^(.+)\[(.+)\]$/

    def initialize
      @resources_by_key = Hash.new
    end

    def insert_as(resource_type, instance_name, resource)
      assert_chef_resource(resource)
      @resources_by_key[create_key(resource_type, instance_name)] = resource
    end

    # TODO when do we need to lookup a resource by resource?  That smells like we should still have the resource say how its indexed, or we shouldn't be doing that.
    def lookup(resource_type, instance_name)
      raise ArgumentError, "Must pass a String to lookup" unless key.kind_of?(String)
      res = @resources_by_key[create_key(resource_type, instance_name)]
      unless res
        raise Chef::Exceptions::ResourceNotFound, "Cannot find a resource matching #{key} (did you define it first?)"
      end
      res
    end

    # Find existing resources by searching the list of existing resources.  Possible
    # forms are:
    #
    # find(:file => "foobar")
    # find(:file => [ "foobar", "baz" ])
    # find("file[foobar]", "file[baz]")
    # find("file[foobar,baz]")
    #
    # Returns the matching resource, or an Array of matching resources.
    #
    # Raises an ArgumentError if you feed it bad lookup information
    # Raises a Runtime Error if it can't find the resources you are looking for.
    def find(*args)
      results = Array.new
      args.each do |arg|
        case arg
          when Hash
            results << find_resource_by_hash(arg)
          when String
            results << find_resource_by_string(arg)
          else
            msg = "arguments to #{self.class.name}#find should be of the form :resource => 'name' or 'resource[name]'"
            raise Chef::Exceptions::InvalidResourceSpecification, msg
        end
      end
      flat_results = results.flatten
      flat_results.length == 1 ? flat_results[0] : flat_results
    end

    # resources is a poorly named, but we have to maintain it for back
    # compat.
    # TODO do we anymore?
    alias_method :resources, :find

    # Returns true if +query_object+ is a valid string for looking up a
    # resource, or raises InvalidResourceSpecification if not.
    # === Arguments
    # * query_object should be a string of the form
    # "resource_type[resource_name]", a single element Hash (e.g., :service =>
    # "apache2"), or a Chef::Resource (this is the happy path). Other arguments
    # will raise an exception.
    # === Returns
    # * true returns true for all valid input.
    # === Raises
    # * Chef::Exceptions::InvalidResourceSpecification for all invalid input.
    def self.validate_lookup_spec!(query_object)
      case query_object
        when Chef::Resource
          true
        when SINGLE_RESOURCE_MATCH, MULTIPLE_RESOURCE_MATCH
          true
        when Hash
          true
        when String
          raise Chef::Exceptions::InvalidResourceSpecification,
                "The string `#{query_object}' is not valid for resource collection lookup. Correct syntax is `resource_type[resource_name]'"
        else
          raise Chef::Exceptions::InvalidResourceSpecification,
                "The object `#{query_object.inspect}' is not valid for resource collection lookup. " +
                    "Use a String like `resource_type[resource_name]' or a Chef::Resource object"
      end
    end

    # TODO the json serialization/unserialization could be put into a module

    def self.create_key(resource_type, instance_name)
      "#{resource_type}[#{instance_name}]"
    end

    private

    def find_resource_by_hash(arg)
      results = Array.new
      arg.each do |resource_type, name_list|
        instance_names = name_list.kind_of?(Array) ? name_list : [ name_list ]
        instance_names.each do |instance_name|
          results << lookup(resource_type, instance_name)
        end
      end
      return results
    end

    def find_resource_by_string(arg)
      results = Array.new
      case arg
        when MULTIPLE_RESOURCE_MATCH
          resource_type = $1
          arg =~ /^.+\[(.+)\]$/
          resource_list = $1
          resource_list.split(",").each do |instance_name|
            results << lookup(resource_type, instance_name)
          end
        when SINGLE_RESOURCE_MATCH
          resource_type = $1
          name = $2
          results << lookup(resource_type, name)
        else
          raise ArgumentError, "Bad string format #{arg}, you must have a string like resource_type[name]!"
      end
      return results
    end

    # TODO put into common module
    def assert_chef_resource(arg)
      unless arg.kind_of?(Chef::Resource)
        raise ArgumentError, "Cannot insert a #{arg.class} into a resource collection: must be a subclass of Chef::Resource"
      end
      true
    end

  end
end