Cleanup requires across library files

balasankarc · balasankarc · commit 6936df9e78ef · 2024-01-30T10:41:53.000+05:30
* Ensure every library `require`s all the other libraries it needs for
  functioning.
* Ensure require statements come before require_relative ones
* Ensure require_relative statements doesn't end with `.rb` extension
    * Also enabled the Cop for that
* Use single quotes for require statements

Signed-off-by: Balasankar "Balu" C &lt;balasankar@gitlab.com&gt;
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -87,3 +87,8 @@ Lint/RedundantSafeNavigation: # (new in 0.93)
   Enabled: true
 Style/ClassEqualityComparison: # (new in 0.93)
   Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+  Exclude:
+    - files/**/*
diff --git a/config/projects/gitlab.rb b/config/projects/gitlab.rb
@@ -17,7 +17,7 @@
 #
 
 require "#{Omnibus::Config.project_root}/lib/gitlab/build_iteration"
-require "#{Omnibus::Config.project_root}/lib/gitlab/build/info"
+require "#{Omnibus::Config.project_root}/lib/gitlab/build/info/package"
 require "#{Omnibus::Config.project_root}/lib/gitlab/version"
 require "#{Omnibus::Config.project_root}/lib/gitlab/util"
 require "#{Omnibus::Config.project_root}/lib/gitlab/ohai_helper.rb"
diff --git a/config/software/package-scripts.rb b/config/software/package-scripts.rb
@@ -16,7 +16,7 @@
 # limitations under the License.
 #
 
-require "#{Omnibus::Config.project_root}/lib/gitlab/build/info"
+require "#{Omnibus::Config.project_root}/lib/gitlab/build/info/package"
 name 'package-scripts'
 
 license 'Apache-2.0'
diff --git a/doc/development/examples/simple.rb b/doc/development/examples/simple.rb
@@ -1,4 +1,4 @@
-require "#{Omnibus::Config.project_root}/lib/gitlab/build/info"
+require "#{Omnibus::Config.project_root}/lib/gitlab/build/info/package"
 require "#{Omnibus::Config.project_root}/lib/gitlab/build_iteration"
 require "#{Omnibus::Config.project_root}/lib/gitlab/ohai_helper.rb"
 require "#{Omnibus::Config.project_root}/lib/gitlab/openssl_helper"
diff --git a/lib/gitlab/api_client.rb b/lib/gitlab/api_client.rb
@@ -1,8 +1,8 @@
+require 'gitlab'
+
 require_relative 'build/info/ci'
 require_relative 'build/info/secrets'
 
-require 'gitlab'
-
 module Gitlab
   class APIClient
     def initialize(endpoint = Build::Info::CI.api_v4_url, token = Build::Info::Secrets.api_token)
diff --git a/lib/gitlab/aws_helper.rb b/lib/gitlab/aws_helper.rb
@@ -1,10 +1,10 @@
-require_relative 'build/info.rb'
-require_relative 'util.rb'
-
 require 'aws-sdk-ec2'
 require 'aws-sdk-marketplacecatalog'
 require 'json'
 
+require_relative 'build/info/ci'
+require_relative 'util'
+
 class AWSHelper
   def initialize(version, type)
     # version specifies the GitLab version being processed
diff --git a/lib/gitlab/build/check.rb b/lib/gitlab/build/check.rb
@@ -1,6 +1,6 @@
-require_relative "info.rb"
-require_relative "info/git"
-require_relative "../util.rb"
+require_relative '../util'
+require_relative 'info/git'
+require_relative 'info/package'
 
 module Build
   class Check
diff --git a/lib/gitlab/build/facts.rb b/lib/gitlab/build/facts.rb
@@ -1,6 +1,8 @@
+require_relative 'gitlab_image'
 require_relative 'info/docker'
 require_relative 'info/git'
 require_relative 'info/package'
+require_relative 'info/qa'
 
 module Build
   class Facts
diff --git a/lib/gitlab/build/gitlab_image.rb b/lib/gitlab/build/gitlab_image.rb
@@ -1,5 +1,5 @@
 require_relative 'image'
-require_relative 'info'
+require_relative 'info/package'
 
 module Build
   class GitlabImage
diff --git a/lib/gitlab/build/image.rb b/lib/gitlab/build/image.rb
@@ -1,6 +1,6 @@
-require_relative 'info'
+require_relative '../util'
 require_relative '../docker_operations'
-require_relative "../util.rb"
+require_relative 'info/docker'
 
 module Build
   module Image
diff --git a/lib/gitlab/build/info.rb b/lib/gitlab/build/info.rb
diff --git a/lib/gitlab/build/info/ci.rb b/lib/gitlab/build/info/ci.rb
@@ -1,5 +1,5 @@
-require_relative '../../util'
 require_relative '../../api_client'
