Class: Chef::Provider::User

Inherits:
Chef::Provider show all
Includes:
Mixin::Command
Defined in:
lib/chef/provider/user.rb,
lib/chef/provider/user/pw.rb,
lib/chef/provider/user/aix.rb,
lib/chef/provider/user/dscl.rb,
lib/chef/provider/user/linux.rb,
lib/chef/provider/user/solaris.rb,
lib/chef/provider/user/useradd.rb,
lib/chef/provider/user/windows.rb

Direct Known Subclasses

Dscl, Linux, Pw, Useradd, Windows

Defined Under Namespace

Classes: Aix, Dscl, Linux, Pw, Solaris, Useradd, Windows

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

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 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, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?

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::ShellOut

#a_to_s, #clean_array, #run_command_compatible_options, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

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) ⇒ User

Returns a new instance of User.



30
31
32
33
34
35
36
 
# File 'lib/chef/provider/user.rb', line 30

def initialize(new_resource, run_context)
  super
  @user_exists = true
  @locked = nil
  @shadow_lib_ok = true
  @group_name_resolved = true
end

Instance Attribute Details

#locked ⇒ Object

Returns the value of attribute locked.



28
29
30
 
# File 'lib/chef/provider/user.rb', line 28

def locked
  @locked
end

#user_exists ⇒ Object

Returns the value of attribute user_exists.



28
29
30
 
# File 'lib/chef/provider/user.rb', line 28

def user_exists
  @user_exists
end

Instance Method Details

#action_create ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/chef/provider/user.rb', line 125

def action_create
  if !@user_exists
    converge_by("create user #{@new_resource.username}") do
      create_user
      Chef::Log.info("#{@new_resource} created")
    end
  elsif compare_user
    converge_by("alter user #{@new_resource.username}") do
      manage_user
      Chef::Log.info("#{@new_resource} altered")
    end
  end
end

#action_lock ⇒ Object 



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/chef/provider/user.rb', line 163

def action_lock
  if check_lock == false
    converge_by("lock the user #{@new_resource.username}") do
      lock_user
      Chef::Log.info("#{@new_resource} locked")
    end
  else
    Chef::Log.debug("#{@new_resource} already locked - nothing to do")
  end
end

#action_manage ⇒ Object 



147
148
149
150
151
152
153
 
# File 'lib/chef/provider/user.rb', line 147

def action_manage
  return unless @user_exists && compare_user
  converge_by("manage user #{@new_resource.username}") do
    manage_user
    Chef::Log.info("#{@new_resource} managed")
  end
end

#action_modify ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/chef/provider/user.rb', line 155

def action_modify
  return unless compare_user
  converge_by("modify user #{@new_resource.username}") do
    manage_user
    Chef::Log.info("#{@new_resource} modified")
  end
end

#action_remove ⇒ Object 



139
140
141
142
143
144
145
 
# File 'lib/chef/provider/user.rb', line 139

def action_remove
  return unless @user_exists
  converge_by("remove user #{@new_resource.username}") do
    remove_user
    Chef::Log.info("#{@new_resource} removed")
  end
end

#action_unlock ⇒ Object 



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/chef/provider/user.rb', line 174

def action_unlock
  if check_lock == true
    converge_by("unlock user #{@new_resource.username}") do
      unlock_user
      Chef::Log.info("#{@new_resource} unlocked")
    end
  else
    Chef::Log.debug("#{@new_resource} already unlocked - nothing to do")
  end
end

#check_lock ⇒ Object

Raises:

  • (NotImplementedError) 


205
206
207
 
# File 'lib/chef/provider/user.rb', line 205

def check_lock
  raise NotImplementedError
end

#compare_user ⇒ Object

Check to see if the user needs any changes

Returns

<true>

If a change is required

<false>

If the users are identical



115
116
117
118
119
120
121
122
123
 
# File 'lib/chef/provider/user.rb', line 115

def compare_user
  return true if !@new_resource.home.nil? && Pathname.new(@new_resource.home).cleanpath != Pathname.new(@current_resource.home).cleanpath

  [ :comment, :shell, :password, :uid, :gid ].each do |user_attrib|
    return true if !@new_resource.send(user_attrib).nil? && @new_resource.send(user_attrib).to_s != @current_resource.send(user_attrib).to_s
  end

  false
end

#convert_group_name ⇒ Object 



38
39
40
41
42
43
44
 
# File 'lib/chef/provider/user.rb', line 38

