Class: Chef::Provider::Group::Pw

Inherits:
Chef::Provider::Group show all
Defined in:
lib/chef/provider/group/pw.rb

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider::Group

#change_desc, #group_exists

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods inherited from Chef::Provider::Group

#action_create, #action_manage, #action_modify, #action_remove, #compare_group, #has_current_group_member?, #initialize, #whyrun_supported?

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, #initialize, #node, node_map, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, #whyrun_mode?, #whyrun_supported?

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

This class inherits a constructor from Chef::Provider::Group

Instance Method Details

#create_group ⇒ Object

Create the group



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

def create_group
  command = "pw groupadd"
  command << set_options

  unless @new_resource.members.empty?
    # pw group[add|mod] -M is used to set the full membership list on a
    # new or existing group. Because pw groupadd does not support the -m
    # and -d options used by manage_group, we treat group creation as a
    # special case and use -M.
    Chef::Log.debug("#{@new_resource} setting group members: #{@new_resource.members.join(',')}")
    command += " -M #{@new_resource.members.join(',')}"
  end

  run_command(:command => command)
end

#define_resource_requirements ⇒ Object 



28
29
30
31
32
33
34
35
36
 
# File 'lib/chef/provider/group/pw.rb', line 28

def define_resource_requirements
  super

  requirements.assert(:all_actions) do |a|
    a.assertion { ::File.exists?("/usr/sbin/pw") }
    a.failure_message Chef::Exceptions::Group, "Could not find binary /usr/sbin/pw for #{@new_resource}"
    # No whyrun alternative: this component should be available in the base install of any given system that uses it
  end
end

#load_current_resource ⇒ Object 



24
25
26
 
# File 'lib/chef/provider/group/pw.rb', line 24

def load_current_resource
  super
end

#manage_group ⇒ Object

Manage the group when it already exists



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/chef/provider/group/pw.rb', line 56

def manage_group
  command = "pw groupmod"
  command << set_options
  member_options = set_members_options
  if member_options.empty?
    run_command(:command => command)
  else
    member_options.each do |option|
      run_command(:command => command + option)
    end
  end
end

#remove_group ⇒ Object

Remove the group



70
71
72
 
# File 'lib/chef/provider/group/pw.rb', line 70

def remove_group
  run_command(:command => "pw groupdel #{@new_resource.group_name}")
end

#set_members_options ⇒ Object

Set the membership option depending on the current resource states



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

def set_members_options
  opts = [ ]
  members_to_be_added = [ ]
  members_to_be_removed = [ ]

  if @new_resource.append
    # Append is set so we will only add members given in the
    # members list and remove members given in the
    # excluded_members list.
    if @new_resource.members && !@new_resource.members.empty?
      @new_resource.members.each do |member|
        members_to_be_added << member if !@current_resource.members.include?(member)
      end
    end

    if @new_resource.excluded_members && !@new_resource.excluded_members.empty?
      @new_resource.excluded_members.each do |member|
        members_to_be_removed << member if @current_resource.members.include?(member)
      end
    end
  else
    # Append is not set so we're resetting the membership of
    # the group to the given members.
    members_to_be_added = @new_resource.members
    @current_resource.members.each do |member|
      # No need to re-add a member if it's present in the new
      # list of members
      if members_to_be_added.include? member
        members_to_be_added.delete member
      else
        members_to_be_removed << member
      end
    end
  end

  unless members_to_be_added.empty?
    Chef::Log.debug("#{@new_resource} adding group members: #{members_to_be_added.join(',')}")
    opts << " -m #{members_to_be_added.join(',')}"
  end

  unless members_to_be_removed.empty?
    Chef::Log.debug("#{@new_resource} removing group members: #{members_to_be_removed.join(',')}")
    opts << " -d #{members_to_be_removed.join(',')}"
  end

  opts
end

#set_options ⇒ Object

Little bit of magic as per Adam’s useradd provider to pull and assign the command line flags

Returns

<string>

A string containing the option and then the quoted value



78
79
80
81
82
83
84
85
 
# File 'lib/chef/provider/group/pw.rb', line 78

def set_options
  opts = " #{@new_resource.group_name}"
  if @new_resource.gid && (@current_resource.gid != @new_resource.gid)
    Chef::Log.debug("#{@new_resource}: current gid (#{@current_resource.gid}) doesnt match target gid (#{@new_resource.gid}), changing it")
    opts << " -g '#{@new_resource.gid}'"
  end
  opts
end