3153: when deriving unique name, look for all can_login links, not just the vm_uuid...
[arvados.git] / services / api / test / unit / user_test.rb
index 235e5cb72d657e7430e5fa08cf7140a933b68edd..c410787a116b30524f0254ee3a7a3c8694cfc3ef 100644 (file)
@@ -3,6 +3,12 @@ require 'test_helper'
 class UserTest < ActiveSupport::TestCase
   include CurrentApiClient
 
+  # The fixture services/api/test/fixtures/users.yml serves as the input for this test case
+  setup do
+    # Make sure system_user exists before making "pre-test users" list
+    system_user
+  end
+
   test "check non-admin active user properties" do
     @active_user = users(:active)     # get the active user
     assert !@active_user.is_admin, 'is_admin should not be set for a non-admin user'
@@ -54,7 +60,8 @@ class UserTest < ActiveSupport::TestCase
     assert @uninvited_user.can? :write=>"#{@uninvited_user.uuid}"
     assert @uninvited_user.can? :manage=>"#{@uninvited_user.uuid}"
 
-    assert @uninvited_user.groups_i_can(:read).size == 0, "inactive and uninvited user should not be able read any groups"
+    assert @uninvited_user.groups_i_can(:read).size == 1, "inactive and uninvited user can only read anonymous user group"
+    assert @uninvited_user.groups_i_can(:read).first.ends_with? 'anonymouspublic' , "inactive and uninvited user can only read anonymous user group"
     assert @uninvited_user.groups_i_can(:write).size == 0, "inactive and uninvited user should not be able write to any groups"
     assert @uninvited_user.groups_i_can(:manage).size == 0, "inactive and uninvited user should not be able manage any groups"
   end
@@ -109,134 +116,110 @@ class UserTest < ActiveSupport::TestCase
     assert_equal(user.first_name, 'first_name_for_newly_created_user_updated')
   end
 
-  test "create new inactive user with new_inactive_user_notification_recipients empty" do
+  test "create new user with notifications" do
     set_user_from_auth :admin
 
-    Rails.configuration.new_inactive_user_notification_recipients = ''
-
-    ActionMailer::Base.deliveries = []
-
-    user = User.new
-    user.first_name = "first_name_for_newly_created_user"
-    user.is_active = false
-    user.save
-
-    assert_equal '', Rails.configuration.new_inactive_user_notification_recipients
-
-    ActionMailer::Base.deliveries.each do |d|
-      assert_not_equal "#{Rails.configuration.email_subject_prefix}New inactive user notification", setup_email.subject
-    end
-
+    create_user_and_verify_setup_and_notifications true, 'active-notify-address@example.com', 'inactive-notify-address@example.com', nil, false
+    create_user_and_verify_setup_and_notifications true, 'active-notify-address@example.com', [], nil, false
+    create_user_and_verify_setup_and_notifications true, [], [], nil, false
+    create_user_and_verify_setup_and_notifications false, 'active-notify-address@example.com', 'inactive-notify-address@example.com', nil, false
+    create_user_and_verify_setup_and_notifications false, [], 'inactive-notify-address@example.com', nil, false
+    create_user_and_verify_setup_and_notifications false, [], [], nil, false
   end
 
-  test "create new inactive user with new_user_notification_recipients empty" do
-    set_user_from_auth :admin
+  [
+    [false, [], [], 'inactive-none@example.com', false, false, true],
+    [false, [], [], 'inactive-vm@example.com', true, false, true],
+    [false, [], [], 'inactive-repo@example.com', false, true, true],
+    [false, [], [], 'inactive-both@example.com', true, true, true],
 
-    Rails.configuration.new_user_notification_recipients = ''
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-none@example.com', false, false, true],
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-vm@example.com', true, false, true],
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-repo@example.com', false, true, true],
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'active-both@example.com', true, true, true],
 
-    ActionMailer::Base.deliveries = []
+    [false, [], [], nil, true, true, false],
 
-    user = User.new
-    user.first_name = "first_name_for_newly_created_user"
-    user.is_active = false
-    user.save
+    [false, [], [], 'arvados', true, true, false],
+    [false, [], [], 'arvados', false, false, true],   # since we are not creating repo and vm login, this blaklisted name is not a problem
 
-    assert_equal '', Rails.configuration.new_user_notification_recipients
+    [false, [], [], 'arvados@example.com', false, false, true],   # since we are not creating repo and vm login, this blaklisted name is not a problem
+    [false, [], [], 'arva.dos@example.com', true, true, true],    # not blaklisted name
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'root@example.com', true, false, false], # blacklisted name after removing -._ characters
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'roo_t@example.com', false, true, true], # not blacklisted name
 
