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

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

Instance Attribute Summary

Attributes inherited from Chef::Provider::Group

#change_desc, #group_exists

Attributes inherited from Chef::Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #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

#compare_group, #create_group, #group_gid_match?, #group_members_match?, #has_current_group_member?, #initialize, #manage_group, #remove_group, #validate_member!

Methods inherited from Chef::Provider

action, action_description, action_descriptions, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #introduced, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #recipe_name, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #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 Mixin::LazyModuleInclude

#descendants, #include, #included

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

#default_secret_config, #default_secret_service, #secret, #with_secret_config, #with_secret_service

Methods included from DSL::RenderHelpers

#render_json, #render_toml, #render_yaml

Methods included from DSL::ReaderHelpers

#parse_file, #parse_json, #parse_toml, #parse_yaml

Methods included from DSL::Powershell

#ps_credential

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::ChefVault

#chef_vault, #chef_vault_item, #chef_vault_item_for_environment

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::Recipe

#exec, #have_resource_class_for?, #resource_class_for

Methods included from DSL::Definitions

add_definition, #evaluate_resource_definition, #has_resource_definition?

Methods included from DSL::Resources

add_resource_dsl, remove_resource_dsl

Methods included from DSL::Cheffish

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::IncludeRecipe

#include_recipe, #load_recipe

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!, #resources, #with_run_context

Methods included from DSL::Compliance

#include_input, #include_profile, #include_waiver

Constructor Details

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

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

def append_flags
  "-G" if platform?("openbsd", "netbsd", "aix", "smartos", "omnios")
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 { ::TargetIO::File.exist?("/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 



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}"
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.
  unless new_resource.action.include?(:create)
    raise Chef::Exceptions::UnsupportedAction, "Setting members directly is not supported by #{self}"
  end

  members.each do |member|
    add_member(member)
  end
end