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/gpasswd.rb,
lib/chef/provider/group/usermod.rb,
lib/chef/provider/group/windows.rb,
lib/chef/provider/group/groupadd.rb,
lib/chef/provider/group/groupmod.rb

Direct Known Subclasses

Dscl, Groupadd, Groupmod, Pw, Windows

Defined Under Namespace

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

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods included from Mixin::Command

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

Methods included from Mixin::Command::Windows

#popen4

Methods included from Mixin::Command::Unix

#popen4

Methods inherited from Chef::Provider

#action_nothing, #cleanup_after_converge, #converge_by, #events, #node, node_map, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, #whyrun_mode?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Constructor Details

#initialize(new_resource, run_context) ⇒ Group

Returns a new instance of Group.



34
35
36
37
 
# File 'lib/chef/provider/group.rb', line 34

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

Instance Attribute Details

#change_desc ⇒ Object

Returns the value of attribute change_desc.



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

def change_desc
  @change_desc
end

#group_exists ⇒ Object

Returns the value of attribute group_exists.



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

def group_exists
  @group_exists
end

Instance Method Details

#action_create ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/chef/provider/group.rb', line 123

def action_create
  case @group_exists
  when false
    converge_by("create #{@new_resource}") do
      create_group
      Chef::Log.info("#{@new_resource} created")
    end
  else
    if compare_group
      converge_by(["alter group #{@new_resource}"] + change_desc) do
        manage_group
        Chef::Log.info("#{@new_resource} altered")
      end
    end
  end
end

#action_manage ⇒ Object 



149
150
151
152
153
154
155
156
 
# File 'lib/chef/provider/group.rb', line 149

def action_manage
  if @group_exists && compare_group
    converge_by(["manage group #{@new_resource}"] + change_desc) do
      manage_group
      Chef::Log.info("#{@new_resource} managed")
    end
  end
end

#action_modify ⇒ Object 



158
159
160
161
162
163
164
165
 
# File 'lib/chef/provider/group.rb', line 158

def action_modify
  if compare_group
    converge_by(["modify group #{@new_resource}"] + change_desc) do
      manage_group
      Chef::Log.info("#{@new_resource} modified")
    end
  end
end

#action_remove ⇒ Object 



140
141
142
143
144
145
146
147
 
# File 'lib/chef/provider/group.rb', line 140

def action_remove
  if @group_exists
    converge_by("remove group #{@new_resource}") do
      remove_group
      Chef::Log.info("#{@new_resource} removed")
    end
  end
end

#compare_group ⇒ Object

Check to see if a group needs any changes. Populate

Returns

<true>

If a change is required

<false>

If a change is not required



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
 
# File 'lib/chef/provider/group.rb', line 85

def compare_group
  @change_desc = [ ]
  if @new_resource.gid.to_s  != @current_resource.gid.to_s
    @change_desc << "change gid #{@current_resource.gid} to #{@new_resource.gid}"
  end

  if(@new_resource.append)
    missing_members = []
    @new_resource.members.each do |member|
      next if has_current_group_member?(member)
      missing_members << member
    end
    if missing_members.length > 0
      @change_desc << "add missing member(s): #{missing_members.join(", ")}"
    end

    members_to_be_removed = []
    @new_resource.excluded_members.each do |member|
      if has_current_group_member?(member)
        members_to_be_removed << member
      end
    end
    if members_to_be_removed.length > 0
      @change_desc << "remove existing member(s): #{members_to_be_removed.join(", ")}"
    end
  else
    if @new_resource.members != @current_resource.members
      @change_desc << "replace group members with new list of members"
    end
  end

  !@change_desc.empty?
end

#create_group ⇒ Object

Raises:

  • (NotImplementedError) 


167
168
169
 
# File 'lib/chef/provider/group.rb', line 167

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

#define_resource_requirements ⇒ Object 



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

def define_resource_requirements
  requirements.assert(:modify) do |a|
    a.assertion { @group_exists }
    a.failure_message(Chef::Exceptions::Group, "Cannot modify #{@new_resource} - group does not exist!")
    a.whyrun("Group #{@new_resource} does not exist. Unless it would have been created earlier in this run, this attempt to modify it would fail.")
  end

  requirements.assert(:all_actions) do |a|
    # Make sure that the resource doesn't contain any common
    # user names in the members and exclude_members properties.
    if !@new_resource.members.nil? && !@new_resource.excluded_members.nil?
      common_members = @new_resource.members & @new_resource.excluded_members
      a.assertion { common_members.empty? }
      a.failure_message(Chef::Exceptions::ConflictingMembersInGroup, "Attempting to both add and remove users from a group: '#{common_members.join(', ')}'")
      # No why-run alternative
    end
  end
end

#has_current_group_member?(member) ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_current_group_member?(member)
  @current_resource.members.include?(member)
end

#load_current_resource ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/chef/provider/group.rb', line 39

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_group ⇒ Object

Raises:

  • (NotImplementedError) 


171
172
173
 
# File 'lib/chef/provider/group.rb', line 171

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

#remove_group ⇒ Object

Raises:

  • (NotImplementedError) 


175
176
177
 
# File 'lib/chef/provider/group.rb', line 175

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

#whyrun_supported? ⇒ Boolean

Returns:

  • (Boolean) 


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

def whyrun_supported?
  true
end