xmigra 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e69aae7f431f58d88125bfc0a31adb4a0f3b76c
-  data.tar.gz: 65f872a4d23fd7515bf6231c636c0f10725effc7
+  metadata.gz: 5e70e491aa62e8fdf597baa7794b6c342ebb074d
+  data.tar.gz: 6d95f99d62ca23e9fb0f801dc37e0eaca2656cd0
 SHA512:
-  metadata.gz: 299d09f45384c3dc16473c59e6d2494583c8486d776a3edef6ab4123e2245374e4cbe13472b73c013f9c82081f44fdef0a242b6048f694d666f2b5102b6a988d
-  data.tar.gz: 5016ef96078d289add80ec678ca6a5e989fcaac0a9dc4fd30ce186c0fc7e766ab22c00c752f5f62c0c11ccdf6621b808d920709792b2dae8d0df774e3e61c158
+  metadata.gz: ddf810521f87c7ecf49c5aef49d8f51ce913c9e7ae6b0bb3ba14395560d965c9ff538ebd80872b97c1870e986f09e7f523e58054caf1b2387b80a44be4558ad5
+  data.tar.gz: 54aea5341db82a73aa972f6ad6e27f11a9c24780d5f83bd146f6c4c25b9cc1376aa99081177ddb14310720b0cb68081c1a4fa2d1fd67b91fa1dc961bad43f670

data/lib/xmigra/db_support/mssql.rb

@@ -12,6 +12,8 @@ module XMigra
     $/ix
     STATISTICS_FILE = 'statistics-objects.yaml'
     
+    ID_COLLATION = 'Latin1_General_CS_AS'
+    
     class StatisticsObject
       def initialize(name, params)
         (@name = name.dup).freeze
