services/api/test/unit/arvados_model_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 ArvadosModelTest < ActiveSupport::TestCase
   8   fixtures :all
   9
  10   def create_with_attrs attrs
  11     a = Collection.create({properties: {'foo' => 'bar'}}.merge(attrs))
  12     a if a.valid?
  13   end
  14
  15   test 'non-admin cannot assign uuid' do
  16     set_user_from_auth :active_trustedclient
  17     want_uuid = Collection.generate_uuid
  18     a = create_with_attrs(uuid: want_uuid)
  19     assert_nil a, "Non-admin should not assign uuid."
  20   end
  21
  22   test 'admin can assign valid uuid' do
  23     set_user_from_auth :admin_trustedclient
  24     want_uuid = Collection.generate_uuid
  25     a = create_with_attrs(uuid: want_uuid)
  26     assert_equal want_uuid, a.uuid, "Admin should assign valid uuid."
  27     assert a.uuid.length==27, "Auto assigned uuid length is wrong."
  28   end
  29
  30   test 'admin cannot assign uuid with wrong object type' do
  31     set_user_from_auth :admin_trustedclient
  32     want_uuid = Group.generate_uuid
  33     a = create_with_attrs(uuid: want_uuid)
  34     assert_nil a, "Admin should not be able to assign invalid uuid."
  35   end
  36
  37   test 'admin cannot assign badly formed uuid' do
  38     set_user_from_auth :admin_trustedclient
  39     a = create_with_attrs(uuid: "ntoheunthaoesunhasoeuhtnsaoeunhtsth")
  40     assert_nil a, "Admin should not be able to assign invalid uuid."
  41   end
  42
  43   test 'admin cannot assign empty uuid' do
  44     set_user_from_auth :admin_trustedclient
  45     a = create_with_attrs(uuid: "")
  46     assert_nil a, "Admin cannot assign empty uuid."
  47   end
  48
  49   [ {:a => 'foo'},
  50     {'a' => :foo},
  51     {:a => ['foo', 'bar']},
  52     {'a' => [:foo, 'bar']},
  53     {'a' => ['foo', :bar]},
  54     {:a => [:foo, :bar]},
  55     {:a => {'foo' => {'bar' => 'baz'}}},
  56     {'a' => {:foo => {'bar' => 'baz'}}},
  57     {'a' => {'foo' => {:bar => 'baz'}}},
  58     {'a' => {'foo' => {'bar' => :baz}}},
  59     {'a' => {'foo' => ['bar', :baz]}},
  60   ].each do |x|
  61     test "prevent symbol keys in serialized db columns: #{x.inspect}" do
  62       set_user_from_auth :active
  63       link = Link.create!(link_class: 'test',
  64                           properties: x)
  65       raw = ActiveRecord::Base.connection.
  66           select_value("select properties from links where uuid='#{link.uuid}'")
  67       refute_match(/:[fb]/, raw)
  68     end
  69   end
  70
  71   [ {['foo'] => 'bar'},
  72     {'a' => {['foo', :foo] => 'bar'}},
  73     {'a' => {{'foo' => 'bar'} => 'bar'}},
  74     {'a' => {['foo', :foo] => ['bar', 'baz']}},
  75   ].each do |x|
  76     test "refuse non-string keys in serialized db columns: #{x.inspect}" do
  77       set_user_from_auth :active
  78       assert_raises(ArgumentError) do
  79         Link.create!(link_class: 'test',
  80                      properties: x)
  81       end
  82     end
  83   end
  84
  85   test "No HashWithIndifferentAccess in database" do
  86     set_user_from_auth :admin_trustedclient
  87     link = Link.create!(link_class: 'test',
  88                         properties: {'foo' => 'bar'}.with_indifferent_access)
  89     raw = ActiveRecord::Base.connection.
  90       select_value("select properties from links where uuid='#{link.uuid}'")
  91     assert_equal '{"foo": "bar"}', raw
  92   end
  93
  94   test "store long string" do
  95     set_user_from_auth :active
  96     longstring = "a"
  97     while longstring.length < 2**16
  98       longstring = longstring + longstring
  99     end
 100     g = Group.create! name: 'Has a long description', description: longstring, group_class: "project"
 101     g = Group.find_by_uuid g.uuid
 102     assert_equal g.description, longstring
 103   end
 104
 105   [['uuid', {unique: true}],
 106    ['owner_uuid', {}]].each do |the_column, requires|
 107     test "unique index on all models with #{the_column}" do
 108       checked = 0
 109       ActiveRecord::Base.connection.tables.each do |table|
 110         columns = ActiveRecord::Base.connection.columns(table)
 111
 112         next unless columns.collect(&:name).include? the_column
 113
 114         indexes = ActiveRecord::Base.connection.indexes(table).reject do |index|
 115           requires.map do |key, val|
 116             index.send(key) == val
 117           end.include? false
 118         end
 119         assert_includes indexes.collect(&:columns), [the_column], 'no index'
 120         checked += 1
 121       end
 122       # Sanity check: make sure we didn't just systematically miss everything.
 123       assert_operator(10, :<, checked,
 124                       "Only #{checked} tables have a #{the_column}?!")
 125     end
 126   end
 127
 128   test "search index exists on models that go into projects" do
 129     all_tables =  ActiveRecord::Base.connection.tables - [
 130       'ar_internal_metadata',
 131       'permission_refresh_lock',
 132       'schema_migrations',
 133       # tables that may still exist in the database even though model
 134       # classes have been deleted:
 135       'humans',
 136       'jobs',
 137       'job_tasks',
 138       'keep_disks',
 139       'nodes',
 140       'pipeline_instances',
 141       'pipeline_templates',
 142       'repositories',
 143       'specimens',
 144       'traits',
 145     ]
 146
 147     all_tables.each do |table|
 148       table_class = table.classify.constantize
 149       if table_class.respond_to?('searchable_columns')
 150         search_index_columns = table_class.searchable_columns('ilike')
 151         # Disappointing, but text columns aren't indexed yet.
 152         search_index_columns -= table_class.columns.select { |c|
 153           c.type == :text or c.name == 'description' or c.name == 'file_names'
 154         }.collect(&:name)
 155
 156         indexes = ActiveRecord::Base.connection.indexes(table)
 157         search_index_by_columns = indexes.select do |index|
 158           # After rails 5.0 upgrade, AR::Base.connection.indexes() started to include
 159           # GIN indexes, with its 'columns' attribute being a String like
 160           # 'to_tsvector(...)'
 161           index.columns.is_a?(Array) ? index.columns.sort == search_index_columns.sort : false
 162         end
 163         search_index_by_name = indexes.select do |index|
 164           index.name == "#{table}_search_index"
 165         end
 166         assert !search_index_by_columns.empty?, "#{table} has no search index with columns #{search_index_columns}. Instead found search index with columns #{search_index_by_name.first.andand.columns}"
 167       end
 168     end
 169   end
 170
 171   [
 172     %w[collections collections_trgm_text_search_idx],
 173     %w[container_requests container_requests_trgm_text_search_idx],
 174     %w[groups groups_trgm_text_search_idx],
 175     %w[workflows workflows_trgm_text_search_idx]
 176   ].each do |model|
 177     table = model[0]
 178     indexname = model[1]
 179     test "trigram index exists on #{table} model" do
 180       table_class = table.classify.constantize
 181       expect = table_class.full_text_searchable_columns
 182       ok = false
 183       conn = ActiveRecord::Base.connection
 184       conn.exec_query("SELECT indexdef FROM pg_indexes WHERE tablename = '#{table}' AND indexname = '#{indexname}'").each do |res|
 185         searchable = res['indexdef'].scan(/COALESCE\(+([A-Za-z_]+)/).flatten
 186         ok = (expect == searchable)
 187         assert ok, "Invalid or no trigram index on #{table} named #{indexname}\nexpect: #{expect.inspect}\nfound: #{searchable}"
 188       end
 189     end
 190
 191     test "UUID and hash columns are excluded from #{table} full text index" do
 192       class_name = model.first.classify
 193       actual = class_name.constantize.full_text_searchable_columns
 194       assert_equal(
 195         actual & full_text_excluded_columns, [],
 196         "UUID/hash columns returned by #{class_name}.full_text_searchable_columns",
 197       )
 198     end
 199   end
 200
 201   test "selectable_attributes includes database attributes" do
 202     assert_includes(Collection.selectable_attributes, "name")
 203   end
 204
 205   test "selectable_attributes includes non-database attributes" do
 206     assert_includes(Collection.selectable_attributes, "unsigned_manifest_text")
 207   end
 208
 209   test "selectable_attributes includes common attributes in extensions" do
 210     assert_includes(Collection.selectable_attributes, "uuid")
 211   end
 212
 213   test "selectable_attributes does not include unexposed attributes" do
 214     refute_includes(Collection.selectable_attributes, "id")
 215   end
 216
 217   test "selectable_attributes on a non-default template" do
 218     attr_a = Collection.selectable_attributes(:common)
 219     assert_includes(attr_a, "uuid")
 220     refute_includes(attr_a, "name")
 221   end
 222
 223   test 'create and retrieve using created_at time' do
 224     set_user_from_auth :active
 225     group = Group.create! name: 'test create and retrieve group', group_class: "project"
 226     assert group.valid?, "group is not valid"
 227
 228     results = Group.where(created_at: group.created_at)
 229     assert_includes results.map(&:uuid), group.uuid,
 230       "Expected new group uuid in results when searched with its created_at timestamp"
 231   end
 232
 233   test 'create and update twice and expect different update times' do
 234     set_user_from_auth :active
 235     group = Group.create! name: 'test create and retrieve group', group_class: "project"
 236     assert group.valid?, "group is not valid"
 237
 238     # update 1
 239     group.update!(name: "test create and update name 1")
 240     results = Group.where(uuid: group.uuid)
 241     assert_equal "test create and update name 1", results.first.name, "Expected name to be updated to 1"
 242     updated_at_1 = results.first.updated_at.to_f
 243
 244     # update 2
 245     group.update!(name: "test create and update name 2")
 246     results = Group.where(uuid: group.uuid)
 247     assert_equal "test create and update name 2", results.first.name, "Expected name to be updated to 2"
 248     updated_at_2 = results.first.updated_at.to_f
 249
 250     assert_equal true, (updated_at_2 > updated_at_1), "Expected updated time 2 to be newer than 1"
 251   end
 252
 253   test 'jsonb column' do
 254     set_user_from_auth :active
 255
 256     c = Collection.create!(properties: {})
 257     assert_equal({}, c.properties)
 258
 259     c.update(properties: {'foo' => 'foo'})
 260     c.reload
 261     assert_equal({'foo' => 'foo'}, c.properties)
 262
 263     c.update(properties: nil)
 264     c.reload
 265     assert_equal({}, c.properties)
 266
 267     c.update(properties: {foo: 'bar'})
 268     assert_equal({'foo' => 'bar'}, c.properties)
 269     c.reload
 270     assert_equal({'foo' => 'bar'}, c.properties)
 271   end
 272
 273   test 'serialized attributes dirty tracking with audit log settings' do
 274     Rails.configuration.AuditLogs.MaxDeleteBatch = 1000
 275     set_user_from_auth :admin
 276     [false, true].each do |auditlogs_enabled|
 277       if auditlogs_enabled
 278         Rails.configuration.AuditLogs.MaxAge = 3600
 279       else
 280         Rails.configuration.AuditLogs.MaxAge = 0
 281       end
 282       tested_serialized = false
 283       [
 284         User.find_by_uuid(users(:active).uuid),
 285         ContainerRequest.find_by_uuid(container_requests(:queued).uuid),
 286         Container.find_by_uuid(containers(:queued).uuid),
 287         Group.find_by_uuid(groups(:afiltergroup).uuid),
 288         Collection.find_by_uuid(collections(:collection_with_one_property).uuid),
 289       ].each do |obj|
 290         if !obj.class.serialized_attributes.empty?
 291           tested_serialized = true
 292         end
 293         # obj shouldn't have changed since it's just retrieved from the database
 294         assert_not(obj.changed?, "#{obj.class} model's attribute(s) appear as changed: '#{obj.changes.keys.join(',')}' with audit logs #{auditlogs_enabled ? '': 'not '}enabled.")
 295       end
 296       assert(tested_serialized, "did not test any models with serialized attributes")
 297     end
 298   end
 299 end