pg_trunk 0.1.0

data/spec/operations/triggers/change_trigger_spec.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#change_trigger" do
+  before_all do
+    run_migration <<~RUBY
+      create_table "users", force: :cascade do |t|
+        t.string "name"
+        t.boolean "admin"
+      end
+
+      create_function "do_nothing() trigger" do |f|
+        f.language "plpgsql"
+        f.body "BEGIN END;"
+      end
+
+      create_function "set_foo() trigger" do |f|
+        f.language "plpgsql"
+        f.body "BEGIN SET custom.foo = 42; END;"
+      end
+    RUBY
+  end
+  before { run_migration(old_snippet) }
+
+  let(:old_snippet) do
+    <<~RUBY
+      create_trigger "users", "do_nothing" do |t|
+        t.function "do_nothing()"
+        t.for_each :row
+        t.type :after
+        t.events %i[update]
+        t.comment "Old comment"
+      end
+    RUBY
+  end
+
+  context "in PostgreSQL v14+", since_version: 14 do
+    context "with explicitly reversible changes" do
+      let(:migration) do
+        <<~RUBY
+          change_trigger "users", "do_nothing" do |t|
+            t.function "set_foo()", from: "do_nothing()"
+            t.type :before, from: :after
+            t.events %i[insert update], from: %i[update]
+            t.comment "New comment", from: "Old comment"
+          end
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_trigger "users", "do_nothing" do |t|
+            t.function "set_foo()"
+            t.for_each :row
+            t.type :before
+            t.events %i[insert update]
+            t.comment "New comment"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:execution) { is_expected.to remove(old_snippet).from_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "with implicitly reversible changes" do
+      let(:migration) do
+        <<~RUBY
+          change_trigger "users", "do_nothing" do |t|
+            t.for_each :statement
+          end
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_trigger "users", "do_nothing" do |t|
+            t.function "do_nothing()"
+            t.type :after
+            t.events %i[update]
+            t.comment "Old comment"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:execution) { is_expected.to remove(old_snippet).from_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "with irreversible changes" do
+      let(:migration) do
+        <<~RUBY
+          change_trigger "users", "do_nothing" do |t|
+            t.function "set_foo()"
+            t.type :before
+            t.events %i[insert update]
+            t.comment "New comment"
+          end
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_trigger "users", "do_nothing" do |t|
+            t.function "set_foo()"
+            t.for_each :row
+            t.type :before
+            t.events %i[insert update]
+            t.comment "New comment"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:execution) { is_expected.to remove(old_snippet).from_schema }
+      it { is_expected.to be_irreversible.because_of(/body|comment/i) }
+    end
+
+    context "when the procedure is absent" do
+      let(:migration) do
+        <<~RUBY
+          change_trigger "users", "unknown" do |t|
+            t.comment "New comment", from: "Old comment"
+          end
+        RUBY
+      end
+
+      context "without the `if_exists` option" do
+        its(:execution) { is_expected.to raise_error(StandardError) }
+      end
+
+      context "with the `if_exists: true` option" do
+        let(:migration) do
+          <<~RUBY
+            change_trigger "users", "unknown", if_exists: true do |t|
+              t.comment "New comment", from: "Old comment"
+            end
+          RUBY
+        end
+
+        its(:execution) { is_expected.not_to change_schema }
+        it { is_expected.to be_irreversible.because_of(/if_exists: true/i) }
+      end
+    end
+
+    context "with unknown table" do
+      let(:migration) do
+        <<~RUBY
+          change_trigger "user", "do_nothing" do |t|
+            t.comment "New comment", from: "Old comment"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to raise_error(StandardError) }
+    end
+  end
+
+  context "in PostgreSQL before v14", before_version: 14 do
+    context "with explicitly reversible changes" do
+      let(:migration) do
+        <<~RUBY
+          change_trigger "users", "do_nothing" do |t|
+            t.function "set_foo()", from: "do_nothing()"
+            t.type :before, from: :after
+            t.events %i[insert update], from: %i[update]
+            t.comment "New comment", from: "Old comment"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to raise_error(/supported by PostgreSQL server v14+/i) }
+    end
+  end
+
+  context "with no changes" do
+    let(:migration) do
+      <<~RUBY
+        change_trigger "users", "do_nothing"
+      RUBY
+    end
+
+    it { is_expected.to fail_validation.because(/changes can't be blank/i) }
+  end
+
+  context "without name" do
+    let(:migration) do
+      <<~RUBY
+        change_trigger "users", if_exists: true do |t|
+          t.comment "New comment", from: "Old comment"
+        end
+      RUBY
+    end
+
+    it { is_expected.to fail_validation.because(/name can't be blank/i) }
+  end
+end

data/spec/operations/triggers/create_trigger_spec.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#create_trigger" do
+  before_all do
+    run_migration <<~RUBY
+      create_table "users", force: :cascade do |t|
+        t.string "name"
+        t.boolean "admin"
+      end
+
+      create_function "do_nothing() trigger" do |f|
+        f.language "plpgsql"
+        f.body "BEGIN END;"
+      end
+    RUBY
+  end
+
+  context "with an explicit name" do
+    let(:migration) do
+      <<~RUBY
+        create_trigger "users", "do_nothing" do |t|
+          t.function "do_nothing()"
+          t.for_each :row
+          t.type :after
+          t.events %i[update]
+          t.comment "Block granting rights of an admin"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "with a constraint" do
+    let(:migration) do
+      <<~RUBY
+        create_trigger "users", "do_nothing" do |t|
+          t.function "do_nothing()"
+          t.constraint true
+          t.events %i[update]
+          t.comment "Block granting rights of an admin"
+        end
+      RUBY
+    end
+    let(:snippet) do
+      <<~RUBY
+        create_trigger "users", "do_nothing" do |t|
+          t.function "do_nothing()"
+          t.constraint true
+          t.for_each :row
+          t.type :after
+          t.events %i[update]
+          t.comment "Block granting rights of an admin"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(snippet).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "without a name" do
+    let(:migration) do
+      <<~RUBY
+        create_trigger "users" do |t|
+          t.function "do_nothing()"
+          t.for_each :row
+          t.type :before
+          t.events %i[insert]
+          t.comment "Block creation of an admin"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "without a function" do
+    let(:migration) do
+      <<~RUBY
+        create_trigger "users" do |t|
+          t.type :instead_of
+          t.events %i[insert]
+        end
+      RUBY
+    end
+
+    it { is_expected.to fail_validation.because_of(/function/i) }
+  end
+
+  context "without events definition" do
+    let(:migration) do
+      <<~RUBY
+        create_trigger "users" do |t|
+          t.function "do_nothing()"
+        end
+      RUBY
+    end
+
+    it { is_expected.to fail_validation.because_of(/events/i) }
+  end
+end

data/spec/operations/triggers/drop_trigger_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#drop_trigger" do
+  before_all do
+    run_migration <<~RUBY
+      create_table "users", force: :cascade do |t|
+        t.string "name"
+        t.boolean "admin"
+      end
+
+      create_function "do_nothing() trigger" do |f|
+        f.language "plpgsql"
+        f.body "BEGIN END;"
+      end
+    RUBY
+  end
+  before { run_migration(snippet) }
+
+  context "when a trigger had an explicit name" do
+    let(:snippet) do
+      <<~RUBY
+        create_trigger "users", "do_nothing" do |t|
+          t.function "do_nothing()"
+          t.for_each :row
+          t.type :after
+          t.events %i[update]
+          t.comment "My new trigger"
+        end
+      RUBY
+    end
+
+    context "with the full definition of the trigger" do
+      let(:migration) do
+        <<~RUBY
+          drop_trigger "users", "do_nothing" do |t|
+            t.function "do_nothing()"
+            t.for_each :row
+            t.type :after
+            t.events %i[update]
+            t.comment "My new trigger"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "with the explicit name only" do
+      let(:migration) do
+        <<~RUBY
+          drop_trigger "users", "do_nothing"
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      it { is_expected.to be_irreversible.because_of(/function/i) }
+    end
+
+    context "when the trigger not existed" do
+      context "without the `if_exists` option" do
+        let(:migration) do
+          <<~RUBY
+            drop_trigger "users", "weird"
+          RUBY
+        end
+
+        its(:execution) { is_expected.to raise_error(StandardError) }
+      end
+
+      context "with the `if_exists` option" do
+        let(:migration) do
+          <<~RUBY
+            drop_trigger "users", "weird", if_exists: true
+          RUBY
+        end
+
+        its(:execution) { is_expected.not_to raise_error }
+        it { is_expected.to be_irreversible.because_of(/if_exists: true/i) }
+      end
+    end
+  end
+
+  context "when a trigger was anonymous (with a generated name)" do
+    let(:snippet) do
+      <<~RUBY
+        create_trigger "users" do |t|
+          t.function "do_nothing()"
+          t.for_each :row
+          t.type :after
+          t.events %i[update]
+          t.comment "My new trigger"
+        end
+      RUBY
+    end
+
+    context "with the full definition of the trigger" do
+      let(:migration) do
+        <<~RUBY
+          drop_trigger "users" do |t|
+            t.function "do_nothing()"
+            t.for_each :row
+            t.type :after
+            t.events %i[update]
+            t.comment "My new trigger"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "without a full definition" do
+      let(:migration) do
+        <<~RUBY
+          drop_trigger "users"
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/name can't be blank/i) }
+    end
+  end
+end

data/spec/operations/triggers/rename_trigger_spec.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#rename_trigger" do
+  before_all do
+    run_migration <<~RUBY
+      create_table :foo
+      create_function "avoid() trigger", language: :plpgsql, body: "BEGIN END;"
+    RUBY
+  end
+  before { run_migration(old_snippet) }
+
+  context "when a trigger had an explicit name" do
+    let(:old_snippet) do
+      <<~RUBY
+        create_trigger "foo", "do_nothing" do |t|
+          t.function "avoid()"
+          t.type :after
+          t.events %i[insert]
+        end
+      RUBY
+    end
+
+    context "with both old and new names" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger :foo, :do_nothing, to: :do_something
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_trigger "foo", "do_something" do |t|
+            t.function "avoid()"
+            t.type :after
+            t.events %i[insert]
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(old_snippet).from_schema }
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "when a new name can be generated from params" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger "foo", "do_nothing" do |t|
+            t.function "avoid()"
+            t.type :after
+            t.events %i[insert]
+          end
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_trigger "foo" do |t|
+            t.function "avoid()"
+            t.type :after
+            t.events %i[insert]
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(old_snippet).from_schema }
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "when a new name can't be generated" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger "foo", "do_nothing"
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/new name can't be blank/i) }
+    end
+
+    context "with the same name" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger :foo, :do_nothing, to: :do_nothing
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/new name must be different/i) }
+    end
+
+    context "without an old name" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger :foo, to: :do_something
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/name can't be blank/i) }
+    end
+  end
+
+  context "when a trigger had a generated name" do
+    let(:old_snippet) do
+      <<~RUBY
+        create_trigger "foo" do |t|
+          t.function "avoid()"
+          t.type :after
+          t.events %i[insert]
+        end
+      RUBY
+    end
+
+    context "when the old name can be generated from params" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger "foo", to: "do_something" do |t|
+            t.function "avoid()"
+            t.type :after
+            t.events %i[insert]
+          end
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_trigger "foo", "do_something" do |t|
+            t.function "avoid()"
+            t.type :after
+            t.events %i[insert]
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(old_snippet).from_schema }
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "when the old name can't be generated" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger "foo", to: "do_something"
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/name can't be blank/i) }
+    end
+
+    context "without a new name" do
+      let(:migration) do
+        <<~RUBY
+          rename_trigger "foo" do |t|
+            t.function "avoid()"
+            t.type :after
+            t.events %i[insert]
+          end
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/new name must be different/i) }
+    end
+  end
+end