data_migrate 3.0.1 → 4.0.0

data/spec/data_migrate/data_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe DataMigrate::Data do
+  let(:subject) { DataMigrate::Data }
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+  let(:fixture_file_timestamps) do
+    %w[20091231235959 20101231235959 20111231235959]
+  end
+
+  around do |example|
+    Dir.mktmpdir do |temp_dir|
+      @temp_dir = temp_dir
+
+      # create the fake data migration files
+      fixture_file_timestamps.each do |timestamp|
+        FileUtils.touch File.join(temp_dir, "#{timestamp}_data_migration.rb")
+      end
+
+      example.run
+    end
+  end
+
+  describe :define do
+    before do
+      allow(DataMigrate::DataMigrator).
+        to receive(:db_config) { db_config }
+      ActiveRecord::Base.establish_connection(db_config)
+      ActiveRecord::SchemaMigration.create_table
+    end
+
+    after do
+      ActiveRecord::Migration.drop_table("data_migrations")
+    end
+
+    context "when no version is supplied" do
+      it "returns nil" do
+        expect(subject.define(version: nil)).to be_nil
+      end
+    end
+
+    context "when a version is supplied" do
+      before do
+        allow(DataMigrate::DataMigrator).
+          to receive(:full_migrations_path).and_return(@temp_dir)
+      end
+
+      it "sets the current version to the supplied version" do
+        version = fixture_file_timestamps[1]
+
+        expect(DataMigrate::DataMigrator.current_version).not_to eq version.to_i
+        subject.define(version: version)
+        expect(DataMigrate::DataMigrator.current_version).to eq version.to_i
+      end
+
+      it "creates entries for migration versions that come " \
+         "before the supplied version" do
+
+        version = fixture_file_timestamps[1]
+
+        subject.define(version: version)
+
+        sql_select = <<-SQL
+          SELECT version
+          FROM #{DataMigrate::DataSchemaMigration.table_name}
+        SQL
+
+        db_list_data = ActiveRecord::Base.connection.
+          select_values(sql_select).map(&:to_i)
+        expect(db_list_data).to match_array(
+          [fixture_file_timestamps[0], fixture_file_timestamps[1]].map(&:to_i)
+        )
+
+        # The last remaining migration (fixture_file_timestamps[2]) was
+        # not included as part of the supplied version and so should not
+        # appear in the data_migrations table.
+        expect(db_list_data).not_to include(fixture_file_timestamps[2])
+      end
+    end
+  end
+end

