Merge branch 'refactor-monitor-specs' into 'master'

Refactor monitor tests to use a shared context

Closes #222278

See merge request gitlab-org/gitlab!40141

qa/qa/specs/features/browser_ui/8_monitor/cluster_with_prometheus.rb

+# frozen_string_literal: true
+
+module QA
+  RSpec.configure do |rspec|
+    # This config option will be enabled by default on RSpec 4,
+    # but for reasons of backwards compatibility, you have to
+    # set it on RSpec 3.
+    #
+    # It causes the host group and examples to inherit metadata
+    # from the shared context.
+    rspec.shared_context_metadata_behavior = :apply_to_host_groups
+  end
+
+  RSpec.shared_context "cluster with Prometheus installed", shared_context: :metadata do
+    before :all do
+      @cluster = Service::KubernetesCluster.new(provider_class: Service::ClusterProvider::K3s).create!
+      @project = Resource::Project.fabricate_via_api! do |project|
+        project.name = 'monitoring-project'
+        project.auto_devops_enabled = true
+        project.template_name = 'express'
+      end
+
+      deploy_project_with_prometheus
+    end
+
+    def deploy_project_with_prometheus
+      %w[
+          CODE_QUALITY_DISABLED TEST_DISABLED LICENSE_MANAGEMENT_DISABLED
+          SAST_DISABLED DAST_DISABLED DEPENDENCY_SCANNING_DISABLED
+          CONTAINER_SCANNING_DISABLED PERFORMANCE_DISABLED SECRET_DETECTION_DISABLED
+        ].each do |key|
+        Resource::CiVariable.fabricate_via_api! do |resource|
+          resource.project = @project
+          resource.key = key
+          resource.value = '1'
+          resource.masked = false
+        end
+      end
+
+      Flow::Login.sign_in
+
+      Resource::KubernetesCluster::ProjectCluster.fabricate! do |cluster_settings|
+        cluster_settings.project = @project
+        cluster_settings.cluster = @cluster
+        cluster_settings.install_runner = true
+        cluster_settings.install_ingress = true
+        cluster_settings.install_prometheus = true
+      end
+
+      Resource::Pipeline.fabricate_via_api! do |pipeline|
+        pipeline.project = @project
+      end.visit!
+
+      Page::Project::Pipeline::Show.perform do |pipeline|
+        pipeline.click_job('build')
+      end
+      Page::Project::Job::Show.perform do |job|
+        expect(job).to be_successful(timeout: 600)
+
+        job.click_element(:pipeline_path)
+      end
+
+      Page::Project::Pipeline::Show.perform do |pipeline|
+        pipeline.click_job('production')
+      end
+      Page::Project::Job::Show.perform do |job|
+        expect(job).to be_successful(timeout: 1200)
+
+        job.click_element(:pipeline_path)
+      end
+    end
+
+    after :all do
+      @cluster.remove!
+    end
+  end
+end

qa/qa/specs/features/ee/browser_ui/8_monitor/all_monitor_features_spec.rb

 # frozen_string_literal: true
 require 'pathname'
+require_relative 'cluster_with_prometheus.rb'
 
 module QA
-  RSpec.describe 'Monitor' do
-    describe 'with Prometheus in a Gitlab-managed cluster', :orchestrated, :kubernetes, :requires_admin do
-      before :all do
-        @cluster = Service::KubernetesCluster.new(provider_class: Service::ClusterProvider::K3s).create!
-        @project = Resource::Project.fabricate_via_api! do |project|
-          project.name = 'monitoring-project'
-          project.auto_devops_enabled = true
-          project.template_name = 'express'
-        end
-
-        deploy_project_with_prometheus
-      end
+  RSpec.describe 'Monitor', :orchestrated, :kubernetes, :requires_admin do
+    include_context "cluster with Prometheus installed"
 
-      after :all do
-        @cluster.remove!
-      end
-
-      before do
-        Flow::Login.sign_in_unless_signed_in
-        @project.visit!
-      end
+    before do
+      Flow::Login.sign_in_unless_signed_in
+      @project.visit!
+    end
 
-      it 'allows configuration of alerts', quarantine: { issue: 'https://gitlab.com/gitlab-org/gitlab/-/issues/233409', type: :flaky } do
-        Page::Project::Menu.perform(&:go_to_operations_metrics)
+    it 'allows configuration of alerts', quarantine: { issue: 'https://gitlab.com/gitlab-org/gitlab/-/issues/233409', type: :flaky } do
+      Page::Project::Menu.perform(&:go_to_operations_metrics)
 
-        Page::Project::Operations::Metrics::Show.perform do |on_dashboard|
-          verify_metrics(on_dashboard)
-          verify_add_alert(on_dashboard)
-          verify_edit_alert(on_dashboard)
-          verify_persist_alert(on_dashboard)
-          verify_delete_alert(on_dashboard)
-        end
+      Page::Project::Operations::Metrics::Show.perform do |on_dashboard|
+        verify_metrics(on_dashboard)
+        verify_add_alert(on_dashboard)
+        verify_edit_alert(on_dashboard)
+        verify_persist_alert(on_dashboard)
+        verify_delete_alert(on_dashboard)
       end
+    end
 
-      it 'creates an incident template and opens an incident with template applied', quarantine: { issue: 'https://gitlab.com/gitlab-org/gitlab/-/issues/236203', type: :investigating } do
-        create_incident_template
+    it 'creates an incident template and opens an incident with template applied', quarantine: { issue: 'https://gitlab.com/gitlab-org/gitlab/-/issues/236203', type: :investigating } do
+      create_incident_template
 
-        Page::Project::Menu.perform(&:go_to_operations_settings)
+      Page::Project::Menu.perform(&:go_to_operations_settings)
 
-        Page::Project::Settings::Operations.perform do |settings|
-          settings.expand_incidents do |incident_settings|
-            incident_settings.enable_issues_for_incidents
-            incident_settings.select_issue_template('incident')
-            incident_settings.save_incident_settings
-          end
-        end
-
-        create_incident_issue
-
-        Page::Project::Issue::Show.perform do |issue|
-          expect(issue).to have_metrics_unfurled
+      Page::Project::Settings::Operations.perform do |settings|
+        settings.expand_incidents do |incident_settings|
+          incident_settings.enable_issues_for_incidents
+          incident_settings.select_issue_template('incident')
+          incident_settings.save_incident_settings
         end
       end
 
-      private
-
-      def deploy_project_with_prometheus
-        %w[
-          CODE_QUALITY_DISABLED TEST_DISABLED LICENSE_MANAGEMENT_DISABLED
-          SAST_DISABLED DAST_DISABLED DEPENDENCY_SCANNING_DISABLED
-          CONTAINER_SCANNING_DISABLED PERFORMANCE_DISABLED SECRET_DETECTION_DISABLED
-        ].each do |key|
-          Resource::CiVariable.fabricate_via_api! do |resource|
-            resource.project = @project
-            resource.key = key
-            resource.value = '1'
-            resource.masked = false
-          end
-        end
+      create_incident_issue
 
-        Flow::Login.sign_in
+      Page::Project::Issue::Show.perform do |issue|
+        expect(issue).to have_metrics_unfurled
+      end
+    end
 
-        Resource::KubernetesCluster::ProjectCluster.fabricate! do |cluster_settings|
-          cluster_settings.project = @project
-          cluster_settings.cluster = @cluster
-          cluster_settings.install_runner = true
-          cluster_settings.install_ingress = true
-          cluster_settings.install_prometheus = true
-        end
+    private
 
-        Resource::Pipeline.fabricate_via_api! do |pipeline|
-          pipeline.project = @project
-        end.visit!
+    def verify_metrics(on_dashboard)
+      on_dashboard.wait_for_metrics
 
-        Page::Project::Pipeline::Show.perform do |pipeline|
-          pipeline.click_job('build')
-        end
-        Page::Project::Job::Show.perform do |job|
-          expect(job).to be_successful(timeout: 600)
+      expect(on_dashboard).to have_metrics
+      expect(on_dashboard).not_to have_alert
+    end
 
-          job.click_element(:pipeline_path)
-        end
+    def verify_add_alert(on_dashboard)
+      on_dashboard.write_first_alert('>', 0)
 
-        Page::Project::Pipeline::Show.perform do |pipeline|
-          pipeline.click_job('production')
-        end
-        Page::Project::Job::Show.perform do |job|
-          expect(job).to be_successful(timeout: 1200)
+      expect(on_dashboard).to have_alert
+    end
 
-          job.click_element(:pipeline_path)
-        end
-      end
+    def verify_edit_alert(on_dashboard)
+      on_dashboard.write_first_alert('<', 0)
 
-      def verify_metrics(on_dashboard)
-        on_dashboard.wait_for_metrics
+      expect(on_dashboard).to have_alert('<')
+    end
 
-        expect(on_dashboard).to have_metrics
-        expect(on_dashboard).not_to have_alert
-      end
+    def verify_persist_alert(on_dashboard)
+      on_dashboard.refresh
+      on_dashboard.wait_for_metrics
+      on_dashboard.wait_for_alert('<')
 
-      def verify_add_alert(on_dashboard)
-        on_dashboard.write_first_alert('>', 0)
+      expect(on_dashboard).to have_alert('<')
+    end
 
-        expect(on_dashboard).to have_alert
-      end
+    def verify_delete_alert(on_dashboard)
+      on_dashboard.delete_first_alert
 
-      def verify_edit_alert(on_dashboard)
-        on_dashboard.write_first_alert('<', 0)
+      expect(on_dashboard).not_to have_alert('<')
+    end
 
-        expect(on_dashboard).to have_alert('<')
-      end
+    def create_incident_template
+      Page::Project::Menu.perform(&:go_to_operations_metrics)
 
-      def verify_persist_alert(on_dashboard)
-        on_dashboard.refresh
+      chart_link = Page::Project::Operations::Metrics::Show.perform do |on_dashboard|
         on_dashboard.wait_for_metrics
-        on_dashboard.wait_for_alert('<')
-
-        expect(on_dashboard).to have_alert('<')
+        on_dashboard.copy_link_to_first_chart
       end
 
-      def verify_delete_alert(on_dashboard)
-        on_dashboard.delete_first_alert
-
-        expect(on_dashboard).not_to have_alert('<')
-      end
+      incident_template = "Incident Metric: #{chart_link}"
+      push_template_to_repository(incident_template)
+    end
 
-      def create_incident_template
-        Page::Project::Menu.perform(&:go_to_operations_metrics)
+    def push_template_to_repository(template)
+      @project.visit!
 
-        chart_link = Page::Project::Operations::Metrics::Show.perform do |on_dashboard|
-          on_dashboard.wait_for_metrics
-          on_dashboard.copy_link_to_first_chart
-        end
+      Page::Project::Show.perform(&:create_new_file!)
 
-        incident_template = "Incident Metric: #{chart_link}"
-        push_template_to_repository(incident_template)
+      Page::File::Form.perform do |form|
+        form.add_name('.gitlab/issue_templates/incident.md')
+        form.add_content(template)
+        form.add_commit_message('Add Incident template')
+        form.commit_changes
       end
+    end
 
-      def push_template_to_repository(template)
-        @project.visit!
-
-        Page::Project::Show.perform(&:create_new_file!)
+    def create_incident_issue
+      Page::Project::Menu.perform(&:go_to_operations_incidents)
 
-        Page::File::Form.perform do |form|
-          form.add_name('.gitlab/issue_templates/incident.md')
-          form.add_content(template)
-          form.add_commit_message('Add Incident template')
-          form.commit_changes
-        end
+      Page::Project::Operations::Incidents::Index.perform do |incidents_page|
+        incidents_page.create_incident
       end
 
-      def create_incident_issue
-        Page::Project::Menu.perform(&:go_to_operations_incidents)
-
-        Page::Project::Operations::Incidents::Index.perform do |incidents_page|
-          incidents_page.create_incident
-        end
-
-        Page::Project::Issue::New.perform do |new_issue|
-          new_issue.fill_title('test incident')
-          new_issue.create_new_issue
-        end
+      Page::Project::Issue::New.perform do |new_issue|
+        new_issue.fill_title('test incident')
+        new_issue.create_new_issue
       end
     end
   end

qa/qa/specs/features/ee/browser_ui/8_monitor/cluster_with_prometheus.rb

+# frozen_string_literal: true
+#
+module QA
+  RSpec.configure do |rspec|
+    # This config option will be enabled by default on RSpec 4,
+    # but for reasons of backwards compatibility, you have to
+    # set it on RSpec 3.
+    #
+    # It causes the host group and examples to inherit metadata
+    # from the shared context.
+    rspec.shared_context_metadata_behavior = :apply_to_host_groups
+  end
+
+  RSpec.shared_context "cluster with Prometheus installed", shared_context: :metadata do
+    before :all do
+      @cluster = Service::KubernetesCluster.new(provider_class: Service::ClusterProvider::K3s).create!
+      @project = Resource::Project.fabricate_via_api! do |project|
+        project.name = 'monitoring-project'
+        project.auto_devops_enabled = true
+        project.template_name = 'express'
+      end
+
+      deploy_project_with_prometheus
+    end
+
+    def deploy_project_with_prometheus
+      %w[
+          CODE_QUALITY_DISABLED TEST_DISABLED LICENSE_MANAGEMENT_DISABLED
+          SAST_DISABLED DAST_DISABLED DEPENDENCY_SCANNING_DISABLED
+          CONTAINER_SCANNING_DISABLED PERFORMANCE_DISABLED SECRET_DETECTION_DISABLED
+        ].each do |key|
+        Resource::CiVariable.fabricate_via_api! do |resource|
+          resource.project = @project
+          resource.key = key
+          resource.value = '1'
+          resource.masked = false
+        end
+      end
+
+      Flow::Login.sign_in
+
+      Resource::KubernetesCluster::ProjectCluster.fabricate! do |cluster_settings|
+        cluster_settings.project = @project
+        cluster_settings.cluster = @cluster
+        cluster_settings.install_runner = true
+        cluster_settings.install_ingress = true
+        cluster_settings.install_prometheus = true
+      end
+
+      Resource::Pipeline.fabricate_via_api! do |pipeline|
+        pipeline.project = @project
+      end.visit!
+
+      Page::Project::Pipeline::Show.perform do |pipeline|
+        pipeline.click_job('build')
+      end
+      Page::Project::Job::Show.perform do |job|
+        expect(job).to be_successful(timeout: 600)
+
+        job.click_element(:pipeline_path)
+      end
+
+      Page::Project::Pipeline::Show.perform do |pipeline|
+        pipeline.click_job('production')
+      end
+      Page::Project::Job::Show.perform do |job|
+        expect(job).to be_successful(timeout: 1200)
+
+        job.click_element(:pipeline_path)
+      end
+    end
+
+    after :all do
+      @cluster.remove!
+    end
+  end
+end