cassandra-schema 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56d06dbe1704f5dde353807ef36e71c49b6cd431
-  data.tar.gz: 3010c1e9b8556c0c8556ab95007299c4d925f0cc
+  metadata.gz: b8952ab5b3596d5370d883b95b1fd0729db5aa1d
+  data.tar.gz: 89eb6476ec2461fe77b5f531c1c42a7bdbb27e7d
 SHA512:
-  metadata.gz: a769484a9b5ea4d7edd06a783e1e2f29176ff0fbe4ba2ade021ac6c3829562f2591282ef3f55518d681c5afd21b08fcfaf2e3cf654da6fb76d5e805b569f2be4
-  data.tar.gz: dca8a92e44664c35676cb269d373306f11f63e563802d3f3bc802f5d5fd4d802ca8404c5a83fdf0c46d73bf91f706f3aa9f5a23d85ab911922ba45ea8de30f61
+  metadata.gz: 9e7e3df43fa96784a8486aa3b4f1215090d718b92e77590c9b12e5a88f9abfe92ffd7cf0656917e6826436922ccef564e3791908149bd98522fb419870ef89d6
+  data.tar.gz: 220f759eff1b2c967b559d6850018087e38a6e58bbf13374229dcdbe12de2ea7dfc73f3e11556c5beeefc47c056597bf0c1fd8efb444fefc3ab889a989e790f6

data/README.md

@@ -2,6 +2,13 @@
 
 Simple reversible schema migrations for cassandra.
 
+## Changelog
+
+### Version `0.2.0`
+
+- Refactor `schema_information` queries to use LWT and `:quorum` consistency level
+- Implement a simple locking system to prevent concurrent migrations
+
 ## Usage
 
 CassandraSchema uses a DSL via the `CassandraSchema.migration(version)` method. A migration must have an `up` block with the changes you want to apply to the schema, and a `down` block reversing the change made by `up`.

data/cassandra-schema.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cassandra-schema"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
   s.summary = "Cassandra schema migrations"
   s.license = "MIT"
   s.description = "Simple reversible schema migrations for Cassandra."

data/lib/cassandra-schema/migrator.rb

@@ -2,19 +2,30 @@ require_relative "migration"
 
 module CassandraSchema
   class Migrator
-    attr_reader :connection, :current_version
+    attr_reader :connection, :current_version, :options
 
-    def initialize(connection:, migrations:, logger: Logger.new(STDOUT))
+    DEFAULT_OPTIONS = {
+      lock:         true,
+      lock_timeout: 30,
+    }
+
+    def initialize(connection:, migrations:, logger: Logger.new(STDOUT), options: {})
       @connection = connection
       @logger     = logger
       @migrations = migrations
+      @options    = DEFAULT_OPTIONS.merge(options)
 
       generate_migrator_schema!
-
-      @current_version = get_current_version || init_versioning
     end
 
     def migrate(target = nil)
+      if @options.fetch(:lock) && !lock_schema
+        @logger.info "Can't run migrations. Schema is locked."
+        return
+      end
+
+      @current_version = get_current_version
+
       target ||= @migrations.keys.max || 0
 
       @logger.info "Running migrations..."
@@ -29,12 +40,14 @@ module CassandraSchema
           # excludes current version's up
           (current_version + 1).upto(target) do |next_version|
             migrate_to(next_version, :up)
+            renew_lock if @options.fetch(:lock)
           end
         else
           # includes current version's :down
           # excludes target version's :down
           current_version.downto(target + 1) do |version|
             migrate_to(version, :down)
+            renew_lock if @options.fetch(:lock)
           end
         end
 
@@ -42,35 +55,49 @@ module CassandraSchema
         @logger.info "Done!"
       rescue => ex
         @logger.info "Failed migrating all files. Current schema version: #{@current_version}"
+      ensure
+        unlock_schema if @options.fetch(:lock)
       end
     end
 
     private
 
     def generate_migrator_schema!
-      result = @connection.execute <<~CQL
-        CREATE TABLE IF NOT EXISTS schema_information (
-          name VARCHAR,
-          value VARCHAR,
-          PRIMARY KEY (name)
-        );
-      CQL
+      @connection.execute(
+        <<~CQL,
+          CREATE TABLE IF NOT EXISTS schema_information (
+            name VARCHAR,
+            value VARCHAR,
+            PRIMARY KEY (name)
+          );
+        CQL
+        consistency: :quorum
+      )
+
+      @connection.execute(
+        <<~CQL,
+          INSERT INTO schema_information(name, value)
+          VALUES('version', '0')
+          IF NOT EXISTS
+        CQL
+        consistency: :quorum
+      )
     end
 
     def get_current_version
-      result = @connection.execute <<~CQL
-        SELECT value FROM schema_information WHERE name = 'version'
-      CQL
-
-      result.rows.any? && result.rows.first["value"].to_i
-    end
+      result = @connection.execute(
+        <<~CQL,
+          SELECT value FROM schema_information WHERE name = 'version'
+        CQL
+        consistency: :quorum
+      )
 