data/spec/data_migrate/database_tasks_spec.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe DataMigrate::DatabaseTasks do
+  let(:subject) { DataMigrate::DatabaseTasks }
+  let(:migration_path) {
+    if Rails::VERSION::MAJOR == 5
+      if Rails::VERSION::MINOR == 2
+        "spec/db/migrate/5.2"
+      else
+        "spec/db/migrate/5.0"
+      end
+    else
+      "spec/db/migrate/4.2"
+    end
+  }
+  let(:data_migrations_path) {
+    if Rails::VERSION::MAJOR == 5
+      if Rails::VERSION::MINOR == 2
+        "spec/db/data"
+      else
+        "spec/db/5.0"
+      end
+    else
+      "spec/db/4.2"
+    end
+  }
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+
+  before do
+    # In a normal Rails installation, db_dir would defer to
+    # Rails.application.config.paths["db"].first
+    # @see https://github.com/rails/rails/blob/a7d49ef78c36df2d1ca876451f30915ada1079a5/activerecord/lib/active_record/tasks/database_tasks.rb#L54
+    allow(subject).to receive(:db_dir).and_return("db")
+  end
+
+  before do
+    allow(DataMigrate::Tasks::DataMigrateTasks).to receive(:migrations_paths) {
+      data_migrations_path
+    }
+    allow(DataMigrate::DataMigrator).to receive(:db_config) { db_config }
+    ActiveRecord::Base.establish_connection(db_config)
+  end
+
+  describe :data_schema_file do
+    it "returns the correct data schema file path" do
+      expect(subject.data_schema_file).to eq "db/data_schema.rb"
+    end
+  end
+
+  context "migrations" do
+    after do
+      begin
+        ActiveRecord::Migration.drop_table("data_migrations")
+      rescue ActiveRecord::StatementInvalid
+      end
+      ActiveRecord::Migration.drop_table("schema_migrations")
+    end
+
+    before do
+      ActiveRecord::Base.establish_connection(db_config)
+      ActiveRecord::SchemaMigration.create_table
+
+      allow(DataMigrate::SchemaMigration).to receive(:migrations_paths) {
+        migration_path
+      }
+      allow(DataMigrate::DatabaseTasks).to receive(:data_migrations_path) {
+        data_migrations_path
+      }.at_least(:once)
+      allow(DataMigrate::DatabaseTasks).to receive(:schema_migrations_path) {
+        migration_path
+      }.at_least(:once)
+    end
+
+    describe :past_migrations do
+      it do
+        subject.forward
+        m = subject.past_migrations
+        expect(m.count).to eq 1
+        expect(m.first[:version]).to eq 20091231235959
+      end
+
+      it "shows nothing without any migrations" do
+        m = subject.past_migrations
+        expect(m.count).to eq 0
+      end
+    end
+
+    describe :forward do
+
+      it "run forward default amount of times" do
+        subject.forward
+        versions = DataMigrate::DataSchemaMigration.normalized_versions
+        expect(versions.count).to eq(1)
+      end
+
+      it "run forward defined number of times" do
+        subject.forward(2)
+        versions = DataMigrate::DataSchemaMigration.normalized_versions
+        expect(versions.count).to eq(1)
+        expect(versions.first).to eq "20091231235959"
+        versions = ActiveRecord::SchemaMigration.normalized_versions
+        expect(versions.count).to eq(1)
+        expect(versions.first).to eq "20131111111111"
+      end
+    end
+  end
+end

data/spec/data_migrate/migration.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+if Rails::VERSION::MAJOR >= 5
+  subject = DataMigrate::MigrationFive
+else
+  subject = DataMigrate::Migration
+end
+
+describe subject do
+  it "uses correct table name" do
+    expect(subject.table_name).to eq("data_migrations")
+  end
+
+  it "uses correct index name" do
+    expect(subject).to receive(:table_name_prefix) { "" }
+    expect(subject).to receive(:table_name_suffix) { "" }
+    expect(subject.index_name).to eq("unique_data_migrations")
+  end
+end

