Class: Chef::Provider::Group::Windows

Inherits:
Chef::Provider::Group show all
Defined in:
lib/chef/provider/group/windows.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, #define_resource_requirements, #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, #define_resource_requirements, #events, include_resource_dsl, include_resource_dsl_module, #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

#initialize(new_resource, run_context) ⇒ Windows

Returns a new instance of Windows.



31
32
33
34
# File 'lib/chef/provider/group/windows.rb', line 31

def initialize(new_resource, run_context)
  super
  @net_group = Chef::Util::Windows::NetGroup.new(@new_resource.group_name)
end

Instance Method Details

#create_groupObject



55
56
57
58
# File 'lib/chef/provider/group/windows.rb', line 55

def create_group
  @net_group.local_add
  manage_group
end

#has_current_group_member?(member) ⇒ Boolean

Returns:

  • (Boolean)


82
83
84
85
# File 'lib/chef/provider/group/windows.rb', line 82

def has_current_group_member?(member)
  member_sid = (member)
  @current_resource.members.include?(member_sid)
end

#load_current_resourceObject



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/chef/provider/group/windows.rb', line 36

def load_current_resource
  @current_resource = Chef::Resource::Group.new(@new_resource.name)
  @current_resource.group_name(@new_resource.group_name)

  members = nil
  begin
    members = @net_group.local_get_members
  rescue => e
    @group_exists = false
    Chef::Log.debug("#{@new_resource} group does not exist")
  end

  if members
    @current_resource.members(members)
  end

  @current_resource
end

#locally_qualified_name(account_name) ⇒ Object



91
92
93
# File 'lib/chef/provider/group/windows.rb', line 91

def locally_qualified_name()
  .include?("\\") ?  : "#{ENV['COMPUTERNAME']}\\#{}"
end

#lookup_account_name(account_name) ⇒ Object



99
100
101
102
103
104
105
106
# File 'lib/chef/provider/group/windows.rb', line 99

def ()
  begin
    Chef::ReservedNames::Win32::Security.(locally_qualified_name())[1].to_s
  rescue Chef::Exceptions::Win32APIError
    Chef::Log.warn("SID for '#{locally_qualified_name()}' could not be found")
    ""
  end
end

#manage_groupObject



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/chef/provider/group/windows.rb', line 60

def manage_group
  if @new_resource.append
    members_to_be_added = [ ]
    @new_resource.members.each do |member|
      members_to_be_added << member if ! has_current_group_member?(member) && validate_member!(member)
    end

    # local_add_members will raise ERROR_MEMBER_IN_ALIAS if a
    # member already exists in the group.
    @net_group.local_add_members(members_to_be_added) unless members_to_be_added.empty?

    members_to_be_removed = [ ]
    @new_resource.excluded_members.each do |member|
      member_sid = (member)
      members_to_be_removed << member if has_current_group_member?(member)
    end
    @net_group.local_delete_members(members_to_be_removed) unless members_to_be_removed.empty?
  else
    @net_group.local_set_members(@new_resource.members)
  end
end

#remove_groupObject



87
88
89
# File 'lib/chef/provider/group/windows.rb', line 87

def remove_group
  @net_group.local_delete
end

#validate_member!(member) ⇒ Object



95
96
97
# File 'lib/chef/provider/group/windows.rb', line 95

def validate_member!(member)
  Chef::ReservedNames::Win32::Security.(locally_qualified_name(member))[1].to_s
end