Class: Chef::Provider::Group::Pw

Inherits:
Chef::Provider::Group show all
Defined in:
lib/chef/provider/group/pw.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 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

#create_group ⇒ Object

Create the group



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/chef/provider/group/pw.rb', line 40

def create_group
  command = [ "pw", "groupadd", set_options ]
  unless new_resource.members.empty?
    # pw group[add|mod] -M is used to set the full membership list on a
    # new or existing group. Because pw groupadd does not support the -m
    # and -d options used by manage_group, we treat group creation as a
    # special case and use -M.
    logger.debug("#{new_resource} setting group members: #{new_resource.members.join(",")}")
    command += [ "-M", new_resource.members.join(",") ]
  end

  shell_out!(command)
end

#define_resource_requirements ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/chef/provider/group/pw.rb', line 29

def define_resource_requirements
  super

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

#load_current_resource ⇒ Object 



25
26
27
 
# File 'lib/chef/provider/group/pw.rb', line 25

def load_current_resource
  super
end

#manage_group ⇒ Object

Manage the group when it already exists



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

def manage_group
  member_options = set_members_options
  if member_options.empty?
    shell_out!("pw", "groupmod", set_options)
  else
    member_options.each do |option|
      shell_out!("pw", "groupmod", set_options, option)
    end
  end
end

#remove_group ⇒ Object

Remove the group



67
68
69
 
# File 'lib/chef/provider/group/pw.rb', line 67

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

#set_members_options ⇒ Object

Set the membership option depending on the current resource states



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/chef/provider/group/pw.rb', line 86

def set_members_options
  opts = [ ]
  members_to_be_added = [ ]
  members_to_be_removed = [ ]

  if new_resource.append
    # Append is set so we will only add members given in the
    # members list and remove members given in the
    # excluded_members list.
    if new_resource.members && !new_resource.members.empty?
      new_resource.members.each do |member|
        members_to_be_added << member unless current_resource.members.include?(member)
      end
    end

    if new_resource.excluded_members && !new_resource.excluded_members.empty?
      new_resource.excluded_members.each do |member|
        members_to_be_removed << member if current_resource.members.include?(member)
      end
    end
  else
    # Append is not set so we're resetting the membership of
    # the group to the given members.
    members_to_be_added = new_resource.members.dup
    current_resource.members.each do |member|
      # No need to re-add a member if it's present in the new
      # list of members
      if members_to_be_added.include? member
        members_to_be_added.delete member
      else
        members_to_be_removed << member
      end
    end
  end

  unless members_to_be_added.empty?
    logger.debug("#{new_resource} adding group members: #{members_to_be_added.join(",")}")
    opts << [ "-m", members_to_be_added.join(",") ]
  end

  unless members_to_be_removed.empty?
    logger.debug("#{new_resource} removing group members: #{members_to_be_removed.join(",")}")
    opts << [ "-d", members_to_be_removed.join(",") ]
  end

  opts
end

#set_options ⇒ Object

Little bit of magic as per Adam’s useradd provider to pull and assign the command line flags

Returns

<string>

A string containing the option and then the quoted value



75
76
77
78
79
80
81
82
83
 
# File 'lib/chef/provider/group/pw.rb', line 75

def set_options
  opts = [ new_resource.group_name ]
  if new_resource.gid && (current_resource.gid != new_resource.gid)
    logger.trace("#{new_resource}: current gid (#{current_resource.gid}) doesn't match target gid (#{new_resource.gid}), changing it")
    opts << "-g"
    opts << new_resource.gid
  end
  opts
end