xmigra 1.0.1

data/test/git_vcs.rb

@@ -0,0 +1,242 @@
+#!/usr/bin/env ruby
+
+
+GIT_PRESENT = begin
+  `git --version` && $?.success?
+rescue
+  false
+end
+
+def initialize_git_repo(dir)
+  Dir.chdir(dir) do
+    do_or_die "git init", "Failed to initialize git repository"
+    initialize_xmigra_schema
+  end
+end
+
+def commit_all(msg)
+  do_or_die "git add -A"
+  do_or_die "git commit -m \"#{msg}\""
+end
+
+def commit_a_migration(desc_tail)
+  XMigra::NewMigrationAdder.new('.').tap do |tool|
+    tool.add_migration "Create #{desc_tail}"
+  end
+  commit_all "Added #{desc_tail}"
+end
+
+def get_migration_chain_head
+  (Pathname('.') + XMigra::SchemaManipulator::STRUCTURE_SUBDIR + XMigra::MigrationChain::HEAD_FILE).open do |f|
+    YAML.load(f)[XMigra::MigrationChain::LATEST_CHANGE]
+  end
+end
+
+def make_this_branch_master
+  open('.gitattributes', 'w') do |f|
+    f.puts("%s %s=file://%s#%s" % [
+      XMigra::SchemaManipulator::DBINFO_FILE,
+      XMigra::GitSpecifics::MASTER_HEAD_ATTRIBUTE,
+      Dir.pwd,
+      `git rev-parse --abbrev-ref HEAD`.chomp
+    ])
+  end
+  commit_all "Updated master database location"
+end
+
+if GIT_PRESENT
+  run_test "Initialize a git repository" do
+    1.temp_dirs do |repo|
+      initialize_git_repo(repo)
+    end
+  end
+  
+  run_test "XMigra recognizes git version control" do
+    1.temp_dirs do |repo|
+      initialize_git_repo(repo)
+      
+      Dir.chdir(repo) do
+        tool = XMigra::SchemaManipulator.new('.')
+        assert {tool.is_a? XMigra::MSSQLSpecifics}
+      end
+    end
+  end
+  
+  run_test "XMigra can create a new migration" do
+    1.temp_dirs do |repo|
+      initialize_git_repo(repo)
+      
+      Dir.chdir(repo) do
+        tool = XMigra::NewMigrationAdder.new('.')
+        description = "Create the first table"
+        fpath = tool.add_migration(description)
+        assert_include fpath.to_s, description
+      end
+    end
+  end
+  
+  run_test "XMigra can recognize a migration chain conflict" do
+    1.temp_dirs do |repo|
+      initialize_git_repo(repo)
+      
+      Dir.chdir(repo) do
+        commit_a_migration "first table"
+        do_or_die "git branch side"
+        commit_a_migration "foo table"
+        do_or_die "git checkout side 2>/dev/null"
+        commit_a_migration "bar table"
+        `git merge master` # This is not going to go well!
+        
+        XMigra::SchemaManipulator.new('.').tap do |tool|
+          conflict = tool.get_conflict_info
+          assert {not conflict.nil?}
+        end
+      end
+    end
+  end
+  
+  run_test "XMigra can fix a migration chain conflict" do
+    1.temp_dirs do |repo|
+      initialize_git_repo(repo)
+      
+      Dir.chdir(repo) do
+        commit_a_migration "first table"
+        do_or_die "git branch side"
+        commit_a_migration "foo table"
+        do_or_die "git checkout side 2>/dev/null"
+        commit_a_migration "bar table"
+        my_head = get_migration_chain_head
+        `git merge master` # This is not going to go well!
+        
+        XMigra::SchemaManipulator.new('.').tap do |tool|
+          conflict = tool.get_conflict_info
+          assert {not conflict.nil?}
+          conflict.fix_conflict!
+          
+          # Check that the merged migrations are at the end of the chain
+          assert_neq get_migration_chain_head, my_head
+        end
+      end
+    end
+  end
+  
+  run_test "XMigra is aware of upstream branch relationship" do
+    2.temp_dirs do |upstream, repo|
+      initialize_git_repo(upstream)
+      
+      Dir.chdir(upstream) do
+        commit_a_migration "first table"
+      end
+      
+      `git clone "#{upstream}" "#{repo}" 2>/dev/null`
+      
+      Dir.chdir(upstream) do
+        commit_a_migration "foo table"
+      end
+      
+      Dir.chdir(repo) do
+        commit_a_migration "bar table"
+        
+        # Get head migration
+        downstream_head = get_migration_chain_head
+        
+        `git pull origin master 2>/dev/null`
+        
+        XMigra::SchemaManipulator.new('.').tap do |tool|
+          conflict = tool.get_conflict_info
+          assert {conflict}
+          conflict.fix_conflict!
+          
+          # Check that head migration is still what it was (i.e.
+          # merged migrations precede local branch migrations, preventing
+          # modifications to upstream)
+          assert_eq get_migration_chain_head, downstream_head
+        end
+      end
+    end
+  end
+  
+  run_test "XMigra will not generate a production script from a working tree that does not match the master branch" do
+    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(upstream) do
+        commit_a_migration "foo table"
+      end
+      
+      Dir.chdir(repo) do
+        commit_a_migration "bar table"
+        
+        XMigra::SchemaUpdater.new('.').tap do |tool|
+          tool.production = true
+          assert_neq(tool.branch_use, :production)
+          assert_raises(XMigra::VersionControlError) {tool.update_sql}
+        end
+      end
+    end
+  end
+  
+  run_test "XMigra will generate a production script from an older commit from the master branch" do
+    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(upstream) do
+        commit_a_migration "foo table"
+      end
+      
+      Dir.chdir(repo) do
+        XMigra::SchemaUpdater.new('.').tap do |tool|
+          tool.production = true
+          assert_noraises {tool.update_sql}
+        end
+      end
+    end
+  end
+  
+  run_test "XMigra will generate a production script even if an access object's definition changes" do
+    2.temp_dirs do |upstream, repo|
+      initialize_git_repo(upstream)
+      
+      Dir.chdir(upstream) do
+        commit_a_migration "first table"
+        make_this_branch_master
+        Dir.mkdir(XMigra::SchemaManipulator::ACCESS_SUBDIR)
+        (Pathname(XMigra::SchemaManipulator::ACCESS_SUBDIR) + 'Bar.yaml').open('w') do |f|
+          YAML.dump({'define'=>'stored procedure', 'sql'=>'definition goes here'}, f)
+        end
+        commit_all 'Defined Bar'
+        (Pathname(XMigra::SchemaManipulator::ACCESS_SUBDIR) + 'Bar.yaml').open('w') do |f|
+          YAML.dump({'define'=>'view', 'sql'=>'definition goes here'}, f)
+        end
+        commit_all 'Changed Bar to a view'
+      end
+      
+      `git clone "#{upstream.expand_path}" "#{repo}" 2>/dev/null`
+      
+      Dir.chdir(upstream) do
+        commit_a_migration "foo table"
+      end
+      
+      Dir.chdir(repo) do
+        XMigra::SchemaUpdater.new('.').tap do |tool|
+          tool.production = true
+          assert_noraises {tool.update_sql}
+        end
+      end
+    end
+  end
+end

