database_cleaner-spanner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c8d719d3f246b5bda9a82752ffbea98675e9776f10310eea0b94ef3a3f44a71
+  data.tar.gz: 6bff1b7b11584e8c81cfb0b26ab0675b217c0a8e5888c0e901713f12feafc89e
+SHA512:
+  metadata.gz: 1a221c3bc36d5280d1b11588d30e3cb7ad855eb7589feb5f59b0ebaaeb66a4c9ee066f21402aa0ea33a7dfbe69acde970919ac8cedbc6ad779a9459f8fadc390
+  data.tar.gz: c42d9eb77c819a65d241614395a42ae8bb1a409dcbc91fe557dea8daa34308b6ee37fb79f35879f5405b3f386b6ce3c6f3f4be1e7126dba745c1b41d1c910b8d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at nownabe@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in database_cleaner-spanner.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/README.md

@@ -0,0 +1,106 @@
+# Database Claner Adapter for Cloud Spanner
+
+Clean your Cloud Spanner databases with Database Cleaner.
+
+See also [https://github.com/DatabaseCleaner/database_cleaner](https://github.com/DatabaseCleaner/database_cleaner) for more information.
+
+## Motivation
+
+* You cannot use [rspec-rails's `use_transactional_fixtures` option](https://relishapp.com/rspec/rspec-rails/v/6-0/docs/transactions) for Cloud Spanner because
+  [ActiveRecord Cloud Spanner Adapter](https://github.com/googleapis/ruby-spanner-activerecord) doesn't support nested transactions.
+* [database_cleaner-active_record](https://github.com/DatabaseCleaner/database_cleaner-active_record) doesn't support Cloud Spanner perfectly.
+  * Transaction strategy cannot be used for the same reason as the `use_transactional_fixtures` option.
+  * Truncation strategy isn't available because Cloud Spanner doesn't support `TRUNCATE` statement.
+  * Deletion strategy is incompatible with Cloud Spanner because `DELETE FROM <table>` statement executed by the deletion strategy doesn't work on Cloud Spanner.
+* Cloud Spanner is sometimes used with [Spanner Client](https://github.com/googleapis/ruby-spanner) instead of ActiveRecord.
+* If tables are interleaved, the order of deletion needs to be considered.
+* If tables has foreign key constraints, the order of deletion needs to be considered.
+
+The core ideas of database_cleaner-spanner are:
+
+* no dependence on ActiveRecord
+* consider deletion orders based on actual schema
+
+**NOTE:** This gem determines deletion orders based on dependency graph of tables using the topological sort algorithm, which means `only` option and `except` option don't guarantees removal of as many tables as dependencies allow.
+
+## Installation
+
+```ruby
+# Gemfile
+group :test do
+  gem "database_cleaner-spanner"
+end
+```
+
+## Example
+
+Configuration for RSpec on Rails:
+
+```ruby
+# spec/rails_helper.rb
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.around(:each) do |example|
+    DatabaseCleaner[:spanner].cleaning do
+      example.run
+    end
+  end
+end
+```
+
+## Supported strategies
+
+The Cloud Spanner adapter has only the deletion strategy.
+
+## Strategy configuration options
+
+* `:cache_tables` - When set to `true`, the list of tables to delete and the deletion orders will be
+  read from the Cloud Spanner once, otherwise they will be read before each deletion. Defaults to
+  `true`.
+
+## Adapter configuration options
+
+You need to specify instance and database, or to pass an instance of Spanner client.
+If you're using ActiveRecord, you can use database name on ActiveRecord.
+This adapter tries to get database configurations from ActiveRecord.
+
+```ruby
+# Specify instance and database with default credentials and project ID.
+DatabaseCleaner[:spanner].db = {
+  instance_id: "my-instance",
+  database_id: "my-database",
+}
+
+# In addition, specify project ID and credentials.
+DatabaseCleaner[:spanner].db = {
+  credentials: "/path/to/key.json",
+  project_id: "my-project",
+  instance_id: "my-instance",
+  database_id: "my-database",
+}
+
+# ActiveRecord database name
+DatabaseCleaner[:spanner].db = "secondary"
+
+# Spanner client object
+DatabaseCleaner[:spanner].db =
+  Google::Cloud::Spanner.new.client("my-instance", "my-database")
+```
+
+See [Spanner client reference](https://googleapis.dev/ruby/google-cloud-spanner/latest/Google/Cloud/Spanner.html#new-class_method) for more database options.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nownabe/database_cleaner-spanner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nownabe/database_cleaner-spanner/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the DatabaseCleaner::Spanner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nownabe/database_cleaner-spanner/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/database_cleaner-spanner.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/database_cleaner/spanner/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "database_cleaner-spanner"
+  spec.version = DatabaseCleaner::Spanner::VERSION
+  spec.authors = ["nownabe"]
+  spec.email = ["nownabe@gmail.com"]
+
+  spec.summary = "Strategies for cleaning tables on Cloud Spanner. Can be used to ensure a clean state for testing."
+  spec.description = "Strategies for cleaning tables on Cloud Spanner. Can be used to ensure a clean state for testing."
+  spec.homepage = "https://github.com/nownabe/database_cleaner-spanner"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "google-cloud-spanner", "~> 2.10"
+  spec.add_dependency "database_cleaner-core", "~> 2.0.0"
+end

data/lib/database_cleaner/spanner/deletion.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "database_cleaner/strategy"
+require "database_cleaner/spanner/table_dependency"
+
+module DatabaseCleaner
+  module Spanner
+    class Deletion < Strategy
+      SQL = <<~SQL
+        WITH References AS (
+          SELECT
+            ccu.TABLE_NAME AS TABLE_NAME
+            , tc.TABLE_NAME AS referenced_by
+          FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS tc
+          INNER JOIN INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE AS ccu USING (CONSTRAINT_NAME)
+          WHERE
+            CONSTRAINT_TYPE = "FOREIGN KEY"
+            AND tc.TABLE_NAME <> ccu.TABLE_NAME
+        )
+        SELECT
+          t.TABLE_NAME AS table_name
+          , children.TABLE_NAME AS child_table_name
+          , children.ON_DELETE_ACTION AS delete_action
+          , r.referenced_by AS referenced_by
+        FROM INFORMATION_SCHEMA.TABLES AS t
+        LEFT JOIN INFORMATION_SCHEMA.TABLES AS children
+          ON t.TABLE_NAME = children.PARENT_TABLE_NAME
+        LEFT JOIN References AS r
+          ON t.TABLE_NAME = r.table_name
+        WHERE t.TABLE_TYPE = "BASE TABLE"
+      SQL
+
+      def initialize(
+        only: [],
+        except: [],
+        cache_tables: true
+      )
+        @only = only
+        @except = except
+        @cache_tables = cache_tables
+
+        @deletable_tables = {}
+      end
+
+      def clean
+        sorted_table_groups.each do |group|
+          clean_table_group(group)
+        end
+      end
+
+      private
+
+      def clean_table_group(group)
+        group.each do |table|
+          client.delete(table) if deletable?(table)
+        end
+      end
+
+      def deletable?(table)
+        return true if @only.empty? && @except.empty?
+
+        return @deletable_tables[table] if @deletable_tables.key?(table)
+
+        @deletable_tables[table] =
+          if @only.empty?
+            !@except.include?(table)
+          else
+            (@only - @except).include?(table)
+          end
+      end
+
+      def sorted_table_groups
+        return @sorted_table_groups if @cache_tables && @sorted_table_groups
+
+        dep = TableDependency.new
+        result = client.execute_query(SQL)
+
+        result.rows.each do |row|
+          dep.add_child(row[:table_name], row[:child_table_name])
+          dep.add_child(row[:table_name], row[:referenced_by])
+        end
+
+        @sorted_table_groups = dep.divide.map(&:tsort)
+      end
+
+      def client
+        @client ||=
+          if db.is_a?(Google::Cloud::Spanner::Client)
+            db
+          elsif db.is_a?(Hash)
+            Google::Cloud::Spanner.new(
+              project_id: db[:project_id],
+              credentials: db[:credentials]
+            ).client(db[:instance_id], db[:database_id])
+          else
+            configure_client_from_active_record(db)
+          end
+      end
+
+      def configure_client_from_active_record(name)
+        # "primary" is hardcoded in ActiveRecord
+        # https://github.com/rails/rails/blob/v7.0.4/activerecord/lib/active_record/database_configurations.rb
+        name = "primary" if name == :default
+
+        # DB config from ActiveRecord
+        config = ActiveRecord::Base.configurations.configs_for(name: name.to_s).configuration_hash
+
+        # Keep metadata tables
+        @except << ActiveRecord::SchemaMigration.table_name # schema_migrations
+        @except << ActiveRecord::Base.internal_metadata_table_name # ar_internal_metadata
+
+        Google::Cloud::Spanner.new(
+          project_id: config[:project],
+          credentials: config[:credentials]
+        ).client(config[:instance], config[:database])
+      end
+    end
+  end
+end

data/lib/database_cleaner/spanner/table_dependency.rb

@@ -0,0 +1,73 @@
+require "set"
+require "tsort"
+
+module DatabaseCleaner
+  module Spanner
+    class TableDependency < Hash
+      include TSort
+
+      def initialize
+        @parents = Hash.new { |h, k| h[k] = Set.new }
+      end
+
+      def add_child(parent, child)
+        store(parent, Set.new) unless key?(parent)
+
+        return if child.nil?
+
+        store(child, Set.new) unless key?(child)
+
+        fetch(parent).add(child)
+
+        @parents[child].add(parent)
+      end
+
+      def add_children(parent, children)
+        store(parent, children || Set.new)
+        children.each { |child| @parents[child].add(parent) }
+      end
+
+      def divide
+        groups = []
+        visited = Set.new
+
+        each_table do |table|
+          next if visited.include?(table)
+
+          group = TableDependency.new
+          dfs(table, group, visited)
+          groups << group
+        end
+
+        groups
+      end
+
+      alias_method :each_table, :each_key
+
+      def tsort_each_child(node, &block)
+        fetch(node).each(&block)
+      end
+
+      alias_method :tsort_each_node, :each_key
+
+      private
+
+      def dfs(table, group, visited)
+        visited.add(table)
+        children = fetch(table)
+        group.add_children(table, children)
+
+        related_tables = if @parents.key?(table)
+          children + @parents[table]
+        else
+          children
+        end
+
+        related_tables.each do |table|
+          next if visited.include?(table)
+          dfs(table, group, visited)
+        end
+      end
+    end
+  end
+end

data/lib/database_cleaner/spanner/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DatabaseCleaner
+  module Spanner
+    VERSION = "0.1.0"
+  end
+end

data/lib/database_cleaner/spanner.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "database_cleaner/spanner/version"
+require "database_cleaner/core"
+require "database_cleaner/spanner/deletion"
+
+DatabaseCleaner[:spanner].strategy = :deletion

data/lib/database_cleaner-spanner.rb

@@ -0,0 +1 @@
+require "database_cleaner/spanner"

data/sig/database_cleaner/spanner.rbs

@@ -0,0 +1,6 @@
+module DatabaseCleaner
+  module Spanner
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: database_cleaner-spanner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nownabe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-spanner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Strategies for cleaning tables on Cloud Spanner. Can be used to ensure
+  a clean state for testing.
+email:
+- nownabe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- database_cleaner-spanner.gemspec
+- lib/database_cleaner-spanner.rb
+- lib/database_cleaner/spanner.rb
+- lib/database_cleaner/spanner/deletion.rb
+- lib/database_cleaner/spanner/table_dependency.rb
+- lib/database_cleaner/spanner/version.rb
+- sig/database_cleaner/spanner.rbs
+homepage: https://github.com/nownabe/database_cleaner-spanner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nownabe/database_cleaner-spanner
+  source_code_uri: https://github.com/nownabe/database_cleaner-spanner
+  changelog_uri: https://github.com/nownabe/database_cleaner-spanner/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Strategies for cleaning tables on Cloud Spanner. Can be used to ensure a
+  clean state for testing.
+test_files: []