Merge branch 'bvl-dont-use-factories-in-bg-migration-specs-ce' into 'master'

Enable FactoriesInMigration cop for background migrations

See merge request gitlab-org/gitlab-ce!24425

rubocop/spec_helpers.rb

 module RuboCop
   module SpecHelpers
     SPEC_HELPERS = %w[fast_spec_helper.rb rails_helper.rb spec_helper.rb].freeze
+    MIGRATION_SPEC_DIRECTORIES = ['spec/migrations', 'spec/lib/gitlab/background_migration'].freeze
 
     # Returns true if the given node originated from the spec directory.
     def in_spec?(node)
@@ -10,14 +11,18 @@ module RuboCop
         path.start_with?(File.join(Dir.pwd, 'spec'), File.join(Dir.pwd, 'ee', 'spec'))
     end
 
+    def migration_directories
+      @migration_directories ||= MIGRATION_SPEC_DIRECTORIES.map do |dir|
+        [File.join(Dir.pwd, dir), File.join(Dir.pwd, 'ee', dir)]
+      end.flatten
+    end
+
     # Returns true if the given node originated from a migration spec.
     def in_migration_spec?(node)
       path = node.location.expression.source_buffer.name
 
       in_spec?(node) &&
-        path.start_with?(
-          File.join(Dir.pwd, 'spec', 'migrations'),
-          File.join(Dir.pwd, 'ee', 'spec', 'migrations'))
+        path.start_with?(*migration_directories)
     end
   end
 end

spec/lib/gitlab/background_migration/backfill_project_repositories_spec.rb

@@ -2,6 +2,7 @@
 
 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::BackfillProjectRepositories do
   let(:group) { create(:group, name: 'foo', path: 'foo') }
 
@@ -102,3 +103,4 @@ describe Gitlab::BackgroundMigration::BackfillProjectRepositories do
     end
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/create_gpg_key_subkeys_from_gpg_keys_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Gitlab::BackgroundMigration::CreateGpgKeySubkeysFromGpgKeys, :migration, schema: 20171005130944 do
   context 'when GpgKey exists' do
-    let!(:gpg_key) { create(:gpg_key, key: GpgHelpers::User3.public_key) }
+    let!(:gpg_key) { create(:gpg_key, key: GpgHelpers::User3.public_key) } # rubocop:disable RSpec/FactoriesInMigrationSpecs
 
     before do
       GpgKeySubkey.destroy_all # rubocop: disable DestroyAll

spec/lib/gitlab/background_migration/delete_diff_files_spec.rb

 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::DeleteDiffFiles, :migration, :sidekiq, schema: 20180619121030 do
   describe '#perform' do
     context 'when diff files can be deleted' do
@@ -71,3 +72,4 @@ describe Gitlab::BackgroundMigration::DeleteDiffFiles, :migration, :sidekiq, sch
     end
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/deserialize_merge_request_diffs_and_commits_spec.rb

 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::DeserializeMergeRequestDiffsAndCommits, :migration, schema: 20171114162227 do
   include GitHelpers
 
@@ -324,3 +325,4 @@ describe Gitlab::BackgroundMigration::DeserializeMergeRequestDiffsAndCommits, :m
     end
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/migrate_events_to_push_event_payloads_spec.rb

 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::MigrateEventsToPushEventPayloads::Event, :migration, schema: 20170608152748 do
   describe '#commit_title' do
     it 'returns nil when there are no commits' do
@@ -429,3 +430,4 @@ describe Gitlab::BackgroundMigration::MigrateEventsToPushEventPayloads, :migrati
     end
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/migrate_system_uploads_to_new_folder_spec.rb

 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::MigrateSystemUploadsToNewFolder, :delete do
   let(:migration) { described_class.new }
 
@@ -17,3 +18,4 @@ describe Gitlab::BackgroundMigration::MigrateSystemUploadsToNewFolder, :delete d
     end
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/move_personal_snippet_files_spec.rb

 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::MovePersonalSnippetFiles do
   let(:test_dir) { File.join(Rails.root, 'tmp', 'tests', 'move_snippet_files_test') }
   let(:old_uploads_dir) { File.join('uploads', 'system', 'personal_snippet') }
@@ -70,3 +71,4 @@ describe Gitlab::BackgroundMigration::MovePersonalSnippetFiles do
     "[an upload](#{path})"
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/populate_cluster_kubernetes_namespace_table_spec.rb

@@ -2,6 +2,7 @@
 
 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::PopulateClusterKubernetesNamespaceTable, :migration, schema: 20181022173835 do
   let(:migration) { described_class.new }
   let(:clusters) { create_list(:cluster, 10, :project, :provided_by_gcp) }
@@ -95,3 +96,4 @@ describe Gitlab::BackgroundMigration::PopulateClusterKubernetesNamespaceTable, :
     end
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/populate_external_pipeline_source_spec.rb

@@ -2,6 +2,7 @@
 
 require 'spec_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::PopulateExternalPipelineSource, :migration, schema: 20180916011959 do
   let(:migration) { described_class.new }
 
@@ -65,3 +66,4 @@ describe Gitlab::BackgroundMigration::PopulateExternalPipelineSource, :migration
     it_behaves_like 'no changes'
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs

spec/lib/gitlab/background_migration/populate_merge_request_metrics_with_events_data_spec.rb

 require 'rails_helper'
 
+# rubocop:disable RSpec/FactoriesInMigrationSpecs
 describe Gitlab::BackgroundMigration::PopulateMergeRequestMetricsWithEventsData, :migration, schema: 20171128214150 do
   # commits_count attribute is added in a next migration
   before do
@@ -128,3 +129,4 @@ describe Gitlab::BackgroundMigration::PopulateMergeRequestMetricsWithEventsData,
     end
   end
 end
+# rubocop:enable RSpec/FactoriesInMigrationSpecs