activerecord-spanner-adapter 0.3.0 → 0.5.0

data/acceptance/models/author.rb

@@ -0,0 +1,11 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Author < ActiveRecord::Base
+  has_many :posts
+  has_many :comments, through: :posts
+  belongs_to :organization
+end

data/acceptance/models/club.rb

@@ -0,0 +1,12 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Club < ActiveRecord::Base
+  has_many :memberships
+  has_many :members, through: :memberships
+  has_many :favourites, -> { where(memberships: { favourite: true }) },
+           through: :memberships, source: :member
+end

data/acceptance/models/comment.rb

@@ -0,0 +1,9 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Comment < ActiveRecord::Base
+  belongs_to :post, counter_cache: true
+end

data/acceptance/models/customer.rb

@@ -0,0 +1,9 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Customer < ActiveRecord::Base
+  has_many :accounts
+end

data/acceptance/models/department.rb

@@ -0,0 +1,9 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Department < ActiveRecord::Base
+  belongs_to :resource, polymorphic: true
+end

data/acceptance/models/firm.rb

@@ -0,0 +1,10 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Firm < ActiveRecord::Base
+  has_one :account
+  has_many :departments, as: :resource
+end

data/acceptance/models/member.rb

@@ -0,0 +1,13 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Member < ActiveRecord::Base
+  has_one :membership
+  has_one :club, through: :membership
+  has_one :favourite_club, -> { where "memberships.favourite = ?", true },
+          through: :membership, source: :club
+  belongs_to :member_type
+end

data/acceptance/models/member_type.rb

@@ -0,0 +1,9 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class MemberType < ActiveRecord::Base
+  has_many :members
+end

data/acceptance/models/membership.rb

@@ -0,0 +1,10 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Membership < ActiveRecord::Base
+  belongs_to :member
+  belongs_to :club
+end

data/acceptance/models/organization.rb

@@ -0,0 +1,9 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Organization < ActiveRecord::Base
+  has_many :authors, dependent: :destroy
+end

data/acceptance/models/post.rb

@@ -0,0 +1,10 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Post < ActiveRecord::Base
+  belongs_to :author
+  has_many :comments
+end

data/acceptance/models/singer.rb

@@ -0,0 +1,10 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Singer < ActiveRecord::Base
+  has_many :albums, foreign_key: "singerid", dependent: :delete_all
+  has_many :tracks, foreign_key: "singerid"
+end

data/acceptance/models/track.rb

@@ -0,0 +1,20 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Track < ActiveRecord::Base
+  belongs_to :album, foreign_key: "albumid"
+  belongs_to :singer, foreign_key: "singerid", counter_cache: true
+
+  def initialize attributes = nil
+    super
+    self.singer ||= self.album&.singer
+  end
+
+  def album=value
+    super
+    self.singer = value&.singer
+  end
+end

data/acceptance/models/transaction.rb

@@ -0,0 +1,9 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+class Transaction < ActiveRecord::Base
+  belongs_to :account, counter_cache: true
+end

data/acceptance/schema/schema.rb

