Class: Chef::Provider::Group::Usermod

Inherits:
Groupadd show all
Includes:
Mixin::ShellOut
Defined in:
lib/chef/provider/group/usermod.rb

Direct Known Subclasses

Aix

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, #current_resource, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!

Methods inherited from Groupadd

#create_group, #groupadd_options, #manage_group, #modify_group_members, #remove_group, #required_binaries, #set_options

Methods inherited from Chef::Provider::Group

#action_create, #action_manage, #action_modify, #action_remove, #compare_group, #create_group, #initialize, #manage_group, #remove_group, #whyrun_supported?

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::Windows

#popen4

Methods included from Mixin::Command::Unix

#popen4

Methods inherited from Chef::Provider

#action_nothing, build_from_file, #cleanup_after_converge, #cookbook_name, #events, #initialize, #node, #process_resource_requirements, #requirements, #resource_collection, #run_action, #set_updated_status, #whyrun_mode?, #whyrun_supported?

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::EnforceOwnershipAndPermissions

#access_controls, #enforce_ownership_and_permissions

Methods included from Mixin::RecipeDefinitionDSLCore

#method_missing

Methods included from Mixin::Language

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

Constructor Details

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

Dynamic Method Handling

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

Instance Method Details

#add_member(member) ⇒ Object 



68
69
70
 
# File 'lib/chef/provider/group/usermod.rb', line 68

def add_member(member)
  shell_out!("usermod #{append_flags} #{@new_resource.group_name} #{member}")
end

#append_flags ⇒ Object 



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

def append_flags
  case node[:platform]
  when "openbsd", "netbsd", "aix", "solaris2", "smartos"
    "-G"
  when "solaris", "suse", "opensuse"
    "-a -G"
  end
end

#define_resource_requirements ⇒ Object 



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

def define_resource_requirements
  super

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

  requirements.assert(:modify, :manage) do |a|
    a.assertion { @new_resource.members.empty? || @new_resource.append }
    a.failure_message Chef::Exceptions::Group, "setting group members directly is not supported by #{self.to_s}, must set append true in group"
    # No whyrun alternative - this action is simply not supported.
  end

  requirements.assert(:all_actions) do |a|
    a.assertion { @new_resource.excluded_members.empty? }
    a.failure_message Chef::Exceptions::Group, "excluded_members is not supported by #{self.to_s}"
    # No whyrun alternative - this action is simply not supported.
  end
end

#load_current_resource ⇒ Object 



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

def load_current_resource
  super
end

#remove_member(member) ⇒ Object

Raises:



72
73
74
75
76
 
# File 'lib/chef/provider/group/usermod.rb', line 72

def remove_member(member)
  # This provider only supports adding members with
  # append. This function should never be called.
  raise Chef::Exceptions::UnsupportedAction, "Removing members members is not supported by #{self.to_s}"
end

#set_members(members) ⇒ Object 



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

def set_members(members)
  return if members.empty?
  # This provider only supports adding members with
  # append. Only if the action is create we will go
  # ahead and add members.
  if @new_resource.action == :create
    members.each do |member|
      add_member(member)
    end
  else
    raise Chef::Exceptions::UnsupportedAction, "Setting members directly is not supported by #{self.to_s}"
  end
end