-    ActionMailer::Base.deliveries.each do |d|
-      assert_not_equal "#{Rails.configuration.email_subject_prefix}New user notification", d.subject
-    end
+    [false, [], [], '@example.com', true, false, false],  # incorrect format
+    [false, [], [], '@example.com', false, true, false],
+    [false, [], [], '@example.com', false, false, true],  # no repo and vm login, so no issue with email format
 
-  end
+    [false, [], [], '^^incorrect_format@example.com', true, true, false],
 
-  test "create new inactive user with new_user_notification_recipients and new_inactive_user_notification_recipients set" do
-    set_user_from_auth :admin
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_repo@example.com', true, true, true],  # existing repository name 'auto_setup_repo'
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_repo@example.com', true, false, true],  # existing repository name 'auto_setup_repo'
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_repo@example.com', false, true, true],  # existing repository name 'auto_setup_repo'
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_repo@example.com', false, false, true],  # existing repository name 'auto_setup_repo', but we are not creating repo or login link
 
-    Rails.configuration.new_user_notification_recipients = 'foo_new@example.com'
-    Rails.configuration.new_inactive_user_notification_recipients = 'foo_new_inactive@example.com'
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_vm_login@example.com', true, true, true], # existing vm login name
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_vm_login@example.com', true, false, true], # existing vm login name
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_vm_login@example.com', false, true, true], # existing vm login name
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', 'auto_setup_vm_login@example.com', false, false, true], # existing vm login name, but we are not creating repo or login link
 
-    ActionMailer::Base.deliveries = []
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '*!*@example.com', true, false, false], # username is invalid format
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', '*!*@example.com', false, false, true], # since no repo and vm login, username is ok (not validated)
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '*!*@example.com', false, false, true], # since no repo and vm login, username is ok (not validated)
 
-    user = User.new
-    user.first_name = "first_name_for_newly_created_user"
-    user.is_active = false
-    user.save
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '&4ad@example.com', true, true, false], # username is invalid format
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '&4ad@example.com', false, false, true], # no repo or vm login, so format not checked
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', '&4ad@example.com', true, true, false], # username is invalid format
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', '&4ad@example.com', false, false, true], # no repo or vm login, so format not checked
 
-    new_user_email = nil
-    new_inactive_user_email = nil
-    ActionMailer::Base.deliveries.each do |d|
-      if d.subject == "#{Rails.configuration.email_subject_prefix}New inactive user notification" then
-        new_inactive_user_email = d
-      end
-      if d.subject == "#{Rails.configuration.email_subject_prefix}New user notification" then
-        new_user_email = d
-      end
-    end
-
-    assert_not_nil new_inactive_user_email, 'Expected new inactive user email after setup'
-    assert_not_nil new_user_email, 'Expected new user email after setup'
-
-    assert_equal 'foo_new@example.com', Rails.configuration.new_user_notification_recipients
-    assert_equal 'foo_new_inactive@example.com', Rails.configuration.new_inactive_user_notification_recipients
-
-    assert_equal Rails.configuration.user_notifier_email_from, new_inactive_user_email.from[0]
-    assert_equal 'foo_new_inactive@example.com', new_inactive_user_email.to[0]
-    assert_equal "#{Rails.configuration.email_subject_prefix}New inactive user notification", new_inactive_user_email.subject
-
-    assert_equal Rails.configuration.user_notifier_email_from, new_user_email.from[0]
-    assert_equal 'foo_new@example.com', new_user_email.to[0]
-    assert_equal "#{Rails.configuration.email_subject_prefix}New user notification", new_user_email.subject
-  end
-
-  test "create new inactive user with new_user_notification_recipients set" do
-    set_user_from_auth :admin
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '4ad@example.com', true, true, false], # username is invalid format
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '4ad@example.com', false, false, true], # no repo or vm login, so format not checked
+    [false, 'active-notify@example.com', 'inactive-notify@example.com', '4ad@example.com', false, false, true], # no repo or vm login, so format not checked
 
-    Rails.configuration.new_user_notification_recipients = 'foo@example.com'
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '.foo@example.com', false, false, true], # no repo or vm login, so format not checked
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', '.foo@example.com', true, false, false], # invalid format
 
-    user = User.new
-    user.first_name = "first_name_for_newly_created_user"
-    user.is_active = false
-    user.save
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'bar.@example.com', false, false, true], # no repo or vm login, so format not checked
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'bar.@example.com', true, false, false], # valid format
 
-    new_user_email = nil
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'ice9@example.com', false, false, true], # no repo or vm login, so format not checked
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'ice9@example.com', true, false, true], # valid format
 
-    ActionMailer::Base.deliveries.each do |d|
-      if d.subject == "#{Rails.configuration.email_subject_prefix}New user notification" then
-        new_user_email = d
-        break
-      end
-    end
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'o_o@example.com', false, false, true], # no repo or vm login, so format not checked
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'o_o@example.com', true, false, true], # valid format
 
