- 
                Notifications
    You must be signed in to change notification settings 
- Fork 8.9k
optimize: Introduce automated flaky test tracking like OpenSearch #7545
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Open
      
      
            OmCheeLin
  wants to merge
  17
  commits into
  apache:2.x
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
OmCheeLin:flaky-test
  
      
      
   
  
    
  
  
  
 
  
      
    base: 2.x
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
  
     Open
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            17 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      cd14644
              
                add
              
              
                OmCheeLin f9dc410
              
                Update build.yml
              
              
                OmCheeLin bcf5887
              
                example
              
              
                OmCheeLin d497468
              
                example
              
              
                OmCheeLin 62ea426
              
                1
              
              
                OmCheeLin d52e7ba
              
                1
              
              
                OmCheeLin fc2443b
              
                1
              
              
                OmCheeLin ed7c6ef
              
                Update rerun-build.yml
              
              
                OmCheeLin 8e5ae62
              
                1
              
              
                OmCheeLin ebd776a
              
                1
              
              
                OmCheeLin 31c1284
              
                Update rerun-build.yml
              
              
                OmCheeLin b60b15e
              
                Merge branch '2.x' into flaky-test
              
              
                OmCheeLin 20fc95a
              
                Merge branch '2.x' into flaky-test
              
              
                YongGoose b527ac4
              
                update
              
              
                OmCheeLin e815072
              
                changes.log
              
              
                OmCheeLin 547f8ea
              
                Merge branch '2.x' into flaky-test
              
              
                YongGoose 3eb316c
              
                Merge branch '2.x' into flaky-test
              
              
                OmCheeLin File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
