alterity 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e235d55d20337f7ff9bf2b4eed178c3585c4ff682bda637a34339c507644438
-  data.tar.gz: b41b2d051afdbb66a42f5ce00e2daff2b8e9b4f8935fa3c9f01e64ab0148d9e4
+  metadata.gz: bf1aafe98960046d356a7f82baa19dca7a2160ec58fa48a93da12ebd12794d16
+  data.tar.gz: 4793526689c37e33673aab4e0a8b570445fd78b369c0edbe382cf9e9aa078a97
 SHA512:
-  metadata.gz: 749cd02d5f7b2b6feb3e5e3b63c52274f701946cc03fd067b51f5c4214d7a2c73fab365ca329323058d1fb7c09999d3c1c7a8608bcb9574faa406bc244ad08cd
-  data.tar.gz: a0234815613fe77cf4db1950b8ef72de5c0def70b6abe45394c4efa1d5c7b1154d99454f81d9babcd8f00f58cbdf63edcd2f9cb181c22102e08cbaf7aa15691e
+  metadata.gz: 0dfad0d6f235e3fb8da9cc0074015298261532d9f1da903cc47d73fb776d13c6efe77c7847f59f4be2286292240a2473165b8e7b756c41a1935691b13e8db10a
+  data.tar.gz: b931b6805769dcc0ae2c9fbeddb25036e3aca3cb8bb1ad194a3b5265fb7ae9fc895f43223b3b5409e7367db69ff40f07dff5bc881bc294733e220f66abe9ddad

data/lib/alterity.rb

@@ -10,7 +10,18 @@ class Alterity
     def process_sql_query(sql, &block)
       case sql.tr("\n", " ").strip
       when /^alter\s+table\s+(?<table>.+?)\s+(?<updates>.+)/i
-        execute_alter($~[:table], $~[:updates])
+        table = $~[:table]
+        updates = $~[:updates]
+        if updates.split(",").all? { |s| s =~ /^\s*drop\s+foreign\s+key/i } ||
+           updates.split(",").all? { |s| s =~ /^\s*add\s+constraint/i }
+          block.call
+        elsif updates =~ /drop\s+foreign\s+key/i || updates =~ /add\s+constraint/i
+          # ADD CONSTRAINT / DROP FOREIGN KEY have to go to the original table,
+          # other alterations need to got to the new table.
+          raise "[Alterity] Can't change a FK and do something else in the same query. Split it."
+        else
+          execute_alter(table, updates)
+        end
       when /^create\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+?)\s+(?<updates>.+)/i
         execute_alter($~[:table], "ADD INDEX #{$~[:index]} #{$~[:updates]}")
       when /^create\s+unique\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+?)\s+(?<updates>.+)/i
@@ -24,6 +35,7 @@ class Alterity
 
     # hooks
     def before_running_migrations
+      require "open3"
       state.migrating = true
       set_database_config
       prepare_replicas_dsns_table
@@ -40,7 +52,21 @@ class Alterity
       alter_argument = %("#{updates.gsub('"', '\\"').gsub('`', '\\\`')}")
       prepared_command = config.command.call(altered_table, alter_argument).to_s.gsub(/\n/, "\\\n")
       puts "[Alterity] Will execute: #{prepared_command}"
-      system(prepared_command) || raise("[Alterity] Command failed")
+      config.before_command&.call(prepared_command)
+
+      result_str = +""
+      exit_status = nil
+      Open3.popen2e(prepared_command) do |_stdin, stdout_and_stderr, wait_thr|
+        stdout_and_stderr.each do |line|
+          puts line
+          result_str << line
+          config.on_command_output&.call(line)
+        end
+        exit_status = wait_thr.value
+        config.after_command&.call(wait_thr.value.to_i)
+      end
+
+      raise("[Alterity] Command failed. Full output: #{result_str}") unless exit_status.success?
     end
 
     def set_database_config

data/lib/alterity/configuration.rb

@@ -4,7 +4,10 @@ class Alterity
   Configuration = Struct.new(
     :command,
     :host, :port, :database, :username, :password,
-    :replicas_dsns_database, :replicas_dsns_table, :replicas_dsns
+    :replicas_dsns_database, :replicas_dsns_table, :replicas_dsns,
+    :before_command,
+    :on_command_output,
+    :after_command
   )
   CurrentState = Struct.new(:migrating, :disabled)
   cattr_accessor :state
