Move custom formatters to separate module

Create separate Formatters module
Move all custom formatter under same Formatters namespace

qa/qa/runtime/allure_report.rb

@@ -73,7 +73,7 @@ module QA
         def configure_rspec
           RSpec.configure do |config|
             config.add_formatter(AllureRspecFormatter)
-            config.add_formatter(QA::Support::AllureMetadataFormatter)
+            config.add_formatter(QA::Support::Formatters::AllureMetadataFormatter)
           end
         end
 

qa/qa/support/allure_metadata_formatter.rb

-# frozen_string_literal: true
-
-require 'rspec/core'
-require "rspec/core/formatters/base_formatter"
-
-module QA
-  module Support
-    class AllureMetadataFormatter < ::RSpec::Core::Formatters::BaseFormatter
-      ::RSpec::Core::Formatters.register(
-        self,
-        :example_started
-      )
-
-      # Starts example
-      # @param [RSpec::Core::Notifications::ExampleNotification] example_notification
-      # @return [void]
-      def example_started(example_notification)
-        example = example_notification.example
-
-        quarantine_issue = example.metadata.dig(:quarantine, :issue)
-        example.issue('Quarantine issue', quarantine_issue) if quarantine_issue
-
-        spec_file = example.file_path.split('/').last
-        example.issue(
-          'Failure issues',
-          "https://gitlab.com/gitlab-org/gitlab/-/issues?scope=all&state=opened&search=#{spec_file}"
-        )
-        return unless Runtime::Env.running_in_ci?
-
-        example.add_link(name: "Job(#{Runtime::Env.ci_job_name})", url: Runtime::Env.ci_job_url)
-      end
-    end
-  end
-end

qa/qa/support/formatters/allure_metadata_formatter.rb

+# frozen_string_literal: true
+
+module QA
+  module Support
+    module Formatters
+      class AllureMetadataFormatter < ::RSpec::Core::Formatters::BaseFormatter
+        ::RSpec::Core::Formatters.register(
+          self,
+          :example_started
+        )
+
+        # Starts example
+        # @param [RSpec::Core::Notifications::ExampleNotification] example_notification
+        # @return [void]
+        def example_started(example_notification)
+          example = example_notification.example
+
+          quarantine_issue = example.metadata.dig(:quarantine, :issue)
+          example.issue('Quarantine issue', quarantine_issue) if quarantine_issue
+
+          spec_file = example.file_path.split('/').last
+          example.issue(
+            'Failure issues',
+            "https://gitlab.com/gitlab-org/gitlab/-/issues?scope=all&state=opened&search=#{spec_file}"
+          )
+          return unless Runtime::Env.running_in_ci?
+
+          example.add_link(name: "Job(#{Runtime::Env.ci_job_name})", url: Runtime::Env.ci_job_url)
+        end
+      end
+    end
+  end
+end

qa/qa/specs/helpers/context_formatter.rb → qa/qa/support/formatters/context_formatter.rb

 # frozen_string_literal: true
 
-require 'rspec/core'
-require "rspec/core/formatters/base_formatter"
-
 module QA
-  module Specs
-    module Helpers
+  module Support
+    module Formatters
       class ContextFormatter < ::RSpec::Core::Formatters::BaseFormatter
-        include ContextSelector
+        include Specs::Helpers::ContextSelector
 
         ::RSpec::Core::Formatters.register(
           self,

qa/qa/support/formatters/formatters.rb

+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'rspec/core/formatters/base_formatter'
+
+module QA
+  module Support
+    module Formatters
+    end
+  end
+end

qa/qa/specs/helpers/quarantine_formatter.rb → qa/qa/support/formatters/quarantine_formatter.rb

 # frozen_string_literal: true
 
-require 'rspec/core'
-require "rspec/core/formatters/base_formatter"
-
 module QA
-  module Specs
-    module Helpers
+  module Support
+    module Formatters
       class QuarantineFormatter < ::RSpec::Core::Formatters::BaseFormatter
-        include Quarantine
+        include Specs::Helpers::Quarantine
 
         ::RSpec::Core::Formatters.register(
           self,

qa/spec/spec_helper.rb

@@ -25,8 +25,8 @@ RSpec.configure do |config|
   config.include QA::Support::Matchers::EventuallyMatcher
   config.include QA::Support::Matchers::HaveMatcher
 
-  config.add_formatter QA::Specs::Helpers::ContextFormatter
-  config.add_formatter QA::Specs::Helpers::QuarantineFormatter
+  config.add_formatter QA::Support::Formatters::ContextFormatter
+  config.add_formatter QA::Support::Formatters::QuarantineFormatter
 
   config.before do |example|
     QA::Runtime::Logger.debug("\nStarting test: #{example.full_description}\n")

qa/spec/specs/allure_report_spec.rb

@@ -68,7 +68,8 @@ describe QA::Runtime::AllureReport do
 
     it 'adds rspec and metadata formatter' do
       expect(rspec_config).to have_received(:add_formatter).with(AllureRspecFormatter).ordered
-      expect(rspec_config).to have_received(:add_formatter).with(QA::Support::AllureMetadataFormatter).ordered
+      expect(rspec_config).to have_received(:add_formatter)
+        .with(QA::Support::Formatters::AllureMetadataFormatter).ordered
     end
 
     it 'configures screenshot saving' do

qa/spec/specs/helpers/context_selector_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe QA::Specs::Helpers::ContextSelector do
     QA::Runtime::Scenario.define(:gitlab_address, 'https://staging.gitlab.com')
 
     RSpec::Core::Sandbox.sandboxed do |config|
-      config.formatter = QA::Specs::Helpers::ContextFormatter
+      config.formatter = QA::Support::Formatters::ContextFormatter
 
       # If there is an example-within-an-example, we want to make sure the inner example
       # does not get a reference to the outer example (the real spec) if it calls

qa/spec/specs/helpers/quarantine_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe QA::Specs::Helpers::Quarantine do
 
   around do |ex|
     RSpec::Core::Sandbox.sandboxed do |config|
-      config.formatter = QA::Specs::Helpers::QuarantineFormatter
+      config.formatter = QA::Support::Formatters::QuarantineFormatter
 
       # If there is an example-within-an-example, we want to make sure the inner example
       # does not get a reference to the outer example (the real spec) if it calls

qa/spec/support/allure_metadata_formatter_spec.rb → qa/spec/support/formatters/allure_metadata_formatter_spec.rb

 # frozen_string_literal: true
 
-describe QA::Support::AllureMetadataFormatter do
+describe QA::Support::Formatters::AllureMetadataFormatter do
   include QA::Support::Helpers::StubEnv
 
   let(:formatter) { described_class.new(StringIO.new) }