@@ -153,7 +155,7 @@ IF NOT EXISTS (
 )
 BEGIN
   CREATE TABLE [xmigra].[applied] (
-    [MigrationID]            nvarchar(80) NOT NULL,
+    [MigrationID]            nvarchar(80) COLLATE #{ID_COLLATION} NOT NULL,
     [ApplicationOrder]       int IDENTITY(1,1) NOT NULL,
     [VersionBridgeMark]      bit NOT NULL,
     [Description]            nvarchar(max) NOT NULL,
@@ -171,6 +173,45 @@ BEGIN
 END;
 GO
 
+IF NOT EXISTS (
+  SELECT * FROM sys.columns
+  WHERE object_id = OBJECT_ID(N'[xmigra].[applied]')
+  AND name = N'MigrationID'
+  AND collation_name = N'#{ID_COLLATION}'
+)
+BEGIN
+  ALTER TABLE xmigra.applied DROP CONSTRAINT PK_version;
+  ALTER TABLE xmigra.applied ALTER COLUMN [MigrationID] nvarchar(80) COLLATE Latin1_General_CS_AS NOT NULL;
+  ALTER TABLE xmigra.applied ADD CONSTRAINT PK_version PRIMARY KEY ([MigrationID] ASC) WITH (
+    PAD_INDEX = OFF,
+    STATISTICS_NORECOMPUTE  = OFF,
+    IGNORE_DUP_KEY = OFF,
+    ALLOW_ROW_LOCKS = ON,
+    ALLOW_PAGE_LOCKS = ON
+  ) ON [PRIMARY];
+END;
+
+IF NOT EXISTS (
+  SELECT * FROM sys.objects
+  WHERE object_id = OBJECT_ID(N'[xmigra].[previous_states]')
+  AND type IN (N'U')
+)
+BEGIN
+  CREATE TABLE [xmigra].[previous_states] (
+    [Changed]                   datetime NOT NULL,
+    [MigrationApplicationOrder] int NOT NULL,
+    [FromMigrationID]           nvarchar(80) COLLATE #{ID_COLLATION},
+    [ToRangeStartMigrationID]   nvarchar(80) COLLATE #{ID_COLLATION} NOT NULL,
+    [ToRangeEndMigrationID]     nvarchar(80) COLLATE #{ID_COLLATION} NOT NULL,
+    
+    CONSTRAINT [PK_previous_states] PRIMARY KEY CLUSTERED (
+      [Changed] ASC,
+      [MigrationApplicationOrder] ASC
+    )
+  );
+END;
+GO
+
 IF NOT EXISTS (
   SELECT * FROM sys.objects
   WHERE object_id = OBJECT_ID(N'[xmigra].[DF_version_VersionBridgeMark]')
@@ -244,6 +285,30 @@ BEGIN
     [CompletesMigration] nvarchar(80) NULL
   ) ON [PRIMARY];
 END;
+
+IF EXISTS (
+  SELECT * FROM sys.objects
+  WHERE object_id = OBJECT_ID(N'[xmigra].[last_applied_migrations]')
+  AND type IN (N'V')
+)
+BEGIN
+  DROP VIEW [xmigra].[last_applied_migrations];
+END;
+GO
+
+CREATE VIEW [xmigra].[last_applied_migrations] AS
+SELECT
+  ROW_NUMBER() OVER (ORDER BY a.[ApplicationOrder] DESC) AS [RevertOrder],
+  a.[Description]
+FROM
+  [xmigra].[applied] a
+WHERE
+  a.[ApplicationOrder] > COALESCE((
+    SELECT TOP (1) ps.[MigrationApplicationOrder]
+    FROM [xmigra].[previous_states] ps
+    JOIN [xmigra].[applied] a2 ON ps.[ToRangeStartMigrationID] = a2.[MigrationID]
+    ORDER BY ps.[Changed] DESC
+  ), 0);
       END_OF_SQL
     end
     
@@ -260,7 +325,7 @@ END;
 GO
 
 CREATE TABLE [xmigra].[migrations] (
-  [MigrationID]            nvarchar(80) NOT NULL,
+  [MigrationID]            nvarchar(80) COLLATE #{ID_COLLATION} NOT NULL,
   [ApplicationOrder]       int NOT NULL,
   [Description]            ntext NOT NULL,
   [Install]                bit NOT NULL DEFAULT(0)
@@ -472,6 +537,38 @@ ELSE BEGIN
   )
   AND [ApplicationOrder] > @BridgePoint;
 END;
+
+INSERT INTO [xmigra].[previous_states] (
+  [Changed],
+  [MigrationApplicationOrder],
+  [FromMigrationID],
+  [ToRangeStartMigrationID],
+  [ToRangeEndMigrationID]
+)
+SELECT TOP (1)
+  CURRENT_TIMESTAMP,
+  -- Application order of last installed migration --
+  COALESCE(
+    ( 
+      SELECT TOP(1) [ApplicationOrder] FROM [xmigra].[applied]
+      ORDER BY [ApplicationOrder] DESC
+    ),
+    0
+  ),
+  ( -- Last installed migration --
+    SELECT TOP (1) [MigrationID]
+    FROM [xmigra].[applied]
+    ORDER BY [ApplicationOrder] DESC
+  ),
+  m.[MigrationID],
+  ( -- Last migration to install --
+    SELECT TOP(1) [MigrationID] FROM [xmigra].[migrations]
+    WHERE [Install] <> 0
+    ORDER BY [ApplicationOrder] DESC
+  )
+FROM [xmigra].[migrations] m
+WHERE m.[Install] <> 0
+ORDER BY m.[ApplicationOrder] ASC;
       END_OF_SQL
     end
     
@@ -885,6 +982,10 @@ END;
       end.join("\n"))
     end
     
+    def reversion_tracking_sql
+      "DELETE FROM [xmigra].[applied] WHERE [MigrationID] = '#{id}';\n"
+    end
+    
     def each_batch(sql)
       current_batch_lines = []
       sql.each_line do |line|

