Merge pull request #6132 from ethereum/pipelineoptim

yann300 · web-flow · commit 9b7ccdc05aa3 · 2025-07-24T10:48:38.000+02:00
Pipelineoptim
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,14 +1,27 @@
 version: 2.1
 parameters:
+  run_all_tests:
+    type: boolean
+    default: false
+  run_pr_tests:
+    type: boolean
+    default: false
+  run_file_tests:
+    type: string
+    default: ""  
+  run_metamask_tests:
+    type: boolean
+    default: false
   run_flaky_tests:
     type: boolean
-    default: false   
+    default: false
+  resource_class:
+    type: enum
+    enum: ["small", "medium", "medium+", "large", "xlarge", "2xlarge"]
+    default: "xlarge"
   web:
     type: boolean
     default: true
-  run_metamask_tests:
-    type: boolean
-    default: false   
 orbs:
   browser-tools: circleci/browser-tools@1.5.2
   node: circleci/node@7.0.0
@@ -18,9 +31,7 @@ jobs:
   build:
     docker:
       - image: cimg/node:20.0.0-browsers
-
-    resource_class:
-      xlarge
+    resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     steps:
       - run: sudo apt update && sudo apt install zstd
@@ -62,8 +73,7 @@ jobs:
   build-plugin:
       docker:
       - image: cimg/node:20.0.0-browsers
-      resource_class:
-        xlarge
+      resource_class: << pipeline.parameters.resource_class >>
       working_directory: ~/remix-project
       parameters:
         plugin:
@@ -83,15 +93,12 @@ jobs:
         - persist_to_workspace:
             root: .
             paths:
-              - "persist"
-
+              - "persist"  
   lint:
     docker:
       - image: cimg/node:20.0.0-browsers
-    resource_class:
-      xlarge
+    resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
-
     steps:
       - checkout
       - restore_cache:
@@ -105,10 +112,8 @@ jobs:
   remix-libs:
     docker:
       - image: cimg/node:20.0.0-browsers
-    resource_class:
-      xlarge
+    resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
-
     steps:
       - checkout
       - attach_workspace:
@@ -128,17 +133,46 @@ jobs:
       - run: node dist/libs/remix-tests/bin/remix-tests ./libs/remix-tests/tests/examples_0/assert_ok_test.sol
       - run: yarn run test:libs
 
+
+  check-flaky-or-pr-tests:
+    docker:
+      - image: cimg/node:24.3.0
+    working_directory: ~/remix-project
+    parameters:
+      pattern:
+        type: string
+    steps:
+      - checkout
+      - run: node apps/remix-ide-e2e/src/buildGroupTests.js
+      - run:
+          name: Check for enabled tests matching tag
+          command: |
+            PATTERN="<< parameters.pattern >>"
+            if [ -z "$PATTERN" ]; then
+              echo "❌ Tag parameter is empty!"
+              exit 2
+            fi
+            echo "🔍 Searching for enabled tests with .$PATTERN extension..."
+            if grep -IRiL "'@disabled': \?true" "./apps/remix-ide-e2e/src/tests" | grep "${PATTERN}"; then
+              echo "✅ Found enabled .$PATTERN tests."
+              exit 0
+            else
+              echo "⚠️ No enabled .$PATTERN tests found. Skipping workflow."
+              exit 1
+            fi   
+
   remix-ide-browser:
     docker:
       - image: cimg/node:20.19.0-browsers
-    resource_class:
-      xlarge
+    resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     parameters:
       browser:
         type: string
       script:
         type: string
+      scriptparameter:
+        type: string
       job:
         type: string
       jobsize:
@@ -199,7 +233,7 @@ jobs:
                 install-chromedriver: false
             - run: yarn install_webdriver
             - run: firefox --version
-      - run: ./apps/remix-ide/ci/<< parameters.script >> << parameters.browser >> << parameters.jobsize >> << parameters.job >>
+      - run: ./apps/remix-ide/ci/<< parameters.script >> << parameters.browser >> << parameters.jobsize >> << parameters.job >> << parameters.scriptparameter >>
       - store_test_results:
           path: ./reports/tests
       - store_artifacts:
@@ -217,8 +251,7 @@ jobs:
   remix-test-plugins:
     docker:
       - image: cimg/node:20.17.0-browsers
-    resource_class:
-      xlarge
+    resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     parameters:
       plugin:
@@ -253,8 +286,7 @@ jobs:
   predeploy:
     docker:
       - image: cimg/node:20.0.0-browsers
-    resource_class:
-      xlarge
+    resource_class: << pipeline.parameters.resource_class >>
     working_directory: ~/remix-project
     steps:
       - checkout
@@ -297,20 +329,65 @@ jobs:
     
 workflows:
 
