From 8e87ecbf3048333034c080b4b49647b12ddec5db Mon Sep 17 00:00:00 2001
From: Lin Jen-Shin <godfat@godfat.org>
Date: Wed, 24 Jan 2018 16:12:33 +0800
Subject: [PATCH] Eliminate the warnings from task helpers

---
 lib/{tasks => }/gitlab/task_helpers.rb |  0
 lib/system_check/helpers.rb            |  2 --
 lib/tasks/gitlab/backup.rake           | 36 +++++++++++++-------------
 lib/tasks/gitlab/check.rake            | 24 +++++++----------
 lib/tasks/gitlab/cleanup.rake          |  8 +++---
 lib/tasks/gitlab/git.rake              |  8 +++---
 lib/tasks/gitlab/gitaly.rake           |  2 +-
 lib/tasks/gitlab/helpers.rake          |  4 +--
 lib/tasks/gitlab/info.rake             |  2 +-
 lib/tasks/gitlab/setup.rake            |  2 +-
 lib/tasks/gitlab/shell.rake            |  8 +++---
 lib/tasks/gitlab/workhorse.rake        |  2 +-
 spec/tasks/gitlab/task_helpers_spec.rb |  1 -
 13 files changed, 45 insertions(+), 54 deletions(-)
 rename lib/{tasks => }/gitlab/task_helpers.rb (100%)

diff --git a/lib/tasks/gitlab/task_helpers.rb b/lib/gitlab/task_helpers.rb
similarity index 100%
rename from lib/tasks/gitlab/task_helpers.rb
rename to lib/gitlab/task_helpers.rb
diff --git a/lib/system_check/helpers.rb b/lib/system_check/helpers.rb
index c42ae4fe4c4..914ed794601 100644
--- a/lib/system_check/helpers.rb
+++ b/lib/system_check/helpers.rb
@@ -1,5 +1,3 @@
-require 'tasks/gitlab/task_helpers'
-
 module SystemCheck
   module Helpers
     include ::Gitlab::TaskHelpers
diff --git a/lib/tasks/gitlab/backup.rake b/lib/tasks/gitlab/backup.rake
index 2383bcf954b..24e37f6c6cc 100644
--- a/lib/tasks/gitlab/backup.rake
+++ b/lib/tasks/gitlab/backup.rake
@@ -4,7 +4,7 @@ namespace :gitlab do
   namespace :backup do
     # Create backup of GitLab system
     desc "GitLab | Create a backup of the GitLab system"
-    task create: :environment do
+    task create: :gitlab_environment do
       warn_user_is_not_gitlab
       configure_cron_mode
 
@@ -25,7 +25,7 @@ namespace :gitlab do
 
     # Restore backup of GitLab system
     desc 'GitLab | Restore a previously created backup'
-    task restore: :environment do
+    task restore: :gitlab_environment do
       warn_user_is_not_gitlab
       configure_cron_mode
 
@@ -73,7 +73,7 @@ namespace :gitlab do
     end
 
     namespace :repo do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping repositories ...".color(:blue)
 
         if ENV["SKIP"] && ENV["SKIP"].include?("repositories")
@@ -84,7 +84,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring repositories ...".color(:blue)
         Backup::Repository.new.restore
         $progress.puts "done".color(:green)
@@ -92,7 +92,7 @@ namespace :gitlab do
     end
 
     namespace :db do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping database ... ".color(:blue)
 
         if ENV["SKIP"] && ENV["SKIP"].include?("db")
@@ -103,7 +103,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring database ... ".color(:blue)
         Backup::Database.new.restore
         $progress.puts "done".color(:green)
@@ -111,7 +111,7 @@ namespace :gitlab do
     end
 
     namespace :builds do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping builds ... ".color(:blue)
 
         if ENV["SKIP"] && ENV["SKIP"].include?("builds")
@@ -122,7 +122,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring builds ... ".color(:blue)
         Backup::Builds.new.restore
         $progress.puts "done".color(:green)
@@ -130,7 +130,7 @@ namespace :gitlab do
     end
 
     namespace :uploads do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping uploads ... ".color(:blue)
 
         if ENV["SKIP"] && ENV["SKIP"].include?("uploads")
@@ -141,7 +141,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring uploads ... ".color(:blue)
         Backup::Uploads.new.restore
         $progress.puts "done".color(:green)
@@ -149,7 +149,7 @@ namespace :gitlab do
     end
 
     namespace :artifacts do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping artifacts ... ".color(:blue)
 
         if ENV["SKIP"] && ENV["SKIP"].include?("artifacts")
@@ -160,7 +160,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring artifacts ... ".color(:blue)
         Backup::Artifacts.new.restore
         $progress.puts "done".color(:green)
