Add RailsSchemaUpToDate Hook

Change-Id: I0d72670f215b79a46bce84abaf7f6fcc7a990b37
Reviewed-on: http://gerrit.causes.com/37946
Tested-by: jenkins <jenkins@causes.com>
Reviewed-by: Shane da Silva <shane@causes.com>

Author: jfelchner

config/default.yml

@@ -102,6 +102,13 @@ PreCommit:
     description: 'Analyzing with flake8'
     include: '**/*.py'
 
+  RailsSchemaUpToDate:
+    description: 'Checking if database schema is up to date'
+    include:
+      - 'db/migrate/*.rb'
+      - 'db/schema.rb'
+      - 'db/structure.sql'
+
   Rubocop:
     description: 'Analyzing with Rubocop'
     include:

lib/overcommit/hook/pre_commit/rails_schema_up_to_date.rb

@@ -0,0 +1,36 @@
+module Overcommit::Hook::PreCommit
+  # Check to see whether the schema file is in line with the migrations
+  class RailsSchemaUpToDate < Base
+    def run
+      if migration_files.any? && schema_files.none?
+        return :bad, "It looks like you're adding a migration, but did not update the schema file"
+      elsif migration_files.none? && schema_files.any?
+        return :bad, "You're trying to change the schema without adding a migration file"
+      elsif migration_files.any? && schema_files.any?
+        latest_version = migration_files.map  { |file| file[/\d+/] }.sort.last
+        schema         = schema_files.map     { |file| File.read(file) }.join
+        up_to_date     = schema.include?(latest_version)
+
+        unless up_to_date
+          return :bad, "The latest migration version you're committing is #{latest_version} but your schema file #{schema_files.join(' or ')} is on a different version."
+        end
+      end
+
+      :good
+    end
+
+    private
+
+    def migration_files
+      @migration_files ||= applicable_files.select do |file|
+        file.match %r{db/migrate/.*\.rb}
+      end
+    end
+
+    def schema_files
+      @schema_files    ||= applicable_files.select do |file|
+        file.match %r{db/schema\.rb|db/structure.*\.sql}
+      end
+    end
+  end
+end

spec/overcommit/hook/pre_commit/rails_schema_up_to_date_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+describe Overcommit::Hook::PreCommit::RailsSchemaUpToDate do
+  let(:config)            { Overcommit::ConfigurationLoader.default_configuration }
+  let(:context)           { double('context') }
+  let(:migration_files)   { %w{db/migrate/20140304042233_some_migration.rb
+                               db/migrate/20140305123456_some_migration.rb} }
+  let(:ruby_schema_file)  { 'db/schema.rb' }
+  let(:sql_schema_file)   { 'db/structure.sql' }
+
+  subject                 { described_class.new(config, context) }
+
+  context "when a migration was added but the schema wasn't updated" do
+    before do
+      subject.stub(:applicable_files).and_return(migration_files)
+    end
+
+    around do |example|
+      repo do
+        FileUtils.mkdir_p('db/migrate')
+
+        migration_files.each do |migration_file|
+          File.open(migration_file, 'w') { |f| f.write('migration') }
+          `git add #{migration_file}`
+        end
+
+        example.run
+      end
+    end
+
+    it { should fail_hook }
+  end
+
+  context "when a ruby schema file was added but no migration files were" do
+    before do
+      subject.stub(:applicable_files).and_return([ruby_schema_file])
+    end
+
+    around do |example|
+      repo do
+        FileUtils.mkdir_p('db/migrate')
+        File.open(ruby_schema_file, 'w') { |f| f.write('schema') }
+        `git add #{ruby_schema_file}`
+        example.run
+      end
+    end
+
+    it { should fail_hook }
+  end
+
+  context "when a SQL schema file was added but no migration files were" do
+    before do
+      subject.stub(:applicable_files).and_return([sql_schema_file])
+    end
+
+    around do |example|
+      repo do
+        FileUtils.mkdir_p('db/migrate')
+        File.open(sql_schema_file, 'w') { |f| f.write('schema') }
+        `git add #{sql_schema_file}`
+        example.run
+      end
+    end
+
+    it { should fail_hook }
+  end
+
+  context "when both a Ruby schema file with the latest version and migrations are added" do
+    before do
+      subject.stub(:applicable_files).and_return(migration_files << ruby_schema_file)
+    end
+
+    around do |example|
+      repo do
+        FileUtils.mkdir_p('db/migrate')
+
+        File.open(ruby_schema_file, 'w') { |f| f.write('20140305123456') }
+        `git add #{ruby_schema_file}`
+
+        migration_files.each do |migration_file|
+          File.open(migration_file, 'w') { |f| f.write('migration') }
+          `git add #{migration_file}`
+        end
+
+        example.run
+      end
+    end
+
+    it { should pass }
+  end
+
+  context "when both a Ruby schema file which is not at the latest version and migrations are added" do
+    before do
+      subject.stub(:applicable_files).and_return(migration_files << ruby_schema_file)
+    end
+
+    around do |example|
+      repo do
+        FileUtils.mkdir_p('db/migrate')
+
+        File.open(ruby_schema_file, 'w') { |f| f.write('20140205123456') }
+        `git add #{ruby_schema_file}`
+
+        migration_files.each do |migration_file|
+          File.open(migration_file, 'w') { |f| f.write('migration') }
+          `git add #{migration_file}`
+        end
+
+        example.run
+      end
+    end
+
+    it { should fail_hook }
+  end
+
+  context "when both a SQL schema file with the latest version and migrations are added" do
+    before do
+      subject.stub(:applicable_files).and_return(migration_files << sql_schema_file)
+    end
+
+    around do |example|
+      repo do
+        FileUtils.mkdir_p('db/migrate')
+
+        File.open(sql_schema_file, 'w') { |f| f.write('20140305123456') }
+        `git add #{sql_schema_file}`
+
+        migration_files.each do |migration_file|
+          File.open(migration_file, 'w') { |f| f.write('migration') }
+          `git add #{migration_file}`
+        end
+
+        example.run
+      end
+    end
+
+    it { should pass }
+  end
+
+  context "when both a SQL schema file which is not at the latest version and migrations are added" do
+    before do
+      subject.stub(:applicable_files).and_return(migration_files << sql_schema_file)
+    end
+
+    around do |example|
+      repo do
+        FileUtils.mkdir_p('db/migrate')
+
+        File.open(sql_schema_file, 'w') { |f| f.write('20140205123456') }
+        `git add #{sql_schema_file}`
+
+        migration_files.each do |migration_file|
+          File.open(migration_file, 'w') { |f| f.write('migration') }
+          `git add #{migration_file}`
+        end
+
+        example.run
+      end
+    end
+
+    it { should fail_hook }
+  end
+end