data/test/runner.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'pathname'
+require 'stringio'
+require 'tmpdir'
+
+TESTS = %w[
+  git_vcs
+]
+
+$:.unshift Pathname(__FILE__).expand_path.dirname.dirname
+require 'xmigra'
+
+$test_count = 0
+$test_successes = 0
+$tests_failed = []
+
+$xmigra_test_system = 'Microsoft SQL Server'
+
+def run_test(name, &block)
+  $test_count += 1
+  
+  if child_pid = Process.fork
+    Process.wait(child_pid)
+    
+    if $?.success?
+      print '.'
+      $test_successes += 1
+    else
+      print 'F'
+      $tests_failed << name
+    end
+  else
+    begin
+      block.call
+      exit! 0
+    rescue
+      puts
+      puts "Exception: #{$!}"
+      puts $!.backtrace
+      exit! 1
+    end
+  end
+end
+
+class Integer
+  def temp_dirs(prefix='')
+    tmpdirs = []
+    begin
+      (1..self).each do |i|
+        tmpdirs << Pathname(Dir.mktmpdir([prefix, ".#{i}"]))
+      end
+      
+      yield(*tmpdirs)
+    ensure
+      tmpdirs.each do |dp|
+        begin
+          FileUtils.remove_entry dp
+        rescue
+          # Skip failure
+        end
+      end
+    end
+  end
+end
+
+def do_or_die(command, message=nil, exc_type=Exception)
+  output = `#{command}`
+  $?.success? || raise(exc_type, message || ("Unable to " + command + "\n" + output))
+end
+
+def initialize_xmigra_schema(path='.', options={})
+  (Pathname(path) + XMigra::SchemaManipulator::DBINFO_FILE).open('w') do |f|
+    YAML.dump({
+      'system' => $xmigra_test_system,
+    }.merge(options[:db_info] || {}), f)
+  end
+end
+
+class AssertionFailure < Exception; end
+
+def assert(message=nil, &block)
+  get_message = proc {
+    if !message and File.exist?(block.source_location[0])
+      File.read(block.source_location[0]).lines[block.source_location[1] - 1].strip
+    elsif message.is_a? Proc
+      message.call
+    else
+      message
+    end
+  }
+  
+  block.call || raise(AssertionFailure, get_message.call)
+end
+
+def assert_eq(actual, expected)
+  assert(proc {"#{actual.inspect} was not equal to #{expected.inspect}"}) {actual == expected}
+end
+
+def assert_neq(actual, expected)
+  assert(proc {"Value #{actual.inspect} was unexpected"}) {actual != expected}
+end
+
+def assert_include(container, item)
+  assert(proc {"#{item.inspect} was not in #{container.inspect}"}) {container.include? item}
+end
+
+def assert_raises(expected_exception)
+  begin
+    yield
+  rescue Exception => ex
+    assert("#{ex.class} is not #{expected_exception}") {ex.is_a? expected_exception}
+    return
+  end
+  
+  assert("No #{expected_exception} raised") {false}
+end
+
+def assert_noraises
+  yield
+end
+
+TESTS.each {|t| require "test/#{t}"}
+
+puts
+puts "#{$test_successes}/#{$test_count} succeeded"
+puts "Failed tests:" unless $tests_failed.empty?
+$tests_failed.each {|name| puts "    #{name}"}
+

data/xmigra.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xmigra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xmigra"
+  spec.version       = XMigra::VERSION
+  spec.authors       = ["Next IT Corporation", "Richard Weeks"]
+  spec.email         = ["rtweeks21@gmail.com"]
+  spec.summary       = %q{Toolkit for managing database schema evolution with version control.}
+  spec.description   = <<-END
+    XMigra is a suite of tools for managing database schema evolution with
+    version controlled files.  All database manipulations are written in
+    SQL (specific to the target database).  Works with Git or Subversion.
+    Currently supports Microsoft SQL Server.
+  END
+  spec.homepage      = "https://github.com/rtweeks/xmigra"
+  spec.license       = "CC-BY-SA 4.0 Itnl."
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = ["test/runner.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: xmigra
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Next IT Corporation
+- Richard Weeks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      XMigra is a suite of tools for managing database schema evolution with
+      version controlled files.  All database manipulations are written in
+      SQL (specific to the target database).  Works with Git or Subversion.
+      Currently supports Microsoft SQL Server.
+email:
+- rtweeks21@gmail.com
+executables:
+- xmigra
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.html
+- README.md
+- Rakefile
+- bin/xmigra
+- lib/xmigra.rb
+- lib/xmigra/version.rb
+- test/git_vcs.rb
+- test/runner.rb
+- xmigra.gemspec
+homepage: https://github.com/rtweeks/xmigra
+licenses:
+- CC-BY-SA 4.0 Itnl.
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Toolkit for managing database schema evolution with version control.
+test_files:
+- test/runner.rb