@@ -168,7 +168,7 @@ namespace :gitlab do
     end
 
     namespace :pages do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping pages ... ".color(:blue)
 
         if ENV["SKIP"] && ENV["SKIP"].include?("pages")
@@ -179,7 +179,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring pages ... ".color(:blue)
         Backup::Pages.new.restore
         $progress.puts "done".color(:green)
@@ -187,7 +187,7 @@ namespace :gitlab do
     end
 
     namespace :lfs do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping lfs objects ... ".color(:blue)
 
         if ENV["SKIP"] && ENV["SKIP"].include?("lfs")
@@ -198,7 +198,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring lfs objects ... ".color(:blue)
         Backup::Lfs.new.restore
         $progress.puts "done".color(:green)
@@ -206,7 +206,7 @@ namespace :gitlab do
     end
 
     namespace :registry do
-      task create: :environment do
+      task create: :gitlab_environment do
         $progress.puts "Dumping container registry images ... ".color(:blue)
 
         if Gitlab.config.registry.enabled
@@ -221,7 +221,7 @@ namespace :gitlab do
         end
       end
 
-      task restore: :environment do
+      task restore: :gitlab_environment do
         $progress.puts "Restoring container registry images ... ".color(:blue)
 
         if Gitlab.config.registry.enabled
