3 class UserTest < ActiveSupport::TestCase
4 include CurrentApiClient
6 # The fixture services/api/test/fixtures/users.yml serves as the input for this test case
8 # Make sure system_user exists before making "pre-test users" list
12 test "check non-admin active user properties" do
13 @active_user = users(:active) # get the active user
14 assert !@active_user.is_admin, 'is_admin should not be set for a non-admin user'
15 assert @active_user.is_active, 'user should be active'
16 assert @active_user.is_invited, 'is_invited should be set'
17 assert_not_nil @active_user.prefs, "user's preferences should be non-null, but may be size zero"
18 assert (@active_user.can? :read=>"#{@active_user.uuid}"), "user should be able to read own object"
19 assert (@active_user.can? :write=>"#{@active_user.uuid}"), "user should be able to write own object"
20 assert (@active_user.can? :manage=>"#{@active_user.uuid}"), "user should be able to manage own object"
22 assert @active_user.groups_i_can(:read).size > 0, "active user should be able read at least one group"
24 # non-admin user cannot manage or write other user objects
25 @uninvited_user = users(:inactive_uninvited) # get the uninvited user
26 assert !(@active_user.can? :read=>"#{@uninvited_user.uuid}")
27 assert !(@active_user.can? :write=>"#{@uninvited_user.uuid}")
28 assert !(@active_user.can? :manage=>"#{@uninvited_user.uuid}")
31 test "check admin user properties" do
32 @admin_user = users(:admin) # get the admin user
33 assert @admin_user.is_admin, 'is_admin should be set for admin user'
34 assert @admin_user.is_active, 'admin user cannot be inactive'
35 assert @admin_user.is_invited, 'is_invited should be set'
36 assert_not_nil @admin_user.uuid.size, "user's uuid should be non-null"
37 assert_not_nil @admin_user.prefs, "user's preferences should be non-null, but may be size zero"
38 assert @admin_user.identity_url.size > 0, "user's identity url is expected"
39 assert @admin_user.can? :read=>"#{@admin_user.uuid}"
40 assert @admin_user.can? :write=>"#{@admin_user.uuid}"
41 assert @admin_user.can? :manage=>"#{@admin_user.uuid}"
43 assert @admin_user.groups_i_can(:read).size > 0, "admin active user should be able read at least one group"
44 assert @admin_user.groups_i_can(:write).size > 0, "admin active user should be able write to at least one group"
45 assert @admin_user.groups_i_can(:manage).size > 0, "admin active user should be able manage at least one group"
47 # admin user can also write or manage other users
48 @uninvited_user = users(:inactive_uninvited) # get the uninvited user
49 assert @admin_user.can? :read=>"#{@uninvited_user.uuid}"
50 assert @admin_user.can? :write=>"#{@uninvited_user.uuid}"
51 assert @admin_user.can? :manage=>"#{@uninvited_user.uuid}"
54 test "check inactive and uninvited user properties" do
55 @uninvited_user = users(:inactive_uninvited) # get the uninvited user
56 assert !@uninvited_user.is_admin, 'is_admin should not be set for a non-admin user'
57 assert !@uninvited_user.is_active, 'user should be inactive'
58 assert !@uninvited_user.is_invited, 'is_invited should not be set'
59 assert @uninvited_user.can? :read=>"#{@uninvited_user.uuid}"
60 assert @uninvited_user.can? :write=>"#{@uninvited_user.uuid}"
61 assert @uninvited_user.can? :manage=>"#{@uninvited_user.uuid}"
63 assert @uninvited_user.groups_i_can(:read).size == 1, "inactive and uninvited user can only read anonymous user group"
64 assert @uninvited_user.groups_i_can(:read).first.ends_with? 'anonymouspublic' , "inactive and uninvited user can only read anonymous user group"
65 assert @uninvited_user.groups_i_can(:write).size == 0, "inactive and uninvited user should not be able write to any groups"
66 assert @uninvited_user.groups_i_can(:manage).size == 0, "inactive and uninvited user should not be able manage any groups"
69 test "find user method checks" do
70 User.find(:all).each do |user|
71 assert_not_nil user.uuid, "non-null uuid expected for " + user.full_name
74 user = users(:active) # get the active user
76 found_user = User.find(user.id) # find a user by the row id
78 assert_equal found_user.full_name, user.first_name + ' ' + user.last_name
79 assert_equal found_user.identity_url, user.identity_url
82 test "full name should not contain spurious whitespace" do
83 set_user_from_auth :admin
85 user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: 'foo@example.com' })
87 assert_equal '', user.full_name
89 user.first_name = 'John'
90 user.last_name = 'Smith'
92 assert_equal user.first_name + ' ' + user.last_name, user.full_name
95 test "create new user" do
96 set_user_from_auth :admin
98 @all_users = User.find(:all)
101 user.first_name = "first_name_for_newly_created_user"
104 # verify there is one extra user in the db now
105 assert_equal @all_users.size+1, User.find(:all).size
107 user = User.find(user.id) # get the user back
108 assert_equal(user.first_name, 'first_name_for_newly_created_user')
109 assert_not_nil user.uuid, 'uuid should be set for newly created user'
110 assert_nil user.email, 'email should be null for newly created user, because it was not passed in'
111 assert_nil user.identity_url, 'identity_url should be null for newly created user, because it was not passed in'
113 user.first_name = 'first_name_for_newly_created_user_updated'
115 user = User.find(user.id) # get the user back
116 assert_equal(user.first_name, 'first_name_for_newly_created_user_updated')
119 test "create new user with notifications" do
120 set_user_from_auth :admin
122 create_user_and_verify_setup_and_notifications true, 'active-notify-address@example.com', 'inactive-notify-address@example.com', nil, false
123 create_user_and_verify_setup_and_notifications true, 'active-notify-address@example.com', [], nil, false
124 create_user_and_verify_setup_and_notifications true, [], [], nil, false
125 create_user_and_verify_setup_and_notifications false, 'active-notify-address@example.com', 'inactive-notify-address@example.com', nil, false
126 create_user_and_verify_setup_and_notifications false, [], 'inactive-notify-address@example.com', nil, false
127 create_user_and_verify_setup_and_notifications false, [], [], nil, false
131 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'inactive-none@example.com', false, false, true],
132 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'inactive-vm@example.com', true, false, true],
133 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'inactive-repo@example.com', false, true, true],
134 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'inactive-both@example.com', true, true, true],
136 [false, [], [], 'inactive-none-no-notifications@example.com', false, false, true],
137 [false, [], [], 'inactive-vm-no-notifications@example.com', true, false, true],
138 [false, [], [], 'inactive-repo-no-notifications@example.com', false, true, true],
139 [false, [], [], 'inactive-both-no-notifications@example.com', true, true, true],
141 [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-none@example.com', false, false, true],
142 [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-vm@example.com', true, false, true],
143 [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-repo@example.com', false, true, true],
144 [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-both@example.com', true, true, true],
146 [true, [], [], 'active-none-no-notifications@example.com', false, false, true],
147 [true, [], [], 'active-vm-no-notifications@example.com', true, false, true],
148 [true, [], [], 'active-notify-no-notifications@example.com', 'inactive-repo@example.com', false, true, true],
149 [true, [], [], 'active-both-no-notifications@example.com', true, true, true],
151 [false, [], [], nil, true, true, false],
152 [false, [], [], 'arvados', true, true, false],
153 [false, [], [], '@example.com', true, true, false],
154 [false, [], [], '^^incorrect_format@example.com', true, true, false],
156 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'foo@example.com', true, true, true], # existing repository name 'foo'
157 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'foo@example.com', true, false, true], # existing repository name 'foo'
158 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'foo@example.com', false, true, true], # existing repository name 'foo'
159 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'foo@example.com', false, false, true], # existing repository name 'foo', but we are not creating repo or login link
160 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'xyz_can_login_to_vm@example.com', true, true, true], # existing vm login name
161 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'xyz_can_login_to_vm@example.com', true, false, true], # existing vm login name
162 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'xyz_can_login_to_vm@example.com', false, true, true], # existing vm login name
163 [false, 'active-notify@example.com', 'inactive-notify@example.com', 'xyz_can_login_to_vm@example.com', false, false, true], # existing vm login name, but we are not creating repo or login link
164 ].each do |active, active_recipients, inactive_recipients, email, auto_setup_vm, auto_setup_repo, valid_email_format|
165 test "create new user with auto setup #{email} #{auto_setup_vm} #{auto_setup_repo}" do
166 auto_setup_new_users = Rails.configuration.auto_setup_new_users
167 auto_setup_new_users_with_vm_uuid = Rails.configuration.auto_setup_new_users_with_vm_uuid
168 auto_setup_new_users_with_repository = Rails.configuration.auto_setup_new_users_with_repository
171 set_user_from_auth :admin
173 Rails.configuration.auto_setup_new_users = true
176 Rails.configuration.auto_setup_new_users_with_vm_uuid = virtual_machines(:testvm)['uuid']
178 Rails.configuration.auto_setup_new_users_with_vm_uuid = false
181 Rails.configuration.auto_setup_new_users_with_repository = auto_setup_repo
183 create_user_and_verify_setup_and_notifications active, active_recipients, inactive_recipients, email, valid_email_format
185 Rails.configuration.auto_setup_new_users = auto_setup_new_users
186 Rails.configuration.auto_setup_new_users_with_vm_uuid = auto_setup_new_users_with_vm_uuid
187 Rails.configuration.auto_setup_new_users_with_repository = auto_setup_new_users_with_repository
192 test "update existing user" do
193 set_user_from_auth :active # set active user as current user
195 @active_user = users(:active) # get the active user
197 @active_user.first_name = "first_name_changed"
200 @active_user = User.find(@active_user.id) # get the user back
201 assert_equal(@active_user.first_name, 'first_name_changed')
203 # admin user also should be able to update the "active" user info
204 set_user_from_auth :admin # set admin user as current user
205 @active_user.first_name = "first_name_changed_by_admin_for_active_user"
208 @active_user = User.find(@active_user.id) # get the user back
209 assert_equal(@active_user.first_name, 'first_name_changed_by_admin_for_active_user')
212 test "delete a user and verify" do
213 @active_user = users(:active) # get the active user
214 active_user_uuid = @active_user.uuid
216 set_user_from_auth :admin
219 found_deleted_user = false
220 User.find(:all).each do |user|
221 if user.uuid == active_user_uuid
222 found_deleted_user = true
226 assert !found_deleted_user, "found deleted user: "+active_user_uuid
230 test "create new user as non-admin user" do
231 set_user_from_auth :active
236 rescue ArvadosModel::PermissionDeniedError => e
238 assert (e.message.include? 'PermissionDeniedError'),
239 'Expected PermissionDeniedError'
242 test "setup new user" do
243 set_user_from_auth :admin
245 email = 'foo@example.com'
246 openid_prefix = 'http://openid/prefix'
248 user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
250 vm = VirtualMachine.create
252 response = User.setup user, openid_prefix, 'test_repo', vm.uuid
254 resp_user = find_obj_in_resp response, 'User'
255 verify_user resp_user, email
257 oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
259 verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
262 assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
263 'expected identity_url_prefix not found for oid_login_perm'
265 group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
266 verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
268 repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
269 verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
271 vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
272 verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
275 test "setup new user with junk in database" do
276 set_user_from_auth :admin
278 email = 'foo@example.com'
279 openid_prefix = 'http://openid/prefix'
281 user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
283 vm = VirtualMachine.create
285 # Set up the bogus Link
286 bad_uuid = 'zzzzz-tpzed-xyzxyzxyzxyzxyz'
288 resp_link = Link.create ({tail_uuid: email, link_class: 'permission',
289 name: 'can_login', head_uuid: bad_uuid})
290 resp_link.save(validate: false)
292 verify_link resp_link, 'permission', 'can_login', email, bad_uuid
294 response = User.setup user, openid_prefix, 'test_repo', vm.uuid
296 resp_user = find_obj_in_resp response, 'User'
297 verify_user resp_user, email
299 oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
301 verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
304 assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
305 'expected identity_url_prefix not found for oid_login_perm'
307 group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
308 verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
310 repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
311 verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
313 vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
314 verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
319 test "setup new user in multiple steps" do
320 set_user_from_auth :admin
322 email = 'foo@example.com'
323 openid_prefix = 'http://openid/prefix'
325 user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
327 response = User.setup user, openid_prefix
329 resp_user = find_obj_in_resp response, 'User'
330 verify_user resp_user, email
332 oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
333 verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
335 assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
336 'expected identity_url_prefix not found for oid_login_perm'
338 group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
339 verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
341 # invoke setup again with repo_name
342 response = User.setup user, openid_prefix, 'test_repo'
343 resp_user = find_obj_in_resp response, 'User', nil
344 verify_user resp_user, email
345 assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
347 group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
348 verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
350 repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
351 verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
353 # invoke setup again with a vm_uuid
354 vm = VirtualMachine.create
356 response = User.setup user, openid_prefix, 'test_repo', vm.uuid
358 resp_user = find_obj_in_resp response, 'User', nil
359 verify_user resp_user, email
360 assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
362 group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
363 verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
365 repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
366 verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
368 vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
369 verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
372 def find_obj_in_resp (response_items, object_type, head_kind=nil)
374 response_items.each { |x|
379 if object_type == 'User'
380 if ArvadosModel::resource_class_for_uuid(x['uuid']) == User
384 else # looking for a link
385 if ArvadosModel::resource_class_for_uuid(x['head_uuid']).kind == head_kind
394 def verify_user (resp_user, email)
395 assert_not_nil resp_user, 'expected user object'
396 assert_not_nil resp_user['uuid'], 'expected user object'
397 assert_equal email, resp_user['email'], 'expected email not found'
401 def verify_link (link_object, link_class, link_name, tail_uuid, head_uuid)
402 assert_not_nil link_object, "expected link for #{link_class} #{link_name}"
403 assert_not_nil link_object[:uuid],
404 "expected non-nil uuid for link for #{link_class} #{link_name}"
405 assert_equal link_class, link_object[:link_class],
406 "expected link_class not found for #{link_class} #{link_name}"
407 assert_equal link_name, link_object[:name],
408 "expected link_name not found for #{link_class} #{link_name}"
409 assert_equal tail_uuid, link_object[:tail_uuid],
410 "expected tail_uuid not found for #{link_class} #{link_name}"
412 assert_equal head_uuid, link_object[:head_uuid],
413 "expected head_uuid not found for #{link_class} #{link_name}"
417 def create_user_and_verify_setup_and_notifications (active, active_recipients, inactive_recipients, email, valid_email_format)
418 Rails.configuration.new_user_notification_recipients = active_recipients
419 Rails.configuration.new_inactive_user_notification_recipients = inactive_recipients
421 assert_equal active_recipients, Rails.configuration.new_user_notification_recipients
422 assert_equal inactive_recipients, Rails.configuration.new_inactive_user_notification_recipients
424 ActionMailer::Base.deliveries = []
427 user.first_name = "first_name_for_newly_created_user"
429 user.is_active = active
433 group = Group.where(name: 'All users').select do |g|
434 g[:uuid].match /-f+$/
437 username = email.partition('@')[0] if email
439 if !Rails.configuration.auto_setup_new_users || !valid_email_format
440 # verify that the user is not added to "All groups" by auto_setup
441 verify_link_exists false, group[:uuid], user.uuid, 'permission', 'can_read', nil, nil
443 # check oid login link not created by auto_setup
444 verify_link_exists false, user.uuid, user.email, 'permission', 'can_login', nil, nil
446 # verify that auto_setup took place
447 # verify that the user is added to "All groups"
448 verify_link_exists true, group[:uuid], user.uuid, 'permission', 'can_read', nil, nil
450 # check oid login link
451 verify_link_exists true, user.uuid, user.email, 'permission', 'can_login', nil, nil
453 username = user.email.partition('@')[0]
456 vm_uuid = Rails.configuration.auto_setup_new_users_with_vm_uuid
458 verify_link_exists true, vm_uuid, user.uuid, 'permission', 'can_login', 'username', username
460 verify_link_exists false, vm_uuid, user.uuid, 'permission', 'can_login', 'username', username
464 if Rails.configuration.auto_setup_new_users_with_repository
465 repos = Repository.where('name like ?', "%#{username}%")
466 assert_not_nil repos, 'repository not found'
467 assert_equal true, repos.any?, 'repository not found'
470 repo_uuids << repo[:uuid]
472 verify_link_exists true, repo_uuids, user.uuid, 'permission', 'can_manage', nil, nil
476 # check email notifications
478 new_inactive_user_email = nil
480 ActionMailer::Base.deliveries.each do |d|
481 if d.subject == "#{Rails.configuration.email_subject_prefix}New user notification" then
483 elsif d.subject == "#{Rails.configuration.email_subject_prefix}New inactive user notification" then
484 new_inactive_user_email = d
489 if not inactive_recipients.empty? then
490 assert_not_nil new_inactive_user_email, 'Expected new inactive user email after setup'
491 assert_equal Rails.configuration.user_notifier_email_from, new_inactive_user_email.from[0]
492 assert_equal inactive_recipients, new_inactive_user_email.to[0]
493 assert_equal "#{Rails.configuration.email_subject_prefix}New inactive user notification", new_inactive_user_email.subject
495 assert_nil new_inactive_user_email, 'Did not expect new inactive user email after setup'
500 assert_nil new_inactive_user_email, 'Expected no inactive user email after setting up active user'
501 if not active_recipients.empty? then
502 assert_not_nil new_user_email, 'Expected new user email after setup'
503 assert_equal Rails.configuration.user_notifier_email_from, new_user_email.from[0]
504 assert_equal active_recipients, new_user_email.to[0]
505 assert_equal "#{Rails.configuration.email_subject_prefix}New user notification", new_user_email.subject
507 assert_nil new_user_email, 'Did not expect new user email after setup'
510 ActionMailer::Base.deliveries = []
514 def verify_link_exists link_exists, head_uuid, tail_uuid, link_class, link_name, property_name, property_value
515 all_links = Link.where(head_uuid: head_uuid,
516 tail_uuid: tail_uuid,
517 link_class: link_class,
519 assert_equal link_exists, all_links.any?, "Link #{'not' if link_exists} found #{property_value}"
520 if link_exists && property_name && property_value
521 all_links.each do |link|
522 assert_equal true, all_links.first.properties[property_name].start_with?(property_value), 'Property not found in link'