Class: Chef::Provider::Group

Inherits:
Chef::Provider show all
Includes:
Mixin::Command
Defined in:
lib/chef/provider/group.rb,
lib/chef/provider/group/pw.rb,
lib/chef/provider/group/aix.rb,
lib/chef/provider/group/dscl.rb,
lib/chef/provider/group/suse.rb,
lib/chef/provider/group/windows.rb,
lib/chef/provider/group/gpasswd.rb,
lib/chef/provider/group/usermod.rb,
lib/chef/provider/group/groupadd.rb

Direct Known Subclasses

Dscl, Groupadd, Pw, Windows

Defined Under Namespace

Classes: Aix, Dscl, Gpasswd, Groupadd, Pw, Suse, Usermod, Windows

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

#current_resource, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Mixin::Command

#chdir_or_tmpdir, #handle_command_failures, #output_of_command, #run_command, #run_command_with_systems_locale

Methods included from Mixin::Command::Unix

#popen4

Methods included from Mixin::Command::Windows

#popen4

Methods inherited from Chef::Provider

#action_nothing, build_from_file, #cookbook_name, #node, #resource_collection

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::RecipeDefinitionDSLCore

#method_missing

Methods included from Mixin::Language

#data_bag, #data_bag_item, #platform?, #search, #value_for_platform

Constructor Details

#initialize(new_resource, run_context) ⇒ Group



30
31
32
33
# File 'lib/chef/provider/group.rb', line 30

def initialize(new_resource, run_context)
  super
  @group_exists = true
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Mixin::RecipeDefinitionDSLCore

Instance Attribute Details

#group_existsObject

Returns the value of attribute group_exists



28
29
30
# File 'lib/chef/provider/group.rb', line 28

def group_exists
  @group_exists
end

Instance Method Details

#action_createObject



76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/chef/provider/group.rb', line 76

def action_create
  case @group_exists
  when false
    create_group
    Chef::Log.info("#{@new_resource} created")
    @new_resource.updated_by_last_action(true)
  else 
    if compare_group
      manage_group
      Chef::Log.info("#{@new_resource} altered")
      @new_resource.updated_by_last_action(true)
    end
  end
end

#action_manageObject



99
100
101
102
103
104
105
# File 'lib/chef/provider/group.rb', line 99

def action_manage
  if @group_exists && compare_group
    manage_group 
    @new_resource.updated_by_last_action(true)
    Chef::Log.info("#{@new_resource} managed")
  end
end

#action_modifyObject



107
108
109
110
111
112
113
114
115
116
117
# File 'lib/chef/provider/group.rb', line 107

def action_modify
  if @group_exists 
    if compare_group
      manage_group
      @new_resource.updated_by_last_action(true)
      Chef::Log.info("#{@new_resource} modified")
    end
  else
    raise Chef::Exceptions::Group, "Cannot modify #{@new_resource} - group does not exist!"
  end
end

#action_removeObject



91
92
93
94
95
96
97
# File 'lib/chef/provider/group.rb', line 91

def action_remove
  if @group_exists
    remove_group
    @new_resource.updated_by_last_action(true)
    Chef::Log.info("#{@new_resource} removed")
  end
end

#compare_groupObject

Check to see if a group needs any changes

Returns

<true>

If a change is required

<false>

If a change is not required



61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/chef/provider/group.rb', line 61

def compare_group
  return true if @new_resource.gid != @current_resource.gid

  if(@new_resource.append)
    @new_resource.members.each do |member|
      next if @current_resource.members.include?(member)
      return true
    end
  else
    return true if @new_resource.members != @current_resource.members
  end

  return false
end

#create_groupObject

Raises:

  • (NotImplementedError)


119
120
121
# File 'lib/chef/provider/group.rb', line 119

def create_group
  raise NotImplementedError, "subclasses of Chef::Provider::Group should define #create_group"
end

#load_current_resourceObject



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/chef/provider/group.rb', line 35

def load_current_resource
  @current_resource = Chef::Resource::Group.new(@new_resource.name)
  @current_resource.group_name(@new_resource.group_name)
  
  group_info = nil
  begin
    group_info = Etc.getgrnam(@new_resource.group_name)
  rescue ArgumentError => e
    @group_exists = false
    Chef::Log.debug("#{@new_resource} group does not exist")
  end
  
  if group_info
    @new_resource.gid(group_info.gid) unless @new_resource.gid
    @current_resource.gid(group_info.gid)
    @current_resource.members(group_info.mem)
  end
  
  @current_resource
end

#manage_groupObject

Raises:

  • (NotImplementedError)


123
124
125
# File 'lib/chef/provider/group.rb', line 123

def manage_group
  raise NotImplementedError, "subclasses of Chef::Provider::Group should define #manage_group"
end

#remove_groupObject

Raises:

  • (NotImplementedError)


127
128
129
# File 'lib/chef/provider/group.rb', line 127

def remove_group
  raise NotImplementedError, "subclasses of Chef::Provider::Group should define #remove_group"
end