+  run_file_tests:
+    when: << pipeline.parameters.run_file_tests >>
+    jobs:
+      - check-flaky-or-pr-tests:
+          pattern: << pipeline.parameters.run_file_tests >>
+      - build:
+          requires:
+            - check-flaky-or-pr-tests
+      - remix-ide-browser:
+          requires:
+            - build
+          matrix:
+            parameters:
+              browser: ["chrome"]
+              script: ["singletest.sh"]
+              job: ["nogroup"]
+              jobsize: ["1"]
+              parallelism: [1]
+              scriptparameter: [<< pipeline.parameters.run_file_tests >>]
+
+  run_pr_tests:
+    when: << pipeline.parameters.run_pr_tests >>
+    jobs:
+      - check-flaky-or-pr-tests:
+          pattern: "\\.pr"
+      - build:
+          requires:
+            - check-flaky-or-pr-tests
+      - remix-ide-browser:
+          requires:
+            - build
+          matrix:
+            parameters:
+              browser: ["chrome"]
+              script: ["singletest.sh"]
+              job: ["nogroup"]
+              jobsize: ["1"]
+              parallelism: [1]
+              scriptparameter: ["\\.pr"]
+
   run_flaky_tests:
     when: << pipeline.parameters.run_flaky_tests >>
     jobs:
-      - build
+      - check-flaky-or-pr-tests:
+          pattern: "\\.flaky"
+      - build:
+          requires:
+            - check-flaky-or-pr-tests
       - remix-ide-browser:
           requires:
             - build
           matrix:
             parameters:
               browser: ["chrome", "firefox"]
-              script: ["flaky.sh"]
+              script: ["singletest.sh"]
               job: ["nogroup"]
               jobsize: ["1"]
               parallelism: [5]
+              scriptparameter: ["\\.flaky"]
 
   run_metamask_tests:
     when: << pipeline.parameters.run_metamask_tests >>
@@ -327,7 +404,7 @@ workflows:
               jobsize: ["1"]
               parallelism: [1]
   web:
-    when: << pipeline.parameters.web >>
+    when: << pipeline.parameters.run_all_tests >>
     jobs:
       - build
       - build-plugin:
@@ -363,6 +440,7 @@ workflows:
               job: ["0","1","2","3","4","5","6","7","8","9"]
               jobsize: ["10"]
               parallelism: [15]
+              scriptparameter: [""]
       - remix-ide-browser:
           requires:
             - build
@@ -374,6 +452,7 @@ workflows:
               job: ["0"]
               jobsize: ["10"]
               parallelism: [1]
+              scriptparameter: [""]
           filters:
             branches:
               only: [/.*metamask.*/, 'master', 'remix_live', 'remix_beta']
diff --git a/apps/remix-ide-e2e/CIRCLE_CI.md b/apps/remix-ide-e2e/CIRCLE_CI.md
@@ -0,0 +1,44 @@
+
+
+# CircleCI Parameters and Workflows Overview
+
+This project uses **CircleCI pipeline parameters** to control workflows and resources dynamically. Below is a description of the main parameters and their purpose:
+
+## ✅ Boolean Parameters
+
+These are used to enable or disable specific workflows:
+
+- **`run_all_tests`**  
+  When `true`, runs the full suite of tests.
+- **`run_pr_tests`**  
+  When `true`, runs tests tagged with `#pr` or `#PR`.
+- **`run_flaky_tests`**  
+  When `true`, runs tests tagged with `#flaky`.
+- **`run_metamask_tests`**  
+  When `true`, runs only the MetaMask-related tests.
+- **`windows`, `mac`, `linux`**  
+  Used to selectively run OS-specific builds or tests.
+
+## ✅ String Parameters
+
+- **`run_file_tests`**  
+  Specifies a specific filename or pattern to run targeted tests.
+- **`keyword`**  
+  A custom keyword string. When specified, the workflow searches for test files containing this keyword in their filenames. This is used by the `run_custom_keyword_tests` workflow to trigger tests selectively.
+
+## ✅ Enum Parameter
+
+- **`resource_class`**  
+  Controls the compute size used for jobs.
+  Allowed values:  
+  - `medium`  
+  - `large`  
+  - `xlarge` (default)  
+  - `2xlarge`
+
+  This parameter is applied across jobs to adjust resource allocation dynamically. For example, you can trigger a pipeline with:
+  ```
+  resource_class=2xlarge
+  ```
+  to speed up builds on more powerful machines.
+
diff --git a/apps/remix-ide-e2e/src/buildGroupTests.js b/apps/remix-ide-e2e/src/buildGroupTests.js
@@ -15,23 +15,23 @@ fs.readdirSync(testFolder).forEach(file => {
   if (!file.includes('group')) {
     const content = fs.readFileSync(testFolder + file, 'utf8')
     const matches = content.match(/group\d+/g)
-    createFlakyTestFiles(file, content)
+    createTaggedTestFiles(file, content)
     createFiles(file, matches)
   }
 })
 