def convert_group_name
  if @new_resource.gid.is_a? String
    @new_resource.gid(Etc.getgrnam(@new_resource.gid).gid)
  end
rescue ArgumentError
  @group_name_resolved = false
end

#create_user ⇒ Object

Raises:

  • (NotImplementedError) 


185
186
187
 
# File 'lib/chef/provider/user.rb', line 185

def create_user
  raise NotImplementedError
end

#define_resource_requirements ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/chef/provider/user.rb', line 91

def define_resource_requirements
  requirements.assert(:create, :modify, :manage, :lock, :unlock) do |a|
    a.assertion { @group_name_resolved }
    a.failure_message Chef::Exceptions::User, "Couldn't lookup integer GID for group name #{@new_resource.gid}"
    a.whyrun "group name #{@new_resource.gid} does not exist.  This will cause group assignment to fail.  Assuming this group will have been created previously."
  end
  requirements.assert(:all_actions) do |a|
    a.assertion { @shadow_lib_ok }
    a.failure_message Chef::Exceptions::MissingLibrary, "You must have ruby-shadow installed for password support!"
    a.whyrun "ruby-shadow is not installed. Attempts to set user password will cause failure.  Assuming that this gem will have been previously installed." \
      "Note that user update converge may report false-positive on the basis of mismatched password. "
  end
  requirements.assert(:modify, :lock, :unlock) do |a|
    a.assertion { @user_exists }
    a.failure_message(Chef::Exceptions::User, "Cannot modify user #{@new_resource.username} - does not exist!")
    a.whyrun("Assuming user #{@new_resource.username} would have been created")
  end
end

#load_current_resource ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
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
 
# File 'lib/chef/provider/user.rb', line 50

def load_current_resource
  @current_resource = Chef::Resource::User.new(@new_resource.name)
  @current_resource.username(@new_resource.username)

  begin
     = Etc.getpwnam(@new_resource.username)
  rescue ArgumentError
    @user_exists = false
    Chef::Log.debug("#{@new_resource} user does not exist")
     = nil
  end

  if 
    @current_resource.uid(.uid)
    @current_resource.gid(.gid)
    @current_resource.home(.dir)
    @current_resource.shell(.shell)
    @current_resource.password(.passwd)

    if @new_resource.comment
      .gecos.force_encoding(@new_resource.comment.encoding)
    end
    @current_resource.comment(.gecos)

    if @new_resource.password && @current_resource.password == "x"
      begin
        require "shadow"
      rescue LoadError
        @shadow_lib_ok = false
      else
        shadow_info = Shadow::Passwd.getspnam(@new_resource.username)
        @current_resource.password(shadow_info.sp_pwdp)
      end
    end

    convert_group_name if @new_resource.gid
  end

  @current_resource
end

#lock_user ⇒ Object

Raises:

  • (NotImplementedError) 


197
198
199
 
# File 'lib/chef/provider/user.rb', line 197

def lock_user
  raise NotImplementedError
end

#manage_user ⇒ Object

Raises:

  • (NotImplementedError) 


193
194
195
 
# File 'lib/chef/provider/user.rb', line 193

def manage_user
  raise NotImplementedError
end

#managing_home_dir? ⇒ Boolean

Returns:

  • (Boolean) 


214
215
216
217
 
# File 'lib/chef/provider/user.rb', line 214

def managing_home_dir?
  # XXX: THIS GOES AWAY IN CHEF-13 AND BECOMES JUST new_resource.manage_home
  new_resource.manage_home || new_resource.supports[:manage_home]
end

#non_unique? ⇒ Boolean

Returns:

  • (Boolean) 


209
210
211
212
 
# File 'lib/chef/provider/user.rb', line 209

def non_unique?
  # XXX: THIS GOES AWAY IN CHEF-13 AND BECOMES JUST new_resource.non_unique
  new_resource.non_unique || new_resource.supports[:non_unique]
end

#remove_user ⇒ Object

Raises:

  • (NotImplementedError) 


189
190
191
 
# File 'lib/chef/provider/user.rb', line 189

def remove_user
  raise NotImplementedError
end

#unlock_user ⇒ Object

Raises:

  • (NotImplementedError) 


201
202
203
 
# File 'lib/chef/provider/user.rb', line 201

def unlock_user
  raise NotImplementedError
end

#whyrun_supported? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/chef/provider/user.rb', line 46

def whyrun_supported?
  true
end