activerecord-spanner-adapter 0.3.0 → 0.5.0

data/Rakefile

@@ -1,6 +1,82 @@
+# 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.
+
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
+require "securerandom"
+
+desc "Run tests."
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task :default => :test
+
+require "yard"
+require "yard/rake/yardoc_task"
+YARD::Rake::YardocTask.new do |y|
+  # y.options << "--fail-on-warning"
+end
+
+desc "Run the spanner connector acceptance tests."
+task :acceptance, [:project, :keyfile, :instance, :tests] do |t, args|
+  project = args[:project]
+  project ||= ENV["SPANNER_TEST_PROJECT"] || ENV["GCLOUD_TEST_PROJECT"]
+  emulator_host = args[:emulator_host]
+  emulator_host ||= ENV["SPANNER_EMULATOR_HOST"]
+  keyfile = args[:keyfile]
+  keyfile ||= ENV["SPANNER_TEST_KEYFILE"] || ENV["GCLOUD_TEST_KEYFILE"] || ENV["GOOGLE_APPLICATION_CREDENTIALS"]
+  if keyfile
+    keyfile = File.read keyfile
+  else
+    keyfile ||= ENV["SPANNER_TEST_KEYFILE_JSON"] || ENV["GCLOUD_TEST_KEYFILE_JSON"]
+  end
+  if project.nil? || (keyfile.nil? && emulator_host.nil?)
+    fail "You must provide a project and keyfile or emulator host name."
+  end
+  instance = args[:instance]
+  instance ||= ENV["SPANNER_TEST_INSTANCE"]
+  if instance.nil?
+    fail "You must provide an instance name"
+  end
+
+  # clear any env var already set
+  require "google/cloud/spanner/credentials"
+  Google::Cloud::Spanner::Credentials.env_vars.each do |path|
+    ENV[path] = nil
+  end
+
+  tests = args[:tests]
+  tests ||= "**"
+
+  # always overwrite when running tests
+  ENV["SPANNER_PROJECT"] = project
+  ENV["SPANNER_KEYFILE_JSON"] = keyfile
+  ENV["SPANNER_TEST_INSTANCE"] = instance
+  ENV["SPANNER_EMULATOR_HOST"] = emulator_host
+
+  Rake::TestTask.new :run do |t|
+    t.libs << "acceptance"
+    t.libs << "lib"
+    t.test_files = FileList["acceptance/#{tests}/*_test.rb"] unless tests.start_with? "exclude "
+    t.test_files = FileList.new("acceptance/**/*_test.rb") do |fl|
+      fl.exclude "acceptance/#{tests.split(" ")[1]}/*_test.rb"
+      puts "excluding acceptance/#{tests.split(" ")[1]}/*_test.rb"
+    end if tests.start_with? "exclude"
+    t.warning = false
+  end
 
-RSpec::Core::RakeTask.new("spec")
-task :default => :spec
+  Rake::Task["run"].invoke
+end
 
+desc +"Runs the `examples/snippets/quickstart` example on a Spanner emulator. See the directory `examples/snippets`"
+      "for more examples."
+task :example do
+  Dir.chdir("examples/snippets/quickstart") { sh "bundle exec rake run" }
+end

data/SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
+
+The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
+
+We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.

data/acceptance/cases/associations/has_many_associations_test.rb

