Class: Chef::Provider::Group::Dscl

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

#action_create, #action_manage, #action_modify, #action_remove, #compare_group, #has_current_group_member?, #initialize, #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

#create_group ⇒ Object 



141
142
143
144
145
 
# File 'lib/chef/provider/group/dscl.rb', line 141

def create_group
  dscl_create_group
  set_gid
  set_members
end

#define_resource_requirements ⇒ Object 



132
133
134
135
136
137
138
139
 
# File 'lib/chef/provider/group/dscl.rb', line 132

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

#dscl(*args) ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/chef/provider/group/dscl.rb', line 26

def dscl(*args)
  host = "."
  stdout_result = ""; stderr_result = ""; cmd = "dscl #{host} -#{args.join(' ')}"
  status = shell_out(cmd)
  status.stdout.each_line { |line| stdout_result << line }
  status.stderr.each_line { |line| stderr_result << line }
  return [cmd, status, stdout_result, stderr_result]
end

#dscl_create_group ⇒ Object 



159
160
161
162
 
# File 'lib/chef/provider/group/dscl.rb', line 159

def dscl_create_group
  safe_dscl("create /Groups/#{@new_resource.group_name}")
  safe_dscl("create /Groups/#{@new_resource.group_name} Password '*'")
end

#get_free_gid(search_limit = 1000) ⇒ Object

get a free GID greater than 200



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/chef/provider/group/dscl.rb', line 72

def get_free_gid(search_limit = 1000)
  gid = nil; next_gid_guess = 200
  groups_gids = safe_dscl("list /Groups gid")
  while next_gid_guess < search_limit + 200
    if groups_gids =~ Regexp.new("#{Regexp.escape(next_gid_guess.to_s)}\n")
      next_gid_guess += 1
    else
      gid = next_gid_guess
      break
    end
  end
  return gid || raise("gid not found. Exhausted. Searched #{search_limit} times")
end

#gid_used?(gid) ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
89
90
 
# File 'lib/chef/provider/group/dscl.rb', line 86

def gid_used?(gid)
  return false unless gid
  groups_gids = safe_dscl("list /Groups gid")
  !! ( groups_gids =~ Regexp.new("#{Regexp.escape(gid.to_s)}\n") )
end

#load_current_resource ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/chef/provider/group/dscl.rb', line 43

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 = safe_dscl("read /Groups/#{@new_resource.group_name}")
  rescue Chef::Exceptions::Group
    @group_exists = false
    Chef::Log.debug("#{@new_resource} group does not exist")
  end

  if group_info
    group_info.each_line do |line|
      key, val = line.split(": ")
      val.strip! if val
      case key.downcase
      when "primarygroupid"
        @new_resource.gid(val) unless @new_resource.gid
        @current_resource.gid(val)
      when "groupmembership"
        @current_resource.members(val.split(" "))
      end
    end
  end

  @current_resource
end

#manage_group ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/chef/provider/group/dscl.rb', line 147

def manage_group
  if @new_resource.group_name && (@current_resource.group_name != @new_resource.group_name)
    dscl_create_group
  end
  if @new_resource.gid && (@current_resource.gid != @new_resource.gid)
    set_gid
  end
  if @new_resource.members || @new_resource.excluded_members
    set_members
  end
end

#remove_group ⇒ Object 



164
165
166
 
# File 'lib/chef/provider/group/dscl.rb', line 164

def remove_group
  safe_dscl("delete /Groups/#{@new_resource.group_name}")
end

#safe_dscl(*args) ⇒ Object

Raises:



35
36
37
38
39
40
41
 
# File 'lib/chef/provider/group/dscl.rb', line 35

def safe_dscl(*args)
  result = dscl(*args)
  return "" if ( args.first =~ /^delete/ ) && ( result[1].exitstatus != 0 )
  raise(Chef::Exceptions::Group, "dscl error: #{result.inspect}") unless result[1].exitstatus == 0
  raise(Chef::Exceptions::Group, "dscl error: #{result.inspect}") if result[2] =~ /No such key: /
  return result[2]
end

#set_gid ⇒ Object

Raises:



92
93
94
95
96
 
# File 'lib/chef/provider/group/dscl.rb', line 92

def set_gid
  @new_resource.gid(get_free_gid) if [nil, ""].include? @new_resource.gid
  raise(Chef::Exceptions::Group, "gid is already in use") if gid_used?(@new_resource.gid)
  safe_dscl("create /Groups/#{@new_resource.group_name} PrimaryGroupID #{@new_resource.gid}")
end

#set_members ⇒ Object 



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

def set_members
  # First reset the memberships if the append is not set
  unless @new_resource.append
    Chef::Log.debug("#{@new_resource} removing group members #{@current_resource.members.join(' ')}") unless @current_resource.members.empty?
    safe_dscl("create /Groups/#{@new_resource.group_name} GroupMembers ''") # clear guid list
    safe_dscl("create /Groups/#{@new_resource.group_name} GroupMembership ''") # clear user list
    @current_resource.members([ ])
  end

  # Add any members that need to be added
  if @new_resource.members && !@new_resource.members.empty?
    members_to_be_added = [ ]
    @new_resource.members.each do |member|
      members_to_be_added << member if !@current_resource.members.include?(member)
    end
    unless members_to_be_added.empty?
      Chef::Log.debug("#{@new_resource} setting group members #{members_to_be_added.join(', ')}")
      safe_dscl("append /Groups/#{@new_resource.group_name} GroupMembership #{members_to_be_added.join(' ')}")
    end
  end

  # Remove any members that need to be removed
  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
    unless members_to_be_removed.empty?
      Chef::Log.debug("#{@new_resource} removing group members #{members_to_be_removed.join(', ')}")
      safe_dscl("delete /Groups/#{@new_resource.group_name} GroupMembership #{members_to_be_removed.join(' ')}")
    end
  end
end