-    assert_not_nil new_user_email, 'Expected email after setup'
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'r00t@example.com', false, false, true], # no repo or vm login, so format not checked
+    [true, 'active-notify@example.com', 'inactive-notify@example.com', 'r00t@example.com', true, false, true], # valid format
 
-    assert_equal 'foo@example.com', Rails.configuration.new_user_notification_recipients
+  ].each do |active, active_recipients, inactive_recipients, email, auto_setup_vm, auto_setup_repo, valid_username|
+    test "create new user with auto setup #{active} #{email} #{auto_setup_vm} #{auto_setup_repo}" do
+      auto_setup_new_users = Rails.configuration.auto_setup_new_users
+      auto_setup_new_users_with_vm_uuid = Rails.configuration.auto_setup_new_users_with_vm_uuid
+      auto_setup_new_users_with_repository = Rails.configuration.auto_setup_new_users_with_repository
 
-    assert_equal Rails.configuration.user_notifier_email_from, new_user_email.from[0]
-    assert_equal 'foo@example.com', new_user_email.to[0]
-    assert_equal "#{Rails.configuration.email_subject_prefix}New user notification", new_user_email.subject
-  end
-
-  test "create new active user with new_inactive_user_notification_recipients set" do
-    set_user_from_auth :admin
+      begin
+        set_user_from_auth :admin
 
-    Rails.configuration.new_inactive_user_notification_recipients = 'foo@example.com'
+        Rails.configuration.auto_setup_new_users = true
 
-    ActionMailer::Base.deliveries = []
-
-    user = User.new
-    user.first_name = "first_name_for_newly_created_user"
-    user.is_active = true
-    user.save
+        if auto_setup_vm
+          Rails.configuration.auto_setup_new_users_with_vm_uuid = virtual_machines(:testvm)['uuid']
+        else
+          Rails.configuration.auto_setup_new_users_with_vm_uuid = false
+        end
 
-    assert_equal 'foo@example.com', Rails.configuration.new_inactive_user_notification_recipients
+        Rails.configuration.auto_setup_new_users_with_repository = auto_setup_repo
 
-    ActionMailer::Base.deliveries.each do |d|
-      assert_not_equal "#{Rails.configuration.email_subject_prefix}New inactive user notification", setup_email.subject
+        create_user_and_verify_setup_and_notifications active, active_recipients, inactive_recipients, email, valid_username
+      ensure
+        Rails.configuration.auto_setup_new_users = auto_setup_new_users
+        Rails.configuration.auto_setup_new_users_with_vm_uuid = auto_setup_new_users_with_vm_uuid
+        Rails.configuration.auto_setup_new_users_with_repository = auto_setup_new_users_with_repository
+      end
     end
-
   end
 
-
   test "update existing user" do
     set_user_from_auth :active    # set active user as current user
 
@@ -314,7 +297,7 @@ class UserTest < ActiveSupport::TestCase
     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 
     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
-    verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
+    verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 
     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
@@ -356,14 +339,12 @@ class UserTest < ActiveSupport::TestCase
     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 
     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
-    verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
+    verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 
     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
   end
 
-
-
   test "setup new user in multiple steps" do
     set_user_from_auth :admin
 
@@ -396,7 +377,7 @@ class UserTest < ActiveSupport::TestCase
     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 
     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
-    verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
+    verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 
     # invoke setup again with a vm_uuid
     vm = VirtualMachine.create
@@ -411,7 +392,7 @@ class UserTest < ActiveSupport::TestCase
     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
 
     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
-    verify_link repo_perm, 'permission', 'can_write', resp_user[:uuid], nil
+    verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
 
     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
@@ -462,4 +443,135 @@ class UserTest < ActiveSupport::TestCase
     end
   end
 
