# class Chef::Role

### Public Class Methods

chef_server_rest() click to toggle source

    # File lib/chef/role.rb, line 48
    def self.chef_server_rest
      Chef::REST.new(Chef::Config[:chef_server_url])
    end

from_disk(name, force=nil) click to toggle source

Load a role from disk - prefers to load the JSON, but will happily load the raw rb files as well.

    # File lib/chef/role.rb, line 235
    def self.from_disk(name, force=nil)
      paths = Array(Chef::Config[:role_path])

      paths.each do |p|
        js_file = File.join(p, "#{name}.json")
        rb_file = File.join(p, "#{name}.rb")

        if File.exists?(js_file) || force == "json"
          # from_json returns object.class => json_class in the JSON.
          return Chef::JSONCompat.from_json(IO.read(js_file))
        elsif File.exists?(rb_file) || force == "ruby"
          role = Chef::Role.new
          role.name(name)
          role.from_file(rb_file)
          return role
        end
      end

      raise Chef::Exceptions::RoleNotFound, "Role '#{name}' could not be loaded from disk"
    end

json_create(o) click to toggle source

Create a Chef::Role from JSON

    # File lib/chef/role.rb, line 159
    def self.json_create(o)
      role = new
      role.name(o["name"])
      role.description(o["description"])
      role.default_attributes(o["default_attributes"])
      role.override_attributes(o["override_attributes"])

      # _default run_list is in 'run_list' for newer clients, and
      # 'recipes' for older clients.
      env_run_list_hash = {"_default" => (o.has_key?("run_list") ? o["run_list"] : o["recipes"])}

      # Clients before 0.10 do not include env_run_lists, so only
      # merge if it's there.
      if o["env_run_lists"]
        env_run_list_hash.merge!(o["env_run_lists"])
      end
      role.env_run_lists(env_run_list_hash)

      role
    end

list(inflate=false) click to toggle source

Get the list of all roles from the API.

    # File lib/chef/role.rb, line 181
    def self.list(inflate=false)
      if inflate
        response = Hash.new
        Chef::Search::Query.new.search(:role) do |n|
          response[n.name] = n unless n.nil?
        end
        response
      else
        chef_server_rest.get_rest("roles")
      end
    end

load(name) click to toggle source

Load a role by name from the API

    # File lib/chef/role.rb, line 194
    def self.load(name)
      chef_server_rest.get_rest("roles/#{name}")
    end

new() click to toggle source

Create a new Chef::Role object.

    # File lib/chef/role.rb, line 36
    def initialize
      @name = ''
      @description = ''
      @default_attributes = Mash.new
      @override_attributes = Mash.new
      @env_run_lists = {"_default" => Chef::RunList.new}
    end

### Public Instance Methods

active_run_list_for(environment) click to toggle source

    # File lib/chef/role.rb, line 86
    def active_run_list_for(environment)
      @env_run_lists.has_key?(environment) ? environment : '_default'
    end

chef_server_rest() click to toggle source

    # File lib/chef/role.rb, line 44
    def chef_server_rest
      Chef::REST.new(Chef::Config[:chef_server_url])
    end

create() click to toggle source

Create the role via the REST API

    # File lib/chef/role.rb, line 223
    def create
      chef_server_rest.post_rest("roles", self)
      self
    end

default_attributes(arg=nil) click to toggle source

    # File lib/chef/role.rb, line 106
    def default_attributes(arg=nil)
      set_or_return(
        :default_attributes,
        arg,
        :kind_of => Hash
      )
    end

description(arg=nil) click to toggle source

    # File lib/chef/role.rb, line 60
    def description(arg=nil)
      set_or_return(
        :description,
        arg,
        :kind_of => String
      )
    end

destroy() click to toggle source

Remove this role via the REST API

    # File lib/chef/role.rb, line 207
    def destroy
      chef_server_rest.delete_rest("roles/#{@name}")
    end

env_run_list(env_run_lists=nil)
Alias for: env_run_lists
env_run_lists(env_run_lists=nil) click to toggle source

Per environment run lists

    # File lib/chef/role.rb, line 91
    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

Also aliased as: env_run_list
environment(env_name) click to toggle source

    # File lib/chef/role.rb, line 198
    def environment(env_name)
      chef_server_rest.get_rest("roles/#{@name}/environments/#{env_name}")
    end

environments() click to toggle source

    # File lib/chef/role.rb, line 202
    def environments
      chef_server_rest.get_rest("roles/#{@name}/environments")
    end

name(arg=nil) click to toggle source

    # File lib/chef/role.rb, line 52
    def name(arg=nil)
      set_or_return(
        :name,
        arg,
        :regex => /^[\-[:alnum:]_]+$/
      )
    end

override_attributes(arg=nil) click to toggle source

    # File lib/chef/role.rb, line 114
    def override_attributes(arg=nil)
      set_or_return(
        :override_attributes,
        arg,
        :kind_of => Hash
      )
    end

recipes(*args)
Alias for: run_list
run_list(*args) click to toggle source

    # File lib/chef/role.rb, line 68
    def run_list(*args)
      if (args.length > 0)
        @env_run_lists["_default"].reset!(args)
      end
      @env_run_lists["_default"]
    end

Also aliased as: recipes
run_list_for(environment) click to toggle source

For #run_list expansion

    # File lib/chef/role.rb, line 78
    def run_list_for(environment)
      if env_run_lists[environment].nil?
        env_run_lists["_default"]
      else
        env_run_lists[environment]
      end
    end

save() click to toggle source

Save this role via the REST API

    # File lib/chef/role.rb, line 212
    def save
      begin
        chef_server_rest.put_rest("roles/#{@name}", self)
      rescue Net::HTTPServerException => e
        raise e unless e.response.code == "404"
        chef_server_rest.post_rest("roles", self)
      end
      self
    end

to_hash() click to toggle source

    # File lib/chef/role.rb, line 122
    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",

        #Render to_json correctly for run_list items (both run_list and evn_run_lists)
        #so malformed json does not result
        "run_list" => run_list.run_list.map { |item| item.to_s },
        "env_run_lists" => env_run_lists_without_default.inject({}) do |accumulator, (k, v)|
          accumulator[k] = v.map { |x| x.to_s }
          accumulator
        end
      }
      result
    end

to_json(*a) click to toggle source

Serialize this object as a hash

    # File lib/chef/role.rb, line 145
    def to_json(*a)
      to_hash.to_json(*a)
    end

to_s() click to toggle source

As a string

    # File lib/chef/role.rb, line 229
    def to_s
      "role[#{@name}]"
    end

update_from!(o) click to toggle source

    # File lib/chef/role.rb, line 149
    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