Class: Chef::Provider::Group
- Inherits:
-
Chef::Provider
- Object
- Chef::Provider
- Chef::Provider::Group
- Includes:
- Mixin::ShellOut
- Defined in:
- lib/chef/provider/group.rb,
lib/chef/provider/group/pw.rb,
lib/chef/provider/group/aix.rb,
lib/chef/provider/group/dscl.rb,
lib/chef/provider/group/suse.rb,
lib/chef/provider/group/gpasswd.rb,
lib/chef/provider/group/solaris.rb,
lib/chef/provider/group/usermod.rb,
lib/chef/provider/group/windows.rb,
lib/chef/provider/group/groupadd.rb,
lib/chef/provider/group/groupmod.rb
Defined Under Namespace
Classes: Aix, Dscl, Gpasswd, Groupadd, Groupmod, Pw, Solaris, Suse, Usermod, Windows
Instance Attribute Summary collapse
-
#change_desc ⇒ Object
Returns the value of attribute change_desc.
-
#group_exists ⇒ Object
Returns the value of attribute group_exists.
Attributes inherited from Chef::Provider
#action, #current_resource, #logger, #new_resource, #recipe_name, #run_context
Instance Method Summary collapse
- #action_create ⇒ Object
- #action_manage ⇒ Object
- #action_modify ⇒ Object
- #action_remove ⇒ Object
-
#compare_group ⇒ Object
Check to see if a group needs any changes.
- #create_group ⇒ Object
- #define_resource_requirements ⇒ Object
- #has_current_group_member?(member) ⇒ Boolean
-
#initialize(new_resource, run_context) ⇒ Group
constructor
A new instance of Group.
- #load_current_resource ⇒ Object
- #manage_group ⇒ Object
- #remove_group ⇒ Object
- #validate_member!(member) ⇒ Object
Methods included from Mixin::ShellOut
apply_default_env, maybe_add_timeout, #shell_out, #shell_out!
Methods inherited from Chef::Provider
action, #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, #introduced, #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 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 Mixin::PowershellExec
Methods included from DSL::Powershell
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::DataQuery
#data_bag, #data_bag_item, #search, #tagged?
Methods included from EncryptedDataBagItem::CheckEncrypted
Methods included from DSL::PlatformIntrospection
#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family
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
Constructor Details
#initialize(new_resource, run_context) ⇒ Group
Returns a new instance of Group.
30 31 32 33 |
# File 'lib/chef/provider/group.rb', line 30 def initialize(new_resource, run_context) super @group_exists = true end |
Instance Attribute Details
#change_desc ⇒ Object
Returns the value of attribute change_desc.
28 29 30 |
# File 'lib/chef/provider/group.rb', line 28 def change_desc @change_desc end |
#group_exists ⇒ Object
Returns the value of attribute group_exists.
27 28 29 |
# File 'lib/chef/provider/group.rb', line 27 def group_exists @group_exists end |
Instance Method Details
#action_create ⇒ Object
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/chef/provider/group.rb', line 125 def action_create case @group_exists when false converge_by("create group #{new_resource.group_name}") do create_group logger.info("#{new_resource} created") end else if compare_group converge_by(["alter group #{new_resource.group_name}"] + change_desc) do manage_group logger.info("#{new_resource} altered") end end end end |
#action_manage ⇒ Object
151 152 153 154 155 156 157 158 |
# File 'lib/chef/provider/group.rb', line 151 def action_manage return unless @group_exists && compare_group converge_by(["manage group #{new_resource.group_name}"] + change_desc) do manage_group logger.info("#{new_resource} managed") end end |
#action_modify ⇒ Object
160 161 162 163 164 165 166 167 |
# File 'lib/chef/provider/group.rb', line 160 def action_modify return unless compare_group converge_by(["modify group #{new_resource.group_name}"] + change_desc) do manage_group logger.info("#{new_resource} modified") end end |
#action_remove ⇒ Object
142 143 144 145 146 147 148 149 |
# File 'lib/chef/provider/group.rb', line 142 def action_remove return unless @group_exists converge_by("remove group #{new_resource.group_name}") do remove_group logger.info("#{new_resource} removed") end end |
#compare_group ⇒ Object
Check to see if a group needs any changes. Populate
Returns
- <true>
-
If a change is required
- <false>
-
If a change is not required
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/chef/provider/group.rb', line 81 def compare_group @change_desc = [ ] if new_resource.gid.to_s != current_resource.gid.to_s @change_desc << "change gid #{current_resource.gid} to #{new_resource.gid}" end if new_resource.append missing_members = [] new_resource.members.each do |member| next if has_current_group_member?(member) validate_member!(member) missing_members << member end unless missing_members.empty? @change_desc << "add missing member(s): #{missing_members.join(", ")}" end members_to_be_removed = [] new_resource.excluded_members.each do |member| if has_current_group_member?(member) members_to_be_removed << member end end unless members_to_be_removed.empty? @change_desc << "remove existing member(s): #{members_to_be_removed.join(", ")}" end elsif new_resource.members != current_resource.members @change_desc << "replace group members with new list of members" end !@change_desc.empty? end |
#create_group ⇒ Object
169 170 171 |
# File 'lib/chef/provider/group.rb', line 169 def create_group raise NotImplementedError, "subclasses of Chef::Provider::Group should define #create_group" end |
#define_resource_requirements ⇒ Object
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/chef/provider/group.rb', line 56 def define_resource_requirements requirements.assert(:modify) do |a| a.assertion { @group_exists } a.(Chef::Exceptions::Group, "Cannot modify #{new_resource} - group does not exist!") a.whyrun("Group #{new_resource} does not exist. Unless it would have been created earlier in this run, this attempt to modify it would fail.") end requirements.assert(:all_actions) do |a| # Make sure that the resource doesn't contain any common # user names in the members and exclude_members properties. if !new_resource.members.nil? && !new_resource.excluded_members.nil? common_members = new_resource.members & new_resource.excluded_members a.assertion { common_members.empty? } a.(Chef::Exceptions::ConflictingMembersInGroup, "Attempting to both add and remove users from a group: '#{common_members.join(", ")}'") # No why-run alternative end end end |
#has_current_group_member?(member) ⇒ Boolean
115 116 117 |
# File 'lib/chef/provider/group.rb', line 115 def has_current_group_member?(member) current_resource.members.include?(member) end |
#load_current_resource ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/chef/provider/group.rb', line 35 def load_current_resource @current_resource = Chef::Resource::Group.new(new_resource.name) current_resource.group_name(new_resource.group_name) group_info = nil begin group_info = Etc.getgrnam(new_resource.group_name) rescue ArgumentError @group_exists = false logger.trace("#{new_resource} group does not exist") end if group_info new_resource.gid(group_info.gid) unless new_resource.gid current_resource.gid(group_info.gid) current_resource.members(group_info.mem) end current_resource end |
#manage_group ⇒ Object
173 174 175 |
# File 'lib/chef/provider/group.rb', line 173 def manage_group raise NotImplementedError, "subclasses of Chef::Provider::Group should define #manage_group" end |
#remove_group ⇒ Object
177 178 179 |
# File 'lib/chef/provider/group.rb', line 177 def remove_group raise NotImplementedError, "subclasses of Chef::Provider::Group should define #remove_group" end |
#validate_member!(member) ⇒ Object
119 120 121 122 123 |
# File 'lib/chef/provider/group.rb', line 119 def validate_member!(member) # Sub-classes can do any validation if needed # and raise an error if validation fails true end |