Merge branch 'caw-improve-smoke-test-suite-and-specs' into 'master'

Improve remote dev smoke test script and specs

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/147415



Merged-by: Peter Leitzen <pleitzen@gitlab.com>
Approved-by: Peter Leitzen <pleitzen@gitlab.com>
Approved-by: Vishal Tak <vtak@gitlab.com>
Reviewed-by: Peter Leitzen <pleitzen@gitlab.com>
Co-authored-by: Chad Woolley <cwoolley@gitlab.com>

ee/spec/features/remote_development/workspaces_dropdown_group_spec.rb

@@ -73,6 +73,7 @@
     context 'when workspaces dropdown group is visible' do
       before do
         visit subject
+        wait_for_requests
         click_button 'Edit'
       end
 

ee/spec/lib/remote_development/agent_config/main_spec.rb

 # frozen_string_literal: true
 
-require_relative '../fast_spec_helper'
+require_relative '../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::AgentConfig::Main, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::AgentConfig::Main, :rd_fast, feature_category: :remote_development do
   include RemoteDevelopment::RailwayOrientedProgrammingHelpers
 
   let(:value) { {} }

ee/spec/lib/remote_development/message_spec.rb

 # frozen_string_literal: true
 
-require_relative 'fast_spec_helper'
+require_relative 'rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Message, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Message, :rd_fast, feature_category: :remote_development do
   describe '#==' do
     it 'implements equality' do
       expect(described_class.new({ a: 1 })).to eq(described_class.new(a: 1))

ee/spec/lib/remote_development/message_support_spec.rb

 # frozen_string_literal: true
 
-require_relative 'fast_spec_helper'
+require_relative 'rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::MessageSupport, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::MessageSupport, :rd_fast, feature_category: :remote_development do
   let(:object) { Object.new.extend(described_class) }
 
   describe '.generate_error_response_from_message' do

ee/spec/lib/remote_development/fast_spec_helper.rb → ee/spec/lib/remote_development/rd_fast_spec_helper.rb

@@ -25,6 +25,20 @@
 require 'gitlab/rspec/next_instance_of'
 
 RSpec.configure do |config|
+  # Ensure that all specs which require this fast_spec_helper have the `:fast` tag at the top-level describe
+  config.after(:suite) do
+    RSpec.world.example_groups.each do |example_group|
+      # Check only top-level describes
+      next unless example_group.metadata[:parent_example_group].nil?
+
+      unless example_group.metadata[:rd_fast]
+        raise "Top-level describe blocks must have the `:rd_fast` tag when `rd_fast_spec_helper` is required. " \
+              "It is missing on example group: #{example_group.description}"
+      end
+    end
+  end
+
+  # Set up rspec features required by the remote development specs
   config.include NextInstanceOf
   config.mock_with :rspec do |mocks|
     mocks.verify_doubled_constant_names = false

ee/spec/lib/remote_development/settings/defaults_initializer_spec.rb

 # frozen_string_literal: true
 
-require_relative '../fast_spec_helper'
+require_relative '../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Settings::DefaultsInitializer, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Settings::DefaultsInitializer, :rd_fast, feature_category: :remote_development do
   let(:value) { {} }
 
   subject(:returned_value) do

ee/spec/lib/remote_development/settings/env_var_reader_spec.rb

 # frozen_string_literal: true
 
-require_relative "../fast_spec_helper"
+require_relative "../rd_fast_spec_helper"
 
-RSpec.describe RemoteDevelopment::Settings::EnvVarReader, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Settings::EnvVarReader, :rd_fast, feature_category: :remote_development do
   include ResultMatchers
 
   let(:default_setting_value) { 42 }

ee/spec/lib/remote_development/settings/main_spec.rb

 # frozen_string_literal: true
 
-require_relative '../fast_spec_helper'
+require_relative '../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Settings::Main, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Settings::Main, :rd_fast, feature_category: :remote_development do
   include RemoteDevelopment::RailwayOrientedProgrammingHelpers
 
   let(:value) { {} }

ee/spec/lib/remote_development/unmatched_result_error_spec.rb

 # frozen_string_literal: true
 
-require_relative 'fast_spec_helper'
+require_relative 'rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::UnmatchedResultError, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::UnmatchedResultError, :rd_fast, feature_category: :remote_development do
   let(:unmatched_message_class) { stub_const('UnmatchedMessage', Class.new(RemoteDevelopment::Message)) }
   let(:unmatched_message) { unmatched_message_class.new }
 

ee/spec/lib/remote_development/workspaces/create/devfile_flattener_spec.rb

 # frozen_string_literal: true
 
-require_relative "../../fast_spec_helper"
+require_relative "../../rd_fast_spec_helper"
 
-RSpec.describe RemoteDevelopment::Workspaces::Create::DevfileFlattener, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Create::DevfileFlattener, :rd_fast, feature_category: :remote_development do
   include_context 'with remote development shared fixtures'
 
   let(:devfile_yaml) { example_devfile }

ee/spec/lib/remote_development/workspaces/create/main_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../fast_spec_helper'
+require_relative '../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Create::Main, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Create::Main, :rd_fast, feature_category: :remote_development do
   include RemoteDevelopment::RailwayOrientedProgrammingHelpers
 
   let(:value) { {} }

ee/spec/lib/remote_development/workspaces/create/tools_component_injector_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../fast_spec_helper'
+require_relative '../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Create::ToolsComponentInjector, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Create::ToolsComponentInjector, :rd_fast, feature_category: :remote_development do
   include_context 'with remote development shared fixtures'
 
   let(:input_processed_devfile_name) { 'example.flattened-devfile.yaml' }

ee/spec/lib/remote_development/workspaces/create/volume_definer_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../fast_spec_helper'
+require_relative '../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Create::VolumeDefiner, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Create::VolumeDefiner, :rd_fast, feature_category: :remote_development do
   let(:value) { { params: 1 } }
 
   subject(:returned_value) do

ee/spec/lib/remote_development/workspaces/create/workspace_variables_spec.rb

 # frozen_string_literal: true
 
-require_relative "../../fast_spec_helper"
+require_relative "../../rd_fast_spec_helper"
 
-RSpec.describe ::RemoteDevelopment::Workspaces::Create::WorkspaceVariables,
+RSpec.describe ::RemoteDevelopment::Workspaces::Create::WorkspaceVariables, :rd_fast,
   feature_category: :remote_development do
   let(:name) { "name" }
   let(:dns_zone) { "example.dns.zone" }

ee/spec/lib/remote_development/workspaces/reconcile/input/actual_state_calculator_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../../fast_spec_helper'
+require_relative '../../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ActualStateCalculator, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ActualStateCalculator, :rd_fast, feature_category: :remote_development do
   include_context 'with remote development shared fixtures'
 
   describe '.calculate_actual_state' do

ee/spec/lib/remote_development/workspaces/reconcile/input/agent_info_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../../fast_spec_helper'
+require_relative '../../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::AgentInfo, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::AgentInfo, :rd_fast, feature_category: :remote_development do
   let(:agent_info_constructor_args) do
     {
       name: 'name',

ee/spec/lib/remote_development/workspaces/reconcile/input/agent_infos_observer_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../../fast_spec_helper'
+require_relative '../../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::AgentInfosObserver, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::AgentInfosObserver, :rd_fast, feature_category: :remote_development do
   let(:agent) { instance_double("Clusters::Agent", id: 1) }
   let(:update_type) { RemoteDevelopment::Workspaces::Reconcile::UpdateTypes::PARTIAL }
   let(:logger) { instance_double(::Logger) }

ee/spec/lib/remote_development/workspaces/reconcile/input/params_extractor_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../../fast_spec_helper'
+require_relative '../../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ParamsExtractor, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ParamsExtractor, :rd_fast, feature_category: :remote_development do
   let(:agent) { instance_double("Clusters::Agent") }
   let(:original_params) do
     {

ee/spec/lib/remote_development/workspaces/reconcile/input/params_to_infos_converter_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../../fast_spec_helper'
+require_relative '../../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ParamsToInfosConverter, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ParamsToInfosConverter, :rd_fast, feature_category: :remote_development do
   let(:workspace_agent_info_hashes_from_params) do
     [
       {

ee/spec/lib/remote_development/workspaces/reconcile/input/params_validator_spec.rb

 # frozen_string_literal: true
 
-require_relative '../../../fast_spec_helper'
+require_relative '../../../rd_fast_spec_helper'
 
-RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ParamsValidator, feature_category: :remote_development do
+RSpec.describe RemoteDevelopment::Workspaces::Reconcile::Input::ParamsValidator, :rd_fast, feature_category: :remote_development do
   include ResultMatchers
 
   let(:update_type) { "partial" }