data/spec/data_migrate/migration_context_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+
+describe DataMigrate::DataMigrator do
+  let(:context) {
+    DataMigrate::MigrationContext.new("spec/db/data")
+  }
+
+  before do
+    unless Rails::VERSION::MAJOR == 5 and
+           Rails::VERSION::MINOR == 2
+      skip("Tests are only applicable for Rails 5.2")
+    end
+  end
+
+  after do
+    begin
+      ActiveRecord::Migration.drop_table("data_migrations")
+    rescue StandardError
+      nil
+    end
+  end
+
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+
+  describe :migrate do
+    before do
+      ActiveRecord::Base.establish_connection(db_config)
+      ActiveRecord::SchemaMigration.create_table
+    end
+
+    it "migrates existing file" do
+      context.migrate(nil)
+      context.migrations_status
+      versions = DataMigrate::DataSchemaMigration.normalized_versions
+      expect(versions.count).to eq(2)
+      expect(versions).to include("20091231235959")
+      expect(versions).to include("20171231235959")
+    end
+
+    it "undo migration" do
+      context.migrate(nil)
+      context.run(:down, 20171231235959)
+      versions = DataMigrate::DataSchemaMigration.normalized_versions
+      expect(versions.count).to eq(1)
+      expect(versions).to include("20091231235959")
+    end
+
+    it "does not do anything if migration is undone twice" do
+      context.migrate(nil)
+      expect {
+        context.run(:down, 20171231235959)
+      }.to output(/Undoing SuperUpdate/).to_stdout
+      expect {
+        context.run(:down, 20171231235959)
+      }.not_to output(/Undoing SuperUpdate/).to_stdout
+    end
+
+    it "runs a specific migration" do
+      context.run(:up, 20171231235959)
+      versions = DataMigrate::DataSchemaMigration.normalized_versions
+      expect(versions.count).to eq(1)
+      expect(versions).to include("20171231235959")
+    end
+
+    it "does not do anything if migration is ran twice" do
+      expect {
+        context.run(:up, 20171231235959)
+      }.to output(/Doing SuperUpdate/).to_stdout
+      expect {
+        context.run(:down, 20171231235959)
+      }.not_to output(/Doing SuperUpdate/).to_stdout
+    end
+
+    it "alerts for an invalid specific migration" do
+      expect {
+        context.run(:up, 201712312)
+      }.to raise_error(
+        ActiveRecord::UnknownMigrationVersionError,
+        /No migration with version number 201712312/
+      )
+    end
+
+    it "rolls back latest migration" do
+      context.migrate(nil)
+      expect {
+        context.rollback
+      }.to output(/Undoing SuperUpdate/).to_stdout
+      versions = DataMigrate::DataSchemaMigration.normalized_versions
+      expect(versions.count).to eq(1)
+      expect(versions).to include("20091231235959")
+    end
+
+    it "rolls back 2 migrations" do
+      context.migrate(nil)
+      expect {
+        context.rollback(2)
+      }.to output(/Undoing SomeName/).to_stdout
+      versions = DataMigrate::DataSchemaMigration.normalized_versions
+      expect(versions.count).to eq(0)
+    end
+  end
+end

data/spec/data_migrate/schema_dumper_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe DataMigrate::SchemaDumper do
+  let(:subject) { DataMigrate::SchemaDumper }
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+  let(:fixture_file_timestamps) do
+    %w[20091231235959 20101231235959 20111231235959]
+  end
+
+  describe :dump do
+    before do
+      allow(DataMigrate::DataMigrator).
+        to receive(:db_config) { db_config }.at_least(:once)
+      ActiveRecord::Base.establish_connection(db_config)
+
+      ActiveRecord::SchemaMigration.create_table
+      DataMigrate::DataMigrator.assure_data_schema_table
+
+      ActiveRecord::Base.connection.execute <<-SQL
+        INSERT INTO #{DataMigrate::DataSchemaMigration.table_name}
+        VALUES #{fixture_file_timestamps.map { |t| "(#{t})" }.join(', ')}
+      SQL
+    end
+
+    after do
+      ActiveRecord::Migration.drop_table("data_migrations")
+    end
+
+    it "writes the define method with the version key to the stream" do
+      stream = StringIO.new
+      DataMigrate::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      last_version = fixture_file_timestamps.last
+      expected = "DataMigrate::Data.define(version: #{last_version})"
+      expect(stream.read).to include expected
+    end
+  end
+end

