Add tests for 'new inactive user notification' feature.
[arvados.git] / services / api / test / unit / user_test.rb
1 require 'test_helper'
2
3 class UserTest < ActiveSupport::TestCase
4   include CurrentApiClient
5
6   # The fixture services/api/test/fixtures/users.yml serves as the input for this test case
7   setup do
8     # Make sure system_user exists before making "pre-test users" list
9     system_user
10
11     @all_users = User.find(:all)
12
13     @all_users.each do |user|
14       if user.uuid == system_user_uuid
15         @system_user = user
16       elsif user.is_admin && user.is_active
17         @admin_user = user
18       elsif user.is_active && !user.is_admin
19         @active_user = user
20       elsif !user.is_active && !user.is_invited
21         @uninvited_user = user
22       end
23     end
24   end
25
26   test "check non-admin active user properties" do
27     assert !@active_user.is_admin, 'is_admin should not be set for a non-admin user'
28     assert @active_user.is_active, 'user should be active'
29     assert @active_user.is_invited, 'is_invited should be set'
30     assert_not_nil @active_user.prefs, "user's preferences should be non-null, but may be size zero"
31     assert (@active_user.can? :read=>"#{@active_user.uuid}"), "user should be able to read own object"
32     assert (@active_user.can? :write=>"#{@active_user.uuid}"), "user should be able to write own object"
33     assert (@active_user.can? :manage=>"#{@active_user.uuid}"), "user should be able to manage own object"
34
35     assert @active_user.groups_i_can(:read).size > 0, "active user should be able read at least one group"
36
37     # non-admin user cannot manage or write other user objects
38     assert !(@active_user.can? :read=>"#{@uninvited_user.uuid}")
39     assert !(@active_user.can? :write=>"#{@uninvited_user.uuid}")
40     assert !(@active_user.can? :manage=>"#{@uninvited_user.uuid}")
41   end
42
43   test "check admin user properties" do
44     assert @admin_user.is_admin, 'is_admin should be set for admin user'
45     assert @admin_user.is_active, 'admin user cannot be inactive'
46     assert @admin_user.is_invited, 'is_invited should be set'
47     assert_not_nil @admin_user.uuid.size, "user's uuid should be non-null"
48     assert_not_nil @admin_user.prefs, "user's preferences should be non-null, but may be size zero"
49     assert @admin_user.identity_url.size > 0, "user's identity url is expected"
50     assert @admin_user.can? :read=>"#{@admin_user.uuid}"
51     assert @admin_user.can? :write=>"#{@admin_user.uuid}"
52     assert @admin_user.can? :manage=>"#{@admin_user.uuid}"
53
54     assert @admin_user.groups_i_can(:read).size > 0, "admin active user should be able read at least one group"
55     assert @admin_user.groups_i_can(:write).size > 0, "admin active user should be able write to at least one group"
56     assert @admin_user.groups_i_can(:manage).size > 0, "admin active user should be able manage at least one group"
57
58     # admin user can also write or manage other users
59     assert @admin_user.can? :read=>"#{@uninvited_user.uuid}"
60     assert @admin_user.can? :write=>"#{@uninvited_user.uuid}"
61     assert @admin_user.can? :manage=>"#{@uninvited_user.uuid}"
62   end
63
64   test "check inactive and uninvited user properties" do
65     assert !@uninvited_user.is_admin, 'is_admin should not be set for a non-admin user'
66     assert !@uninvited_user.is_active, 'user should be inactive'
67     assert !@uninvited_user.is_invited, 'is_invited should not be set'
68     assert @uninvited_user.can? :read=>"#{@uninvited_user.uuid}"
69     assert @uninvited_user.can? :write=>"#{@uninvited_user.uuid}"
70     assert @uninvited_user.can? :manage=>"#{@uninvited_user.uuid}"
71
72     assert @uninvited_user.groups_i_can(:read).size == 0, "inactive and uninvited user should not be able read any groups"
73     assert @uninvited_user.groups_i_can(:write).size == 0, "inactive and uninvited user should not be able write to any groups"
74     assert @uninvited_user.groups_i_can(:manage).size == 0, "inactive and uninvited user should not be able manage any groups"
75   end
76
77   test "find user method checks" do
78     User.find(:all).each do |user|
79       assert_not_nil user.uuid, "non-null uuid expected for " + user.full_name
80     end
81
82     user = users(:active)     # get the active user
83
84     found_user = User.find(user.id)   # find a user by the row id
85
86     assert_equal found_user.full_name, user.first_name + ' ' + user.last_name
87     assert_equal found_user.identity_url, user.identity_url
88   end
89
90   test "full name should not contain spurious whitespace" do
91     Thread.current[:user] = @admin_user   # set admin user as the current user
92
93     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: 'foo@example.com' })
94
95     assert_equal '', user.full_name
96
97     user.first_name = 'John'
98     user.last_name = 'Smith'
99
100     assert_equal user.first_name + ' ' + user.last_name, user.full_name
101   end
102
103   test "create new user" do
104     Thread.current[:user] = @admin_user   # set admin user as the current user
105
106     user = User.new
107     user.first_name = "first_name_for_newly_created_user"
108     user.save
109
110     # verify there is one extra user in the db now
111     assert_equal @all_users.size+1, User.find(:all).size
112
113     user = User.find(user.id)   # get the user back
114     assert_equal(user.first_name, 'first_name_for_newly_created_user')
115     assert_not_nil user.uuid, 'uuid should be set for newly created user'
116     assert_nil user.email, 'email should be null for newly created user, because it was not passed in'
117     assert_nil user.identity_url, 'identity_url should be null for newly created user, because it was not passed in'
118
119     user.first_name = 'first_name_for_newly_created_user_updated'
120     user.save
121     user = User.find(user.id)   # get the user back
122     assert_equal(user.first_name, 'first_name_for_newly_created_user_updated')
123   end
124
125   test "create new inactive user with new_inactive_user_notification_recipients empty" do
126     Thread.current[:user] = @admin_user   # set admin user as the current user
127
128     Rails.configuration.new_inactive_user_notification_recipients = ''
129
130     user = User.new
131     user.first_name = "first_name_for_newly_created_user"
132     user.is_active = false
133     user.save
134
135     assert_equal '', Rails.configuration.new_inactive_user_notification_recipients
136
137     setup_email = ActionMailer::Base.deliveries.last
138     assert_nil setup_email, 'Expected no email after setup'
139   end
140
141   test "create new inactive user with new_inactive_user_notification_recipients set" do
142     Thread.current[:user] = @admin_user   # set admin user as the current user
143
144     Rails.configuration.new_inactive_user_notification_recipients = 'foo@example.com'
145
146     user = User.new
147     user.first_name = "first_name_for_newly_created_user"
148     user.is_active = false
149     user.save
150
151     setup_email = ActionMailer::Base.deliveries.last
152     assert_not_nil setup_email, 'Expected email after setup'
153
154     assert_equal 'foo@example.com', Rails.configuration.new_inactive_user_notification_recipients
155
156     assert_equal Rails.configuration.user_notifier_email_from, setup_email.from[0]
157     assert_equal 'foo@example.com', setup_email.to[0]
158     assert_equal 'New inactive user notification', setup_email.subject
159   end
160
161   test "update existing user" do
162     Thread.current[:user] = @active_user    # set active user as current user
163     @active_user.first_name = "first_name_changed"
164     @active_user.save
165
166     @active_user = User.find(@active_user.id)   # get the user back
167     assert_equal(@active_user.first_name, 'first_name_changed')
168
169     # admin user also should be able to update the "active" user info
170     Thread.current[:user] = @admin_user # set admin user as current user
171     @active_user.first_name = "first_name_changed_by_admin_for_active_user"
172     @active_user.save
173
174     @active_user = User.find(@active_user.id)   # get the user back
175     assert_equal(@active_user.first_name, 'first_name_changed_by_admin_for_active_user')
176   end
177
178   test "delete a user and verify" do
179     active_user_uuid = @active_user.uuid
180
181     Thread.current[:user] = @admin_user
182     @active_user.delete
183
184     found_deleted_user = false
185     User.find(:all).each do |user|
186       if user.uuid == active_user_uuid
187         found_deleted_user = true
188         break
189       end
190     end
191     assert !found_deleted_user, "found deleted user: "+active_user_uuid
192
193   end
194
195   test "create new user as non-admin user" do
196     Thread.current[:user] = @active_user
197
198     begin
199       user = User.new
200       user.save
201     rescue ArvadosModel::PermissionDeniedError => e
202     end
203     assert (e.message.include? 'PermissionDeniedError'),
204         'Expected PermissionDeniedError'
205   end
206
207   test "setup new user" do
208     Thread.current[:user] = @admin_user
209
210     email = 'foo@example.com'
211     openid_prefix = 'http://openid/prefix'
212
213     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
214
215     vm = VirtualMachine.create
216
217     response = User.setup user, openid_prefix, 'test_repo', vm.uuid
218
219     resp_user = find_obj_in_resp response, 'User'
220     verify_user resp_user, email
221
222     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
223
224     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
225         resp_user[:uuid]
226
227     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
228         'expected identity_url_prefix not found for oid_login_perm'
229
230     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
231     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
232
233     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
234     verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
235
236     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
237     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
238   end
239
240   test "setup new user with junk in database" do
241     Thread.current[:user] = @admin_user
242
243     email = 'foo@example.com'
244     openid_prefix = 'http://openid/prefix'
245
246     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
247
248     vm = VirtualMachine.create
249
250     # Set up the bogus Link
251     bad_uuid = 'zzzzz-tpzed-xyzxyzxyzxyzxyz'
252
253     resp_link = Link.create ({tail_uuid: email, link_class: 'permission',
254         name: 'can_login', head_uuid: bad_uuid})
255     resp_link.save(validate: false)
256
257     verify_link resp_link, 'permission', 'can_login', email, bad_uuid
258
259     response = User.setup user, openid_prefix, 'test_repo', vm.uuid
260
261     resp_user = find_obj_in_resp response, 'User'
262     verify_user resp_user, email
263
264     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
265
266     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
267         resp_user[:uuid]
268
269     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
270         'expected identity_url_prefix not found for oid_login_perm'
271
272     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
273     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
274
275     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
276     verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
277
278     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
279     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
280   end
281
282
283
284   test "setup new user in multiple steps" do
285     Thread.current[:user] = @admin_user
286
287     email = 'foo@example.com'
288     openid_prefix = 'http://openid/prefix'
289
290     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
291
292     response = User.setup user, openid_prefix
293
294     resp_user = find_obj_in_resp response, 'User'
295     verify_user resp_user, email
296
297     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
298     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
299         resp_user[:uuid]
300     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
301         'expected identity_url_prefix not found for oid_login_perm'
302
303     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
304     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
305
306     # invoke setup again with repo_name
307     response = User.setup user, openid_prefix, 'test_repo'
308     resp_user = find_obj_in_resp response, 'User', nil
309     verify_user resp_user, email
310     assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
311
312     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
313     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
314
315     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
316     verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
317
318     # invoke setup again with a vm_uuid
319     vm = VirtualMachine.create
320
321     response = User.setup user, openid_prefix, 'test_repo', vm.uuid
322
323     resp_user = find_obj_in_resp response, 'User', nil
324     verify_user resp_user, email
325     assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
326
327     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
328     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
329
330     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
331     verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
332
333     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
334     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
335   end
336
337   def find_obj_in_resp (response_items, object_type, head_kind=nil)
338     return_obj = nil
339     response_items.each { |x|
340       if !x
341         next
342       end
343
344       if object_type == 'User'
345         if ArvadosModel::resource_class_for_uuid(x['uuid']) == User
346           return_obj = x
347           break
348         end
349       else  # looking for a link
350         if ArvadosModel::resource_class_for_uuid(x['head_uuid']).kind == head_kind
351           return_obj = x
352           break
353         end
354       end
355     }
356     return return_obj
357   end
358
359   def verify_user (resp_user, email)
360     assert_not_nil resp_user, 'expected user object'
361     assert_not_nil resp_user['uuid'], 'expected user object'
362     assert_equal email, resp_user['email'], 'expected email not found'
363
364   end
365
366   def verify_link (link_object, link_class, link_name, tail_uuid, head_uuid)
367     assert_not_nil link_object, "expected link for #{link_class} #{link_name}"
368     assert_not_nil link_object[:uuid],
369         "expected non-nil uuid for link for #{link_class} #{link_name}"
370     assert_equal link_class, link_object[:link_class],
371         "expected link_class not found for #{link_class} #{link_name}"
372     assert_equal link_name, link_object[:name],
373         "expected link_name not found for #{link_class} #{link_name}"
374     assert_equal tail_uuid, link_object[:tail_uuid],
375         "expected tail_uuid not found for #{link_class} #{link_name}"
376     if head_uuid
377       assert_equal head_uuid, link_object[:head_uuid],
378           "expected head_uuid not found for #{link_class} #{link_name}"
379     end
380   end
381
382 end