Class: Chef::Provider::Group::Groupadd

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

Direct Known Subclasses

Aix, Gpasswd, Suse, Usermod

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, #validate_member!, #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 included from Mixin::ShellOut

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

Methods inherited from Chef::Provider

#action_nothing, #check_resource_semantics!, #cleanup_after_converge, #converge_by, #converge_if_changed, #events, include_resource_dsl, include_resource_dsl_module, #initialize, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?, #whyrun_supported?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

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 DeprecatedLWRPClass

#const_missing, #deprecated_constants, #register_deprecated_lwrp_class

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

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

Instance Method Details

#add_member(member) ⇒ Object

Raises:



98
99
100
 
# File 'lib/chef/provider/group/groupadd.rb', line 98

def add_member(member)
  raise Chef::Exceptions::Group, "you must override add_member in #{self}"
end

#create_group ⇒ Object

Create the group



46
47
48
49
50
51
52
 
# File 'lib/chef/provider/group/groupadd.rb', line 46

def create_group
  command = "groupadd"
  command << set_options
  command << groupadd_options
  run_command(:command => command)
  modify_group_members
end

#define_resource_requirements ⇒ Object 



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/chef/provider/group/groupadd.rb', line 34

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

#groupadd_options ⇒ Object 



127
128
129
130
131
132
 
# File 'lib/chef/provider/group/groupadd.rb', line 127

def groupadd_options
  opts = ""
  opts << " -r" if @new_resource.system
  opts << " -o" if @new_resource.non_unique
  opts
end

#load_current_resource ⇒ Object 



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

def load_current_resource
  super
end

#manage_group ⇒ Object

Manage the group when it already exists



55
56
57
58
59
60
 
# File 'lib/chef/provider/group/groupadd.rb', line 55

def manage_group
  command = "groupmod"
  command << set_options
  run_command(:command => command)
  modify_group_members
end

#modify_group_members ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/chef/provider/group/groupadd.rb', line 67

def modify_group_members
  if @new_resource.append
    if @new_resource.members && !@new_resource.members.empty?
      members_to_be_added = [ ]
      @new_resource.members.each do |member|
        members_to_be_added << member if !@current_resource.members.include?(member)
      end
      members_to_be_added.each do |member|
        Chef::Log.debug("#{@new_resource} appending member #{member} to group #{@new_resource.group_name}")
        add_member(member)
      end
    end

    if @new_resource.excluded_members && !@new_resource.excluded_members.empty?
      members_to_be_removed = [ ]
      @new_resource.excluded_members.each do |member|
        members_to_be_removed << member if @current_resource.members.include?(member)
      end

      members_to_be_removed.each do |member|
        Chef::Log.debug("#{@new_resource} removing member #{member} from group #{@new_resource.group_name}")
        remove_member(member)
      end
    end
  else
    members_description = @new_resource.members.empty? ? "none" : @new_resource.members.join(", ")
    Chef::Log.debug("#{@new_resource} setting group members to: #{members_description}")
    set_members(@new_resource.members)
  end
end

#remove_group ⇒ Object

Remove the group



63
64
65
 
# File 'lib/chef/provider/group/groupadd.rb', line 63

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

#remove_member(member) ⇒ Object

Raises:



102
103
104
 
# File 'lib/chef/provider/group/groupadd.rb', line 102

def remove_member(member)
  raise Chef::Exceptions::Group, "you must override remove_member in #{self}"
end

#required_binaries ⇒ Object 



24
25
26
27
28
 
# File 'lib/chef/provider/group/groupadd.rb', line 24

def required_binaries
  [ "/usr/sbin/groupadd",
    "/usr/sbin/groupmod",
    "/usr/sbin/groupdel" ]
end

#set_members(members) ⇒ Object

Raises:



106
107
108
 
# File 'lib/chef/provider/group/groupadd.rb', line 106

def set_members(members)
  raise Chef::Exceptions::Group, "you must override set_members in #{self}"
end

#set_options ⇒ Object

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

Returns

<string>

A string containing the option and then the quoted value



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/chef/provider/group/groupadd.rb', line 114

def set_options
  opts = ""
  { :gid => "-g" }.sort { |a, b| a[0] <=> b[0] }.each do |field, option|
    if @current_resource.send(field) != @new_resource.send(field)
      if @new_resource.send(field)
        opts << " #{option} '#{@new_resource.send(field)}'"
        Chef::Log.debug("#{@new_resource} set #{field} to #{@new_resource.send(field)}")
      end
    end
  end
  opts << " #{@new_resource.group_name}"
end