data/spec/data_migrate/schema_migration_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe DataMigrate::SchemaMigration do
+  let(:migration_path) {
+    if Rails::VERSION::MAJOR == 5
+      if Rails::VERSION::MINOR == 2
+        "spec/db/migrate/5.2"
+      else
+        "spec/db/migrate/5.0"
+      end
+    else
+      "spec/db/migrate/4.2"
+    end
+  }
+
+  let(:subject) { DataMigrate::SchemaMigration }
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+  let(:fixture_file_timestamps) do
+    %w[20091231235959 20101231235959 20111231235959]
+  end
+
+  before do
+    ActiveRecord::Base.establish_connection(db_config)
+    ActiveRecord::SchemaMigration.create_table
+  end
+
+  after do
+    ActiveRecord::Migration.drop_table("schema_migrations")
+  end
+
+  describe :pending_schema_migrations do
+    it "list sorted schema migrations" do
+      expect(subject).to receive(:migrations_paths) {
+        migration_path
+      }
+      migrations = subject.pending_schema_migrations
+
+      expect(migrations.count).to eq 2
+      expect(migrations[0][:version]).to eq(20131111111111)
+      expect(migrations[1][:version]).to eq(20202020202011)
+    end
+  end
+
+  describe :run do
+    it do
+      expect {
+        subject.run(:up, migration_path, 20202020202011)
+      }.to output(/20202020202011 DbMigration: migrating/).to_stdout
+      versions = ActiveRecord::SchemaMigration.normalized_versions
+      expect(versions.first).to eq("20202020202011")
+    end
+
+    it "undo migration" do
+      subject.run(:up, migration_path, 20202020202011)
+      expect {
+        subject.run(:down, migration_path, 20202020202011)
+      }.to output(/Undoing DbMigration/).to_stdout
+      versions = ActiveRecord::SchemaMigration.normalized_versions
+      expect(versions.count).to eq(0)
+    end
+  end
+end

data/spec/data_migrate/status_service_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe DataMigrate::StatusService do
+  let(:subject) { DataMigrate::SchemaDumper }
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+  let(:service) { DataMigrate::StatusService }
+
+  context "table does not exists" do
+    before do
+      ActiveRecord::Base.establish_connection(db_config)
+    end
+
+    it "show error message" do
+      allow_any_instance_of(service).to receive(:table_name) { "bogus"}
+      stream = StringIO.new
+
+      service.dump(ActiveRecord::Base.connection, stream)
+
+      stream.rewind
+      expected = "Data migrations table does not exist"
+      expect(stream.read).to include expected
+    end
+  end
+
+  context "table exists" do
+    let(:fixture_file_timestamps) do
+      %w[20091231235959 20101231235959 20111231235959]
+    end
+
+    before do
+      allow(DataMigrate::DataMigrator).
+        to receive(:db_config) { db_config }.at_least(:once)
+      ActiveRecord::Base.establish_connection(db_config)
+
+      ActiveRecord::SchemaMigration.create_table
+      DataMigrate::DataMigrator.assure_data_schema_table
+
+      ActiveRecord::Base.connection.execute <<-SQL
+        INSERT INTO #{DataMigrate::DataSchemaMigration.table_name}
+        VALUES #{fixture_file_timestamps.map { |t| "(#{t})" }.join(', ')}
+      SQL
+
+      allow_any_instance_of(service).to receive(:root_folder) { "spec" }
+    end
+
+    after do
+      ActiveRecord::Migration.drop_table("data_migrations")
+    end
+
+    it "shows successfully executed migration" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      expected = "   up     20091231235959  Some name"
+      expect(stream.read).to include expected
+    end
+
+    it "shows missing file migration" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      expected = "   up     20101231235959  ********** NO FILE **********"
+      s = stream.read
+      expect(s).to include expected
+    end
+
+    it "shows migration that has not run yet" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+
+      expected = "  down    20171231235959  Super update"
+      s = stream.read
+      expect(s).to include expected
+    end
+
+    it "outputs migrations in chronological order" do
+      stream = StringIO.new
+      service.dump(ActiveRecord::Base.connection, stream)
+      stream.rewind
+      s = stream.read
+      expect(s.index("20091231235959")).to be < s.index("20111231235959")
+    end
+  end
+end