data/lib/xmigra/db_support/psql.rb

@@ -111,6 +111,24 @@ module XMigra
           );
         END IF;
         
+        IF NOT EXISTS(
+          SELECT * FROM information_schema.tables
+          WHERE table_schema = 'xmigra' AND table_name = 'previous_states'
+        ) THEN
+          CREATE TABLE xmigra.previous_states (
+            "Changed"                   timestamp NOT NULL,
+            "MigrationApplicationOrder" int NOT NULL,
+            "FromMigrationID"           varchar(80),
+            "ToRangeStartMigrationID"   varchar(80) NOT NULL,
+            "ToRangeEndMigrationID"     varchar(80) NOT NULL,
+            
+            CONSTRAINT PK_previous_states PRIMARY KEY (
+              "Changed",
+              "MigrationApplicationOrder"
+            )
+          );
+        END IF;
+        
         IF NOT EXISTS(
           SELECT * FROM information_schema.tables
           WHERE table_schema = 'xmigra' AND table_name = 'access_objects'
@@ -145,6 +163,26 @@ module XMigra
           );
         END IF;
         
+        IF NOT EXISTS(
+          SELECT * FROM information_schema.views
+          WHERE table_schema = 'xmigra' and table_name = 'last_applied_migrations'
+        ) THEN
+          CREATE VIEW xmigra.last_applied_migrations AS
+          SELECT
+            row_number() OVER (ORDER BY a."ApplicationOrder" DESC) AS "RevertOrder",
+            a."Description"
+          FROM
+            xmigra.applied a
+          WHERE
+            a."ApplicationOrder" > COALESCE((
+              SELECT ps."MigrationApplicationOrder"
+              FROM xmigra.previous_states ps
+              JOIN xmigra.applied a2 ON ps."ToRangeStartMigrationID" = a2."MigrationID"
+              ORDER BY ps."Changed" DESC
+              LIMIT 1
+            ), 0);
+        END IF;
+        
         RAISE NOTICE '    done';
       }
     end
@@ -292,6 +330,40 @@ module XMigra
           );
         END IF;
         
+        INSERT INTO xmigra.previous_states (
+          "Changed",
+          "MigrationApplicationOrder",
+          "FromMigrationID",
+          "ToRangeStartMigrationID",
+          "ToRangeEndMigrationID"
+        )
+        SELECT
+          CURRENT_TIMESTAMP,
+          -- Application order of last installed migration --
+          COALESCE(
+            (
+              SELECT "ApplicationOrder" FROM xmigra.applied
+              ORDER BY "ApplicationOrder" DESC
+            ),
+            0
+          ),
+          ( -- Last installed migration --
+            SELECT "MigrationID" FROM xmigra.applied
+            ORDER BY "ApplicationOrder" DESC
+            LIMIT 1
+          ),
+          m."MigrationID",
+          ( -- Last migration to install --
+            SELECT "MigrationID" FROM temp$xmigra_migrations
+            WHERE "Install"
+            ORDER BY "ApplicationOrder" DESC
+            LIMIT 1
+          )
+        FROM temp$xmigra_migrations m
+        WHERE "Install"
+        ORDER BY "ApplicationOrder" ASC
+        LIMIT 1;
+        
         RAISE NOTICE '    done';
       })
     end
@@ -490,6 +562,10 @@ module XMigra
       }
     end
     
+    def reversion_tracking_sql
+      %Q{DELETE FROM xmigra.applied WHERE "MigrationID" = '#{id}';\n}
+    end
+    
     def check_existence_sql(for_existence, error_message)
       error_message_literal = PgSQLSpecifics.string_literal sprintf(error_message, quoted_name)
       
@@ -591,7 +667,7 @@ module XMigra
           DELETE FROM xmigra.applied WHERE "MigrationID" = CompletedMigration.applied;
           
           INSERT INTO xmigra.applied ("MigrationID", "VersionBridgeMark", "Description")
-          VALUE (CompletedMigration.applied, TRUE, 'Branch upgrade from branch ' || CompletedMigration.old_branch || '.');
+          VALUES (CompletedMigration.applied, TRUE, 'Branch upgrade from branch ' || CompletedMigration.old_branch || '.');
           
           RAISE NOTICE '    done';
         END IF;

data/lib/xmigra/migration.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+require 'xmigra/revert_file'
 
 module XMigra
   class Migration
@@ -18,6 +20,15 @@ module XMigra
     attr_reader :id, :follows, :sql, :description, :changes
     attr_accessor :file_path
     
+    def schema_dir
+      Pathname(file_path).dirname.join('..')
+    end
+    
+    def reversion
+      result = RevertFile.new(self)
+      return result if result.exist?
+    end
+    
     class << self
       def id_from_filename(fname)
         XMigra.secure_digest(fname.upcase) # Base64 encoded digest

data/lib/xmigra/program.rb

@@ -184,7 +184,7 @@ END_OF_HELP
       
       def output_to(fpath_or_nil)
         if fpath_or_nil.nil?
-          yield(STDOUT)
+          yield($stdout)
         else
           File.open(fpath_or_nil, "w") do |stream|
             yield(stream)
@@ -457,6 +457,7 @@ system shall be targeted for the generation of scripts.  Currently the
 supported values are:
 
   - Microsoft SQL Server
+  - PostgreSQL
 
 Each system can also have sub-settings that modify the generated scripts.
 
@@ -671,6 +672,36 @@ END_OF_HELP
       end
     end
     
+    subcommand 'reversions', "Generate a script file containing reversions" do |argv|
+      args, options = command_line(argv, {:outfile=>true},
+                                   :help=> <<END_OF_HELP)
+This command generates a script file containing parts that can be run to
+revert individual migrations in reverse of the order they are applied.  The
+SQL for reverting the migration is taken from a file with the same basename
+as the migration it reverts, but in the 'rollback' subfolder and with a
+'.sql' extension.  The output file will not run as a viable script; a 
+contiguous section starting at the first SQL command and terminating at a
+migration boundary should be run.  Subsequent sections, consecutive with those
+previously run, may also be run to further revert the database if necessary.
+
+It may be helpful to execute the query:
+
+    SELECT * FROM xmigra.last_applied_migrations ORDER BY "RevertOrder";
+
+This query lists the migrations applied by the last upgrade script that was
+run.
+END_OF_HELP
+
+      argument_error_unless(args.length == 0,
+                            "'%prog %cmd' does not take any arguments.")
+      
+      sql_gen = SchemaUpdater.new(options.source_dir).extend(WarnToStderr)
+      
+      output_to(options.outfile) do |out_stream|
+        out_stream.print(sql_gen.reversion_script)
+      end
+    end
+    
     subcommand 'render', "Generate SQL script for an access object" do |argv|
       args, options = command_line(argv, {:outfile=>true},
                                    :argument_desc=>"ACCESS_OBJECT_FILE",

data/lib/xmigra/reversion_script_building.rb

@@ -0,0 +1,40 @@
+
+module XMigra
+  module ReversionScriptBuilding
+    # This module is intended to be included into XMigra::SchemaUpdater
+    
+    def reversions
+      if @reversions.nil?
+        @reversions = []
+        migrations.reverse_each do |m|
+          reversion = m.reversion
+          break unless reversion
+          @reversions << reversion
+        end
+      end
+      
+      return @reversions if @reversions
+    end
+    
+    def reversion_script
+      return nil if reversions.empty?
+      
+      usage_note = [
+        "Run the reversion scripts below (separated by -- ======= -- dividers) in",
+        "the order given to revert changes as far as desired.  Migrations should",
+        "always be reverted in the order given in this file.  If any migration is",
+        "not reverted and one further down this file is, XMigra will no longer be",
+        "able to update the database schema.\n",
+        "The query:",
+        "",
+        "    SELECT * FROM xmigra.last_applied_migrations ORDER BY \"RevertOrder\";",
+        "",
+        "lists the migrations applied by the last upgrade script run against this",
+        "database.\n",
+      ].collect {|l| '-- ' + l + "\n"}.join('')
+      
+      return usage_note + "========================================\n" + \
+          reversions.join("-- ================================== --\n")
+    end
+  end
+end

data/lib/xmigra/revert_file.rb

@@ -0,0 +1,42 @@
+require 'pathname'
+
+module XMigra
+  class RevertFile
+    REVERSION_SUBDIR = 'rollback'
+    
+    def initialize(migration)
+      @migration = migration
+      mig_path = Pathname(migration.file_path)
+      @description = "REVERT #{migration.description} (#{mig_path.basename})"
+      @path = migration.schema_dir.join(
+        REVERSION_SUBDIR,
+        mig_path.basename.to_s.sub(/\..*?$/, '.sql')
+      )
+    end
+    
+    attr_reader :path, :description
+    
+    def to_s
+      if @path.exist?
+        @sql ||= "-- %s:\n\n%s\n%s" % [
+          @description,
+          @path.read,
+          @migration.reversion_tracking_sql
+        ]
+      else
+        "-- #@description: No reversion given\n"
+      end
+    end
+    
+    def inspect
+      "#<#{self.class.name} %s%s>" % [
+        @path,
+        (" (missing)" unless @path.exist?),
+      ]
+    end
+    
+    def exist?
+      @path.exist?
+    end
+  end
+end

data/lib/xmigra/schema_updater.rb

@@ -1,8 +1,11 @@
 
 require 'xmigra/schema_manipulator'
+require 'xmigra/reversion_script_building'
 
 module XMigra
   class SchemaUpdater < SchemaManipulator
+    include ReversionScriptBuilding
+    
     DEV_SCRIPT_WARNING = <<-"END_OF_TEXT"
 *********************************************************
 ***                    WARNING                        ***

data/lib/xmigra/vcs_support/git.rb

@@ -8,7 +8,7 @@ module XMigra
     
     class << self
       def manages(path)
-        run_git(:status, :check_exit=>true)
+        run_git(:status, :check_exit=>true, :quiet=>true)
       end
       
       def run_git(subcmd, *args)

data/lib/xmigra/version.rb

@@ -1,3 +1,3 @@
 module XMigra
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/test/reversions.rb

@@ -0,0 +1,97 @@
+
+def in_xmigra_schema
+  1.temp_dirs do |schema|
+    Dir.chdir(schema) do
+      initialize_xmigra_schema
+      yield
+    end
+  end
+end
+
+def add_migration(migration_name, reversion_sql=nil)
+  tool = XMigra::NewMigrationAdder.new('.')
+  mig_path = tool.add_migration migration_name
+  mig_chain = XMigra::MigrationChain.new('structure')
+  migration = mig_chain[-1]
+  unless reversion_sql.nil?
+    class <<migration
+      def reversion_tracking_sql
+        '-- TRACK REVERSION OF MIGRATION --'
+      end
+    end
+    rev_file = XMigra::RevertFile.new(migration)
+    rev_file.path.dirname.mkpath
+    rev_file.path.open('w') do |rev_stream|
+      rev_stream.puts reversion_sql
+    end
+  end
+  return migration
+end
+
+def add_migration_reversion_pair(migration_name, reversion_sql)
+  return [add_migration(migration_name, reversion_sql), reversion_sql]
+end
+
+run_test "Generate upgrade with no reversions" do
+  in_xmigra_schema do
+    XMigra::NewMigrationAdder.new('.').tap do |tool|
+      tool.add_migration "Create foo table"
+    end
+    XMigra::Program.run(['upgrade', '--outfile=/dev/null'])
+  end
+end
+
+run_test "Generate reversions script with no reversions" do
+  in_xmigra_schema do
+    XMigra::NewMigrationAdder.new('.').tap do |tool|
+      tool.add_migration "Create foo table"
+    end
+    XMigra::Program.run(['reversions', '--outfile=/dev/null'])
+  end
+end
+
+run_test "Migration reversion contains SQL in reversion file" do
+  in_xmigra_schema do
+    reversion_sql = "DROP TABLE foo;"
+    migration = add_migration("Create foo table", reversion_sql)
+    assert("Reversion commands did not contain expected SQL") {
+      migration.reversion.to_s.include? reversion_sql
+    }
+  end
+end
+
+run_test "Generated revisions script for one migration" do
+  in_xmigra_schema do
+    reversion_sql = "DROP TABLE foo;"
+    migration = add_migration("Create foo table", reversion_sql)
+    assert("Reversions script did not contain reversion SQL") {
+      XMigra::Program.run(['reversions'])
+      test_output.include? reversion_sql
+    }
+  end
+end
+
+run_test "Generated revisions script for one migration removes application record" do
+  in_xmigra_schema do
+    reversion_sql = "DROP TABLE foo;"
+    migration = add_migration("Create foo table", reversion_sql)
+    assert("Reversions script does not remove migration application record") {
+      XMigra::Program.run(['reversions'])
+      script = test_output
+      script =~ /DELETE\s+FROM\s+.?xmigra.?\..?applied.?\s+WHERE\s+.?MigrationID.?\s*=\s*'#{migration.id}'\s*;/
+    }
+  end
+end
+
+run_test "Generate reversions script for two migrations" do
+  in_xmigra_schema do
+    migrations = []
+    migrations << add_migration_reversion_pair("Create foo table", "DROP TABLE foo;")
+    migrations << add_migration_reversion_pair("Add bar column to foo table", "ALTER TABLE foo DROP bar;")
+    assert("ALTER TABLE appeared after DROP TABLE") {
+      XMigra::Program.run(['reversions'])
+      script = test_output
+      (script =~ /ALTER\s+TABLE/) < (script =~ /DROP\s+TABLE/)
+    }
+  end
+end

data/test/runner.rb

@@ -7,6 +7,7 @@ require 'tmpdir'
 
 TESTS = %w[
   git_vcs
+  reversions
 ]
 
 $:.unshift Pathname(__FILE__).expand_path.dirname.dirname + 'lib'
@@ -48,7 +49,13 @@ def run_test(name, &block)
     end
   else
     begin
-      block.call
+      prev_stdout = $stdout
+      $stdout = StringIO.new
+      begin
+        block.call
+      ensure
+        $stdout = prev_stdout
+      end
       exit! 0
     rescue AssertionFailure
       exit! 2
@@ -95,6 +102,11 @@ def initialize_xmigra_schema(path='.', options={})
   end
 end
 
+def test_output
+  return nil unless $stdout.kind_of? StringIO
+  return $stdout.string
+end
+
 def assert(message=nil, &block)
   get_message = proc {
     if !message and File.exist?(block.source_location[0])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmigra
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Next IT Corporation
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,8 @@ files:
 - lib/xmigra/new_migration_adder.rb
 - lib/xmigra/permission_script_writer.rb
 - lib/xmigra/program.rb
+- lib/xmigra/reversion_script_building.rb
+- lib/xmigra/revert_file.rb
 - lib/xmigra/schema_manipulator.rb
 - lib/xmigra/schema_updater.rb
 - lib/xmigra/stored_procedure.rb
@@ -82,6 +84,7 @@ files:
 - lib/xmigra/version.rb
 - lib/xmigra/view.rb
 - test/git_vcs.rb
+- test/reversions.rb
 - test/runner.rb
 - xmigra.gemspec
 homepage: https://github.com/rtweeks/xmigra