Restore backup database.yml when retesting after interrupt

MSP-11153

Restore the config/database.yml backed up to
config/database.yml.cucumber.bak in the db:config:restore task, which is
made a dependency of the environment rake task so that
config/database.yml is restored before Rails tries to use it in the
environment task.  This specifically, allows for rake cucumber to be
interrupted when the config/database.yml has been moved to
config/database.yml.cucumber.bak and a subsequence rake cucumber to
succeed and restore config/database.yml, but any task that depends on
environment will restore the config/database.yml.

Author: limhoff-r7

features/step_definitions/project.rb

@@ -1,28 +1,14 @@
-project_database_yaml_path = Rails.root.join('config', 'database.yml').to_path
-backup_project_database_yaml_path = "#{project_database_yaml_path}.cucumber.bak"
-
-Before do
-  if File.exist?(backup_project_database_yaml_path)
-    File.delete(backup_project_database_yaml_path)
-  end
-end
+require 'metasploit/framework/database/cucumber'
 
 Given /^the project "database.yml" does not exist$/ do
-  if File.exist?(project_database_yaml_path)
-    File.rename(project_database_yaml_path, backup_project_database_yaml_path)
-  end
+  Metasploit::Framework::Database::Cucumber.backup_project_configurations
 end
 
 Given /^the project "database.yml" exists with:$/ do |file_content|
-  if File.exist?(project_database_yaml_path)
-    File.rename(project_database_yaml_path, backup_project_database_yaml_path)
-  end
-
-  write_file(project_database_yaml_path, file_content)
+  Metasploit::Framework::Database::Cucumber.backup_project_configurations
+  write_file(Metasploit::Framework::Database::Cucumber.project_configurations_path, file_content)
 end
 
 After do
-  if File.exist?(backup_project_database_yaml_path)
-    File.rename(backup_project_database_yaml_path, project_database_yaml_path)
-  end
+  Metasploit::Framework::Database::Cucumber.restore_project_configurations
 end

lib/metasploit/framework/database/cucumber.rb

@@ -0,0 +1,36 @@
+require 'metasploit/framework/database'
+
+module Metasploit::Framework::Database::Cucumber
+  def self.project_configurations_path
+    Rails.root.join('config', 'database.yml').to_path
+  end
+
+  def self.backup_project_configurations
+    if File.exist?(project_configurations_path)
+      # assume that the backup file is from a previously aborted run and it contains the real database.yml data, so
+      # just delete the fake database.yml and the After hook will restore the real database.yml from the backup location
+      if File.exist?(backup_project_configurations_path)
+        File.delete(project_configurations_path)
+      else
+        # project contains the real database.yml and there was no previous, aborted run.
+        File.rename(project_configurations_path, backup_project_configurations_path)
+      end
+    end
+  end
+
+  def self.backup_project_configurations_path
+    "#{project_configurations_path}.cucumber.bak"
+  end
+
+  def self.restore_project_configurations
+    if File.exist?(backup_project_configurations_path)
+      if File.exist?(project_configurations_path)
+        # Remove fake, leftover database.yml
+        File.delete(project_configurations_path)
+      end
+
+      File.rename(backup_project_configurations_path, project_configurations_path)
+    end
+  end
+end
+

lib/tasks/cucumber.rake

@@ -54,6 +54,15 @@ begin
   task 'db:test:prepare' do
   end
 
+  task 'db:config:restore' do
+    require 'metasploit/framework/database/cucumber'
+    Metasploit::Framework::Database::Cucumber.restore_project_configurations
+  end
+
+  # Restore the config/database.yml from config/database.cucumber.yml before attempting to copy development to test
+  # database in order to recover from interrupted cucumber runs
+  task 'environment' => 'db:config:restore'
+
   task :stats => 'cucumber:statsetup'
 rescue LoadError
   desc 'cucumber rake task not available (cucumber not installed)'