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   end
  11
  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"
  21
  22     assert @active_user.groups_i_can(:read).size > 0, "active user should be able read at least one group"
  23
  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}")
  29   end
  30
  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}"
  42
  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"
  46
  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}"
  52   end
  53
  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}"
  62
  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"
  67   end
  68
  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
  72     end
  73
  74     user = users(:active)     # get the active user
  75
  76     found_user = User.find(user.id)   # find a user by the row id
  77
  78     assert_equal found_user.full_name, user.first_name + ' ' + user.last_name
  79     assert_equal found_user.identity_url, user.identity_url
  80   end
  81
  82   test "full name should not contain spurious whitespace" do
  83     set_user_from_auth :admin
  84
  85     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: 'foo@example.com' })
  86
  87     assert_equal '', user.full_name
  88
  89     user.first_name = 'John'
  90     user.last_name = 'Smith'
  91
  92     assert_equal user.first_name + ' ' + user.last_name, user.full_name
  93   end
  94
  95   test "create new user" do
  96     set_user_from_auth :admin
  97
  98     @all_users = User.find(:all)
  99
 100     user = User.new
 101     user.first_name = "first_name_for_newly_created_user"
 102     user.save
 103
 104     # verify there is one extra user in the db now
 105     assert_equal @all_users.size+1, User.find(:all).size
 106
 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'
 112
 113     user.first_name = 'first_name_for_newly_created_user_updated'
 114     user.save
 115     user = User.find(user.id)   # get the user back
 116     assert_equal(user.first_name, 'first_name_for_newly_created_user_updated')
 117   end
 118
 119   test "create new user with notifications" do
 120     set_user_from_auth :admin
 121
 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
 128   end
 129
 130   [
 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],
 135
 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],
 140
 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],
 145
 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],
 150
 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],
 155
 156 #    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'repeat_username@example.com', true, true, true],
 157 #    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'repeat_username@example.com', true, false, true],
 158 #    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'with existing repo name', true, false, true],
 159 #    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'with existing vm login name', true, false, true],
 160   ].each do |active, active_recipients, inactive_recipients, email, auto_setup_vm, auto_setup_repo, valid_email_format|
 161     test "create new user with auto setup #{email} #{auto_setup_vm} #{auto_setup_repo}" do
 162       auto_setup_new_users = Rails.configuration.auto_setup_new_users
 163       auto_setup_new_users_with_vm_uuid = Rails.configuration.auto_setup_new_users_with_vm_uuid
 164       auto_setup_new_users_with_repository = Rails.configuration.auto_setup_new_users_with_repository
 165
 166       begin
 167         set_user_from_auth :admin
 168
 169         Rails.configuration.auto_setup_new_users = true
 170
 171         if auto_setup_vm
 172           Rails.configuration.auto_setup_new_users_with_vm_uuid = virtual_machines(:testvm)['uuid']
 173         else
 174           Rails.configuration.auto_setup_new_users_with_vm_uuid = false
 175         end
 176
 177         Rails.configuration.auto_setup_new_users_with_repository = auto_setup_repo
 178
 179         create_user_and_verify_setup_and_notifications active, active_recipients, inactive_recipients, email, valid_email_format
 180       ensure
 181         Rails.configuration.auto_setup_new_users = auto_setup_new_users
 182         Rails.configuration.auto_setup_new_users_with_vm_uuid = auto_setup_new_users_with_vm_uuid
 183         Rails.configuration.auto_setup_new_users_with_repository = auto_setup_new_users_with_repository
 184       end
 185     end
 186   end
 187
 188   test "update existing user" do
 189     set_user_from_auth :active    # set active user as current user
 190
 191     @active_user = users(:active)     # get the active user
 192
 193     @active_user.first_name = "first_name_changed"
 194     @active_user.save
 195
 196     @active_user = User.find(@active_user.id)   # get the user back
 197     assert_equal(@active_user.first_name, 'first_name_changed')
 198
 199     # admin user also should be able to update the "active" user info
 200     set_user_from_auth :admin # set admin user as current user
 201     @active_user.first_name = "first_name_changed_by_admin_for_active_user"
 202     @active_user.save
 203
 204     @active_user = User.find(@active_user.id)   # get the user back
 205     assert_equal(@active_user.first_name, 'first_name_changed_by_admin_for_active_user')
 206   end
 207
 208   test "delete a user and verify" do
 209     @active_user = users(:active)     # get the active user
 210     active_user_uuid = @active_user.uuid
 211
 212     set_user_from_auth :admin
 213     @active_user.delete
 214
 215     found_deleted_user = false
 216     User.find(:all).each do |user|
 217       if user.uuid == active_user_uuid
 218         found_deleted_user = true
 219         break
 220       end
 221     end
 222     assert !found_deleted_user, "found deleted user: "+active_user_uuid
 223
 224   end
 225
 226   test "create new user as non-admin user" do
 227     set_user_from_auth :active
 228
 229     begin
 230       user = User.new
 231       user.save
 232     rescue ArvadosModel::PermissionDeniedError => e
 233     end
 234     assert (e.message.include? 'PermissionDeniedError'),
 235         'Expected PermissionDeniedError'
 236   end
 237
 238   test "setup new user" do
 239     set_user_from_auth :admin
 240
 241     email = 'foo@example.com'
 242     openid_prefix = 'http://openid/prefix'
 243
 244     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
 245
 246     vm = VirtualMachine.create
 247
 248     response = User.setup user, openid_prefix, 'test_repo', vm.uuid
 249
 250     resp_user = find_obj_in_resp response, 'User'
 251     verify_user resp_user, email
 252
 253     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
 254
 255     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
 256         resp_user[:uuid]
 257
 258     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
 259         'expected identity_url_prefix not found for oid_login_perm'
 260
 261     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
 262     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 263
 264     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
 265     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 266
 267     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
 268     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
 269   end
 270
 271   test "setup new user with junk in database" do
 272     set_user_from_auth :admin
 273
 274     email = 'foo@example.com'
 275     openid_prefix = 'http://openid/prefix'
 276
 277     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
 278
 279     vm = VirtualMachine.create
 280
 281     # Set up the bogus Link
 282     bad_uuid = 'zzzzz-tpzed-xyzxyzxyzxyzxyz'
 283
 284     resp_link = Link.create ({tail_uuid: email, link_class: 'permission',
 285         name: 'can_login', head_uuid: bad_uuid})
 286     resp_link.save(validate: false)
 287
 288     verify_link resp_link, 'permission', 'can_login', email, bad_uuid
 289
 290     response = User.setup user, openid_prefix, 'test_repo', vm.uuid
 291
 292     resp_user = find_obj_in_resp response, 'User'
 293     verify_user resp_user, email
 294
 295     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
 296
 297     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
 298         resp_user[:uuid]
 299
 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     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
 307     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 308
 309     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
 310     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
 311   end
 312
 313
 314
 315   test "setup new user in multiple steps" do
 316     set_user_from_auth :admin
 317
 318     email = 'foo@example.com'
 319     openid_prefix = 'http://openid/prefix'
 320
 321     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
 322
 323     response = User.setup user, openid_prefix
 324
 325     resp_user = find_obj_in_resp response, 'User'
 326     verify_user resp_user, email
 327
 328     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
 329     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
 330         resp_user[:uuid]
 331     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
 332         'expected identity_url_prefix not found for oid_login_perm'
 333
 334     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
 335     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 336
 337     # invoke setup again with repo_name
 338     response = User.setup user, openid_prefix, 'test_repo'
 339     resp_user = find_obj_in_resp response, 'User', nil
 340     verify_user resp_user, email
 341     assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
 342
 343     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
 344     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 345
 346     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
 347     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 348
 349     # invoke setup again with a vm_uuid
 350     vm = VirtualMachine.create
 351
 352     response = User.setup user, openid_prefix, 'test_repo', vm.uuid
 353
 354     resp_user = find_obj_in_resp response, 'User', nil
 355     verify_user resp_user, email
 356     assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
 357
 358     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
 359     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 360
 361     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
 362     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 363
 364     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
 365     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
 366   end
 367
 368   def find_obj_in_resp (response_items, object_type, head_kind=nil)
 369     return_obj = nil
 370     response_items.each { |x|
 371       if !x
 372         next
 373       end
 374
 375       if object_type == 'User'
 376         if ArvadosModel::resource_class_for_uuid(x['uuid']) == User
 377           return_obj = x
 378           break
 379         end
 380       else  # looking for a link
 381         if ArvadosModel::resource_class_for_uuid(x['head_uuid']).kind == head_kind
 382           return_obj = x
 383           break
 384         end
 385       end
 386     }
 387     return return_obj
 388   end
 389
 390   def verify_user (resp_user, email)
 391     assert_not_nil resp_user, 'expected user object'
 392     assert_not_nil resp_user['uuid'], 'expected user object'
 393     assert_equal email, resp_user['email'], 'expected email not found'
 394
 395   end
 396
 397   def verify_link (link_object, link_class, link_name, tail_uuid, head_uuid)
 398     assert_not_nil link_object, "expected link for #{link_class} #{link_name}"
 399     assert_not_nil link_object[:uuid],
 400         "expected non-nil uuid for link for #{link_class} #{link_name}"
 401     assert_equal link_class, link_object[:link_class],
 402         "expected link_class not found for #{link_class} #{link_name}"
 403     assert_equal link_name, link_object[:name],
 404         "expected link_name not found for #{link_class} #{link_name}"
 405     assert_equal tail_uuid, link_object[:tail_uuid],
 406         "expected tail_uuid not found for #{link_class} #{link_name}"
 407     if head_uuid
 408       assert_equal head_uuid, link_object[:head_uuid],
 409           "expected head_uuid not found for #{link_class} #{link_name}"
 410     end
 411   end
 412
 413   def create_user_and_verify_setup_and_notifications (active, active_recipients, inactive_recipients, email, valid_email_format)
 414     Rails.configuration.new_user_notification_recipients = active_recipients
 415     Rails.configuration.new_inactive_user_notification_recipients = inactive_recipients
 416
 417     assert_equal active_recipients, Rails.configuration.new_user_notification_recipients
 418     assert_equal inactive_recipients, Rails.configuration.new_inactive_user_notification_recipients
 419
 420     ActionMailer::Base.deliveries = []
 421
 422     user = User.new
 423     user.first_name = "first_name_for_newly_created_user"
 424     user.email = email
 425     user.is_active = active
 426     user.save
 427
 428     # check user setup
 429     group = Group.where(name: 'All users').select do |g|
 430       g[:uuid].match /-f+$/
 431     end.first
 432
 433     username = email.partition('@')[0] if email
 434
 435     if !Rails.configuration.auto_setup_new_users || !valid_email_format
 436       # verify that the user is not added to "All groups" by auto_setup
 437       verify_link_exists false, group[:uuid], user.uuid, 'permission', 'can_read', nil, nil
 438
 439       # check oid login link not created by auto_setup
 440       verify_link_exists false, user.uuid, user.email, 'permission', 'can_login', nil, nil
 441     else
 442       # verify that auto_setup took place
 443       # verify that the user is added to "All groups"
 444       verify_link_exists true, group[:uuid], user.uuid, 'permission', 'can_read', nil, nil
 445
 446       # check oid login link
 447       verify_link_exists true, user.uuid, user.email, 'permission', 'can_login', nil, nil
 448
 449       username = user.email.partition('@')[0]
 450
 451       # check vm uuid
 452       vm_uuid = Rails.configuration.auto_setup_new_users_with_vm_uuid
 453       if vm_uuid
 454         verify_link_exists true, vm_uuid, user.uuid, 'permission', 'can_login', 'username', username
 455       else
 456         verify_link_exists false, vm_uuid, user.uuid, 'permission', 'can_login', 'username', username
 457       end
 458
 459       # check repo
 460       if Rails.configuration.auto_setup_new_users_with_repository
 461         repo = Repository.where(name: username).first
 462         assert_not_nil repo, 'repository not found'
 463         verify_link_exists true, repo[:uuid], user.uuid, 'permission', 'can_manage', nil, nil
 464       else
 465         verify_link_exists false, nil, user.uuid, 'permission', 'can_manage', nil, nil
 466       end
 467     end
 468
 469     # check email notifications
 470     new_user_email = nil
 471     new_inactive_user_email = nil
 472
 473     ActionMailer::Base.deliveries.each do |d|
 474       if d.subject == "#{Rails.configuration.email_subject_prefix}New user notification" then
 475         new_user_email = d
 476       elsif d.subject == "#{Rails.configuration.email_subject_prefix}New inactive user notification" then
 477         new_inactive_user_email = d
 478       end
 479     end
 480
 481     if not active
 482       if not inactive_recipients.empty? then
 483         assert_not_nil new_inactive_user_email, 'Expected new inactive user email after setup'
 484         assert_equal Rails.configuration.user_notifier_email_from, new_inactive_user_email.from[0]
 485         assert_equal inactive_recipients, new_inactive_user_email.to[0]
 486         assert_equal "#{Rails.configuration.email_subject_prefix}New inactive user notification", new_inactive_user_email.subject
 487       else
 488         assert_nil new_inactive_user_email, 'Did not expect new inactive user email after setup'
 489       end
 490     end
 491
 492     if active
 493       assert_nil new_inactive_user_email, 'Expected no inactive user email after setting up active user'
 494       if not active_recipients.empty? then
 495         assert_not_nil new_user_email, 'Expected new user email after setup'
 496         assert_equal Rails.configuration.user_notifier_email_from, new_user_email.from[0]
 497         assert_equal active_recipients, new_user_email.to[0]
 498         assert_equal "#{Rails.configuration.email_subject_prefix}New user notification", new_user_email.subject
 499       else
 500         assert_nil new_user_email, 'Did not expect new user email after setup'
 501       end
 502     end
 503     ActionMailer::Base.deliveries = []
 504
 505   end
 506
 507   def verify_link_exists link_exists, head_uuid, tail_uuid, link_class, link_name, property_name, property_value
 508     all_links = Link.where(head_uuid: head_uuid,
 509                            tail_uuid: tail_uuid,
 510                            link_class: link_class,
 511                            name: link_name)
 512     assert_equal link_exists, all_links.any?, "Link not found"
 513     if link_exists && property_name && property_value
 514       assert_equal property_value, all_links.first.properties[property_name], 'Property not found in link'
 515     end
 516   end
 517
 518 end