Merge branch '8784-dir-listings'
[arvados.git] / services / api / test / unit / user_test.rb
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 require 'test_helper'
6
7 class UserTest < ActiveSupport::TestCase
8   include CurrentApiClient
9
10   # The fixture services/api/test/fixtures/users.yml serves as the input for this test case
11   setup do
12     # Make sure system_user exists before making "pre-test users" list
13     system_user
14   end
15
16   %w(a aa a0 aA Aa AA A0).each do |username|
17     test "#{username.inspect} is a valid username" do
18       user = User.new(username: username)
19       assert(user.valid?)
20     end
21   end
22
23   test "username is not required" do
24     user = User.new(username: nil)
25     assert(user.valid?)
26   end
27
28   test "username beginning with numeral is invalid" do
29     user = User.new(username: "0a")
30     refute(user.valid?)
31   end
32
33   "\\.-_/!@#$%^&*()[]{}".each_char do |bad_char|
34     test "username containing #{bad_char.inspect} is invalid" do
35       user = User.new(username: "bad#{bad_char}username")
36       refute(user.valid?)
37     end
38   end
39
40   test "username must be unique" do
41     user = User.new(username: users(:active).username)
42     refute(user.valid?)
43   end
44
45   test "non-admin can't update username" do
46     set_user_from_auth :rominiadmin
47     user = User.find_by_uuid(users(:rominiadmin).uuid)
48     user.username = "selfupdate"
49     assert_not_allowed { user.save }
50   end
51
52   def check_admin_username_change(fixture_name)
53     set_user_from_auth :admin_trustedclient
54     user = User.find_by_uuid(users(fixture_name).uuid)
55     user.username = "newnamefromtest"
56     assert(user.save)
57   end
58
59   test "admin can set username" do
60     check_admin_username_change(:active_no_prefs)
61   end
62
63   test "admin can update username" do
64     check_admin_username_change(:active)
65   end
66
67   test "admin can update own username" do
68     check_admin_username_change(:admin)
69   end
70
71   def check_new_username_setting(email_name, expect_name)
72     set_user_from_auth :admin
73     user = User.create!(email: "#{email_name}@example.org")
74     assert_equal(expect_name, user.username)
75   end
76
77   test "new username set from e-mail" do
78     check_new_username_setting("dakota", "dakota")
79   end
80
81   test "new username set from e-mail with leading digits" do
82     check_new_username_setting("1dakota9", "dakota9")
83   end
84
85   test "new username set from e-mail with punctuation" do
86     check_new_username_setting("dakota.9", "dakota9")
87   end
88
89   test "new username set from e-mail with leading digits and punctuation" do
90     check_new_username_setting("1.dakota.z", "dakotaz")
91   end
92
93   test "new username set from e-mail with extra part" do
94     check_new_username_setting("dakota+arvados", "dakota")
95   end
96
97   test "new username set with deduplication" do
98     name = users(:active).username
99     check_new_username_setting(name, "#{name}2")
100     check_new_username_setting(name, "#{name}3")
101     # Insert some out-of-order conflicts, to ensure our "sort by
102     # username, stop when we see a hole" strategy doesn't depend on
103     # insert order.
104     check_new_username_setting("#{name}13", "#{name}13")
105     check_new_username_setting("#{name}5", "#{name}5")
106     check_new_username_setting(name, "#{name}4")
107     6.upto(12).each do |n|
108       check_new_username_setting(name, "#{name}#{n}")
109     end
110   end
111
112   test "new username set avoiding blacklist" do
113     Rails.configuration.auto_setup_name_blacklist = ["root"]
114     check_new_username_setting("root", "root2")
115   end
116
117   test "no username set when no base available" do
118     check_new_username_setting("_", nil)
119   end
120
121   test "updating username updates repository names" do
122     set_user_from_auth :admin
123     user = users(:active)
124     user.username = "newtestname"
125     assert(user.save, "username update failed")
126     {foo: "newtestname/foo", repository2: "newtestname/foo2"}.
127         each_pair do |repo_sym, expect_name|
128       assert_equal(expect_name, repositories(repo_sym).name)
129     end
130   end
131
132   test "admin can clear username when user owns no repositories" do
133     set_user_from_auth :admin
134     user = users(:spectator)
135     user.username = nil
136     assert(user.save)
137     assert_nil(user.username)
138   end
139
140   test "admin can't clear username when user owns repositories" do
141     set_user_from_auth :admin
142     user = users(:active)
143     user.username = nil
144     assert_not_allowed { user.save }
145     refute_empty(user.errors[:username])
146   end
147
148   test "failed username update doesn't change repository names" do
149     set_user_from_auth :admin
150     user = users(:active)
151     user.username = users(:fuse).username
152     assert_not_allowed { user.save }
153     assert_equal("active/foo", repositories(:foo).name)
154   end
155
156   [[false, 'foo@example.com', true, nil],
157    [false, 'bar@example.com', nil, true],
158    [true, 'foo@example.com', true, nil],
159    [true, 'bar@example.com', true, true],
160    [false, false, nil, nil],
161    [true, false, true, nil]
162   ].each do |auto_admin_first_user_config, auto_admin_user_config, foo_should_be_admin, bar_should_be_admin|
163     # In each case, 'foo' is created first, then 'bar', then 'bar2', then 'baz'.
164     test "auto admin with auto_admin_first=#{auto_admin_first_user_config} auto_admin=#{auto_admin_user_config}" do
165
166       if auto_admin_first_user_config
167         # This test requires no admin users exist (except for the system user)
168         users(:admin).delete
169         @all_users = User.where("uuid not like '%-000000000000000'").where(:is_admin => true)
170         assert_equal 0, @all_users.count, "No admin users should exist (except for the system user)"
171       end
172
173       Rails.configuration.auto_admin_first_user = auto_admin_first_user_config
174       Rails.configuration.auto_admin_user = auto_admin_user_config
175
176       # See if the foo user has is_admin
177       foo = User.new
178       foo.first_name = 'foo'
179       foo.email = 'foo@example.com'
180
181       act_as_system_user do
182         foo.save!
183       end
184
185       foo = User.find(foo.id)   # get the user back
186       assert_equal foo_should_be_admin, foo.is_admin, "is_admin is wrong for user foo"
187       assert_equal 'foo', foo.first_name
188
189       # See if the bar user has is_admin
190       bar = User.new
191       bar.first_name = 'bar'
192       bar.email = 'bar@example.com'
193
194       act_as_system_user do
195         bar.save!
196       end
197
198       bar = User.find(bar.id)   # get the user back
199       assert_equal bar_should_be_admin, bar.is_admin, "is_admin is wrong for user bar"
200       assert_equal 'bar', bar.first_name
201
202       # A subsequent user with the bar@example.com address should never be
203       # elevated to admin
204       bar2 = User.new
205       bar2.first_name = 'bar2'
206       bar2.email = 'bar@example.com'
207
208       act_as_system_user do
209         bar2.save!
210       end
211
212       bar2 = User.find(bar2.id)   # get the user back
213       assert !bar2.is_admin, "is_admin is wrong for user bar2"
214       assert_equal 'bar2', bar2.first_name
215
216       # An ordinary new user should not be elevated to admin
217       baz = User.new
218       baz.first_name = 'baz'
219       baz.email = 'baz@example.com'
220
221       act_as_system_user do
222         baz.save!
223       end
224
225       baz = User.find(baz.id)   # get the user back
226       assert !baz.is_admin
227       assert_equal 'baz', baz.first_name
228
229     end
230   end
231
232   test "check non-admin active user properties" do
233     @active_user = users(:active)     # get the active user
234     assert !@active_user.is_admin, 'is_admin should not be set for a non-admin user'
235     assert @active_user.is_active, 'user should be active'
236     assert @active_user.is_invited, 'is_invited should be set'
237     assert_not_nil @active_user.prefs, "user's preferences should be non-null, but may be size zero"
238     assert (@active_user.can? :read=>"#{@active_user.uuid}"), "user should be able to read own object"
239     assert (@active_user.can? :write=>"#{@active_user.uuid}"), "user should be able to write own object"
240     assert (@active_user.can? :manage=>"#{@active_user.uuid}"), "user should be able to manage own object"
241
242     assert @active_user.groups_i_can(:read).size > 0, "active user should be able read at least one group"
243
244     # non-admin user cannot manage or write other user objects
245     @uninvited_user = users(:inactive_uninvited)     # get the uninvited user
246     assert !(@active_user.can? :read=>"#{@uninvited_user.uuid}")
247     assert !(@active_user.can? :write=>"#{@uninvited_user.uuid}")
248     assert !(@active_user.can? :manage=>"#{@uninvited_user.uuid}")
249   end
250
251   test "check admin user properties" do
252     @admin_user = users(:admin)     # get the admin user
253     assert @admin_user.is_admin, 'is_admin should be set for admin user'
254     assert @admin_user.is_active, 'admin user cannot be inactive'
255     assert @admin_user.is_invited, 'is_invited should be set'
256     assert_not_nil @admin_user.uuid.size, "user's uuid should be non-null"
257     assert_not_nil @admin_user.prefs, "user's preferences should be non-null, but may be size zero"
258     assert @admin_user.identity_url.size > 0, "user's identity url is expected"
259     assert @admin_user.can? :read=>"#{@admin_user.uuid}"
260     assert @admin_user.can? :write=>"#{@admin_user.uuid}"
261     assert @admin_user.can? :manage=>"#{@admin_user.uuid}"
262
263     assert @admin_user.groups_i_can(:read).size > 0, "admin active user should be able read at least one group"
264     assert @admin_user.groups_i_can(:write).size > 0, "admin active user should be able write to at least one group"
265     assert @admin_user.groups_i_can(:manage).size > 0, "admin active user should be able manage at least one group"
266
267     # admin user can also write or manage other users
268     @uninvited_user = users(:inactive_uninvited)     # get the uninvited user
269     assert @admin_user.can? :read=>"#{@uninvited_user.uuid}"
270     assert @admin_user.can? :write=>"#{@uninvited_user.uuid}"
271     assert @admin_user.can? :manage=>"#{@uninvited_user.uuid}"
272   end
273
274   test "check inactive and uninvited user properties" do
275     @uninvited_user = users(:inactive_uninvited)     # get the uninvited user
276     assert !@uninvited_user.is_admin, 'is_admin should not be set for a non-admin user'
277     assert !@uninvited_user.is_active, 'user should be inactive'
278     assert !@uninvited_user.is_invited, 'is_invited should not be set'
279     assert @uninvited_user.can? :read=>"#{@uninvited_user.uuid}"
280     assert @uninvited_user.can? :write=>"#{@uninvited_user.uuid}"
281     assert @uninvited_user.can? :manage=>"#{@uninvited_user.uuid}"
282
283     assert_equal(@uninvited_user.groups_i_can(:read).sort,
284                  [@uninvited_user.uuid, groups(:anonymous_group).uuid].sort)
285     assert_equal(@uninvited_user.groups_i_can(:write),
286                  [@uninvited_user.uuid])
287     assert_equal(@uninvited_user.groups_i_can(:manage),
288                  [@uninvited_user.uuid])
289   end
290
291   test "find user method checks" do
292     User.all.each do |user|
293       assert_not_nil user.uuid, "non-null uuid expected for " + user.full_name
294     end
295
296     user = users(:active)     # get the active user
297
298     found_user = User.find(user.id)   # find a user by the row id
299
300     assert_equal found_user.full_name, user.first_name + ' ' + user.last_name
301     assert_equal found_user.identity_url, user.identity_url
302   end
303
304   test "full name should not contain spurious whitespace" do
305     set_user_from_auth :admin
306
307     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: 'foo@example.com' })
308
309     assert_equal '', user.full_name
310
311     user.first_name = 'John'
312     user.last_name = 'Smith'
313
314     assert_equal user.first_name + ' ' + user.last_name, user.full_name
315   end
316
317   test "create new user" do
318     set_user_from_auth :admin
319
320     @all_users = User.all.to_a
321
322     user = User.new
323     user.first_name = "first_name_for_newly_created_user"
324     user.save
325
326     # verify there is one extra user in the db now
327     assert_equal @all_users.size+1, User.all.count
328
329     user = User.find(user.id)   # get the user back
330     assert_equal(user.first_name, 'first_name_for_newly_created_user')
331     assert_not_nil user.uuid, 'uuid should be set for newly created user'
332     assert_nil user.email, 'email should be null for newly created user, because it was not passed in'
333     assert_nil user.identity_url, 'identity_url should be null for newly created user, because it was not passed in'
334
335     user.first_name = 'first_name_for_newly_created_user_updated'
336     user.save
337     user = User.find(user.id)   # get the user back
338     assert_equal(user.first_name, 'first_name_for_newly_created_user_updated')
339   end
340
341   test "create new user with notifications" do
342     set_user_from_auth :admin
343
344     create_user_and_verify_setup_and_notifications true, 'active-notify-address@example.com', 'inactive-notify-address@example.com', nil, nil
345     create_user_and_verify_setup_and_notifications true, 'active-notify-address@example.com', [], nil, nil
346     create_user_and_verify_setup_and_notifications true, [], [], nil, nil
347     create_user_and_verify_setup_and_notifications false, 'active-notify-address@example.com', 'inactive-notify-address@example.com', nil, nil
348     create_user_and_verify_setup_and_notifications false, [], 'inactive-notify-address@example.com', nil, nil
349     create_user_and_verify_setup_and_notifications false, [], [], nil, nil
350   end
351
352   [
353     # Easy inactive user tests.
354     [false, [], [], "inactive-none@example.com", false, false, "inactivenone"],
355     [false, [], [], "inactive-vm@example.com", true, false, "inactivevm"],
356     [false, [], [], "inactive-repo@example.com", false, true, "inactiverepo"],
357     [false, [], [], "inactive-both@example.com", true, true, "inactiveboth"],
358
359     # Easy active user tests.
360     [true, "active-notify@example.com", "inactive-notify@example.com", "active-none@example.com", false, false, "activenone"],
361     [true, "active-notify@example.com", "inactive-notify@example.com", "active-vm@example.com", true, false, "activevm"],
362     [true, "active-notify@example.com", "inactive-notify@example.com", "active-repo@example.com", false, true, "activerepo"],
363     [true, "active-notify@example.com", "inactive-notify@example.com", "active-both@example.com", true, true, "activeboth"],
364
365     # Test users with malformed e-mail addresses.
366     [false, [], [], nil, true, true, nil],
367     [false, [], [], "arvados", true, true, nil],
368     [false, [], [], "@example.com", true, true, nil],
369     [true, "active-notify@example.com", "inactive-notify@example.com", "*!*@example.com", true, false, nil],
370     [true, "active-notify@example.com", "inactive-notify@example.com", "*!*@example.com", false, false, nil],
371
372     # Test users with various username transformations.
373     [false, [], [], "arvados@example.com", false, false, "arvados2"],
374     [true, "active-notify@example.com", "inactive-notify@example.com", "arvados@example.com", false, false, "arvados2"],
375     [true, "active-notify@example.com", "inactive-notify@example.com", "root@example.com", true, false, "root2"],
376     [false, "active-notify@example.com", "inactive-notify@example.com", "root@example.com", true, false, "root2"],
377     [true, "active-notify@example.com", "inactive-notify@example.com", "roo_t@example.com", false, true, "root2"],
378     [false, [], [], "^^incorrect_format@example.com", true, true, "incorrectformat"],
379     [true, "active-notify@example.com", "inactive-notify@example.com", "&4a_d9.@example.com", true, true, "ad9"],
380     [true, "active-notify@example.com", "inactive-notify@example.com", "&4a_d9.@example.com", false, false, "ad9"],
381     [false, "active-notify@example.com", "inactive-notify@example.com", "&4a_d9.@example.com", true, true, "ad9"],
382     [false, "active-notify@example.com", "inactive-notify@example.com", "&4a_d9.@example.com", false, false, "ad9"],
383   ].each do |active, new_user_recipients, inactive_recipients, email, auto_setup_vm, auto_setup_repo, expect_username|
384     test "create new user with auto setup #{active} #{email} #{auto_setup_vm} #{auto_setup_repo}" do
385       set_user_from_auth :admin
386
387       Rails.configuration.auto_setup_new_users = true
388
389       if auto_setup_vm
390         Rails.configuration.auto_setup_new_users_with_vm_uuid = virtual_machines(:testvm)['uuid']
391       else
392         Rails.configuration.auto_setup_new_users_with_vm_uuid = false
393       end
394
395       Rails.configuration.auto_setup_new_users_with_repository = auto_setup_repo
396
397       create_user_and_verify_setup_and_notifications active, new_user_recipients, inactive_recipients, email, expect_username
398     end
399   end
400
401   test "update existing user" do
402     set_user_from_auth :active    # set active user as current user
403
404     @active_user = users(:active)     # get the active user
405
406     @active_user.first_name = "first_name_changed"
407     @active_user.save
408
409     @active_user = User.find(@active_user.id)   # get the user back
410     assert_equal(@active_user.first_name, 'first_name_changed')
411
412     # admin user also should be able to update the "active" user info
413     set_user_from_auth :admin # set admin user as current user
414     @active_user.first_name = "first_name_changed_by_admin_for_active_user"
415     @active_user.save
416
417     @active_user = User.find(@active_user.id)   # get the user back
418     assert_equal(@active_user.first_name, 'first_name_changed_by_admin_for_active_user')
419   end
420
421   test "delete a user and verify" do
422     @active_user = users(:active)     # get the active user
423     active_user_uuid = @active_user.uuid
424
425     set_user_from_auth :admin
426     @active_user.delete
427
428     found_deleted_user = false
429     User.all.each do |user|
430       if user.uuid == active_user_uuid
431         found_deleted_user = true
432         break
433       end
434     end
435     assert !found_deleted_user, "found deleted user: "+active_user_uuid
436
437   end
438
439   test "create new user as non-admin user" do
440     set_user_from_auth :active
441     assert_not_allowed { User.new.save }
442   end
443
444   test "setup new user" do
445     set_user_from_auth :admin
446
447     email = 'foo@example.com'
448     openid_prefix = 'http://openid/prefix'
449
450     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
451
452     vm = VirtualMachine.create
453
454     response = user.setup(openid_prefix: openid_prefix,
455                           repo_name: 'foo/testrepo',
456                           vm_uuid: vm.uuid)
457
458     resp_user = find_obj_in_resp response, 'User'
459     verify_user resp_user, email
460
461     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
462
463     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
464         resp_user[:uuid]
465
466     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
467         'expected identity_url_prefix not found for oid_login_perm'
468
469     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
470     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
471
472     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
473     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
474
475     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
476     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
477     assert_equal("foo", vm_perm.properties["username"])
478   end
479
480   test "setup new user with junk in database" do
481     set_user_from_auth :admin
482
483     email = 'foo@example.com'
484     openid_prefix = 'http://openid/prefix'
485
486     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
487
488     vm = VirtualMachine.create
489
490     # Set up the bogus Link
491     bad_uuid = 'zzzzz-tpzed-xyzxyzxyzxyzxyz'
492
493     resp_link = Link.create ({tail_uuid: email, link_class: 'permission',
494         name: 'can_login', head_uuid: bad_uuid})
495     resp_link.save(validate: false)
496
497     verify_link resp_link, 'permission', 'can_login', email, bad_uuid
498
499     response = user.setup(openid_prefix: openid_prefix,
500                           repo_name: 'foo/testrepo',
501                           vm_uuid: vm.uuid)
502
503     resp_user = find_obj_in_resp response, 'User'
504     verify_user resp_user, email
505
506     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
507
508     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
509         resp_user[:uuid]
510
511     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
512         'expected identity_url_prefix not found for oid_login_perm'
513
514     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
515     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
516
517     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
518     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
519
520     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
521     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
522     assert_equal("foo", vm_perm.properties["username"])
523   end
524
525   test "setup new user in multiple steps" do
526     set_user_from_auth :admin
527
528     email = 'foo@example.com'
529     openid_prefix = 'http://openid/prefix'
530
531     user = User.create ({uuid: 'zzzzz-tpzed-abcdefghijklmno', email: email})
532
533     response = user.setup(openid_prefix: openid_prefix)
534
535     resp_user = find_obj_in_resp response, 'User'
536     verify_user resp_user, email
537
538     oid_login_perm = find_obj_in_resp response, 'Link', 'arvados#user'
539     verify_link oid_login_perm, 'permission', 'can_login', resp_user[:email],
540         resp_user[:uuid]
541     assert_equal openid_prefix, oid_login_perm[:properties]['identity_url_prefix'],
542         'expected identity_url_prefix not found for oid_login_perm'
543
544     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
545     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
546
547     # invoke setup again with repo_name
548     response = user.setup(openid_prefix: openid_prefix,
549                           repo_name: 'foo/testrepo')
550     resp_user = find_obj_in_resp response, 'User', nil
551     verify_user resp_user, email
552     assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
553
554     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
555     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
556
557     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
558     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
559
560     # invoke setup again with a vm_uuid
561     vm = VirtualMachine.create
562
563     response = user.setup(openid_prefix: openid_prefix,
564                           repo_name: 'foo/testrepo',
565                           vm_uuid: vm.uuid)
566
567     resp_user = find_obj_in_resp response, 'User', nil
568     verify_user resp_user, email
569     assert_equal user.uuid, resp_user[:uuid], 'expected uuid not found'
570
571     group_perm = find_obj_in_resp response, 'Link', 'arvados#group'
572     verify_link group_perm, 'permission', 'can_read', resp_user[:uuid], nil
573
574     repo_perm = find_obj_in_resp response, 'Link', 'arvados#repository'
575     verify_link repo_perm, 'permission', 'can_manage', resp_user[:uuid], nil
576
577     vm_perm = find_obj_in_resp response, 'Link', 'arvados#virtualMachine'
578     verify_link vm_perm, 'permission', 'can_login', resp_user[:uuid], vm.uuid
579     assert_equal("foo", vm_perm.properties["username"])
580   end
581
582   def find_obj_in_resp (response_items, object_type, head_kind=nil)
583     return_obj = nil
584     response_items.each { |x|
585       if !x
586         next
587       end
588
589       if object_type == 'User'
590         if ArvadosModel::resource_class_for_uuid(x['uuid']) == User
591           return_obj = x
592           break
593         end
594       else  # looking for a link
595         if ArvadosModel::resource_class_for_uuid(x['head_uuid']).kind == head_kind
596           return_obj = x
597           break
598         end
599       end
600     }
601     return return_obj
602   end
603
604   def verify_user (resp_user, email)
605     assert_not_nil resp_user, 'expected user object'
606     assert_not_nil resp_user['uuid'], 'expected user object'
607     assert_equal email, resp_user['email'], 'expected email not found'
608
609   end
610
611   def verify_link (link_object, link_class, link_name, tail_uuid, head_uuid)
612     assert_not_nil link_object, "expected link for #{link_class} #{link_name}"
613     assert_not_nil link_object[:uuid],
614         "expected non-nil uuid for link for #{link_class} #{link_name}"
615     assert_equal link_class, link_object[:link_class],
616         "expected link_class not found for #{link_class} #{link_name}"
617     assert_equal link_name, link_object[:name],
618         "expected link_name not found for #{link_class} #{link_name}"
619     assert_equal tail_uuid, link_object[:tail_uuid],
620         "expected tail_uuid not found for #{link_class} #{link_name}"
621     if head_uuid
622       assert_equal head_uuid, link_object[:head_uuid],
623           "expected head_uuid not found for #{link_class} #{link_name}"
624     end
625   end
626
627   def create_user_and_verify_setup_and_notifications (active, new_user_recipients, inactive_recipients, email, expect_username)
628     Rails.configuration.new_user_notification_recipients = new_user_recipients
629     Rails.configuration.new_inactive_user_notification_recipients = inactive_recipients
630
631     ActionMailer::Base.deliveries = []
632
633     can_setup = (Rails.configuration.auto_setup_new_users and
634                  (not expect_username.nil?))
635     expect_repo_name = "#{expect_username}/#{expect_username}"
636     prior_repo = Repository.where(name: expect_repo_name).first
637
638     user = User.new
639     user.first_name = "first_name_for_newly_created_user"
640     user.email = email
641     user.is_active = active
642     user.save!
643     assert_equal(expect_username, user.username)
644
645     # check user setup
646     verify_link_exists(Rails.configuration.auto_setup_new_users,
647                        groups(:all_users).uuid, user.uuid,
648                        "permission", "can_read")
649     # Check for OID login link.
650     verify_link_exists(Rails.configuration.auto_setup_new_users,
651                        user.uuid, user.email, "permission", "can_login")
652     # Check for repository.
653     if named_repo = (prior_repo or
654                      Repository.where(name: expect_repo_name).first)
655       verify_link_exists((can_setup and prior_repo.nil? and
656                           Rails.configuration.auto_setup_new_users_with_repository),
657                          named_repo.uuid, user.uuid, "permission", "can_manage")
658     end
659     # Check for VM login.
660     if auto_vm_uuid = Rails.configuration.auto_setup_new_users_with_vm_uuid
661       verify_link_exists(can_setup, auto_vm_uuid, user.uuid,
662                          "permission", "can_login", "username", expect_username)
663     end
664
665     # check email notifications
666     new_user_email = nil
667     new_inactive_user_email = nil
668
669     new_user_email_subject = "#{Rails.configuration.email_subject_prefix}New user created notification"
670     if Rails.configuration.auto_setup_new_users
671       new_user_email_subject = (expect_username or active) ?
672                                  "#{Rails.configuration.email_subject_prefix}New user created and setup notification" :
673                                  "#{Rails.configuration.email_subject_prefix}New user created, but not setup notification"
674     end
675
676     ActionMailer::Base.deliveries.each do |d|
677       if d.subject == new_user_email_subject then
678         new_user_email = d
679       elsif d.subject == "#{Rails.configuration.email_subject_prefix}New inactive user notification" then
680         new_inactive_user_email = d
681       end
682     end
683
684     # both active and inactive user creations should result in new user creation notification mails,
685     # if the new user email recipients config parameter is set
686     if not new_user_recipients.empty? then
687       assert_not_nil new_user_email, 'Expected new user email after setup'
688       assert_equal Rails.configuration.user_notifier_email_from, new_user_email.from[0]
689       assert_equal new_user_recipients, new_user_email.to[0]
690       assert_equal new_user_email_subject, new_user_email.subject
691     else
692       assert_nil new_user_email, 'Did not expect new user email after setup'
693     end
694
695     if not active
696       if not inactive_recipients.empty? then
697         assert_not_nil new_inactive_user_email, 'Expected new inactive user email after setup'
698         assert_equal Rails.configuration.user_notifier_email_from, new_inactive_user_email.from[0]
699         assert_equal inactive_recipients, new_inactive_user_email.to[0]
700         assert_equal "#{Rails.configuration.email_subject_prefix}New inactive user notification", new_inactive_user_email.subject
701       else
702         assert_nil new_inactive_user_email, 'Did not expect new inactive user email after setup'
703       end
704     else
705       assert_nil new_inactive_user_email, 'Expected no inactive user email after setting up active user'
706     end
707     ActionMailer::Base.deliveries = []
708
709   end
710
711   def verify_link_exists link_exists, head_uuid, tail_uuid, link_class, link_name, property_name=nil, property_value=nil
712     all_links = Link.where(head_uuid: head_uuid,
713                            tail_uuid: tail_uuid,
714                            link_class: link_class,
715                            name: link_name)
716     assert_equal link_exists, all_links.any?, "Link #{'not' if link_exists} found for #{link_name} #{link_class} #{property_value}"
717     if link_exists && property_name && property_value
718       all_links.each do |link|
719         assert_equal true, all_links.first.properties[property_name].start_with?(property_value), 'Property not found in link'
720       end
721     end
722   end
723
724 end