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

Inherits:
Groupadd show all
Defined in:
lib/chef/provider/group/usermod.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 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, #has_current_group_member?, #initialize, #manage_group, #remove_group, #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 



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

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

#append_flags ⇒ Object 



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

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

#define_resource_requirements ⇒ Object 



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

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}, 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}"
    # No whyrun alternative - this action is simply not supported.
  end
end

#load_current_resource ⇒ Object 



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

def load_current_resource
  super
end

#remove_member(member) ⇒ Object

Raises:



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

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}"
end

#set_members(members) ⇒ Object 



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

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}"
  end
end