Anjing Webshells

Website : rimsha.abasa.com
: / var / canvas / spec / support /
Filename : test_database_utils.rb
back
# frozen_string_literal: true

#
# Copyright (C) 2017 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.

module TestDatabaseUtils
  class << self
    def check_migrations!
      if ENV["SKIP_MIGRATION_CHECK"] != "1"
        migrations = ActiveRecord::Base.connection.migration_context.migrations
        skipped_migrations = ActiveRecord::Migrator.new(
          :up,
          migrations,
          ActiveRecord::Base.connection.schema_migration,
          ActiveRecord::InternalMetadata.new(ActiveRecord::Base.connection)
        ).skipped_migrations

        # total migration - all run migrations - all skipped migrations
        needs_migration =
          migrations.map(&:version) -
          ActiveRecord::Base.connection.migration_context.get_all_versions -
          skipped_migrations.map(&:version)

        unless needs_migration.empty?
          if ENV["NO_AUTO_MIGRATE"] == "1"
            raise ActiveRecord::PendingMigrationError
          else
            Switchman::TestHelper.recreate_persistent_test_shards(dont_create: true)
            Shard.with_each_shard do
              ActiveRecord::Tasks::DatabaseTasks.migrate
            end
          end
        end
      end
    end

    def reset_database!
      return unless truncate_all_tables? || randomize_sequences?

      start = Time.now

      # this won't create/migrate them, but it will let us with_each_shard any
      # persistent ones that already exist
      require "switchman/test_helper"
      ::Switchman::TestHelper.recreate_persistent_test_shards(dont_create: ENV["CREATE_SHARDS"] != "1")

      truncate_all_tables! if truncate_all_tables?
      randomize_sequences! if randomize_sequences?

      # now delete any shard objects we created
      Shard.delete_all
      Shard.default(reload: true)

      # RSpecQ fails when using json formatter due to this output. Don't output when running on RSpecQ
      puts "finished resetting test db in #{Time.now - start} seconds" unless ENV["SUPPRESS_OUTPUT"] == "1"
    end

    # Like ActiveRecord::Base.connection.reset_pk_sequence! but handles the
    # dummy Account (id=0) properly.
    def reset_pk_sequence!(t)
      if t == "accounts" && Account.maximum("id") == 0
        # reset_pk_sequence! crashes if the only account is the dummy Account (id=0).
        # Reset PK sequence manually. (Code from reset_pk_sequence!)
        conn = ActiveRecord::Base.connection
        _pk, sequence = conn.pk_and_sequence_for("accounts")
        quoted_sequence = conn.quote_table_name(sequence)
        conn.query_value("SELECT setval(#{conn.quote(quoted_sequence)}, 1, false)", "SCHEMA")
      else
        ActiveRecord::Base.connection.reset_pk_sequence!(t)
      end
    end

    private

    def each_connection(&)
      ::Shard.with_each_shard(::Shard.sharded_models) do
        models = ::ActiveRecord::Base.descendants
        models.reject! { |m| m.connection_class_for_self == [::Switchman::UnshardedRecord] } unless ::Shard.current.default?
        model_connections = models.map(&:connection).uniq
        model_connections.each(&)
      end
    end

    def get_table_names(connection)
      # use custom SQL to exclude tables from extensions
      schema = connection.shard.name
      table_names = connection.query(<<~SQL.squish, "SCHEMA").map(&:first)
        SELECT relname
        FROM pg_class INNER JOIN pg_namespace ON relnamespace=pg_namespace.oid
        WHERE nspname = #{schema ? "'#{schema}'" : "ANY (current_schemas(false))"}
          AND relkind='r'
          AND NOT EXISTS (
            SELECT 1 FROM pg_depend WHERE deptype='e' AND objid=pg_class.oid
          )
      SQL
      table_names.delete(ActiveRecord::Base.internal_metadata_table_name)
      table_names.delete(ActiveRecord::Base.schema_migrations_table_name)
      table_names.delete(Shard.table_name)
      table_names
    end

    def truncate_all_tables?
      # Only account should be the dummy account with id=0
      Account.where.not(id: 0).any? || Account.where(id: 0).none?
    end

    def truncate_all_tables!
      # RSpecQ fails when using json formatter due to this output. Don't output when running on RSpecQ
      puts "truncating all tables..." unless ENV["SUPPRESS_OUTPUT"] == "1"
      each_connection do |connection|
        table_names = get_table_names(connection)
        next if table_names.empty?

        connection.execute("TRUNCATE TABLE #{table_names.map { |t| connection.quote_table_name(t) }.join(",")}")
      end
      Account.ensure_dummy_root_account
    end

    def get_sequences(connection)
      schema = connection.shard.name
      sequences = connection.query(<<~SQL.squish, "SCHEMA").map(&:first)
        SELECT relname
        FROM pg_class INNER JOIN pg_namespace ON relnamespace=pg_namespace.oid
        WHERE nspname = #{schema ? "'#{schema}'" : "ANY (current_schemas(false))"} AND relkind='S'
      SQL
      sequences.delete("switchman_shards_id_seq")
      sequences
    end

    def randomize_sequences?
      ENV["RANDOMIZE_SEQUENCES"] == "1"
    end

    def randomize_sequences!
      # RSpecQ fails when using json formatter due to this output. Don't output when running on RSpecQ
      puts "randomizing db sequences..." unless ENV["SUPPRESS_OUTPUT"] == "1"
      seed = ::RSpec.configuration.seed
      i = 0
      each_connection do |connection|
        i += 1
        sequences = get_sequences(connection)
        sequences.each do |sequence|
          # stable random-ish number <= 2**20 so that we don't overflow pre-migrated Version partitions
          new_val = Digest::MD5.hexdigest("#{seed}#{i}#{sequence}")[0...5].to_i(16) + 1
          connection.execute("ALTER SEQUENCE #{connection.quote_table_name(sequence)} RESTART WITH #{new_val}")
        end
      end
    end
  end
end