Merge branch 'db-configure-rake-task' into 'master'

Add a gitlab:db:configure rake task to handle conditionally seeding or
migrating the database.

Fixes: https://gitlab.com/gitlab-org/gitlab-ce/issues/17328

See merge request !4062

3 files changed, 73 insertions, 0 deletions

diff --git a/CHANGELOG b/CHANGELOG
index c59a66874c3..7aa12018bb3 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -3,6 +3,7 @@ Please view this file on the master branch, on stable branches it's out of date.
 v 8.9.0 (unreleased)
   - Redesign navigation for project pages
   - Use gitlab-shell v3.0.0
+  - Add rake task 'gitlab:db:configure' for conditionally seeding or migrating the database
   - Changed the Slack build message to use the singular duration if necessary (Aran Koning)
   - Fix issues filter when ordering by milestone
   - Todos will display target state if issuable target is 'Closed' or 'Merged'
diff --git a/lib/tasks/gitlab/db.rake b/lib/tasks/gitlab/db.rake
index e473b756023..86f5d65f128 100644
--- a/lib/tasks/gitlab/db.rake
+++ b/lib/tasks/gitlab/db.rake
@@ -36,5 +36,15 @@ namespace :gitlab do
       # Add `IF EXISTS` because cascade could have already deleted a table.
       tables.each { |t| connection.execute("DROP TABLE IF EXISTS #{t} CASCADE") }
     end
+
+    desc 'Configures the database by running migrate, or by loading the schema and seeding if needed'
+    task configure: :environment do
+      if ActiveRecord::Base.connection.tables.any?
+        Rake::Task['db:migrate'].invoke
+      else
+        Rake::Task['db:schema:load'].invoke
+        Rake::Task['db:seed_fu'].invoke
+      end
+    end
   end
 end
diff --git a/spec/tasks/gitlab/db_rake_spec.rb b/spec/tasks/gitlab/db_rake_spec.rb
new file mode 100644
index 00000000000..36d03a224e4
--- /dev/null
+++ b/spec/tasks/gitlab/db_rake_spec.rb
@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'rake'
+
+describe 'gitlab:db namespace rake task' do
+  before :all do
+    Rake.application.rake_require 'active_record/railties/databases'
+    Rake.application.rake_require 'tasks/seed_fu'
+    Rake.application.rake_require 'tasks/gitlab/db'
+
+    # empty task as env is already loaded
+    Rake::Task.define_task :environment
+  end
+
+  before do
+    # Stub out db tasks
+    allow(Rake::Task['db:migrate']).to receive(:invoke).and_return(true)
+    allow(Rake::Task['db:schema:load']).to receive(:invoke).and_return(true)
+    allow(Rake::Task['db:seed_fu']).to receive(:invoke).and_return(true)
+  end
+
+  describe 'configure' do
+    it 'should invoke db:migrate when schema has already been loaded' do
+      allow(ActiveRecord::Base.connection).to receive(:tables).and_return(['default'])
+      expect(Rake::Task['db:migrate']).to receive(:invoke)
+      expect(Rake::Task['db:schema:load']).not_to receive(:invoke)
+      expect(Rake::Task['db:seed_fu']).not_to receive(:invoke)
+      expect { run_rake_task('gitlab:db:configure') }.not_to raise_error
+    end
+
+    it 'should invoke db:shema:load and db:seed_fu when schema is not loaded' do
+      allow(ActiveRecord::Base.connection).to receive(:tables).and_return([])
+      expect(Rake::Task['db:schema:load']).to receive(:invoke)
+      expect(Rake::Task['db:seed_fu']).to receive(:invoke)
+      expect(Rake::Task['db:migrate']).not_to receive(:invoke)
+      expect { run_rake_task('gitlab:db:configure') }.not_to raise_error
+    end
+
+    it 'should not invoke any other rake tasks during an error' do
+      allow(ActiveRecord::Base).to receive(:connection).and_raise(RuntimeError, 'error')
+      expect(Rake::Task['db:migrate']).not_to receive(:invoke)
+      expect(Rake::Task['db:schema:load']).not_to receive(:invoke)
+      expect(Rake::Task['db:seed_fu']).not_to receive(:invoke)
+      expect { run_rake_task('gitlab:db:configure') }.to raise_error(RuntimeError, 'error')
+      # unstub connection so that the database cleaner still works
+      allow(ActiveRecord::Base).to receive(:connection).and_call_original
+    end
+
+    it 'should not invoke seed after a failed schema_load' do
+      allow(ActiveRecord::Base.connection).to receive(:tables).and_return([])
+      allow(Rake::Task['db:schema:load']).to receive(:invoke).and_raise(RuntimeError, 'error')
+      expect(Rake::Task['db:schema:load']).to receive(:invoke)
+      expect(Rake::Task['db:seed_fu']).not_to receive(:invoke)
+      expect(Rake::Task['db:migrate']).not_to receive(:invoke)
+      expect { run_rake_task('gitlab:db:configure') }.to raise_error(RuntimeError, 'error')
+    end
+  end
+
+  def run_rake_task(task_name)
+    Rake::Task[task_name].reenable
+    Rake.application.invoke_task task_name
+  end
+end