@@ -0,0 +1,119 @@
+# 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
+
+require "test_helper"
+require "models/firm"
+require "models/account"
+require "models/transaction"
+require "models/department"
+require "models/customer"
+
+module ActiveRecord
+  module Associations
+    class HasManyTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Associations::TestHelper
+
+      attr_accessor :customer
+
+      def setup
+        super
+
+        @customer = Customer.create name: "Customer - 1"
+
+        Account.create name: "Account - 1", customer: customer, credit_limit: 100
+        Account.create name: "Account - 2", customer: customer, credit_limit: 200
+      end
+
+      def teardown
+        Customer.destroy_all
+        Account.destroy_all
+      end
+
+      def test_has_many
+        assert_equal 2, customer.accounts.count
+        assert_equal customer.accounts.pluck(:credit_limit).sort, [100, 200]
+      end
+
+      def test_finding_using_associated_fields
+        assert_equal Account.where(customer_id: customer.id).to_a, customer.accounts.to_a
+      end
+
+      def test_successful_build_association
+        account = customer.accounts.build(name: "Account - 3", credit_limit: 1000)
+        assert account.save
+
+        customer.reload
+        assert_equal account, customer.accounts.find(account.id)
+      end
+
+      def test_create_and_destroy_associated_records
+        customer2 = Customer.new name: "Customer - 2"
+        customer2.accounts.build name: "Account - 11", credit_limit: 100
+        customer2.accounts.build name: "Account - 12", credit_limit: 200
+        customer2.save!
+
+        customer2.reload
+
+        assert_equal 2, customer2.accounts.count
+        assert_equal 4, Account.count
+
+        customer2.accounts.destroy_all
+        customer2.reload
+
+        assert_equal 0, customer2.accounts.count
+        assert_equal 2, Account.count
+      end
+
+      def test_create_and_delete_associated_records
+        customer2 = Customer.new name: "Customer - 2"
+        customer2.accounts.build name: "Account - 11", credit_limit: 100
+        customer2.accounts.build name: "Account - 12", credit_limit: 200
+        customer2.save!
+
+        customer2.reload
+
+        assert_equal 2, customer2.accounts.count
+        assert_equal 4, Account.count
+
+        assert_equal 2, customer2.accounts.delete_all
+        customer2.reload
+
+        assert_equal 0, customer2.accounts.count
+        assert_equal 2, Account.where(customer_id: nil).count
+      end
+
+      def test_update_associated_records
+        count = customer.accounts.update_all(name: "Account - Update", credit_limit: 1000)
+        assert_equal customer.accounts.count, count
+
+        customer.reload
+        customer.accounts.each do |account|
+          assert_equal "Account - Update", account.name
+          assert_equal 1000, account.credit_limit
+        end
+      end
+
+      def test_fetch_associated_record_with_order
+        accounts = customer.accounts.order(credit_limit: :desc)
+        assert_equal [200, 100], accounts.pluck(:credit_limit)
+
+        accounts = customer.accounts.order(credit_limit: :asc)
+        assert_equal [100, 200], accounts.pluck(:credit_limit)
+      end
+
+      def test_set_counter_cache
+        account = Account.first
+        account.transactions.create!(amount: 10)
+        account.transactions.create!(amount: 20)
+
+        account.reload
+        assert_equal 2, account.transactions_count
+      end
+    end
+  end
+end

data/acceptance/cases/associations/has_many_through_associations_test.rb

@@ -0,0 +1,63 @@
+# 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
+
+require "test_helper"
+require "models/member"
+require "models/membership"
+require "models/member_type"
+require "models/club"
+
+module ActiveRecord
+  module Associations
+    class HasManyThroughTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Associations::TestHelper
+
+      attr_accessor :club, :member_one, :member_two
+
+      def setup
+        super
+
+        @club = Club.create name:  "Club - 1"
+        @member_one = Member.create name: "Member - 1"
+        @member_two = Member.create name: "Member - 2"
+      end
+
+      def teardown
+        Member.destroy_all
+        Club.destroy_all
+      end
+
+      def test_has_many_through_create_record
+        assert club.members.create!(name: "Member - 3")
+      end
+
+      def test_through_association_with_joins
+        club.members = [member_one, member_two]
+        assert_equal [club, club], Club.where(id: club.id).joins(:members).to_a
+      end
+
+      def test_set_record_after_delete_association
+        club.members = [member_one, member_two]
+        club.reload
+        assert_equal 2, club.members.count
+
+        club.members = []
+        club.reload
+        assert_empty club.members
+      end
+
+      def test_has_many_through_eager_loading
+        club.members = [member_one, member_two]
+
+        clubs = Club.includes(:members).all.to_a
+        assert_equal 1, clubs.size
+        assert_not_nil assert_no_queries { clubs[0].members }
+      end
+    end
+  end
+end