+require_relative '../../util'
 require_relative '../check'
 
 module Build
diff --git a/lib/gitlab/build/info/deploy.rb b/lib/gitlab/build/info/deploy.rb
@@ -1,3 +1,5 @@
+require_relative '../check'
+
 module Build
   class Info
     class Deploy
diff --git a/lib/gitlab/build/info/docker.rb b/lib/gitlab/build/info/docker.rb
@@ -1,3 +1,8 @@
+require_relative '../../util'
+require_relative '../check'
+require_relative '../info/ci'
+require_relative '../info/package'
+
 module Build
   class Info
     class Docker
diff --git a/lib/gitlab/build/info/git.rb b/lib/gitlab/build/info/git.rb
@@ -1,3 +1,12 @@
+# `branch_name` and `tag_name` methods in this class calls
+# `Gitlab::Util.shellout_stdout` which uses `mixlib/shellout` under the hood.
+# However, we can't require `mixlib/shellout` in `Gitlab::Util` since it is
+# required by `Gitlab::Version`, which is in turn required by Gemfile. So, when
+# Gemfile is being evaluated, `mixlib/shellout` will become required, but it
+# won't be present in the bundle yet. Hence, we require it here, to demonstrate
+# the transitive dependency requirement this class has on `mixlib/shellout`.
+require 'mixlib/shellout'
+
 require_relative '../../util'
 require_relative '../check'
 require_relative 'ci'
diff --git a/lib/gitlab/build/info/package.rb b/lib/gitlab/build/info/package.rb
@@ -1,5 +1,6 @@
 require 'omnibus'
 
+require_relative '../../build_iteration'
 require_relative '../../util'
 require_relative '../check'
 
diff --git a/lib/gitlab/build/info/qa.rb b/lib/gitlab/build/info/qa.rb
@@ -1,3 +1,7 @@
+require_relative '../../util'
+require_relative 'components'
+require_relative 'package'
+
 module Build
   class Info
     class QA
diff --git a/lib/gitlab/build/info/secrets.rb b/lib/gitlab/build/info/secrets.rb
@@ -1,4 +1,5 @@
 require_relative '../../util'
+require_relative 'ci'
 
 module Build
   class Info
diff --git a/lib/gitlab/build/qa.rb b/lib/gitlab/build/qa.rb
@@ -1,5 +1,5 @@
-require_relative 'info'
 require_relative 'check'
+require_relative 'info/components'
 
 # To use PROCESS_ID instead of $$ to randomize the target directory for cloning
 # GitLab repository. Rubocop requirement to increase readability.
diff --git a/lib/gitlab/build/qa_image.rb b/lib/gitlab/build/qa_image.rb
@@ -1,7 +1,7 @@
+require_relative '../skopeo_helper'
+require_relative 'gitlab_image'
 require_relative 'image'
 require_relative 'info/qa'
-require_relative 'gitlab_image'
-require_relative '../skopeo_helper'
 
 module Build
   class QAImage
diff --git a/lib/gitlab/build/rat/nightly.rb b/lib/gitlab/build/rat/nightly.rb
@@ -1,8 +1,9 @@
-require_relative '../trigger'
-require_relative '../info'
-require_relative "../../util"
 require 'cgi'
 
+require_relative '../../util'
+require_relative '../info/package'
+require_relative '../trigger'
+
 module Build
   class RAT
     class NightlyPipeline
diff --git a/lib/gitlab/build/rat/tag.rb b/lib/gitlab/build/rat/tag.rb
@@ -1,8 +1,9 @@
-require_relative '../trigger'
-require_relative '../info'
-require_relative "../../util"
 require 'cgi'
 
+require_relative '../../util'
+require_relative '../info/package'
+require_relative '../trigger'
+
 module Build
   class RAT
     class TagPipeline
diff --git a/lib/gitlab/build/trigger.rb b/lib/gitlab/build/trigger.rb
@@ -1,8 +1,8 @@
-require 'net/http'
-require 'json'
 require 'cgi'
+require 'json'
+require 'net/http'
 
-require_relative "../util.rb"
+require_relative '../util'
 
 module Build
   module Trigger
diff --git a/lib/gitlab/build_iteration.rb b/lib/gitlab/build_iteration.rb
@@ -1,4 +1,4 @@
-require_relative 'build/check.rb'
+require_relative 'build/check'
 
 # This module has tests in spec/gitlab/build_iteration_spec.rb
 module Gitlab
diff --git a/lib/gitlab/deployer_helper.rb b/lib/gitlab/deployer_helper.rb
@@ -1,6 +1,8 @@
-require "http"
-require "json"
-require_relative "util.rb"
+require 'http'
+require 'json'
+
+require_relative 'build/info/docker'
+require_relative 'util'
 
 PipelineTriggerFailure = Class.new(StandardError)
 class DeployerHelper
