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

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

Direct Known Subclasses

Aix, Gpasswd, Solaris, Usermod

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 Chef::Provider::Group

#compare_group, #group_gid_match?, #group_members_match?, #has_current_group_member?, #initialize, #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

Raises:



93
94
95
 
# File 'lib/chef/provider/group/groupadd.rb', line 93

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

def create_group
  shell_out!("groupadd", set_options, groupadd_options)
  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 { ::TargetIO::File.exist?(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 



123
124
125
126
127
128
129
 
# File 'lib/chef/provider/group/groupadd.rb', line 123

def groupadd_options
  opts = []
  # Solaris doesn't support system groups.
  opts << "-r" if new_resource.system && !node.platform?("solaris2")
  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



52
53
54
55
 
# File 'lib/chef/provider/group/groupadd.rb', line 52

def manage_group
  shell_out!("groupmod", set_options)
  modify_group_members
end

#modify_group_members ⇒ Object 



62
63
64
65
66
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
 
# File 'lib/chef/provider/group/groupadd.rb', line 62

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 unless current_resource.members.include?(member)
      end
      members_to_be_added.each do |member|
        logger.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|
        logger.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(", ")
    logger.debug("#{new_resource} setting group members to: #{members_description}")
    set_members(new_resource.members)
  end
end

#remove_group ⇒ Object

Remove the group



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

def remove_group
  shell_out!("groupdel", new_resource.group_name)
end

#remove_member(member) ⇒ Object

Raises:



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

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:



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

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



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/chef/provider/group/groupadd.rb', line 109

def set_options
  opts = []
  { gid: "-g" }.sort_by { |a| a[0] }.each do |field, option|
    next unless current_resource.send(field) != new_resource.send(field)
    next unless new_resource.send(field)

    opts << option
    opts << new_resource.send(field)
    logger.trace("#{new_resource} set #{field} to #{new_resource.send(field)}")
  end
  opts << new_resource.group_name
  opts
end