diff --git a/lib/tasks/gitlab/check.rake b/lib/tasks/gitlab/check.rake
index a584eb97cf5..e05a3aad824 100644
--- a/lib/tasks/gitlab/check.rake
+++ b/lib/tasks/gitlab/check.rake
@@ -1,7 +1,3 @@
-# Temporary hack, until we migrate all checks to SystemCheck format
-require 'system_check'
-require 'system_check/helpers'
-
 namespace :gitlab do
   desc 'GitLab | Check the configuration of GitLab and its environment'
   task check: %w{gitlab:gitlab_shell:check
@@ -12,7 +8,7 @@ namespace :gitlab do
 
   namespace :app do
     desc 'GitLab | Check the configuration of the GitLab Rails app'
-    task check: :environment  do
+    task check: :gitlab_environment do
       warn_user_is_not_gitlab
 
       checks = [
@@ -43,7 +39,7 @@ namespace :gitlab do
 
   namespace :gitlab_shell do
     desc "GitLab | Check the configuration of GitLab Shell"
-    task check: :environment  do
+    task check: :gitlab_environment do
       warn_user_is_not_gitlab
       start_checking "GitLab Shell"
 
@@ -251,7 +247,7 @@ namespace :gitlab do
 
   namespace :sidekiq do
     desc "GitLab | Check the configuration of Sidekiq"
-    task check: :environment  do
+    task check: :gitlab_environment do
       warn_user_is_not_gitlab
       start_checking "Sidekiq"
 
@@ -310,7 +306,7 @@ namespace :gitlab do
 
   namespace :incoming_email do
     desc "GitLab | Check the configuration of Reply by email"
-    task check: :environment  do
+    task check: :gitlab_environment do
       warn_user_is_not_gitlab
 
       if Gitlab.config.incoming_email.enabled
@@ -333,7 +329,7 @@ namespace :gitlab do
   end
 
   namespace :ldap do
-    task :check, [:limit] => :environment do |_, args|
+    task :check, [:limit] => :gitlab_environment do |_, args|
       # Only show up to 100 results because LDAP directories can be very big.
       # This setting only affects the `rake gitlab:check` script.
       args.with_defaults(limit: 100)
@@ -389,7 +385,7 @@ namespace :gitlab do
 
   namespace :repo do
     desc "GitLab | Check the integrity of the repositories managed by GitLab"
-    task check: :environment do
+    task check: :gitlab_environment do
       puts "This task is deprecated. Please use gitlab:git:fsck instead".color(:red)
       Rake::Task["gitlab:git:fsck"].execute
     end
@@ -397,7 +393,7 @@ namespace :gitlab do
 
   namespace :orphans do
     desc 'Gitlab | Check for orphaned namespaces and repositories'
-    task check: :environment do
+    task check: :gitlab_environment do
       warn_user_is_not_gitlab
       checks = [
         SystemCheck::Orphans::NamespaceCheck,
@@ -408,7 +404,7 @@ namespace :gitlab do
     end
 
     desc 'GitLab | Check for orphaned namespaces in the repositories path'
-    task check_namespaces: :environment do
+    task check_namespaces: :gitlab_environment do
       warn_user_is_not_gitlab
       checks = [SystemCheck::Orphans::NamespaceCheck]
 
@@ -416,7 +412,7 @@ namespace :gitlab do
     end
 
     desc 'GitLab | Check for orphaned repositories in the repositories path'
-    task check_repositories: :environment do
+    task check_repositories: :gitlab_environment do
       warn_user_is_not_gitlab
       checks = [SystemCheck::Orphans::RepositoryCheck]
 
@@ -426,7 +422,7 @@ namespace :gitlab do
 
   namespace :user do
     desc "GitLab | Check the integrity of a specific user's repositories"
-    task :check_repos, [:username] => :environment do |t, args|
+    task :check_repos, [:username] => :gitlab_environment do |t, args|
       username = args[:username] || prompt("Check repository integrity for username? ".color(:blue))
       user = User.find_by(username: username)
       if user
diff --git a/lib/tasks/gitlab/cleanup.rake b/lib/tasks/gitlab/cleanup.rake
index ab601b0d66b..5a53eac0897 100644
--- a/lib/tasks/gitlab/cleanup.rake
+++ b/lib/tasks/gitlab/cleanup.rake
@@ -5,7 +5,7 @@ namespace :gitlab do
     HASHED_REPOSITORY_NAME = '@hashed'.freeze
 
     desc "GitLab | Cleanup | Clean namespaces"
-    task dirs: :environment  do
+    task dirs: :gitlab_environment do
       warn_user_is_not_gitlab
       remove_flag = ENV['REMOVE']
 
@@ -49,7 +49,7 @@ namespace :gitlab do
     end
 
     desc "GitLab | Cleanup | Clean repositories"
-    task repos: :environment  do
+    task repos: :gitlab_environment do
       warn_user_is_not_gitlab
 
       move_suffix = "+orphaned+#{Time.now.to_i}"
@@ -78,7 +78,7 @@ namespace :gitlab do
     end
 
     desc "GitLab | Cleanup | Block users that have been removed in LDAP"
-    task block_removed_ldap_users: :environment  do
+    task block_removed_ldap_users: :gitlab_environment do
       warn_user_is_not_gitlab
       block_flag = ENV['BLOCK']
 
@@ -109,7 +109,7 @@ namespace :gitlab do
     # released. So likely this should only be run once on gitlab.com
     # Faulty refs are moved so they are kept around, else some features break.
     desc 'GitLab | Cleanup | Remove faulty deployment refs'
-    task move_faulty_deployment_refs: :environment do
+    task move_faulty_deployment_refs: :gitlab_environment do
       projects = Project.where(id: Deployment.select(:project_id).distinct)
 
       projects.find_each do |project|
diff --git a/lib/tasks/gitlab/git.rake b/lib/tasks/gitlab/git.rake
index 3f5dd2ae3b3..cb4f7e5c8a8 100644
--- a/lib/tasks/gitlab/git.rake
+++ b/lib/tasks/gitlab/git.rake
@@ -1,7 +1,7 @@
 namespace :gitlab do
   namespace :git do
     desc "GitLab | Git | Repack"
-    task repack: :environment do
+    task repack: :gitlab_environment do
       failures = perform_git_cmd(%W(#{Gitlab.config.git.bin_path} repack -a --quiet), "Repacking repo")
       if failures.empty?
         puts "Done".color(:green)
@@ -11,7 +11,7 @@ namespace :gitlab do
     end
 
     desc "GitLab | Git | Run garbage collection on all repos"
-    task gc: :environment do
+    task gc: :gitlab_environment do
       failures = perform_git_cmd(%W(#{Gitlab.config.git.bin_path} gc --auto --quiet), "Garbage Collecting")
       if failures.empty?
         puts "Done".color(:green)
@@ -21,7 +21,7 @@ namespace :gitlab do
     end
 
     desc "GitLab | Git | Prune all repos"
-    task prune: :environment do
+    task prune: :gitlab_environment do
       failures = perform_git_cmd(%W(#{Gitlab.config.git.bin_path} prune), "Git Prune")
       if failures.empty?
         puts "Done".color(:green)
@@ -31,7 +31,7 @@ namespace :gitlab do
     end
 
     desc 'GitLab | Git | Check all repos integrity'
-    task fsck: :environment do
+    task fsck: :gitlab_environment do
       failures = perform_git_cmd(%W(#{Gitlab.config.git.bin_path} fsck --name-objects --no-progress), "Checking integrity") do |repo|
         check_config_lock(repo)
         check_ref_locks(repo)
diff --git a/lib/tasks/gitlab/gitaly.rake b/lib/tasks/gitlab/gitaly.rake
index a2e68c0471b..bbe1d3643f1 100644
--- a/lib/tasks/gitlab/gitaly.rake
+++ b/lib/tasks/gitlab/gitaly.rake
@@ -1,7 +1,7 @@
 namespace :gitlab do
   namespace :gitaly do
     desc "GitLab | Install or upgrade gitaly"
-    task :install, [:dir, :repo] => :environment do |t, args|
+    task :install, [:dir, :repo] => :gitlab_environment do |t, args|
       require 'toml'
 
       warn_user_is_not_gitlab
diff --git a/lib/tasks/gitlab/helpers.rake b/lib/tasks/gitlab/helpers.rake
index b0a24790c4a..14d1125a03d 100644
--- a/lib/tasks/gitlab/helpers.rake
+++ b/lib/tasks/gitlab/helpers.rake
@@ -1,8 +1,6 @@
-require 'tasks/gitlab/task_helpers'
-
 # Prevent StateMachine warnings from outputting during a cron task
 StateMachines::Machine.ignore_method_conflicts = true if ENV['CRON']
 
-namespace :gitlab do
+task gitlab_environment: :environment do
   extend SystemCheck::Helpers
 end
diff --git a/lib/tasks/gitlab/info.rake b/lib/tasks/gitlab/info.rake
index e9fb6a008b0..45e9a1a1c72 100644
--- a/lib/tasks/gitlab/info.rake
+++ b/lib/tasks/gitlab/info.rake
@@ -1,7 +1,7 @@
 namespace :gitlab do
   namespace :env do
     desc "GitLab | Show information about GitLab and its environment"
-    task info: :environment  do
+    task info: :gitlab_environment do
       # check if there is an RVM environment
       rvm_version = run_and_match(%w(rvm --version), /[\d\.]+/).try(:to_s)
       # check Ruby version
diff --git a/lib/tasks/gitlab/setup.rake b/lib/tasks/gitlab/setup.rake
index 05fcb8e3da5..1d903c81358 100644
--- a/lib/tasks/gitlab/setup.rake
+++ b/lib/tasks/gitlab/setup.rake
@@ -1,6 +1,6 @@
 namespace :gitlab do
   desc "GitLab | Setup production application"
-  task setup: :environment do
+  task setup: :gitlab_environment do
     setup_db
   end
 
diff --git a/lib/tasks/gitlab/shell.rake b/lib/tasks/gitlab/shell.rake
index 12ae4199b69..844664b12d4 100644
--- a/lib/tasks/gitlab/shell.rake
+++ b/lib/tasks/gitlab/shell.rake
@@ -1,7 +1,7 @@
 namespace :gitlab do
   namespace :shell do
     desc "GitLab | Install or upgrade gitlab-shell"
-    task :install, [:repo] => :environment do |t, args|
+    task :install, [:repo] => :gitlab_environment do |t, args|
       warn_user_is_not_gitlab
 
       default_version = Gitlab::Shell.version_required
@@ -58,12 +58,12 @@ namespace :gitlab do
     end
 
     desc "GitLab | Setup gitlab-shell"
-    task setup: :environment do
+    task setup: :gitlab_environment do
       setup
     end
 
     desc "GitLab | Build missing projects"
-    task build_missing_projects: :environment do
+    task build_missing_projects: :gitlab_environment do
       Project.find_each(batch_size: 1000) do |project|
         path_to_repo = project.repository.path_to_repo
         if File.exist?(path_to_repo)
@@ -80,7 +80,7 @@ namespace :gitlab do
     end
 
     desc 'Create or repair repository hooks symlink'
-    task create_hooks: :environment do
+    task create_hooks: :gitlab_environment do
       warn_user_is_not_gitlab
 
       puts 'Creating/Repairing hooks symlinks for all repositories'
diff --git a/lib/tasks/gitlab/workhorse.rake b/lib/tasks/gitlab/workhorse.rake
index 308ffb0e284..b917a293095 100644
--- a/lib/tasks/gitlab/workhorse.rake
+++ b/lib/tasks/gitlab/workhorse.rake
@@ -1,7 +1,7 @@
 namespace :gitlab do
   namespace :workhorse do
     desc "GitLab | Install or upgrade gitlab-workhorse"
-    task :install, [:dir, :repo] => :environment do |t, args|
+    task :install, [:dir, :repo] => :gitlab_environment do |t, args|
       warn_user_is_not_gitlab
 
       unless args.dir.present?
diff --git a/spec/tasks/gitlab/task_helpers_spec.rb b/spec/tasks/gitlab/task_helpers_spec.rb
index fae5ec35c47..e9322ec4931 100644
--- a/spec/tasks/gitlab/task_helpers_spec.rb
+++ b/spec/tasks/gitlab/task_helpers_spec.rb
@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'tasks/gitlab/task_helpers'
 
 class TestHelpersTest
   include Gitlab::TaskHelpers