|  | ||
| import os | ||
| import sys | ||
| import xml.etree.ElementTree as ET | ||
| import json | ||
|  | ||
| def find_testcases_with_status(report_dir): | ||
| """ | ||
| all xml files under report_dir, parse results | ||
| return dict {(classname, testname): 'passed'/'failed'} | ||
| """ | ||
| results = {} | ||
|  | ||
| for root, _, files in os.walk(report_dir): | ||
| for file in files: | ||
| if not file.endswith(".xml"): | ||
| continue | ||
| path = os.path.join(root, file) | ||
| try: | ||
| tree = ET.parse(path) | ||
| root_elem = tree.getroot() | ||
| for testcase in root_elem.iter("testcase"): | ||
| classname = testcase.attrib.get("classname") | ||
| testname = testcase.attrib.get("name") | ||
|  | ||
| failed = testcase.find("failure") is not None or testcase.find("error") is not None | ||
| status = "failed" if failed else "passed" | ||
| results[(classname, testname)] = status | ||
| except Exception as e: | ||
| print(f"Warning: Failed to parse {path}: {e}", file=sys.stderr) | ||
| return results | ||
|  | ||
|  | ||
| def main(): | ||
| if len(sys.argv) != 3: | ||
| print("Usage: parse_failed_tests.py <report_dir_1> <report_dir_2>") | ||
| sys.exit(1) | ||
|  | ||
| report_dir_1 = sys.argv[1] | ||
| report_dir_2 = sys.argv[2] | ||
|  | ||
| results_1 = find_testcases_with_status(report_dir_1) | ||
| results_2 = find_testcases_with_status(report_dir_2) | ||
|  | ||
| flaky_tests = [] | ||
| for test_id, status_1 in results_1.items(): | ||
| status_2 = results_2.get(test_id, "passed") | ||
| if status_1 == "failed" and status_2 == "passed": | ||
| flaky_tests.append(test_id) | ||
|  | ||
| if flaky_tests: | ||
| print(json.dumps([f"{c}.{t}" for c,t in flaky_tests])) | ||
| else: | ||
| print("[]") | ||
|  | ||
| if __name__ == "__main__": | ||
| main() | ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
|  | @@ -66,6 +66,8 @@ jobs: | |
| # step 4 | ||
| - name: "Print maven version" | ||
| run: ./mvnw -version | ||
| - name: "Set RUN_ATTEMPT env variable" | ||
| run: echo "I_RUN_ATTEMPT=${{ github.run_attempt }}" >> $GITHUB_ENV | ||
| # step 5 | ||
| - name: "Restore local maven repository cache" | ||
| uses: actions/cache/restore@v4 | ||
|  | @@ -99,6 +101,15 @@ jobs: | |
| path: ~/.m2/repository | ||
| key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}-${{ env.TODAY }} | ||
| # step 8 | ||
| - name: "Upload Surefire reports" | ||
| if: always() | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: run-${{ github.run_attempt }}-surefire-reports-${{ matrix.java }} | ||
| path: | | ||
| **/target/surefire-reports/*.xml | ||
| **/target/failsafe-reports/*.xml | ||
| # step 9 | ||
| - name: "Codecov" | ||
| if: matrix.java == '8' | ||
| uses: codecov/[email protected] | ||
|  | @@ -139,4 +150,4 @@ jobs: | |
| mvn clean install \ | ||
| -Prelease-seata \ | ||
| -DskipTests \ | ||
| -e -B -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn' | ||
| -e -B -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn' | ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
| name: Detect flaky Test | ||
|  | ||
| on: | ||
| workflow_run: | ||
| workflows: ["build"] | ||
| types: | ||
| - completed | ||
|  | ||
| permissions: | ||
| issues: write | ||
|  | ||
| jobs: | ||
| detect-flaky: | ||
| if: github.event.workflow_run.conclusion == 'success' && fromJSON(github.event.workflow_run.run_attempt) == 2 | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| java: [ 8, 17, 21 ] | ||
| steps: | ||
| # step 1 | ||
| - name: Checkout source code | ||
| uses: actions/checkout@v4 | ||
| # step 2 | ||
| - name: Download artifacts for both runs | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| RUN_ID: ${{ github.event.workflow_run.id }} | ||
| JAVA_VERSION: ${{ matrix.java }} | ||
| run: | | ||
| download_artifact() { | ||
| ARTIFACT_NAME=$1 | ||
| OUTPUT_DIR=$2 | ||
|  | ||
| echo "Fetching artifacts for workflow run ID: $RUN_ID" | ||
| artifacts_url="https://api.github.com/repos/${{ github.repository }}/actions/runs/$RUN_ID/artifacts" | ||
|  | ||
| artifact_url=$(curl -s -H "Authorization: token $GITHUB_TOKEN" $artifacts_url \ | ||
| | jq -r --arg name "$ARTIFACT_NAME" '.artifacts[] | select(.name == $name) | .archive_download_url') | ||
|  | ||
| if [ -z "$artifact_url" ]; then | ||
| echo "❌ Artifact not found: $ARTIFACT_NAME" | ||
| exit 1 | ||
| fi | ||
|  | ||
| echo "✅ Found artifact: $ARTIFACT_NAME" | ||
| curl -L -H "Authorization: token $GITHUB_TOKEN" "$artifact_url" -o artifact.zip | ||
| mkdir -p "$OUTPUT_DIR" | ||
| unzip artifact.zip -d "$OUTPUT_DIR" | ||
| } | ||
|  | ||
| download_artifact "run-1-surefire-reports-$JAVA_VERSION" "reports-1-$JAVA_VERSION" | ||
| download_artifact "run-2-surefire-reports-$JAVA_VERSION" "reports-2-$JAVA_VERSION" | ||
| # step 3 | ||
| - name: "Use Python 3.x" | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: '3.12' | ||
| # step 4 | ||
| - name: Parse failed tests | ||
| id: parse_failed_tests | ||
| run: | | ||
| output=$(python3 .github/scripts/parse_failed_tests.py reports-1-${{ matrix.java }} reports-2-${{ matrix.java }}) | ||
| echo "flaky_tests=$output" >> "$GITHUB_OUTPUT" | ||
| - name: Create GitHub issue for flaky tests | ||
| if: steps.parse_failed_tests.outputs.flaky_tests != '[]' | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| script: | | ||
| const flakyTests = JSON.parse(process.env.FLAKY_TESTS); | ||
| const body = `Detected flaky tests in Java ${{ matrix.java }} run:\n\n` + | ||
| flakyTests.map(t => `- ${t}`).join('\n'); | ||
| await github.rest.issues.create({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| title: `Flaky tests detected for Java ${{ matrix.java }}`, | ||
| body: body, | ||
| labels: ['flaky-test'], | ||
| }); | ||
| env: | ||
| FLAKY_TESTS: ${{ steps.parse_failed_tests.outputs.flaky_tests }} | 
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
      
      Oops, something went wrong.
        
    
  
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assuming a test is 'passed' when it's not found in the second run may be incorrect. A missing test could indicate it was skipped or not executed, which should be handled differently than a passed test.