-function createFiles(file, matches, flaky = false) {
+function createFiles(file, matches, tag = false) {
   if (matches) {
     const unique = matches.filter(onlyUnique)
     unique.map((group) => {
       const rewrite = source.replace('#groupname', group).replace('#file', file.replace('.ts', ''))
       const extension = file.split('.')
       extension.shift()
       let filename
-      if (!flaky) {
+      if (!tag) {
         filename = `${testFolder}${file.split('.').shift()}_${group}.${extension.join('.')}`
       } else {
-        filename = `${testFolder}${file.split('.').shift()}_${group}.flaky.ts`
+        filename = `${testFolder}${file.split('.').shift()}_${group}.${tag.toLowerCase()}.ts`
       }
       fs.writeFileSync(filename, rewrite)
     })
@@ -42,14 +42,17 @@ function onlyUnique(value, index, self) {
   return self.indexOf(value) === index
 }
 
-function createFlakyTestFiles(file, text) {
+function createTaggedTestFiles(file, text) {
   const lines = text.split('\n')
-  lines.forEach((line, index) => {
-    // if line contains #flaky
-    if (line.includes('#flaky')) {
+  lines.forEach((line) => {
+    if (line.includes('#flaky') || line.includes('#pr') || line.includes('#PR')) {
       const matches = line.match(/group\d+/g)
-      const unique = matches.filter(onlyUnique)
-      createFiles(file, matches, true)
+      if (matches) {
+        const tags = line.match(/#(flaky|pr|PR)/gi).map(t => t.replace('#', '').toLowerCase());
+        tags.forEach(tag => {
+          createFiles(file, matches, tag);
+        });
+      }
     }
   })
 }
diff --git a/apps/remix-ide/ci/browser_test.sh b/apps/remix-ide/ci/browser_test.sh
@@ -17,11 +17,21 @@ sleep 5
 node apps/remix-ide/ci/splice_tests.js $2 $3
 TESTFILES=$(node apps/remix-ide/ci/splice_tests.js $2 $3 | grep -v 'metamask' | circleci tests split --split-by=timings)
 for TESTFILE in $TESTFILES; do
-    npx nightwatch --config dist/apps/remix-ide-e2e/nightwatch-${1}.js dist/apps/remix-ide-e2e/src/tests/${TESTFILE}.js --env=$1 || npx nightwatch --config dist/apps/remix-ide-e2e/nightwatch-${1}.js dist/apps/remix-ide-e2e/src/tests/${TESTFILE}.js --env=$1 || TEST_EXITCODE=1
+    if ! npx nightwatch --config dist/apps/remix-ide-e2e/nightwatch-${1}.js dist/apps/remix-ide-e2e/src/tests/${TESTFILE}.js --env=$1; then
+      if ! npx nightwatch --config dist/apps/remix-ide-e2e/nightwatch-${1}.js dist/apps/remix-ide-e2e/src/tests/${TESTFILE}.js --env=$1; then
+        TEST_EXITCODE=1
+        break
+      fi
+    fi
 done
 
 echo "$TEST_EXITCODE"
-if [ "$TEST_EXITCODE" -eq 1 ]
-then
+# Fail the test early and cancel the workflow
+if [ "$TEST_EXITCODE" -eq 1 ]; then
+  echo "❌ Test failed. Attempting to cancel the workflow..."
+  curl -s -X POST \
+    -H "Authorization: Basic $FAIL_FAST_TOKEN" \
+    -H "Content-Type: application/json" \
+    "https://circleci.com/api/v2/workflow/${CIRCLE_WORKFLOW_ID}/cancel"
   exit 1
 fi
diff --git a/apps/remix-ide/ci/singletest.sh b/apps/remix-ide/ci/singletest.sh
@@ -2,14 +2,14 @@
 
 set -e
 
-TESTFILES=$(grep -IRiL "\'@disabled\': \?true" "dist/apps/remix-ide-e2e/src/tests" | grep "\.flaky" | sort )
+TESTFILES=$(grep -IRiL "\'@disabled\': \?true" "dist/apps/remix-ide-e2e/src/tests" | grep "${4}" | sort )
 
 # count test files
-fileCount=$(grep -IRiL "\'@disabled\': \?true" "dist/apps/remix-ide-e2e/src/tests" | grep "\.flaky" | wc -l )
+fileCount=$(grep -IRiL "\'@disabled\': \?true" "dist/apps/remix-ide-e2e/src/tests" | grep "${4}" | wc -l )
 # if fileCount is 0
 if [ $fileCount -eq 0 ]
 then
-  echo "No flaky tests found"
+  echo "No flaky or PR tests found"
   exit 0
 fi
 
diff --git a/package.json b/package.json
diff --git a/projects.json b/projects.json