@@ -0,0 +1,143 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define do
+  ActiveRecord::Base.connection.ddl_batch do
+    create_table :all_types do |t|
+      t.column :col_string, :string
+      t.column :col_int64, :bigint
+      t.column :col_float64, :float
+      t.column :col_numeric, :numeric
+      t.column :col_bool, :boolean
+      t.column :col_bytes, :binary
+      t.column :col_date, :date
+      t.column :col_timestamp, :datetime
+
+      t.column :col_array_string, :string, array: true
+      t.column :col_array_int64, :bigint, array: true
+      t.column :col_array_float64, :float, array: true
+      t.column :col_array_numeric, :numeric, array: true
+      t.column :col_array_bool, :boolean, array: true
+      t.column :col_array_bytes, :binary, array: true
+      t.column :col_array_date, :date, array: true
+      t.column :col_array_timestamp, :datetime, array: true
+    end
+
+    create_table :firms do |t|
+      t.string  :name
+      t.integer :rating
+      t.string :description
+      t.references :account
+    end
+
+    create_table :customers do |t|
+      t.string  :name
+    end
+
+    create_table :accounts do |t|
+      t.references :customer, index: false
+      t.references :firm, index: false
+      t.string  :name
+      t.integer :credit_limit
+      t.integer :transactions_count
+    end
+
+    create_table :transactions do |t|
+      t.float :amount
+      t.references :account, index: false
+    end
+
+    create_table :departments do |t|
+      t.string :name
+      t.references :resource, polymorphic: true
+    end
+
+    create_table :member_types do |t|
+      t.string :name
+    end
+
+    create_table :members do |t|
+      t.string :name
+      t.references :member_type, index: false
+      t.references :admittable, polymorphic: true, index: false
+    end
+
+    create_table :memberships do |t|
+      t.datetime :joined_on
+      t.references :club, index: false
+      t.references :member, index: false
+      t.boolean :favourite
+    end
+
+    create_table :clubs do |t|
+      t.string :name
+    end
+
+    create_table :authors do |t|
+      t.string :name, null: false
+      t.date :registered_date
+      t.references :organization, index: false
+    end
+
+    create_table :posts do |t|
+      t.string :title
+      t.string :content
+      t.references :author
+      t.integer :comments_count
+      t.date :post_date
+      t.time :published_time
+    end
+
+    create_table :comments do |t|
+      t.string :comment
+      t.references :post, index: false, foreign_key: true
+    end
+
+    create_table :addresses do |t|
+      t.string :line1
+      t.string :postal_code
+      t.string :city
+      t.references :author, index: false
+    end
+
+    create_table :organizations do |t|
+      t.string :name
+      t.datetime :last_updated, allow_commit_timestamp: true
+    end
+
+    create_table :singers, id: false do |t|
+      t.primary_key :singerid
+      t.column :first_name, :string, limit: 200
+      t.string :last_name
+      t.integer :tracks_count
+      t.integer :lock_version
+      t.string :full_name, as: "COALESCE(first_name || ' ', '') || last_name", stored: true
+    end
+
+    create_table :albums, id: false do |t|
+      t.interleave_in :singers
+      t.primary_key :albumid
+      # `singerid` is part of the primary key in the table definition, but it is not visible to ActiveRecord as part of
+      # the primary key, to prevent ActiveRecord from considering this to be an entity with a composite primary key.
+      t.parent_key :singerid
+      t.string :title
+      t.integer :lock_version
+    end
+
+    create_table :tracks, id: false do |t|
+      # `:cascade` causes all tracks that belong to an album to automatically be deleted when an album is deleted.
+      t.interleave_in :albums, :cascade
+      t.primary_key :trackid
+      t.parent_key :singerid
+      t.parent_key :albumid
+      t.string :title
+      t.numeric :duration
+      t.integer :lock_version
+    end
+  end
+end

data/acceptance/test_helper.rb

