Refactor DBUps into subclasses

Author: ianballou

definitions/checks/candlepin/db_up.rb

@@ -1,33 +1,22 @@
+require_relative '../db_up_check'
+
 module Checks
   module Candlepin
-    class DBUp < ForemanMaintain::Check
+    class DBUp < DBUpCheck
       metadata do
         description 'Make sure Candlepin DB is up'
         label :candlepin_db_up
         for_feature :candlepin_database
       end
 
-      def run
-        status = false
-        if feature(:candlepin_database).psql_cmd_available?
-          with_spinner('Checking connection to the Candlepin DB') do
-            status = feature(:candlepin_database).ping
-          end
-          assert(status, 'Candlepin DB is not responding. ' \
-            'It needs to be up and running to perform the following steps',
-            :next_steps => start_pgsql)
-        else
-          feature(:candlepin_database).raise_psql_missing_error
-        end
+      def database_feature
+        :candlepin_database
       end
 
-      def start_pgsql
-        if feature(:candlepin_database).local?
-          [Procedures::Service::Start.new(:only => 'postgresql')]
-        else
-          [] # there is nothing we can do for remote db
-        end
+      def database_name
+        'Candlepin'
       end
     end
   end
 end
+

definitions/checks/container_gateway/db_up.rb

@@ -1,28 +1,20 @@
+require_relative '../db_up_check'
+
 module Checks
   module ContainerGateway
-    class DBUp < ForemanMaintain::Check
+    class DBUp < DBUpCheck
       metadata do
         description 'Make sure ContainerGateway DB is up'
         label :container_gateway_db_up
         for_feature :container_gateway_database
       end
 
-      def run
-        status = false
-        with_spinner('Checking connection to the Container Gateway DB') do
-          status = feature(:container_gateway_database).ping
-        end
-        assert(status, 'Container Gateway DB is not responding. ' \
-          'It needs to be up and running to perform the following steps',
-          :next_steps => next_steps)
+      def database_feature
+        :container_gateway_database
       end
 
-      def next_steps
-        if feature(:container_gateway_database).local?
-          [Procedures::Service::Start.new(:only => 'postgresql')]
-        else
-          [] # there is nothing we can do for remote db
-        end
+      def database_name
+        'Container Gateway'
       end
     end
   end

definitions/checks/db_up_check.rb

@@ -0,0 +1,34 @@
+module Checks
+  class DBUpCheck < ForemanMaintain::Check
+    def run
+      status = false
+      if feature(database_feature).psql_cmd_available?
+        with_spinner("Checking connection to the #{database_name} DB") do
+          status = feature(database_feature).ping
+        end
+        assert(status, "#{database_name} DB is not responding. " \
+          "It needs to be up and running to perform the following steps",
+          :next_steps => start_pgsql)
+      else
+        feature(database_feature).raise_psql_missing_error
+      end
+    end
+
+    def start_pgsql
+      if feature(database_feature).local?
+        [Procedures::Service::Start.new(:only => 'postgresql')]
+      else
+        [] # there is nothing we can do for remote db
+      end
+    end
+
+    def database_feature
+      raise NotImplementedError, 'Subclasses must define `database_feature`'
+    end
+
+    def database_name
+      raise NotImplementedError, 'Subclasses must define `database_name`'
+    end
+  end
+end
+

definitions/checks/foreman/db_up.rb

@@ -1,33 +1,22 @@
+require_relative '../db_up_check'
+
 module Checks
   module Foreman
-    class DBUp < ForemanMaintain::Check
+    class DBUp < DBUpCheck
       metadata do
         description 'Make sure Foreman DB is up'
         label :foreman_db_up
         for_feature :foreman_database
       end
 
-      def run
-        status = false
-        if feature(:foreman_database).psql_cmd_available?
-          with_spinner('Checking connection to the Foreman DB') do
-            status = feature(:foreman_database).ping
-          end
-          assert(status, 'Foreman DB is not responding. ' \
-            'It needs to be up and running to perform the following steps',
-            :next_steps => start_pgsql)
-        else
-          feature(:foreman_database).raise_psql_missing_error
-        end
+      def database_feature
+        :foreman_database
       end
 
-      def start_pgsql
-        if feature(:foreman_database).local?
-          [Procedures::Service::Start.new(:only => 'postgresql')]
-        else
-          [] # there is nothing we can do for remote db
-        end
+      def database_name
+        'Foreman'
       end
     end
   end
 end
+

definitions/checks/pulpcore/db_up.rb

@@ -1,29 +1,22 @@
+require_relative '../db_up_check'
+
 module Checks
   module Pulpcore
-    class DBUp < ForemanMaintain::Check
+    class DBUp < DBUpCheck
       metadata do
         description 'Make sure Pulpcore DB is up'
         label :pulpcore_db_up
         for_feature :pulpcore_database
       end
 
-      def run
-        status = false
-        with_spinner('Checking connection to the Pulpcore DB') do
-          status = feature(:pulpcore_database).ping
-        end
-        assert(status, 'Pulpcore DB is not responding. ' \
-          'It needs to be up and running to perform the following steps',
-          :next_steps => next_steps)
+      def database_feature
+        :pulpcore_database
       end
 
-      def next_steps
-        if feature(:pulpcore_database).local?
-          [Procedures::Service::Start.new(:only => 'postgresql')]
-        else
-          [] # there is nothing we can do for remote db
-        end
+      def database_name
+        'Pulpcore'
       end
     end
   end
 end
+

definitions/procedures/restore/extract_files.rb

@@ -49,7 +49,12 @@ def extract_pulp_data(backup)
     end
 
     def any_database
-      feature(:foreman_database) || feature(:candlepin_database) || feature(:pulpcore_database) || feature(:container_gateway_database)
+      %i[
+        foreman_database
+        candlepin_database
+        pulpcore_database
+        container_gateway_database
+      ].any? { |db| feature(db) }
     end
 
     def extract_pgsql_data(backup)