+  def create_user_and_verify_setup_and_notifications (active, active_recipients, inactive_recipients, email, valid_username)
+    Rails.configuration.new_user_notification_recipients = active_recipients
+    Rails.configuration.new_inactive_user_notification_recipients = inactive_recipients
+
+    assert_equal active_recipients, Rails.configuration.new_user_notification_recipients
+    assert_equal inactive_recipients, Rails.configuration.new_inactive_user_notification_recipients
+
+    ActionMailer::Base.deliveries = []
+
+    user = User.new
+    user.first_name = "first_name_for_newly_created_user"
+    user.email = email
+    user.is_active = active
+    user.save!
+
+    # check user setup
+    group = Group.where(name: 'All users').select do |g|
+      g[:uuid].match /-f+$/
+    end.first
+
+    if !Rails.configuration.auto_setup_new_users || !valid_username
+      # verify that the user is not added to "All groups" by auto_setup
+      verify_link_exists false, group[:uuid], user.uuid, 'permission', 'can_read', nil, nil
+
+      # check oid login link not created by auto_setup
+      verify_link_exists false, user.uuid, user.email, 'permission', 'can_login', nil, nil
+    else
+      # verify that auto_setup took place
+      # verify that the user is added to "All groups"
+      verify_link_exists true, group[:uuid], user.uuid, 'permission', 'can_read', nil, nil
+
+      # check oid login link
+      verify_link_exists true, user.uuid, user.email, 'permission', 'can_login', nil, nil
+
+      username = user.email.partition('@')[0] if email
+
+      # check repo
+      repo_names = []
+      if Rails.configuration.auto_setup_new_users_with_repository
+        repos = Repository.where('name like ?', "%#{username}%")
+        assert_not_nil repos, 'repository not found'
+        assert_equal true, repos.any?, 'repository not found'
+        repo_uuids = []
+        repos.each do |repo|
+          repo_uuids << repo[:uuid]
+          repo_names << repo[:name]
+        end
+        if username == 'auto_setup_repo'
+          begin
+            repo_names.delete('auto_setup_repo')
+          ensure
+            assert_equal true, repo_names.any?, 'Repository name for username foo is not unique'
+          end
+        end
+        verify_link_exists true, repo_uuids, user.uuid, 'permission', 'can_manage', nil, nil
+      end
+
+      # if username is existing vm login name, make sure the username used to generate any repo is unique
+      if username == 'auto_setup_vm_login'
+        if repo_names.any?
+          assert repo_names.first.start_with? 'auto_setup_vm_login'
+          assert_not_nil /\d$/.match(repo_names.first)
+        end
+      end
+
+      # check vm uuid
+      vm_uuid = Rails.configuration.auto_setup_new_users_with_vm_uuid
+      if vm_uuid
+        verify_link_exists true, vm_uuid, user.uuid, 'permission', 'can_login', 'username', (username == 'auto_setup_repo' ? repo_names.first : username)
+      else
+        verify_link_exists false, vm_uuid, user.uuid, 'permission', 'can_login', 'username', (username == 'auto_setup_repo' ? repo_names.first : username)
+      end
+    end
+
+    # check email notifications
+    new_user_email = nil
+    new_inactive_user_email = nil
+
+    new_user_email_subject = "#{Rails.configuration.email_subject_prefix}New user created notification"
+    if Rails.configuration.auto_setup_new_users
+      new_user_email_subject = valid_username ? "#{Rails.configuration.email_subject_prefix}New user created and setup notification" :
+                                                "#{Rails.configuration.email_subject_prefix}New user created, but not setup notification"
+    end
+
+    ActionMailer::Base.deliveries.each do |d|
+      if d.subject == new_user_email_subject then
+        new_user_email = d
+      elsif d.subject == "#{Rails.configuration.email_subject_prefix}New inactive user notification" then
+        new_inactive_user_email = d
+      end
+    end
+
+    if not active
+      if not inactive_recipients.empty? then
+        assert_not_nil new_inactive_user_email, 'Expected new inactive user email after setup'
+        assert_equal Rails.configuration.user_notifier_email_from, new_inactive_user_email.from[0]
+        assert_equal inactive_recipients, new_inactive_user_email.to[0]
+        assert_equal "#{Rails.configuration.email_subject_prefix}New inactive user notification", new_inactive_user_email.subject
+      else
+        assert_nil new_inactive_user_email, 'Did not expect new inactive user email after setup'
+      end
+    end
+
+    if active
+      assert_nil new_inactive_user_email, 'Expected no inactive user email after setting up active user'
+      if (not active_recipients.empty?) && valid_username then
+        assert_not_nil new_user_email, 'Expected new user email after setup'
+        assert_equal Rails.configuration.user_notifier_email_from, new_user_email.from[0]
+        assert_equal active_recipients, new_user_email.to[0]
+        assert_equal new_user_email_subject, new_user_email.subject
+      else
+        assert_nil new_user_email, 'Did not expect new user email after setup'
+      end
+    end
+    ActionMailer::Base.deliveries = []
+
+  end
+
+  def verify_link_exists link_exists, head_uuid, tail_uuid, link_class, link_name, property_name, property_value
+    all_links = Link.where(head_uuid: head_uuid,
+                           tail_uuid: tail_uuid,
+                           link_class: link_class,
+                           name: link_name)
+    assert_equal link_exists, all_links.any?, "Link #{'not' if link_exists} found for #{link_name} #{link_class} #{property_value}"
+    if link_exists && property_name && property_value
+      all_links.each do |link|
+        assert_equal true, all_links.first.properties[property_name].start_with?(property_value), 'Property not found in link'
+      end
+    end
+  end
+
 end