@@ -0,0 +1,260 @@
+# Copyright 2020 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+gem "minitest"
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/rg"
+require "active_support"
+require "google/cloud/spanner"
+require "active_record"
+require "active_support/testing/stream"
+require "activerecord-spanner-adapter"
+require "active_record/connection_adapters/spanner_adapter"
+require "securerandom"
+
+# rubocop:disable Style/GlobalVars
+
+$spanner_test_database = "ar-test-#{SecureRandom.hex 4}"
+
+def connector_config
+  {
+    "adapter" => "spanner",
+    "emulator_host" => ENV["SPANNER_EMULATOR_HOST"],
+    "project" => ENV["SPANNER_TEST_PROJECT"],
+    "instance" => ENV["SPANNER_TEST_INSTANCE"],
+    "credentials" => ENV["SPANNER_TEST_KEYFILE"],
+    "database" => $spanner_test_database
+  }
+end
+
+def spanner
+  $spanner ||= Google::Cloud::Spanner.new(
+    project_id: ENV["SPANNER_TEST_PROJECT"],
+    credentials: ENV["SPANNER_TEST_KEYFILE"]
+  )
+end
+
+def spanner_instance
+  unless spanner.instance ENV["SPANNER_TEST_INSTANCE"]
+    config = ENV["SPANNER_EMULATOR_HOST"] ? "emulator-config" : "regional-us-central1"
+    puts "Creating test instance #{ENV["SPANNER_TEST_INSTANCE"]} with config #{config}"
+    job = spanner.create_instance ENV["SPANNER_TEST_INSTANCE"],
+                                  name:   "ActiveRecord Test Instance",
+                                  config: config,
+                                  nodes:  1
+    job.wait_until_done!
+    $owned_test_instance = true
+  end
+  $spanner_instance ||= spanner.instance ENV["SPANNER_TEST_INSTANCE"]
+end
+
+def create_test_database
+  job = spanner_instance.create_database $spanner_test_database
+  job.wait_until_done!
+  if job.error?
+    raise "Error in creating database. Error code#{job.error.message}"
+  end
+
+  puts "'#{$spanner_test_database}' test db created."
+
+  puts "Loading test schema..."
+  ActiveRecord::Base.establish_connection connector_config
+  require_relative "schema/schema"
+end
+
+def drop_test_database
+  ActiveRecord::Base.connection_pool.disconnect!
+  spanner_instance&.delete if $owned_test_instance
+  spanner_instance.database($spanner_test_database)&.drop unless $owned_test_instance
+
+  puts "Test instance #{spanner_instance} deleted" if $owned_test_instance
+  puts "#{$spanner_test_database} database deleted" unless $owned_test_instance
+end
+
+def current_adapter? *names
+  names.include? :SpannerAdapter
+end
+
+def load_test_schema
+  ActiveRecord::Base.establish_connection connector_config
+
+  require_relative "schema/schema"
+end
+
+module SpannerAdapter
+  class TestCase < ActiveSupport::TestCase
+    def assert_column(model, column_name, msg = nil)
+      assert has_column?(model, column_name), msg
+    end
+
+    def assert_no_column(model, column_name, msg = nil)
+      assert_not has_column?(model, column_name), msg
+    end
+
+    def has_column?(model, column_name)
+      model.reset_column_information
+      model.column_names.include?(column_name.to_s)
+    end
+
+    def capture_sql
+      ActiveRecord::Base.connection.materialize_transactions
+      SQLCounter.clear_log
+      yield
+      SQLCounter.log.dup
+    end
+
+    def assert_queries(num = 1, options = {})
+      ignore_none = options.fetch(:ignore_none) { num == :any }
+      ActiveRecord::Base.connection.materialize_transactions
+      SQLCounter.clear_log
+      x = yield
+      the_log = ignore_none ? SQLCounter.log_all : SQLCounter.log
+      if num == :any
+        assert_operator the_log.size, :>=, 1, "1 or more queries expected, but none were executed."
+      else
+        mesg = "#{the_log.size} instead of #{num} queries were executed.#{the_log.size == 0 ? '' : "\nQueries:\n#{the_log.join("\n")}"}"
+        assert_equal num, the_log.size, mesg
+      end
+      x
+    end
+
+    def assert_no_queries(options = {}, &block)
+      options.reverse_merge! ignore_none: true
+      assert_queries(0, options, &block)
+    end
+  end
+
+  module Migration
+    module TestHelper
+      attr_accessor :connection
+
+      CONNECTION_METHODS = %w[
+        add_column remove_column rename_column add_index change_column
+        rename_table column_exists? index_exists?
+        add_reference add_belongs_to remove_reference remove_references
+        remove_belongs_to change_column_default
+      ].freeze
+
+      class TestModel < ActiveRecord::Base
+        self.table_name = :test_models
+      end
+
+      def setup
+        ActiveRecord::Base.establish_connection connector_config
+        @connection = ActiveRecord::Base.connection
+
+        unless @skip_test_table_create
+          connection.create_table :test_models do |t|
+            t.timestamps null: true
+          end
+
+          TestModel.reset_column_information
+        end
+        super
+      end
+
+      def skip_test_table_create!
+        @skip_test_table_create = true
+      end
+
+      def teardown
+        TestModel.reset_table_name
+
+        unless @skip_test_table_create
+          connection.drop_table :test_models, if_exists: true
+        end
+
+        super
+      end
+
+      def generate_id
+        connection.next_sequence_value nil
+      end
+
+      delegate *CONNECTION_METHODS, to: :connection
+    end
+  end
+
+  module Types
+    module TestHelper
+      attr_accessor :connection
+
+      class TestTypeModel < ActiveRecord::Base
+        self.table_name = :test_types
+      end
+
+      def setup
+        super
+
+        ActiveRecord::Base.establish_connection connector_config
+        @connection = ActiveRecord::Base.connection
+
+        return if connection.table_exists? :test_types
+
+        connection.create_table :test_types do |t|
+          t.string :name, limit: 255
+          t.string :description
+          t.text :bio
+          t.integer :length
+          t.float :weight
+          t.numeric :price
+          t.boolean :active
+          t.binary :file
+          t.binary :data, limit: 255
+          t.date :start_date
+          t.datetime :start_datetime
+          t.time :start_time
+        end
+      end
+
+      def teardown
+        super
+        TestTypeModel.delete_all
+      end
+    end
+  end
+
+  module Associations
+    module TestHelper
+      def setup
+        ActiveRecord::Base.establish_connection connector_config
+        @connection = ActiveRecord::Base.connection
+      end
+    end
+  end
+
+  class SQLCounter
+    class << self
+      attr_accessor :ignored_sql, :log, :log_all
+
+      def clear_log
+        self.log = []
+        self.log_all = []
+      end
+    end
+
+    clear_log
+
+    def call(name, start, finish, message_id, values)
+      return if values[:cached]
+
+      sql = values[:sql]
+      self.class.log_all << sql
+      self.class.log << sql unless ["SCHEMA", "TRANSACTION"].include? values[:name]
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe("sql.active_record", SQLCounter.new)
+end
+
+Minitest.after_run do
+  drop_test_database
+end
+
+create_test_database
+
+# rubocop:enable Style/GlobalVars