diff --git a/lib/gitlab/docker_operations.rb b/lib/gitlab/docker_operations.rb
@@ -1,6 +1,6 @@
 require 'docker'
 
-require_relative "util.rb"
+require_relative 'util'
 
 class DockerOperations
   def self.set_timeout
diff --git a/lib/gitlab/gitlab_release_helper.rb b/lib/gitlab/gitlab_release_helper.rb
@@ -1,5 +1,7 @@
 require 'json'
 
+require_relative 'build/info/package'
+
 class GitlabReleaseHelper
   class << self
     def release_details
diff --git a/lib/gitlab/license/analyzer.rb b/lib/gitlab/license/analyzer.rb
@@ -1,4 +1,4 @@
-require_relative '../build/info.rb'
+require_relative '../build/info/package'
 
 module License
   class Analyzer
diff --git a/lib/gitlab/license/base.rb b/lib/gitlab/license/base.rb
@@ -1,4 +1,4 @@
-require_relative "../util.rb"
+require_relative '../util'
 
 module License
   class Base
diff --git a/lib/gitlab/license/collector.rb b/lib/gitlab/license/collector.rb
@@ -1,8 +1,8 @@
 require 'erb'
 require 'fileutils'
-require_relative '../build/info.rb'
-require_relative "../util.rb"
-require_relative 'base.rb'
+
+require_relative '../util'
+require_relative 'base'
 
 module License
   class Collector < License::Base
diff --git a/lib/gitlab/license/uploader.rb b/lib/gitlab/license/uploader.rb
@@ -1,8 +1,9 @@
 require 'erb'
 require 'fileutils'
-require_relative '../build/info.rb'
-require_relative "../util.rb"
-require_relative 'base.rb'
+
+require_relative '../build/info/package'
+require_relative '../util'
+require_relative 'base'
 
 module License
   class Uploader < Base
diff --git a/lib/gitlab/manifest/base.rb b/lib/gitlab/manifest/base.rb
@@ -1,4 +1,4 @@
-require_relative "../util.rb"
+require_relative '../util'
 
 module Manifest
   class Base
diff --git a/lib/gitlab/manifest/collector.rb b/lib/gitlab/manifest/collector.rb
@@ -1,8 +1,8 @@
 require 'erb'
 require 'fileutils'
-require_relative '../build/info.rb'
-require_relative "../util.rb"
-require_relative 'base.rb'
+
+require_relative '../util'
+require_relative 'base'
 
 module Manifest
   # Roots through the LICENSE_S3_BUCKET'and creates an html page with links to
diff --git a/lib/gitlab/manifest/uploader.rb b/lib/gitlab/manifest/uploader.rb
@@ -5,8 +5,8 @@
 
 require 'omnibus'
 require 'yaml'
-require 'gitlab/version'
-require_relative 'base.rb'
+
+require_relative 'base'
 
 module Manifest
   # Creates manifest for one edition based on the value of the "ee" environment
diff --git a/lib/gitlab/package_repository.rb b/lib/gitlab/package_repository.rb
@@ -1,7 +1,8 @@
 require 'English'
-require_relative 'retriable.rb'
-require_relative 'build/info.rb'
-require_relative "util.rb"
+
+require_relative 'build/info/package'
+require_relative 'retriable'
+require_relative 'util'
 
 class PackageRepository
   PackageUploadError = Class.new(StandardError)
diff --git a/lib/gitlab/package_size.rb b/lib/gitlab/package_size.rb
@@ -1,7 +1,7 @@
-require_relative "util"
-require_relative "ohai_helper"
-require_relative "build/check"
-require_relative "build/info/secrets"
+require_relative 'build/check'
+require_relative 'build/info/secrets'
+require_relative 'ohai_helper'
+require_relative 'util'
 
 require 'gitlab'
 
diff --git a/lib/gitlab/skopeo_helper.rb b/lib/gitlab/skopeo_helper.rb
@@ -1,5 +1,5 @@
-require 'retriable'
 require 'open3'
+require 'retriable'
 
 class SkopeoHelper
   ImageNotFoundError = Class.new(StandardError)
diff --git a/lib/gitlab/tasks/aws.rake b/lib/gitlab/tasks/aws.rake
@@ -1,8 +1,9 @@
-require_relative '../aws_helper.rb'
-require_relative '../build/info.rb'
-require_relative '../build/check.rb'
 require 'omnibus'
 
+require_relative '../aws_helper'
+require_relative '../build/check'
+require_relative '../build/info/package'
+
 namespace :aws do
   namespace :ami do
     desc "Create AWS AMI"