data/acceptance/cases/associations/has_one_associations_test.rb

@@ -0,0 +1,79 @@
+# 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
+
+require "test_helper"
+require "models/firm"
+require "models/account"
+require "models/department"
+
+
+module ActiveRecord
+  module Associations
+    class HasOneTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Associations::TestHelper
+
+      attr_accessor :firm, :account
+
+      def setup
+        super
+
+        @account = Account.create name: "Account - #{rand 1000}", credit_limit: 100
+        @firm = Firm.create name: "Firm-#{rand 1000}", account: account
+
+        @account.reload
+        @firm.reload
+      end
+
+      def teardown
+        Firm.destroy_all
+        Account.destroy_all
+        Department.destroy_all
+      end
+
+      def test_has_one
+        assert_equal account, firm.account
+        assert_equal account.credit_limit, firm.account.credit_limit
+      end
+
+      def test_has_one_does_not_use_order_by
+        sql_log = capture_sql { firm.account }
+        assert sql_log.all? { |sql| !/order by/i.match?(sql) }, "ORDER BY was used in the query: #{sql_log}"
+      end
+
+      def test_finding_using_primary_key
+        assert_equal Account.find_by(firm_id: firm.id), firm.account
+      end
+
+      def test_successful_build_association
+        account = firm.build_account(credit_limit: 1000)
+        assert account.save
+
+        firm.reload
+        assert_equal account, firm.account
+      end
+
+      def test_delete_associated_records
+        assert_equal account, firm.account
+
+        firm.account.destroy
+        firm.reload
+        assert_nil firm.account
+      end
+
+      def test_polymorphic_association
+        assert_equal 0, firm.departments.count
+
+        firm.departments.create(name: "Department - 1")
+        firm.reload
+
+        assert_equal 1, firm.departments.count
+        assert_equal "Department - 1", firm.departments.first.name
+      end
+    end
+  end
+end

data/acceptance/cases/associations/has_one_through_associations_test.rb

@@ -0,0 +1,98 @@
+# 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
+
+require "test_helper"
+require "models/member"
+require "models/membership"
+require "models/member_type"
+require "models/club"
+
+module ActiveRecord
+  module Associations
+    class HasOneThroughTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Associations::TestHelper
+
+      attr_accessor :club, :member, :member_type
+
+      def setup
+        super
+
+        @club = Club.create name:  "Club - 1"
+        @member_type = MemberType.create name: "MemberType - 1"
+        @member = Member.create name: "Member - 1"
+      end
+
+      def teardown
+        Member.destroy_all
+        Club.destroy_all
+        Membership.destroy_all
+        MemberType.destroy_all
+      end
+
+      def test_has_one_through
+        member.club = club
+        member.reload
+        assert_equal club, member.club
+      end
+
+      def test_creating_association_creates_through_record
+        member.club = club
+
+        assert_equal member.id, member.membership.member_id
+        assert_equal club.id, member.membership.club.id
+        assert_equal club, member.club
+      end
+
+      def test_set_record_to_nil_should_delete_association
+        member.club = club
+        member.reload
+        assert_equal club, member.club
+
+        member.club = nil
+        member.reload
+        assert_nil member.membership
+        assert_nil member.club
+      end
+
+      def test_set_record_after_delete_association
+        member.club = club
+        member.reload
+        assert_equal club, member.club
+
+        member.club = nil
+        member.reload
+        assert_nil member.membership
+        assert_nil member.club
+
+        club = Club.create name: "Club - 2"
+        member.club = club
+        member.reload
+        assert_equal club, member.club
+      end
+
+      def test_has_one_through_eager_loading
+        member.club = club
+
+        members = Member.includes(:club).all.to_a
+        assert_equal 1, members.size
+        assert_not_nil assert_no_queries { members[0].club }
+      end
+
+      def test_has_one_through_with_where_condition
+        member.favourite_club = club
+        membership = member.membership
+        membership.favourite = true
+        membership.save
+
+        member.reload
+
+        assert_equal member.favourite_club, club
+      end
+    end
+  end
+end