data/spec/data_migrate/tasks/data_migrate_tasks_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe DataMigrate::Tasks::DataMigrateTasks do
+  let(:db_config) do
+    {
+      adapter: "sqlite3",
+      database: "spec/db/test.db"
+    }
+  end
+
+  before do
+    if Rails::VERSION::MAJOR == 5
+      if Rails::VERSION::MINOR == 2
+        allow(DataMigrate::Tasks::DataMigrateTasks).to receive(:migrations_paths) {
+          "spec/db/data"
+        }
+      else
+        allow(DataMigrate::Tasks::DataMigrateTasks).to receive(:migrations_paths) {
+          "spec/db/5.0"
+        }
+      end
+    else
+      allow(DataMigrate::Tasks::DataMigrateTasks).to receive(:migrations_paths) {
+        "spec/db/4.2"
+      }
+    end
+    allow(DataMigrate::DataMigrator).to receive(:db_config) { db_config }
+    ActiveRecord::Base.establish_connection(db_config)
+  end
+
+  after do
+    ActiveRecord::Migration.drop_table("data_migrations")
+  end
+
+  describe :migrate do
+    it do
+      expect {
+        DataMigrate::Tasks::DataMigrateTasks.migrate
+      }.to output(/20091231235959 SomeName: migrating/).to_stdout
+    end
+
+    it do
+      expect {
+        DataMigrate::Tasks::DataMigrateTasks.migrate
+      }.to output(/20171231235959 SuperUpdate: migrating/).to_stdout
+    end
+  end
+end

data/spec/db/4.2/20091231235959_some_name.rb

@@ -0,0 +1,9 @@
+class SomeName < ActiveRecord::Migration
+  def up
+    puts "Doing data migration"
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/spec/db/4.2/20171231235959_super_update.rb

@@ -0,0 +1,9 @@
+class SuperUpdate < ActiveRecord::Migration
+  def up
+    puts "Doing data migration"
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/spec/db/5.0/20091231235959_some_name.rb

@@ -0,0 +1,9 @@
+class SomeName < ActiveRecord::Migration[5.0]
+  def up
+    puts "Doing data migration"
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/spec/db/5.0/20171231235959_super_update.rb

@@ -0,0 +1,9 @@
+class SuperUpdate < ActiveRecord::Migration[5.0]
+  def up
+    puts "Doing data migration"
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/spec/db/data/20091231235959_some_name.rb

@@ -0,0 +1,9 @@
+class SomeName < ActiveRecord::Migration[5.2]
+  def up
+    puts "Doing data migration"
+  end
+
+  def down
+    puts "Undoing SomeName"
+  end
+end

data/spec/db/data/20171231235959_super_update.rb

@@ -0,0 +1,9 @@
+class SuperUpdate < ActiveRecord::Migration[5.2]
+  def up
+    puts "Doing SuperUpdate"
+  end
+
+  def down
+    puts "Undoing SuperUpdate"
+  end
+end

data/spec/db/migrate/4.2/20131111111111_late_migration.rb

@@ -0,0 +1,9 @@
+class LateMigration < ActiveRecord::Migration
+  def up
+    puts "Doing schema LateMigration"
+  end
+
+  def down
+    puts "Undoing LateMigration"
+  end
+end

data/spec/db/migrate/4.2/20202020202011_db_migration.rb

@@ -0,0 +1,9 @@
+class DbMigration < ActiveRecord::Migration
+  def up
+    puts "Doing schema migration"
+  end
+
+  def down
+    puts "Undoing DbMigration"
+  end
+end

data/spec/db/migrate/5.0/20131111111111_late_migration.rb

@@ -0,0 +1,9 @@
+class LateMigration < ActiveRecord::Migration[5.0]
+  def up
+    puts "Doing schema LateMigration"
+  end
+
+  def down
+    puts "Undoing LateMigration"
+  end
+end

data/spec/db/migrate/5.0/20202020202011_db_migration.rb

@@ -0,0 +1,9 @@
+class DbMigration < ActiveRecord::Migration[5.0]
+  def up
+    puts "Doing schema migration"
+  end
+
+  def down
+    puts "Undoing DbMigration"
+  end
+end