From 6855e6b5864abcf01689720424a4bea4c3b9fec2 Mon Sep 17 00:00:00 2001
From: Michael Kozono <mkozono@gmail.com>
Date: Tue, 27 Nov 2018 16:08:31 -0800
Subject: Extract system check rake task logic

These changes make the code more reusable, testable, and most
importantly, overrideable.
---
 lib/system_check/gitaly_check.rb                   | 19 +++++++
 lib/system_check/gitlab_shell_check.rb             | 56 ++++++++++++++++++++
 lib/system_check/incoming_email_check.rb           | 27 ++++++++++
 lib/system_check/ldap_check.rb                     | 60 ++++++++++++++++++++++
 lib/system_check/orphans/repository_check.rb       |  1 -
 lib/system_check/rake_task/app_task.rb             | 38 ++++++++++++++
 lib/system_check/rake_task/gitaly_task.rb          | 18 +++++++
 lib/system_check/rake_task/gitlab_shell_task.rb    | 18 +++++++
 lib/system_check/rake_task/gitlab_task.rb          | 33 ++++++++++++
 lib/system_check/rake_task/incoming_email_task.rb  | 18 +++++++
 lib/system_check/rake_task/ldap_task.rb            | 18 +++++++
 .../rake_task/orphans/namespace_task.rb            | 20 ++++++++
 .../rake_task/orphans/repository_task.rb           | 20 ++++++++
 lib/system_check/rake_task/orphans_task.rb         | 21 ++++++++
 lib/system_check/rake_task/rake_task_helpers.rb    | 32 ++++++++++++
 lib/system_check/rake_task/sidekiq_task.rb         | 18 +++++++
 lib/system_check/sidekiq_check.rb                  | 58 +++++++++++++++++++++
 17 files changed, 474 insertions(+), 1 deletion(-)
 create mode 100644 lib/system_check/gitaly_check.rb
 create mode 100644 lib/system_check/gitlab_shell_check.rb
 create mode 100644 lib/system_check/incoming_email_check.rb
 create mode 100644 lib/system_check/ldap_check.rb
 create mode 100644 lib/system_check/rake_task/app_task.rb
 create mode 100644 lib/system_check/rake_task/gitaly_task.rb
 create mode 100644 lib/system_check/rake_task/gitlab_shell_task.rb
 create mode 100644 lib/system_check/rake_task/gitlab_task.rb
 create mode 100644 lib/system_check/rake_task/incoming_email_task.rb
 create mode 100644 lib/system_check/rake_task/ldap_task.rb
 create mode 100644 lib/system_check/rake_task/orphans/namespace_task.rb
 create mode 100644 lib/system_check/rake_task/orphans/repository_task.rb
 create mode 100644 lib/system_check/rake_task/orphans_task.rb
 create mode 100644 lib/system_check/rake_task/rake_task_helpers.rb
 create mode 100644 lib/system_check/rake_task/sidekiq_task.rb
 create mode 100644 lib/system_check/sidekiq_check.rb

(limited to 'lib/system_check')

