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 = Specimen.create({material: 'caloric'}.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 = Specimen.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 = Specimen.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 = Human.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 "Stringify symbols coming from serialized attribute in database" do
  86     set_user_from_auth :admin_trustedclient
  87     fixed = Link.find_by_uuid(links(:has_symbol_keys_in_database_somehow).uuid)
  88     assert_equal(["baz", "foo"], fixed.properties.keys.sort,
  89                  "Hash symbol keys from DB did not get stringified.")
  90     assert_equal(['waz', 'waz', 'waz', 1, nil, false, true],
  91                  fixed.properties['baz'],
  92                  "Array symbol values from DB did not get stringified.")
  93     assert_equal true, fixed.save, "Failed to save fixed model back to db."
  94   end
  95
  96   test "No HashWithIndifferentAccess in database" do
  97     set_user_from_auth :admin_trustedclient
  98     link = Link.create!(link_class: 'test',
  99                         properties: {'foo' => 'bar'}.with_indifferent_access)
 100     raw = ActiveRecord::Base.connection.
 101       select_value("select properties from links where uuid='#{link.uuid}'")
 102     assert_equal '{"foo": "bar"}', raw
 103   end
 104
 105   test "store long string" do
 106     set_user_from_auth :active
 107     longstring = "a"
 108     while longstring.length < 2**16
 109       longstring = longstring + longstring
 110     end
 111     g = Group.create! name: 'Has a long description', description: longstring
 112     g = Group.find_by_uuid g.uuid
 113     assert_equal g.description, longstring
 114   end
 115
 116   [['uuid', {unique: true}],
 117    ['owner_uuid', {}]].each do |the_column, requires|
 118     test "unique index on all models with #{the_column}" do
 119       checked = 0
 120       ActiveRecord::Base.connection.tables.each do |table|
 121         columns = ActiveRecord::Base.connection.columns(table)
 122
 123         next unless columns.collect(&:name).include? the_column
 124
 125         indexes = ActiveRecord::Base.connection.indexes(table).reject do |index|
 126           requires.map do |key, val|
 127             index.send(key) == val
 128           end.include? false
 129         end
 130         assert_includes indexes.collect(&:columns), [the_column], 'no index'
 131         checked += 1
 132       end
 133       # Sanity check: make sure we didn't just systematically miss everything.
 134       assert_operator(10, :<, checked,
 135                       "Only #{checked} tables have a #{the_column}?!")
 136     end
 137   end
 138
 139   test "search index exists on models that go into projects" do
 140     all_tables =  ActiveRecord::Base.connection.tables
 141     all_tables.delete 'schema_migrations'
 142     all_tables.delete 'permission_refresh_lock'
 143     all_tables.delete 'ar_internal_metadata'
 144
 145     all_tables.each do |table|
 146       table_class = table.classify.constantize
 147       if table_class.respond_to?('searchable_columns')
 148         search_index_columns = table_class.searchable_columns('ilike')
 149         # Disappointing, but text columns aren't indexed yet.
 150         search_index_columns -= table_class.columns.select { |c|
 151           c.type == :text or c.name == 'description' or c.name == 'file_names'
 152         }.collect(&:name)
 153
 154         indexes = ActiveRecord::Base.connection.indexes(table)
 155         search_index_by_columns = indexes.select do |index|
 156           # After rails 5.0 upgrade, AR::Base.connection.indexes() started to include
 157           # GIN indexes, with its 'columns' attribute being a String like
 158           # 'to_tsvector(...)'
 159           index.columns.is_a?(Array) ? index.columns.sort == search_index_columns.sort : false
 160         end
 161         search_index_by_name = indexes.select do |index|
 162           index.name == "#{table}_search_index"
 163         end
 164         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}"
 165       end
 166     end
 167   end
 168
 169   test "full text search index exists on models" do
 170     indexes = {}
 171     conn = ActiveRecord::Base.connection
 172     conn.exec_query("SELECT i.relname as indname,
 173       i.relowner as indowner,
 174       idx.indrelid::regclass::text as table,
 175       am.amname as indam,
 176       idx.indkey,
 177       ARRAY(
 178             SELECT pg_get_indexdef(idx.indexrelid, k + 1, true)
 179                    FROM generate_subscripts(idx.indkey, 1) as k
 180                    ORDER BY k
 181                    ) as keys,
 182       idx.indexprs IS NOT NULL as indexprs,
 183       idx.indpred IS NOT NULL as indpred
 184       FROM   pg_index as idx
 185       JOIN   pg_class as i
 186       ON     i.oid = idx.indexrelid
 187       JOIN   pg_am as am
 188       ON     i.relam = am.oid
 189       JOIN   pg_namespace as ns
 190       ON     ns.oid = i.relnamespace
 191       AND    ns.nspname = ANY(current_schemas(false))").each do |idx|
 192       if idx['keys'].match(/to_tsvector/)
 193         indexes[idx['table']] ||= []
 194         indexes[idx['table']] << idx
 195       end
 196     end
 197     fts_tables =  ["collections", "container_requests", "groups", "jobs",
 198                    "pipeline_instances", "pipeline_templates", "workflows"]
 199     fts_tables.each do |table|
 200       table_class = table.classify.constantize
 201       if table_class.respond_to?('full_text_searchable_columns')
 202         expect = table_class.full_text_searchable_columns
 203         ok = false
 204         indexes[table].andand.each do |idx|
 205           if expect == idx['keys'].scan(/COALESCE\(([A-Za-z_]+)/).flatten
 206             ok = true
 207           end
 208         end
 209         assert ok, "#{table} has no full-text index\nexpect: #{expect.inspect}\nfound: #{indexes[table].inspect}"
 210       end
 211     end
 212   end
 213
 214   test "selectable_attributes includes database attributes" do
 215     assert_includes(Job.selectable_attributes, "success")
 216   end
 217
 218   test "selectable_attributes includes non-database attributes" do
 219     assert_includes(Job.selectable_attributes, "node_uuids")
 220   end
 221
 222   test "selectable_attributes includes common attributes in extensions" do
 223     assert_includes(Job.selectable_attributes, "uuid")
 224   end
 225
 226   test "selectable_attributes does not include unexposed attributes" do
 227     refute_includes(Job.selectable_attributes, "nodes")
 228   end
 229
 230   test "selectable_attributes on a non-default template" do
 231     attr_a = Job.selectable_attributes(:common)
 232     assert_includes(attr_a, "uuid")
 233     refute_includes(attr_a, "success")
 234   end
 235
 236   test 'create and retrieve using created_at time' do
 237     set_user_from_auth :active
 238     group = Group.create! name: 'test create and retrieve group'
 239     assert group.valid?, "group is not valid"
 240
 241     results = Group.where(created_at: group.created_at)
 242     assert_includes results.map(&:uuid), group.uuid,
 243       "Expected new group uuid in results when searched with its created_at timestamp"
 244   end
 245
 246   test 'create and update twice and expect different update times' do
 247     set_user_from_auth :active
 248     group = Group.create! name: 'test create and retrieve group'
 249     assert group.valid?, "group is not valid"
 250
 251     # update 1
 252     group.update_attributes!(name: "test create and update name 1")
 253     results = Group.where(uuid: group.uuid)
 254     assert_equal "test create and update name 1", results.first.name, "Expected name to be updated to 1"
 255     updated_at_1 = results.first.updated_at.to_f
 256
 257     # update 2
 258     group.update_attributes!(name: "test create and update name 2")
 259     results = Group.where(uuid: group.uuid)
 260     assert_equal "test create and update name 2", results.first.name, "Expected name to be updated to 2"
 261     updated_at_2 = results.first.updated_at.to_f
 262
 263     assert_equal true, (updated_at_2 > updated_at_1), "Expected updated time 2 to be newer than 1"
 264   end
 265
 266   test 'jsonb column' do
 267     set_user_from_auth :active
 268
 269     c = Collection.create!(properties: {})
 270     assert_equal({}, c.properties)
 271
 272     c.update_attributes(properties: {'foo' => 'foo'})
 273     c.reload
 274     assert_equal({'foo' => 'foo'}, c.properties)
 275
 276     c.update_attributes(properties: nil)
 277     c.reload
 278     assert_equal({}, c.properties)
 279
 280     c.update_attributes(properties: {foo: 'bar'})
 281     assert_equal({'foo' => 'bar'}, c.properties)
 282     c.reload
 283     assert_equal({'foo' => 'bar'}, c.properties)
 284   end
 285 end