diff --git a/lib/gitlab/tasks/build.rake b/lib/gitlab/tasks/build.rake
@@ -1,17 +1,17 @@
 require 'fileutils'
-require_relative "../build.rb"
-require_relative "../build/check.rb"
-require_relative "../build/info.rb"
-require_relative "../build/info/git"
-require_relative "../build/info/package"
-require_relative '../build/facts'
-require_relative "../gcloud_helper.rb"
-require_relative "../ohai_helper.rb"
-require_relative '../version.rb'
-require_relative "../util.rb"
-require_relative "../package_size"
-require 'net/http'
 require 'json'
+require 'net/http'
+
+require_relative '../build'
+require_relative '../build/check'
+require_relative '../build/facts'
+require_relative '../build/info/git'
+require_relative '../build/info/package'
+require_relative '../gcloud_helper'
+require_relative '../ohai_helper'
+require_relative '../package_size'
+require_relative '../util'
+require_relative '../version'
 
 namespace :build do
   desc 'Start project build'
diff --git a/lib/gitlab/tasks/cache.rake b/lib/gitlab/tasks/cache.rake
@@ -1,5 +1,6 @@
 require 'fileutils'
-require_relative "../ohai_helper.rb"
+
+require_relative '../ohai_helper'
 
 namespace :cache do
   desc "Populate cache"
diff --git a/lib/gitlab/tasks/check.rake b/lib/gitlab/tasks/check.rake
diff --git a/lib/gitlab/tasks/docker_tasks.rake b/lib/gitlab/tasks/docker_tasks.rake
diff --git a/lib/gitlab/tasks/docs.rake b/lib/gitlab/tasks/docs.rake
diff --git a/lib/gitlab/tasks/gitlab_com.rake b/lib/gitlab/tasks/gitlab_com.rake
diff --git a/lib/gitlab/tasks/license.rake b/lib/gitlab/tasks/license.rake
diff --git a/lib/gitlab/tasks/manifest.rake b/lib/gitlab/tasks/manifest.rake
diff --git a/lib/gitlab/tasks/qa.rake b/lib/gitlab/tasks/qa.rake
diff --git a/lib/gitlab/tasks/repository.rake b/lib/gitlab/tasks/repository.rake
diff --git a/lib/gitlab/version.rb b/lib/gitlab/version.rb
diff --git a/lib/rubocop/rubocop.rb b/lib/rubocop/rubocop.rb
diff --git a/spec/lib/gitlab/build/facts_spec.rb b/spec/lib/gitlab/build/facts_spec.rb
diff --git a/spec/lib/gitlab/build/info/package_spec.rb b/spec/lib/gitlab/build/info/package_spec.rb
diff --git a/spec/lib/gitlab/deployer_helper_spec.rb b/spec/lib/gitlab/deployer_helper_spec.rb
diff --git a/spec/lib/gitlab/package_repository_spec.rb b/spec/lib/gitlab/package_repository_spec.rb
diff --git a/spec/lib/gitlab/tasks/docker_tasks_spec.rb b/spec/lib/gitlab/tasks/docker_tasks_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`#`
`18`	`18`
`19`	`19`	`require "#{Omnibus::Config.project_root}/lib/gitlab/build_iteration"`
`20`		`-require "#{Omnibus::Config.project_root}/lib/gitlab/build/info"`
	`20`	`+require "#{Omnibus::Config.project_root}/lib/gitlab/build/info/package"`
`21`	`21`	`require "#{Omnibus::Config.project_root}/lib/gitlab/version"`
`22`	`22`	`require "#{Omnibus::Config.project_root}/lib/gitlab/util"`
`23`	`23`	`require "#{Omnibus::Config.project_root}/lib/gitlab/ohai_helper.rb"`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`# limitations under the License.`
`17`	`17`	`#`
`18`	`18`
`19`		`-require "#{Omnibus::Config.project_root}/lib/gitlab/build/info"`
	`19`	`+require "#{Omnibus::Config.project_root}/lib/gitlab/build/info/package"`
`20`	`20`	`name 'package-scripts'`
`21`	`21`
`22`	`22`	`license 'Apache-2.0'`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-require "#{Omnibus::Config.project_root}/lib/gitlab/build/info"`
	`1`	`+require "#{Omnibus::Config.project_root}/lib/gitlab/build/info/package"`
`2`	`2`	`require "#{Omnibus::Config.project_root}/lib/gitlab/build_iteration"`
`3`	`3`	`require "#{Omnibus::Config.project_root}/lib/gitlab/ohai_helper.rb"`
`4`	`4`	`require "#{Omnibus::Config.project_root}/lib/gitlab/openssl_helper"`