diff --git a/lib/system_check/gitaly_check.rb b/lib/system_check/gitaly_check.rb
new file mode 100644
index 00000000000..3d2517a7aca
--- /dev/null
+++ b/lib/system_check/gitaly_check.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  class GitalyCheck < BaseCheck
+    set_name 'Gitaly:'
+
+    def multi_check
+      Gitlab::HealthChecks::GitalyCheck.readiness.each do |result|
+        $stdout.print "#{result.labels[:shard]} ... "
+
+        if result.success
+          $stdout.puts 'OK'.color(:green)
+        else
+          $stdout.puts "FAIL: #{result.message}".color(:red)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/system_check/gitlab_shell_check.rb b/lib/system_check/gitlab_shell_check.rb
new file mode 100644
index 00000000000..31c4ec33247
--- /dev/null
+++ b/lib/system_check/gitlab_shell_check.rb
@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  # Used by gitlab:gitlab_shell:check rake task
+  class GitlabShellCheck < BaseCheck
+    set_name 'GitLab Shell:'
+
+    def multi_check
+      check_gitlab_shell
+      check_gitlab_shell_self_test
+    end
+
+    private
+
+    def check_gitlab_shell
+      required_version = Gitlab::VersionInfo.parse(Gitlab::Shell.version_required)
+      current_version = Gitlab::VersionInfo.parse(gitlab_shell_version)
+
+      $stdout.print "GitLab Shell version >= #{required_version} ? ... "
+      if current_version.valid? && required_version <= current_version
+        $stdout.puts "OK (#{current_version})".color(:green)
+      else
+        $stdout.puts "FAIL. Please update gitlab-shell to #{required_version} from #{current_version}".color(:red)
+      end
+    end
+
+    def check_gitlab_shell_self_test
+      gitlab_shell_repo_base = gitlab_shell_path
+      check_cmd = File.expand_path('bin/check', gitlab_shell_repo_base)
+      $stdout.puts "Running #{check_cmd}"
+
+      if system(check_cmd, chdir: gitlab_shell_repo_base)
+        $stdout.puts 'gitlab-shell self-check successful'.color(:green)
+      else
+        $stdout.puts 'gitlab-shell self-check failed'.color(:red)
+        try_fixing_it(
+          'Make sure GitLab is running;',
+          'Check the gitlab-shell configuration file:',
+          sudo_gitlab("editor #{File.expand_path('config.yml', gitlab_shell_repo_base)}")
+        )
+        fix_and_rerun
+      end
+    end
+
+    # Helper methods
+    ########################
+
+    def gitlab_shell_path
+      Gitlab.config.gitlab_shell.path
+    end
+
+    def gitlab_shell_version
+      Gitlab::Shell.new.version
+    end
+  end
+end
diff --git a/lib/system_check/incoming_email_check.rb b/lib/system_check/incoming_email_check.rb
new file mode 100644
index 00000000000..155b6547595
--- /dev/null
+++ b/lib/system_check/incoming_email_check.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  # Used by gitlab:incoming_email:check rake task
+  class IncomingEmailCheck < BaseCheck
+    set_name 'Incoming Email:'
+
+    def multi_check
+      if Gitlab.config.incoming_email.enabled
+        checks = [
+          SystemCheck::IncomingEmail::ImapAuthenticationCheck
+        ]
+
+        if Rails.env.production?
+          checks << SystemCheck::IncomingEmail::InitdConfiguredCheck
+          checks << SystemCheck::IncomingEmail::MailRoomRunningCheck
+        else
+          checks << SystemCheck::IncomingEmail::ForemanConfiguredCheck
+        end
+
+        SystemCheck.run('Reply by email', checks)
+      else
+        $stdout.puts 'Reply by email is disabled in config/gitlab.yml'
+      end
+    end
+  end
+end
diff --git a/lib/system_check/ldap_check.rb b/lib/system_check/ldap_check.rb
new file mode 100644
index 00000000000..619fb3cccb8
--- /dev/null
+++ b/lib/system_check/ldap_check.rb
@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  # Used by gitlab:ldap:check rake task
+  class LdapCheck < BaseCheck
+    set_name 'LDAP:'
+
+    def multi_check
+      if Gitlab::Auth::LDAP::Config.enabled?
+        # Only show up to 100 results because LDAP directories can be very big.
+        # This setting only affects the `rake gitlab:check` script.
+        limit = ENV['LDAP_CHECK_LIMIT']
+        limit = 100 if limit.blank?
+
+        check_ldap(limit)
+      else
+        $stdout.puts 'LDAP is disabled in config/gitlab.yml'
+      end
+    end
+
+    private
+
+    def check_ldap(limit)
+      servers = Gitlab::Auth::LDAP::Config.providers
+
+      servers.each do |server|
+        $stdout.puts "Server: #{server}"
+
+        begin
+          Gitlab::Auth::LDAP::Adapter.open(server) do |adapter|
+            check_ldap_auth(adapter)
+
+            $stdout.puts "LDAP users with access to your GitLab server (only showing the first #{limit} results)"
+
+            users = adapter.users(adapter.config.uid, '*', limit)
+            users.each do |user|
+              $stdout.puts "\tDN: #{user.dn}\t #{adapter.config.uid}: #{user.uid}"
+            end
+          end
+        rescue Net::LDAP::ConnectionRefusedError, Errno::ECONNREFUSED => e
+          $stdout.puts "Could not connect to the LDAP server: #{e.message}".color(:red)
+        end
+      end
+    end
+
+    def check_ldap_auth(adapter)
+      auth = adapter.config.has_auth?
+
+      message = if auth && adapter.ldap.bind
+                  'Success'.color(:green)
+                elsif auth
+                  'Failed. Check `bind_dn` and `password` configuration values'.color(:red)
+                else
+                  'Anonymous. No `bind_dn` or `password` configured'.color(:yellow)
+                end
+
+      $stdout.puts "LDAP authentication... #{message}"
+    end
+  end
+end
diff --git a/lib/system_check/orphans/repository_check.rb b/lib/system_check/orphans/repository_check.rb
index ef8fe945f61..33020417e95 100644
--- a/lib/system_check/orphans/repository_check.rb
+++ b/lib/system_check/orphans/repository_check.rb
@@ -4,7 +4,6 @@ module SystemCheck
   module Orphans
     class RepositoryCheck < SystemCheck::BaseCheck
       set_name 'Orphaned repositories:'
