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/dscl.rb,
lib/chef/provider/user/useradd.rb,
lib/chef/provider/user/windows.rb

Direct Known Subclasses

Dscl, Pw, Useradd, Windows

Defined Under Namespace

Classes: Dscl, Pw, Useradd, Windows

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

#action, #current_resource, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Mixin::Command

#chdir_or_tmpdir, #handle_command_failures, #output_of_command, #run_command, #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, #cleanup_after_converge, #cookbook_name, #events, #node, #process_resource_requirements, #requirements, #resource_collection, #run_action, #set_updated_status, #whyrun_mode?

Methods included from DSL::Recipe

#method_missing

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Constructor Details

#initialize(new_resource, run_context) ⇒ User

Returns a new instance of User.



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

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::DSL::Recipe

Instance Attribute Details

#locked ⇒ Object

Returns the value of attribute locked.



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

def locked
  @locked
end

#user_exists ⇒ Object

Returns the value of attribute user_exists.



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

def user_exists
  @user_exists
end

Instance Method Details

#action_create ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/chef/provider/user.rb', line 120

def action_create

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

#action_lock ⇒ Object 



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/chef/provider/user.rb', line 170

def action_lock
  if check_lock() == false
    converge_by("lock the user #{@new_resource}") 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 



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

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

#action_modify ⇒ Object 



161
162
163
164
165
166
167
168
 
# File 'lib/chef/provider/user.rb', line 161

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

#action_remove ⇒ Object 



135
136
137
138
139
140
141
142
 
# File 'lib/chef/provider/user.rb', line 135

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

#action_unlock ⇒ Object 



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/chef/provider/user.rb', line 189

def action_unlock
  if check_lock() == true
    converge_by("unlock user #{@new_resource}") 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) 


181
182
183
 
# File 'lib/chef/provider/user.rb', line 181

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



114
115
116
117
118
 
# File 'lib/chef/provider/user.rb', line 114

def compare_user
  [ :uid, :gid, :comment, :home, :shell, :password ].any? do |user_attrib|
    !@new_resource.send(user_attrib).nil? && @new_resource.send(user_attrib) != @current_resource.send(user_attrib)
  end
end

#convert_group_name ⇒ Object 



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

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

#define_resource_requirements ⇒ Object 



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

def define_resource_requirements
  requirements.assert(:all_actions) 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} - does not exist!")
    a.whyrun("Assuming user #{@new_resource} would have been created")
  end
end

#load_current_resource ⇒ Object 



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
 
# File 'lib/chef/provider/user.rb', line 51

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 => e
    @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.comment(.gecos)
    @current_resource.home(.dir)
    @current_resource.shell(.shell)
    @current_resource.password(.passwd)

    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

    if @new_resource.gid
      convert_group_name
    end
  end

  @current_resource
end

#lock_user ⇒ Object

Raises:

  • (NotImplementedError) 


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

def lock_user
  raise NotImplementedError
end

#manage_user ⇒ Object

Raises:

  • (NotImplementedError) 


157
158
159
 
# File 'lib/chef/provider/user.rb', line 157

def manage_user
  raise NotImplementedError
end

#remove_user ⇒ Object

Raises:

  • (NotImplementedError) 


144
145
146
 
# File 'lib/chef/provider/user.rb', line 144

def remove_user
  raise NotImplementedError
end

#unlock_user ⇒ Object

Raises:

  • (NotImplementedError) 


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

def unlock_user
  raise NotImplementedError
end

#whyrun_supported? ⇒ Boolean

Returns:

  • (Boolean) 


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

def whyrun_supported?
  true
end