@@ -36,10 +39,6 @@ class Alterity
       yield config
     end
 
-    def command=(new_command)
-      config.command = new_command
-    end
-
     def disable
       state.disabled = true
       yield

data/lib/alterity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Alterity
-  VERSION = "1.1.0"
+  VERSION = "1.4.0"
 end

data/spec/alterity_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Alterity do
         ["CREATE UNIQUE INDEX `idx_users_on_col` ON `users` (col)", "`users`", "ADD UNIQUE INDEX `idx_users_on_col` (col)"],
         ["DROP INDEX `idx_users_on_col` ON `users`", "`users`", "DROP INDEX `idx_users_on_col`"],
         ["alter table users drop col", "users", "drop col"],
-        ["  ALTER TABLE\n   users\n   DROP col", "users", "DROP col"]
+        ["  ALTER TABLE\n   users\n   DROP col", "users", "DROP col"],
       ].each do |(query, expected_table, expected_updates)|
         puts query.inspect
         expected_block = proc {}
@@ -29,7 +29,11 @@ RSpec.describe Alterity do
         "SHOW CREATE TABLE `users`",
         "SHOW TABLE STATUS LIKE `users`",
         "SHOW KEYS FROM `users`",
-        "SHOW FULL FIELDS FROM `users`"
+        "SHOW FULL FIELDS FROM `users`",
+        "ALTER TABLE `installment_events` DROP FOREIGN KEY _fk_rails_0123456789",
+        "ALTER TABLE `installment_events` DROP FOREIGN KEY _fk_rails_0123456789, DROP FOREIGN KEY _fk_rails_9876543210",
+        "ALTER TABLE `installment_events` ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)",
+        "ALTER TABLE `installment_events` ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`) ON DELETE CASCADE",
       ].each do |query|
         expected_block = proc {}
         expect(expected_block).to receive(:call)
@@ -37,5 +41,19 @@ RSpec.describe Alterity do
         Alterity.process_sql_query(query, &expected_block)
       end
     end
+
+    it "raises an error if mixing FK change and other things" do
+      expected_block = proc {}
+      expect(expected_block).not_to receive(:call)
+      expect(Alterity).not_to receive(:execute_alter)
+      query = "ALTER TABLE `installment_events` ADD `col` VARCHAR(255), DROP FOREIGN KEY _fk_rails_0123456789"
+      expect do
+        Alterity.process_sql_query(query, &expected_block)
+      end.to raise_error(/FK/)
+      query = "ALTER TABLE `installment_events` ADD `col` VARCHAR(255), ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)"
+      expect do
+        Alterity.process_sql_query(query, &expected_block)
+      end.to raise_error(/FK/)
+    end
   end
 end

data/spec/bin/custom_config.rb

@@ -8,6 +8,7 @@ Alterity.configure do |config|
     system("echo '#{string}' > /tmp/custom_command_result.txt")
     system("echo '#{altered_table}' >> /tmp/custom_command_result.txt")
     system("echo '#{alter_argument}' >> /tmp/custom_command_result.txt")
+    "ls /"
   }
 
   config.replicas(
@@ -23,4 +24,16 @@ Alterity.configure do |config|
       "h=#{ENV['MYSQL_HOST']}"
     ]
   )
+
+  config.before_command = lambda do |command|
+    File.new("/tmp/before_command.txt", "w").syswrite(command)
+  end
+
+  config.on_command_output = lambda do |output|
+    File.new("/tmp/on_command_output.txt", "w+").syswrite(output)
+  end
+
+  config.after_command = lambda do |exit_status|
+    File.new("/tmp/after_command.txt", "w").syswrite(exit_status)
+  end
 end

data/spec/bin/test_custom_config_result.rb

@@ -15,6 +15,25 @@ puts result
 p result.chars.map(&:hex)
 
 if result != expected_result
-  puts "=> mismatch"
+  puts "=> mismatched result"
+  exit(1)
+end
+
+
+result = File.read("/tmp/before_command.txt")
+if result != "ls /"
+  puts "=> mismatched before_command"
+  exit(1)
+end
+
+result = File.read("/tmp/on_command_output.txt")
+if !result.include?("var")
+  puts "=> mismatched on_command_output"
+  exit(1)
+end
+
+result = File.read("/tmp/after_command.txt")
+if result.strip != "0"
+  puts "=> mismatched after_command"
   exit(1)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alterity
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Chris Maximin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2