-      attr_accessor :orphans
 
       def multi_check
         Gitlab::GitalyClient::StorageSettings.allow_disk_access do
diff --git a/lib/system_check/rake_task/app_task.rb b/lib/system_check/rake_task/app_task.rb
new file mode 100644
index 00000000000..cc32feb8604
--- /dev/null
+++ b/lib/system_check/rake_task/app_task.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:app:check rake task
+    module AppTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'GitLab App'
+      end
+
+      def self.checks
+        [
+          SystemCheck::App::GitConfigCheck,
+          SystemCheck::App::DatabaseConfigExistsCheck,
+          SystemCheck::App::MigrationsAreUpCheck,
+          SystemCheck::App::OrphanedGroupMembersCheck,
+          SystemCheck::App::GitlabConfigExistsCheck,
+          SystemCheck::App::GitlabConfigUpToDateCheck,
+          SystemCheck::App::LogWritableCheck,
+          SystemCheck::App::TmpWritableCheck,
+          SystemCheck::App::UploadsDirectoryExistsCheck,
+          SystemCheck::App::UploadsPathPermissionCheck,
+          SystemCheck::App::UploadsPathTmpPermissionCheck,
+          SystemCheck::App::InitScriptExistsCheck,
+          SystemCheck::App::InitScriptUpToDateCheck,
+          SystemCheck::App::ProjectsHaveNamespaceCheck,
+          SystemCheck::App::RedisVersionCheck,
+          SystemCheck::App::RubyVersionCheck,
+          SystemCheck::App::GitVersionCheck,
+          SystemCheck::App::GitUserDefaultSSHConfigCheck,
+          SystemCheck::App::ActiveUsersCheck
+        ]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/gitaly_task.rb b/lib/system_check/rake_task/gitaly_task.rb
new file mode 100644
index 00000000000..0c3f694f98a
--- /dev/null
+++ b/lib/system_check/rake_task/gitaly_task.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:gitaly:check rake task
+    class GitalyTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'Gitaly'
+      end
+
+      def self.checks
+        [SystemCheck::GitalyCheck]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/gitlab_shell_task.rb b/lib/system_check/rake_task/gitlab_shell_task.rb
new file mode 100644
index 00000000000..120e984c68b
--- /dev/null
+++ b/lib/system_check/rake_task/gitlab_shell_task.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:gitlab_shell:check rake task
+    class GitlabShellTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'GitLab Shell'
+      end
+
+      def self.checks
+        [SystemCheck::GitlabShellCheck]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/gitlab_task.rb b/lib/system_check/rake_task/gitlab_task.rb
new file mode 100644
index 00000000000..7ff36fd6eb5
--- /dev/null
+++ b/lib/system_check/rake_task/gitlab_task.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:check rake task
+    class GitlabTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'GitLab'
+      end
+
+      def self.manual_run_checks!
+        start_checking("#{name} subtasks")
+
+        subtasks.each(&:run_checks!)
+
+        finished_checking("#{name} subtasks")
+      end
+
+      def self.subtasks
+        [
+          SystemCheck::RakeTask::GitlabShellTask,
+          SystemCheck::RakeTask::GitalyTask,
+          SystemCheck::RakeTask::SidekiqTask,
+          SystemCheck::RakeTask::IncomingEmailTask,
+          SystemCheck::RakeTask::LdapTask,
+          SystemCheck::RakeTask::AppTask
+        ]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/incoming_email_task.rb b/lib/system_check/rake_task/incoming_email_task.rb
new file mode 100644
index 00000000000..c296c46feab
--- /dev/null
+++ b/lib/system_check/rake_task/incoming_email_task.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:incoming_email:check rake task
+    class IncomingEmailTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'Incoming Email'
+      end
+
+      def self.checks
+        [SystemCheck::IncomingEmailCheck]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/ldap_task.rb b/lib/system_check/rake_task/ldap_task.rb
new file mode 100644
index 00000000000..03a180b9dfb
--- /dev/null
+++ b/lib/system_check/rake_task/ldap_task.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:ldap:check rake task
+    class LdapTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'LDAP'
+      end
+
+      def self.checks
+        [SystemCheck::LdapCheck]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/orphans/namespace_task.rb b/lib/system_check/rake_task/orphans/namespace_task.rb
new file mode 100644
index 00000000000..2822da45bc1
--- /dev/null
+++ b/lib/system_check/rake_task/orphans/namespace_task.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    module Orphans
+      # Used by gitlab:orphans:check_namespaces rake task
+      class NamespaceTask
+        extend RakeTaskHelpers
+
+        def self.name
+          'Orphans'
+        end
+
+        def self.checks
+          [SystemCheck::Orphans::NamespaceCheck]
+        end
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/orphans/repository_task.rb b/lib/system_check/rake_task/orphans/repository_task.rb
new file mode 100644
index 00000000000..f14b3af22e8
--- /dev/null
+++ b/lib/system_check/rake_task/orphans/repository_task.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    module Orphans
+      # Used by gitlab:orphans:check_repositories rake task
+      class RepositoryTask
+        extend RakeTaskHelpers
+
+        def self.name
+          'Orphans'
+        end
+
+        def self.checks
+          [SystemCheck::Orphans::RepositoryCheck]
+        end
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/orphans_task.rb b/lib/system_check/rake_task/orphans_task.rb
new file mode 100644
index 00000000000..31f8ede25e0
--- /dev/null
+++ b/lib/system_check/rake_task/orphans_task.rb
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:orphans:check rake task
+    class OrphansTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'Orphans'
+      end
+
+      def self.checks
+        [
+          SystemCheck::Orphans::NamespaceCheck,
+          SystemCheck::Orphans::RepositoryCheck
+        ]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/rake_task_helpers.rb b/lib/system_check/rake_task/rake_task_helpers.rb
new file mode 100644
index 00000000000..95f2a34a719
--- /dev/null
+++ b/lib/system_check/rake_task/rake_task_helpers.rb
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Provides the run! method intended to be called from system check rake tasks
+    module RakeTaskHelpers
+      include ::SystemCheck::Helpers
+
+      def run!
+        warn_user_is_not_gitlab
+
+        if self.respond_to?(:manual_run_checks!)
+          manual_run_checks!
+        else
+          run_checks!
+        end
+      end
+
+      def run_checks!
+        SystemCheck.run(name, checks)
+      end
+
+      def name
+        raise NotImplementedError
+      end
+
+      def checks
+        raise NotImplementedError
+      end
+    end
+  end
+end
diff --git a/lib/system_check/rake_task/sidekiq_task.rb b/lib/system_check/rake_task/sidekiq_task.rb
new file mode 100644
index 00000000000..3ccf009d4b9
--- /dev/null
+++ b/lib/system_check/rake_task/sidekiq_task.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  module RakeTask
+    # Used by gitlab:sidekiq:check rake task
+    class SidekiqTask
+      extend RakeTaskHelpers
+
+      def self.name
+        'Sidekiq'
+      end
+
+      def self.checks
+        [SystemCheck::SidekiqCheck]
+      end
+    end
+  end
+end
diff --git a/lib/system_check/sidekiq_check.rb b/lib/system_check/sidekiq_check.rb
new file mode 100644
index 00000000000..2f5fc2cea89
--- /dev/null
+++ b/lib/system_check/sidekiq_check.rb
@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SystemCheck
+  # Used by gitlab:sidekiq:check rake task
+  class SidekiqCheck < BaseCheck
+    set_name 'Sidekiq:'
+
+    def multi_check
+      check_sidekiq_running
+      only_one_sidekiq_running
+    end
+
+    private
+
+    def check_sidekiq_running
+      $stdout.print "Running? ... "
+
+      if sidekiq_process_count > 0
+        $stdout.puts "yes".color(:green)
+      else
+        $stdout.puts "no".color(:red)
+        try_fixing_it(
+          sudo_gitlab("RAILS_ENV=production bin/background_jobs start")
+        )
+        for_more_information(
+          see_installation_guide_section("Install Init Script"),
+          "see log/sidekiq.log for possible errors"
+        )
+        fix_and_rerun
+      end
+    end
+
+    def only_one_sidekiq_running
+      process_count = sidekiq_process_count
+      return if process_count.zero?
+
+      $stdout.print 'Number of Sidekiq processes ... '
+
+      if process_count == 1
+        $stdout.puts '1'.color(:green)
+      else
+        $stdout.puts "#{process_count}".color(:red)
+        try_fixing_it(
+          'sudo service gitlab stop',
+          "sudo pkill -u #{gitlab_user} -f sidekiq",
+          "sleep 10 && sudo pkill -9 -u #{gitlab_user} -f sidekiq",
+          'sudo service gitlab start'
+        )
+        fix_and_rerun
+      end
+    end
+
+    def sidekiq_process_count
+      ps_ux, _ = Gitlab::Popen.popen(%w(ps uxww))
+      ps_ux.scan(/sidekiq \d+\.\d+\.\d+/).count
+    end
+  end
+end
-- 
cgit v1.2.1