-    def init_versioning
-      @connection.execute <<~CQL
-        INSERT INTO schema_information(name, value) VALUES('version', '0')
-      CQL
+      unless result.rows.any?
+        @logger.info "Can't load current schema version."
+        fail
+      end
 
-      0
+      result.rows.first["value"].to_i
     end
 
     def update_version(target)
@@ -78,12 +105,48 @@ module CassandraSchema
         <<~CQL,
           UPDATE schema_information SET value = ? WHERE name = 'version'
         CQL
-        arguments: [target.to_s]
+        arguments: [target.to_s],
+        consistency: :quorum
       )
 
       @current_version = target
     end
 
+    def lock_schema
+      result = @connection.execute(
+        <<~CQL,
+          INSERT INTO schema_information(name, value)
+          VALUES('lock', '1')
+          IF NOT EXISTS
+          USING TTL #{@options.fetch(:lock_timeout)}
+        CQL
+        consistency: :quorum
+      )
+
+      result.rows.first.fetch("[applied]")
+    end
+
+    def renew_lock
+      @connection.execute(
+        <<~CQL,
+          UPDATE schema_information
+          USING TTL #{@options.fetch(:lock_timeout)}
+          SET value = '1'
+          WHERE name = 'lock'
+        CQL
+        consistency: :quorum
+      )
+    end
+
+    def unlock_schema
+      @connection.execute(
+        <<~CQL,
+          DELETE FROM schema_information WHERE name = 'lock' IF EXISTS;
+        CQL
+        consistency: :quorum
+      )
+    end
+
     def migrate_to(target, direction)
       new_version = direction == :up ? target : target - 1
       @logger.info "Migrating to version #{new_version}"

data/lib/cassandra-schema/version.rb

@@ -1,3 +1,3 @@
 module CassandraSchema
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/migrator_test.rb

@@ -74,8 +74,24 @@ describe "CassandraSchema::Migrator" do
       end
 
       down do
+        execute "DROP MATERIALIZED VIEW table_by_description"
+
         execute "ALTER TABLE table_by_name DROP alt_email"
         execute "ALTER TABLE table_by_name DROP email"
+
+        execute <<~CQL
+          CREATE MATERIALIZED VIEW table_by_description AS
+            SELECT
+              id,
+              name,
+              description
+            FROM table_by_name
+            WHERE id IS NOT NULL
+              AND name IS NOT NULL
+              AND description IS NOT NULL
+            PRIMARY KEY (id, description, name)
+            WITH CLUSTERING ORDER BY (description ASC, name ASC)
+        CQL
       end
     end
 
@@ -89,7 +105,9 @@ describe "CassandraSchema::Migrator" do
       logger: @fake_logger,
     )
 
-    assert_equal 0, migrator.current_version
+    result = CONN.execute "SELECT value FROM schema_information WHERE name = 'version'"
+
+    assert result.rows.first.fetch("value")
   end
 
   describe "migrating up" do
@@ -138,6 +156,35 @@ describe "CassandraSchema::Migrator" do
       assert_equal "Failed migrating all files. Current schema version: 2", @fake_logger.stdout.pop
       assert_equal "Missing migration with version 3", @fake_logger.stdout.pop
     end
+
+    it "fails if another migration is running" do
+      migrator_a = CassandraSchema::Migrator.new(
+        connection: CONN,
+        migrations: CassandraSchema.migrations,
+        logger: @fake_logger,
+      )
+
+      thr = Thread.new do
+        migrator_a.migrate
+      end
+
+      logger_b   = FakeLogger.new
+      migrator_b = CassandraSchema::Migrator.new(
+        connection: CONN,
+        migrations: CassandraSchema.migrations,
+        logger: logger_b,
+      )
+
+      migrator_b.migrate
+
+      assert_equal "Can't run migrations. Schema is locked.", logger_b.stdout.pop
+
+      thr.join
+
+      migrator_b.migrate
+
+      assert_equal "Nothing to migrate.", logger_b.stdout.pop
+    end
   end
 
   describe "migrating down" do
@@ -152,8 +199,15 @@ describe "CassandraSchema::Migrator" do
     end
 
     it "migrates to target version" do
-      @migrator.migrate(1)
-      assert_equal 1, @migrator.current_version
+      logger   = FakeLogger.new
+      migrator = CassandraSchema::Migrator.new(
+        connection: CONN,
+        migrations: CassandraSchema.migrations,
+        logger: logger,
+      )
+      migrator.migrate(1)
+
+      assert_equal 1, migrator.current_version
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cassandra-schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lautaro Orazi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-12-28 00:00:00.000000000 Z
 dependencies: []
 description: Simple reversible schema migrations for Cassandra.
 email: