xmigra 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87e678fcb7c1e98cff100798bd30948628becbcb
-  data.tar.gz: d89d555130e4e53e28f449f1cfdcd5ded31bf942
+  metadata.gz: 0f93c4d5e00f442d8bd288980b7d3754b5dca202
+  data.tar.gz: 9485199a710af1bd8f2c0ecbfc5ae9186c5e0097
 SHA512:
-  metadata.gz: e35d004c20dc96dfd27418281ce19ded3b1c639d8aa7cb3591ba713c29b3c1246a4389ef63801a270b6409cfef22968f6d0eaa97f71ca2db574b35eedf99b933
-  data.tar.gz: ade9c348aacb41f7a81aa669c60511076fbf20b5ea0464f129473e2a859b0dfd87a558b979910eb88104550d0b32e9f8c3cc9ff683f11055bf282ed8006674f8
+  metadata.gz: 2d7104989df02da32dc2adb897e9a4abf986b1422f541431080540ea76b101065bf42617536c7b2f7609da19e82917a98e810fc66d89f935366f53da827ca297
+  data.tar.gz: a7a66fd0a47c0dca11235f3c8593981fc4fb4ec89f33ef69c0d08b9aa665abba68d0854fffbc149913a9391d30af79c24af6f6704cc045b045e9acacd49b9e7f

data/lib/xmigra/db_support/mssql.rb

@@ -57,7 +57,7 @@ module XMigra
       return @stats_objs
     end
     
-    def in_ddl_transaction
+    def in_ddl_transaction(options={})
       parts = []
       parts << <<-"END_OF_SQL"
 SET ANSI_NULLS ON
@@ -71,18 +71,25 @@ GO
 
 SET NOCOUNT ON
 GO
-
+-------------------- ERROR REFERENCE LINE --------------------
+DECLARE @BATCH_START_OFFSET INTEGER; SET @BATCH_START_OFFSET = 0;
 BEGIN TRY
   BEGIN TRAN;
       END_OF_SQL
       
+      offset_lines = 5
       each_batch(yield) do |batch|
         batch_literal = MSSQLSpecifics.string_literal("\n" + batch)
-        parts << "EXEC sp_executesql @statement = #{batch_literal};"
+        parts << "SET @BATCH_START_OFFSET = #{offset_lines}; EXEC sp_executesql @statement = #{batch_literal}; SET @BATCH_START_OFFSET = 0;"
+        offset_lines += parts[-1].count("\n") + 1
       end
       
+      if options[:dry_run]
+        parts << "  PRINT N'Dry-run successful.  Rolling back changes.'; ROLLBACK TRAN;"
+      else
+        parts << "  COMMIT TRAN;"
+      end
       parts << <<-"END_OF_SQL"
-  COMMIT TRAN;
 END TRY
 BEGIN CATCH
   ROLLBACK TRAN;
@@ -93,7 +100,7 @@ BEGIN CATCH
   
   PRINT N'Update failed: ' + ERROR_MESSAGE();
   PRINT N'    State: ' + CAST(ERROR_STATE() AS NVARCHAR);
-  PRINT N'    Line: ' + CAST(ERROR_LINE() AS NVARCHAR);
+  PRINT N'    Line: ' + CAST(@BATCH_START_OFFSET + ERROR_LINE() - 1 AS NVARCHAR) + N' after ERROR REFERENCE LINE'
 
   SELECT 
       @ErrorMessage = N'Update failed: ' + ERROR_MESSAGE(),

data/lib/xmigra/db_support/psql.rb

@@ -23,8 +23,18 @@ module XMigra
     
     def filename_metavariable; "[{filename}]"; end
     
-    def in_ddl_transaction
-      ["BEGIN;", yield, "COMMIT;"].join("\n")
+    def in_ddl_transaction(options={})
+      transaction_wrapup = begin
+        if options[:dry_run]
+          PgSQLSpecifics.in_plpgsql(%Q{
+            RAISE NOTICE 'Dry-run successful.  Rolling back changes.';
+          }) + "\nROLLBACK;"
+        else
+          "COMMIT;"
+        end
+      end
+      
+      ["BEGIN;", yield, transaction_wrapup].join("\n")
     end
     
     def check_execution_environment_sql

data/lib/xmigra/new_migration_adder.rb

@@ -5,6 +5,11 @@ module XMigra
   class NewMigrationAdder < SchemaManipulator
     OBSOLETE_VERINC_FILE = 'version-upgrade-obsolete.yaml'
     
+    # Return this class (not an instance of it) from a Proc yielded by
+    # each_possible_production_chain_extension_handler to continue through the
+    # handler chain.
+    class IgnoreHandler; end
+    
     def initialize(path)
       super(path)
     end
@@ -23,6 +28,13 @@ module XMigra
       end
       Hash === head_info or raise XMigra::Error, "Invalid #{MigrationChain::HEAD_FILE} format"
       
+      if !head_info.empty? && respond_to?(:vcs_production_contents) && (production_head_contents = vcs_production_contents(head_file))
+        production_head_info = YAML.load(production_head_contents)
+        extending_production = head_info[MigrationChain::LATEST_CHANGE] == production_head_info[MigrationChain::LATEST_CHANGE]
+      else
+        extending_production = false
+      end
+      
       new_fpath = struct_dir.join(
         [Date.today.strftime("%Y-%m-%d"), summary].join(' ') + '.yaml'
       )
@@ -68,7 +80,58 @@ module XMigra
         mv_method.call(bufp, obufp)
       end
       
+      production_chain_extended if extending_production
+      
       return new_fpath
     end
+    
+    # Called when the chain of migrations in the production/master branch is
+    # extended with a new migration.
+    #
+    # This method calls each_possible_production_chain_extension_handler to
+    # generate a chain of handlers.
+    #
+    def production_chain_extended
+      Dir.chdir(self.path) do
+        each_possible_production_chain_extension_handler do |handler|
+          if handler.kind_of? Proc
+            handler_result = handler[]
+            break true unless handler_result == IgnoreHandler
+          else
+            handler_result = system(handler)
+            break true unless handler_result.nil?
+          end
+        end
+      end
+    end
+    
+    # Yield command strings or Proc instances to attempt handling the
+    # production-chain-extension event
+    #
+    # Strings yielded by this method will be executed using Kernel#system.  If
+    # this results in `nil` (command does not exist), processing will continue
+    # through the remaining handlers.
+    #
+    # Procs yielded by this method will be executed without any parameters.
+    # Unless the invocation returns IgnoreHandler, event processing will
+    # terminate after invocation.
+    #
+    def each_possible_production_chain_extension_handler
+      yield "on-prod-chain-extended-local"
+      if respond_to?(:vcs_prod_chain_extension_handler) && (vcs_handler = vcs_prod_chain_extension_handler)
+        yield vcs_handler.to_s
+      end
+      yield "on-prod-chain-extended"
+      yield Proc.new {
+        next unless respond_to? :warning
+        warning(<<END_MESSAGE)
+This command has extended the production migration chain.
+
+Backing up your development database now may be advantageous in case you need
+to accept migrations developed in parallel from upstream before merging your
+work back to the mainline.
+END_MESSAGE
+      }
+    end
   end
 end

data/lib/xmigra/program.rb

@@ -161,6 +161,14 @@ END_OF_HELP
             end
           end
           
+          if use[:dry_run]
+            options.dry_run = false
+            flags.on("--dry-run", "Generated script will test upgrade", 
+                     "  commands without committing changes") do
+              options.dry_run = true
+            end
+          end
+          
           options.source_dir = Dir.pwd
           flags.on("--source=DIR", "Work from/on the schema in DIR") do |dir|
             options.source_dir = File.expand_path(dir)
@@ -349,7 +357,9 @@ migration, and is included in the upgrade metadata stored in the database.  Use
 of the '%program_cmd new' command is recommended; it handles several tiresome
 and error-prone tasks: creating a new migration file with a conformant name,
 setting the "starting from" section to the correct value, and updating
-SCHEMA/structure/head.yaml to reference the newly generated file.
+SCHEMA/structure/head.yaml to reference the newly generated file.  It can also
+print a warning or run a command when the source condition indicates a database
+backup would be a good idea.
 
 The SCHEMA/structure/head.yaml file deserves special note: it contains a
 reference to the last migration to be applied.  Because of this, parallel
@@ -672,6 +682,16 @@ This command generates a new migration file and ties it into the current
 migration chain.  The name of the new file is generated from today's date and
 the given MIGRATION_SUMMARY.  The resulting new file may be opened in an
 editor (see the --[no-]edit option).
+
+If this command extends the production migration chain, it will attempt to
+locate a handler function ("on-prod-chain-extended-local", a VCS-specified
+handler, or "on-prod-chain-extended") executable from the schema root
+directory.  If it cannot locate one of these, it will print a message about
+the advisability of taking a backup of the development database.
+
+Git VCS specifics: The #{GitSpecifics::PRODUCTION_CHAIN_EXTENSION_COMMAND} attribute on the
+database.yaml file can be used to specify a handler for the production chain
+extension.
 END_OF_HELP
       
       argument_error_unless(args.length == 1,
@@ -689,7 +709,7 @@ END_OF_HELP
     end
     
     subcommand 'upgrade', "Generate an upgrade script" do |argv|
-      args, options = command_line(argv, {:production=>true, :outfile=>true},
+      args, options = command_line(argv, {:production=>true, :outfile=>true, :dry_run=>true},
                                    :help=> <<END_OF_HELP)
 Running this command will generate an update script from the source schema.
 Generation of a production script involves more checks on the status of the
@@ -705,6 +725,7 @@ END_OF_HELP
       sql_gen = SchemaUpdater.new(options.source_dir).extend(WarnToStderr)
       sql_gen.load_plugin!
       sql_gen.production = options.production
+      sql_gen.dry_run = options.dry_run
       
       output_to(options.outfile) do |out_stream|
         out_stream.print(sql_gen.update_sql)

data/lib/xmigra/schema_updater.rb

@@ -50,16 +50,21 @@ RUNNING THIS SCRIPT ON A PRODUCTION DATABASE WILL FAIL.
       end
       
       @production = false
+      @dry_run = false
     end
     
-    attr_accessor :production
+    attr_accessor :production, :dry_run
     attr_reader :migrations, :access_artifacts, :indexes, :branch_upgrade
     
     def inspect
       "<#{self.class.name}: path=#{path.to_s.inspect}, db=#{@db_specifics}, vcs=#{@vcs_specifics}>"
     end
     
-    def in_ddl_transaction
+    def in_ddl_transaction(options = {})
+      if options[:dry_run]
+        raise(XMigra::Error, 'DDL transaction not supported; dry-run unavailable.')
+      end
+      
       yield
     end
     
@@ -90,7 +95,7 @@ RUNNING THIS SCRIPT ON A PRODUCTION DATABASE WILL FAIL.
       intro_comment << "\n\n"
       
       # If supported, wrap transactionality around modifications
-      intro_comment + in_ddl_transaction do
+      intro_comment + in_ddl_transaction(:dry_run => @dry_run) do
         script_parts = [
           # Check for blatantly incorrect application of script, e.g. running
           # on master or template database.

data/lib/xmigra/vcs_support/git.rb

@@ -6,6 +6,7 @@ module XMigra
     
     MASTER_HEAD_ATTRIBUTE = 'xmigra-master'
     MASTER_BRANCH_SUBDIR = 'xmigra-master'
+    PRODUCTION_CHAIN_EXTENSION_COMMAND = 'xmigra-on-production-chain-extended'
     
     class AttributesFile
       def initialize(effect_root, access=:shared)
@@ -244,6 +245,34 @@ module XMigra
       git(:rm, path, :get_result=>false)
     end
     
+    def vcs_production_contents(path)
+      return nil unless git_master_head(:required => false)
+      git_fetch_master_branch
+      git(:show, [git_master_local_branch, git_internal_path].join(':'), :quiet=>true)
+    rescue VersionControlError
+      return nil
+    end
+    
+    def vcs_prod_chain_extension_handler
+      attr_val = GitSpecifics.attr_values(
+        PRODUCTION_CHAIN_EXTENSION_COMMAND,
+        self.path + SchemaManipulator::DBINFO_FILE,
+        :required=>false,
+      )[0]
+      
+      # Check for special value
+      return nil if attr_val == 'unspecified'
+      
+      handler_path = Pathname(attr_val)
+      if handler_path.absolute?
+        return handler_path if handler_path.exist?
+      else
+        handler_path = self.path + handler_path
+        return handler_path if handler_path.exist?
+      end
+      return attr_val
+    end
+    
     def production_pattern
       ".+"
     end

data/lib/xmigra/vcs_support/svn.rb

@@ -22,7 +22,7 @@ module XMigra
       def run_svn(subcmd, *args)
         options = (Hash === args[-1]) ? args.pop : {}
         no_result = !options.fetch(:get_result, true)
-        raw_result = options.fetch(:raw, false)
+        raw_result = options.fetch(:raw, false) || subcmd.to_s == 'cat'
         
         cmd_parts = ["svn", subcmd.to_s]
         cmd_parts << "--xml" unless no_result || raw_result
@@ -235,5 +235,107 @@ END_OF_MESSAGE
       return @subversion_info if defined? @subversion_info
       return @subversion_info = subversion(:info, self.path)
     end
+    
+    def vcs_production_contents(path)
+      path = Pathname(path)
+      
+      # Check for a production pattern.  If none exists, there is no way to
+      # identify which branches are production, so essentially no production
+      # content:
+      prod_pat = self.production_pattern
+      return nil if prod_pat.nil?
+      prod_pat = Regexp.compile(prod_pat.chomp)
+      
+      # Is the current branch a production branch?  If so, cat the committed
+      # version:
+      if branch_identifier =~ prod_pat
+        return svn(:cat, path.to_s)
+      end
+      
+      # Use an SvnHistoryTracer to walk back through the history of self.path
+      # looking for a copy from a production branch.
+      tracer = SvnHistoryTracer.new(self.path)
+      
+      while !(match = tracer.earliest_loaded_repopath =~ prod_pat) && tracer.load_parent_commit
+        # loop
+      end
+      
+      if match
+        subversion(:cat, "-r#{tracer.earliest_loaded_revision}", path.to_s)
+      end
+    end
+  end
+  
+  class SvnHistoryTracer
+    include SubversionSpecifics
+    
+    def initialize(path)
+      @path = Pathname(path)
+      info_doc = subversion(:info, path.to_s)
+      @root_url = info_doc.elements['string(info/entry/repository/root)']
+      @most_recent_commit = info_doc.elements['string(info/entry/@revision)'].to_i
+      @history = []
+      @next_query = [branch_identifier, @most_recent_commit]
+      @history.unshift(@next_query.dup)
+    end
+    
+    attr_reader :path, :most_recent_commit, :history
+    
+    def load_parent_commit
+      log_doc = next_earlier_log
+      if copy_elt = copying_element(log_doc)
+        trailing_part = branch_identifier[copy_elt.text.length..-1]
+        @next_query = [
+          copy_elt.attributes['copyfrom-path'] + trailing_part,
+          copy_elt.attributes['copyfrom-rev'].to_i
+        ]
+        @history.unshift(@next_query)
+        @next_query.dup
+      elsif change_elt = log_doc.elements['/log/logentry']
+        @next_query[1] = change_elt.attributes['revision'].to_i - 1
+        @next_query.dup if @next_query[1] > 0
+      else
+        @next_query[1] -= 1
+        @next_query.dup if @next_query[1] > 0
+      end
+    end
+    
+    def history_exhausted?
+      @next_query[1] <= 0
+    end
+    
+    def earliest_loaded_repopath
+      history[0][0]
+    end
+    
+    def earliest_loaded_url
+      @root_url + history[0][0]
+    end
+    
+    def earliest_loaded_revision
+      history[0][1]
+    end
+    
+    def earliest_loaded_pinned_url(rel_path=nil)
+      pin_rev = @history[0][1]
+      if rel_path.nil?
+        [earliest_loaded_url, pin_rev.to_s].join('@')
+      else
+        rel_path = Pathname(rel_path)
+        "#{earliest_loaded_url}/#{rel_path}@#{pin_rev}"
+      end
+    end
+    
+    def copying_element(log_doc)
+      log_doc.each_element %Q{/log/logentry/paths/path[@copyfrom-path]} do |elt|
+        return elt if elt.text == @next_query[0]
+        return elt if @next_query[0].start_with? (elt.text + '/')
+      end
+      return nil
+    end
+    
+    def next_earlier_log
+      subversion(:log, '-l1', '-v', "-r#{@next_query[1]}:1", self.path)
+    end
   end
 end

data/lib/xmigra/version.rb

@@ -1,3 +1,3 @@
 module XMigra
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/test/git_vcs.rb

@@ -239,4 +239,33 @@ if GIT_PRESENT
       end
     end
   end
+  
+  run_test "XMigra detects extension of the production migration chain" do
+    capture_chain_extension = Module.new do
+      def production_chain_extended(*args)
+        (@captured_call_args ||= []) << args
+      end
+      
+      attr_reader :captured_call_args
+    end
+    
+    2.temp_dirs do |upstream, repo|
+      initialize_git_repo(upstream)
+      
+      Dir.chdir(upstream) do
+        commit_a_migration "first table"
+        make_this_branch_master
+      end
+      
+      `git clone "#{upstream.expand_path}" "#{repo}" 2>/dev/null`
+      
+      Dir.chdir(repo) do
+        XMigra::NewMigrationAdder.new('.') do |tool|
+          tool.extend(capture_chain_extension)
+          tool.add_migration('Create foo table')
+          assert_eq tool.captured_call_args, [[]]
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmigra
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Next IT Corporation
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler