Merge branch 'allow-test-level-to-take-several-prefixes-2' into 'master'

Allow Quality::TestLevel to have several prefixes

See merge request gitlab-org/gitlab!71644

.gitlab/ci/frontend.gitlab-ci.yml

@@ -130,11 +130,13 @@ update-storybook-yarn-cache:
       - tmp/tests/frontend/
       - knapsack/
 
-rspec frontend_fixture:
+# In gitlab-foss, generates FOSS fixtures. In gitlab, generates FOSS & EE fixtures.
+# That way, we don't need to have two separate jobs.
+rspec-all frontend_fixture:
   extends:
     - .frontend-fixtures-base
     - .frontend:rules:default-frontend-jobs
-  parallel: 2
+  parallel: 5
 
 rspec frontend_fixture as-if-foss:
   extends:
@@ -142,12 +144,6 @@ rspec frontend_fixture as-if-foss:
     - .frontend:rules:default-frontend-jobs-as-if-foss
     - .as-if-foss
 
-rspec-ee frontend_fixture:
-  extends:
-    - .frontend-fixtures-base
-    - .frontend:rules:default-frontend-jobs-ee
-  parallel: 3
-
 graphql-schema-dump:
   variables:
     SETUP_DB: "false"
@@ -198,9 +194,7 @@ jest:
     - .frontend:rules:jest
   needs:
     - job: "detect-tests"
-    - job: "rspec frontend_fixture"
-    - job: "rspec-ee frontend_fixture"
-      optional: true
+    - job: "rspec-all frontend_fixture"
   artifacts:
     name: coverage-frontend
     expire_in: 31d
@@ -227,9 +221,7 @@ jest-integration:
   script:
     - run_timed_command "yarn jest:integration --ci"
   needs:
-    - job: "rspec frontend_fixture"
-    - job: "rspec-ee frontend_fixture"
-      optional: true
+    - job: "rspec-all frontend_fixture"
     - job: "graphql-schema-dump"
 
 jest-as-if-foss:
@@ -343,9 +335,7 @@ startup-css-check:
     - .frontend:rules:default-frontend-jobs
   needs:
     - job: "compile-test-assets"
-    - job: "rspec frontend_fixture"
-    - job: "rspec-ee frontend_fixture"
-      optional: true
+    - job: "rspec-all frontend_fixture"
 
 startup-css-check as-if-foss:
   extends:
@@ -369,9 +359,7 @@ compile-storybook:
     - .compile-storybook-base
     - .frontend:rules:default-frontend-jobs
   needs:
-    - job: "rspec frontend_fixture"
-    - job: "rspec-ee frontend_fixture"
-      optional: true
+    - job: "rspec-all frontend_fixture"
     - job: "graphql-schema-dump"
   artifacts:
     name: storybook

.gitlab/ci/rules.gitlab-ci.yml

@@ -499,13 +499,6 @@
     - <<: *if-default-refs
       changes: *code-backstage-patterns
 
-.frontend:rules:default-frontend-jobs-ee:
-  rules:
-    - <<: *if-not-ee
-      when: never
-    - <<: *if-default-refs
-      changes: *code-backstage-patterns
-
 .frontend:rules:default-frontend-jobs-as-if-foss:
   rules:
     - <<: *if-not-ee

.gitlab/ci/test-metadata.gitlab-ci.yml

@@ -29,8 +29,7 @@ update-tests-metadata:
     - retrieve-tests-metadata
     - setup-test-env
     - rspec migration pg12
-    - rspec frontend_fixture
-    - rspec-ee frontend_fixture
+    - rspec-all frontend_fixture
     - rspec unit pg12
     - rspec integration pg12
     - rspec system pg12

doc/development/pipelines.md

@@ -252,7 +252,7 @@ graph RL;
     2_1-1 & 2_1-2 & 2_1-3 & 2_1-4 --> 1-6;
   end
 
-  2_2-2["rspec frontend_fixture/rspec-ee frontend_fixture (7 minutes)"];
+  2_2-2["rspec-all frontend_fixture (7 minutes)"];
   class 2_2-2 criticalPath;
   click 2_2-2 "https://app.periscopedata.com/app/gitlab/652085/Engineering-Productivity---Pipeline-Build-Durations?widget=7910143&udv=0"
   2_2-4["memory-on-boot (3.5 minutes)"];
@@ -284,7 +284,7 @@ graph RL;
   3_1-1["jest (14.5 minutes)"];
   class 3_1-1 criticalPath;
   click 3_1-1 "https://app.periscopedata.com/app/gitlab/652085/Engineering-Productivity---Pipeline-Build-Durations?widget=6914204&udv=0"
-  subgraph "Needs `rspec frontend_fixture/rspec-ee frontend_fixture`";
+  subgraph "Needs `rspec-all frontend_fixture`";
     3_1-1 --> 2_2-2;
   end
 
@@ -355,7 +355,7 @@ graph RL;
     2_1-1 & 2_1-2 & 2_1-3 & 2_1-4 --> 1-6;
   end
 
-  2_2-2["rspec frontend_fixture/rspec-ee frontend_fixture (7 minutes)"];
+  2_2-2["rspec-all frontend_fixture (7 minutes)"];
   class 2_2-2 criticalPath;
   click 2_2-2 "https://app.periscopedata.com/app/gitlab/652085/Engineering-Productivity---Pipeline-Build-Durations?widget=7910143&udv=0"
   2_2-4["memory-on-boot (3.5 minutes)"];
@@ -395,7 +395,7 @@ graph RL;
   3_1-1["jest (14.5 minutes)"];
   class 3_1-1 criticalPath;
   click 3_1-1 "https://app.periscopedata.com/app/gitlab/652085/Engineering-Productivity---Pipeline-Build-Durations?widget=6914204&udv=0"
-  subgraph "Needs `rspec frontend_fixture/rspec-ee frontend_fixture`";
+  subgraph "Needs `rspec-all frontend_fixture`";
     3_1-1 --> 2_2-2;
   end
 

scripts/rspec_helpers.sh

@@ -109,14 +109,18 @@ function rspec_paralellized_job() {
   local test_level="${job_name[1]}"
   local report_name=$(echo "${CI_JOB_NAME}" | sed -E 's|[/ ]|_|g') # e.g. 'rspec unit pg12 1/24' would become 'rspec_unit_pg12_1_24'
   local rspec_opts="${1}"
-  local spec_folder_prefix=""
+  local spec_folder_prefixes=""
 
   if [[ "${test_tool}" =~ "-ee" ]]; then
-    spec_folder_prefix="ee/"
+    spec_folder_prefixes="'ee/'"
   fi
 
   if [[ "${test_tool}" =~ "-jh" ]]; then
-    spec_folder_prefix="jh/"
+    spec_folder_prefixes="'jh/'"
+  fi
+
+  if [[ "${test_tool}" =~ "-all" ]]; then
+    spec_folder_prefixes="['', 'ee/']"
   fi
 
   export KNAPSACK_LOG_LEVEL="debug"
@@ -131,7 +135,7 @@ function rspec_paralellized_job() {
   cp "${KNAPSACK_RSPEC_SUITE_REPORT_PATH}" "${KNAPSACK_REPORT_PATH}"
 
   if [[ -z "${KNAPSACK_TEST_FILE_PATTERN}" ]]; then
-    pattern=$(ruby -r./tooling/quality/test_level.rb -e "puts Quality::TestLevel.new(%(${spec_folder_prefix})).pattern(:${test_level})")
+    pattern=$(ruby -r./tooling/quality/test_level.rb -e "puts Quality::TestLevel.new(${spec_folder_prefixes}).pattern(:${test_level})")
     export KNAPSACK_TEST_FILE_PATTERN="${pattern}"
   fi
 

spec/tooling/quality/test_level_spec.rb

@@ -63,7 +63,14 @@ RSpec.describe Quality::TestLevel do
     context 'with a prefix' do
       it 'returns a pattern' do
         expect(described_class.new('ee/').pattern(:system))
-          .to eq("ee/spec/{features}{,/**/}*_spec.rb")
+          .to eq("{ee/}spec/{features}{,/**/}*_spec.rb")
+      end
+    end
+
+    context 'with several prefixes' do
+      it 'returns a pattern' do
+        expect(described_class.new(['', 'ee/', 'jh/']).pattern(:system))
+          .to eq("{,ee/,jh/}spec/{features}{,/**/}*_spec.rb")
       end
     end
 
@@ -138,7 +145,14 @@ RSpec.describe Quality::TestLevel do
     context 'with a prefix' do
       it 'returns a regexp' do
         expect(described_class.new('ee/').regexp(:system))
-          .to eq(%r{ee/spec/(features)})
+          .to eq(%r{(ee/)spec/(features)})
+      end
+    end
+
+    context 'with several prefixes' do
+      it 'returns a regexp' do
+        expect(described_class.new(['', 'ee/', 'jh/']).regexp(:system))
+          .to eq(%r{(|ee/|jh/)spec/(features)})
       end
     end
 

tooling/quality/test_level.rb

@@ -60,20 +60,20 @@ module Quality
       system: ['features']
     }.freeze
 
-    attr_reader :prefix
+    attr_reader :prefixes
 
-    def initialize(prefix = nil)
-      @prefix = prefix
+    def initialize(prefixes = nil)
+      @prefixes = Array(prefixes)
       @patterns = {}
       @regexps = {}
     end
 
     def pattern(level)
-      @patterns[level] ||= "#{prefix}spec/#{folders_pattern(level)}{,/**/}*#{suffix(level)}"
+      @patterns[level] ||= "#{prefixes_for_pattern}spec/#{folders_pattern(level)}{,/**/}*#{suffix(level)}"
     end
 
     def regexp(level)
-      @regexps[level] ||= Regexp.new("#{prefix}spec/#{folders_regex(level)}").freeze
+      @regexps[level] ||= Regexp.new("#{prefixes_for_regex}spec/#{folders_regex(level)}").freeze
     end
 
     def level_for(file_path)
@@ -102,6 +102,20 @@ module Quality
 
     private
 
+    def prefixes_for_pattern
+      return '' if prefixes.empty?
+
+      "{#{prefixes.join(',')}}"
+    end
+
+    def prefixes_for_regex
+      return '' if prefixes.empty?
+
+      regex_prefix = prefixes.map(&Regexp.method(:escape)).join('|')
+
+      "(#{regex_prefix})"
+    end
+
     def suffix(level)
       case level
       when :frontend_fixture