# # Author:: Adam Jacob () # Author:: Nuo Yan () # Author:: Christopher Brown () # Copyright:: Copyright (c) 2008 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/config' require 'chef/mixin/params_validate' require 'chef/mixin/from_file' require 'chef/run_list' require 'chef/mash' require 'chef/json_compat' class Chef class Role include Chef::Mixin::FromFile include Chef::Mixin::ParamsValidate # Create a new Chef::Role object. def initialize() @name = '' @description = '' @default_attributes = Mash.new @override_attributes = Mash.new @env_run_lists = {"_default" => Chef::RunList.new} end def name(arg=nil) set_or_return( :name, arg, :regex => /^[\-[:alnum:]_]+$/ ) end def description(arg=nil) set_or_return( :description, arg, :kind_of => String ) end def run_list(*args) if (args.length > 0) @env_run_lists["_default"].reset!(args) end @env_run_lists["_default"] end alias_method :recipes, :run_list # For run_list expansion def run_list_for(environment) if env_run_lists[environment].nil? env_run_lists["_default"] else env_run_lists[environment] end end def active_run_list_for(environment) @env_run_lists.has_key?(environment) ? environment : '_default' end # Per environment run lists def env_run_lists(env_run_lists=nil) if (!env_run_lists.nil?) unless env_run_lists.key?("_default") msg = "_default key is required in env_run_lists.\n" msg << "(env_run_lists: #{env_run_lists.inspect})" raise Chef::Exceptions::InvalidEnvironmentRunListSpecification, msg end @env_run_lists.clear env_run_lists.each { |k,v| @env_run_lists[k] = Chef::RunList.new(*Array(v))} end @env_run_lists end alias :env_run_list :env_run_lists def default_attributes(arg=nil) set_or_return( :default_attributes, arg, :kind_of => Hash ) end def override_attributes(arg=nil) set_or_return( :override_attributes, arg, :kind_of => Hash ) end def to_hash env_run_lists_without_default = @env_run_lists.dup env_run_lists_without_default.delete("_default") result = { "name" => @name, "description" => @description, 'json_class' => self.class.name, "default_attributes" => @default_attributes, "override_attributes" => @override_attributes, "chef_type" => "role", "run_list" => run_list, "env_run_lists" => env_run_lists_without_default } result end # Serialize this object as a hash def to_json(*a) to_hash.to_json(*a) end def update_from!(o) description(o.description) recipes(o.recipes) if defined?(o.recipes) default_attributes(o.default_attributes) override_attributes(o.override_attributes) env_run_lists(o.env_run_lists) unless o.env_run_lists.nil? self end # As a string def to_s "role[#{@name}]" end # Load a role from disk - prefers to load the JSON, but will happily load # the raw rb files as well. def self.from_disk(name) role = nil Chef::Config[:role_path].each do |rp| rb_file = File.join(rp, "#{name}.rb") if File.exists?(rb_file) && role.nil? role = Chef::Role.new role.name(name) role.from_file(rb_file) end end if role role else raise Chef::Exceptions::RoleNotFound, "Role '#{name}' could not be loaded from disk" end end end end