Skip to content
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

ci: update .yml file test report ui #811

Merged
merged 1 commit into from
Sep 28, 2023
Merged

ci: update .yml file test report ui #811

merged 1 commit into from
Sep 28, 2023

Conversation

AndriiFilippov
Copy link
Collaborator

@AndriiFilippov AndriiFilippov commented Aug 15, 2023

Description

Prepare Test Reports for Espressif-IDE

IEP-1008

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How has this been tested?

Check CI Test Report

Test Configuration:

  • ESP-IDF Version:
  • OS (Windows,Linux and macOS): Windows 10

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • Chore: Updated the CI/CD pipeline for Windows in GitHub Actions. The previous action used for publishing test reports has been replaced with phoenix-actions/test-reporting to enhance test reporting capabilities. This new action provides more configuration options, including the ability to specify the name of the test reports, the path to the XML files containing the test results, and the reporter type.

@github-actions
Copy link

github-actions bot commented Aug 15, 2023

Test Results

  17 files    17 suites   35m 16s ⏱️
234 tests 234 ✔️ 0 💤 0
242 runs  242 ✔️ 0 💤 0

Results for commit 132eb2d.

♻️ This comment has been updated with latest results.

@coderabbitai
Copy link

coderabbitai bot commented Aug 21, 2023

Walkthrough

This update modifies the CI/CD pipeline for Windows, replacing the previous test reporting action with a new one. The new action provides more configuration options and uses the phoenix-actions/test-reporting action to generate detailed test reports.

Changes

File Summary
.github/workflows/ci_windows.yml Replaced scacap/action-surefire-report with phoenix-actions/test-reporting for publishing test reports. New action allows specifying report name, path to XML files, and reporter type.

🐇💻

"In the land of code where the shadows lie,
A rabbit hopped forth under the cloudless sky.
With a twitch of his nose and a gleam in his eye,
He swapped out an action, no need to ask why.
Now tests tell their tales, clear as day,
In the CI/CD pipeline, they have their say.
So here's to changes, big and small,
CodeRabbit celebrates them all!" 🎉🥕


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image description CodeRabbit

Actionable comments generated: 1

Commits Files that changed from the base of the PR and between 5ef1178 and 4107b22 commits.
Files selected for processing (1)
  • .github/workflows/ci_windows.yml (1 hunks)
Additional comments (Suppressed): 1
.github/workflows/ci_windows.yml (1)
  • 48-53: The old test reporting action scacap/action-surefire-report@v1 has been commented out. If this is intentional and the new action phoenix-actions/test-reporting@v12 is meant to replace it entirely, please ensure that the new action provides all the necessary functionality and meets the project's requirements.

Tips

Chat with Image description CodeRabbit Bot (@coderabbitai)

  • Tag the bot with @coderabbitai in any review comment to ask it questions. The bot will not respond unless explicitly tagged.
  • A review comment is a comment on a diff or a file and not a comment on the PR itself.
  • You can use the mouse to select multiple lines of code to provide exact context to the bot.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

  • Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

Comment on lines 54 to 55
- name: Test Reporting1
if: ${{ always() }}
uses: scacap/action-surefire-report@v1
uses: phoenix-actions/test-reporting@v12
with:
check_name: 'Windows Test Reports'
name: Test Results
path: |
tests/com.espressif.idf.ui.test/target/surefire-reports/*.xml
tests/com.espressif.idf.core.test/target/surefire-reports/*.xml
reporter: java-junit
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image description CodeRabbit

The new test reporting action phoenix-actions/test-reporting@v12 has been added. Please make sure that the paths specified in line 59-61 are correct and contain the test reports generated by the Maven build. Also, verify that the reporter 'java-junit' is compatible with the format of your test results.

-        name: Test Reporting1
+        name: Test Reporting

The name of the step should be more descriptive and professional. Consider changing it from 'Test Reporting1' to 'Test Reporting'.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Commits Files that changed from the base of the PR and between 4107b22 and 4d47d54 commits.
Files selected for processing (1)
  • .github/workflows/ci_windows.yml (1 hunks)
Additional comments (Suppressed): 2
.github/workflows/ci_windows.yml (2)
  • 45-46: The build step remains unchanged and looks good.

  • 48-52: The old test reporting step has been commented out. Ensure that the new test reporting action covers all the functionalities of the old one.

Comment on lines 54 to 55
- name: Test Reporting1
if: ${{ always() }}
uses: scacap/action-surefire-report@v1
uses: phoenix-actions/test-reporting@v12
with:
check_name: 'Windows Test Reports'
name: Test Results Report
path:
tests/*/*/*/TEST-*.xml
reporter: java-junit
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new test reporting step uses the phoenix-actions/test-reporting action. The configuration seems correct, but ensure that the path tests/*/*/*/TEST-*.xml correctly points to the location of the test result files in your project structure.

-         path:
-           tests/*/*/*/TEST-*.xml
+         path: 'path/to/your/test/results/*.xml'

Also, verify that the reporter java-junit is compatible with the format of your test results.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Commits Files that changed from the base of the PR and between 4d47d54 and 5a6093e commits.
Files selected for processing (1)
  • .github/workflows/ci_windows.yml (1 hunks)
Additional comments (Suppressed): 2
.github/workflows/ci_windows.yml (2)
  • 45-46: The build step remains unchanged and looks good.

  • 48-52: The old test reporting action scacap/action-surefire-report@v1 has been commented out. Ensure that the new action phoenix-actions/test-reporting@v12 provides all the necessary features and is compatible with the project's requirements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Commits Files that changed from the base of the PR and between 9d6c775 and 0621ed6 commits.
Files selected for processing (1)
  • .github/workflows/ci_windows.yml (1 hunks)
Additional comments (Suppressed): 2
.github/workflows/ci_windows.yml (2)
  • 45-46: The Maven build command remains unchanged and should work as expected.

  • 48-52: The old test reporting step has been commented out. Ensure that the new test reporting action phoenix-actions/test-reporting@v12 provides equivalent or better functionality than the previous one scacap/action-surefire-report@v1.

Comment on lines 54 to 55
- name: Test Reporting1
if: ${{ always() }}
uses: scacap/action-surefire-report@v1
uses: phoenix-actions/test-reporting@v12
with:
check_name: 'Windows Test Reports'
name: Windows Test Reports
path:
tests/*/*/*/TEST-*.xml
reporter: java-junit
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new test reporting step uses the phoenix-actions/test-reporting@v12 action. The if: ${{ always() }} condition ensures that this step will always run, regardless of the success or failure of previous steps, which is good for catching all test results.

However, there's a minor indentation issue on line 56 which could cause a YAML parsing error. Here's the corrected version:

    - name: Test Reporting1
       if: ${{ always() }}
      uses: phoenix-actions/test-reporting@v12
       uses: phoenix-actions/test-reporting@v12
       with:
        name: Windows Test Reports
        path:
          tests/*/*/*/TEST-*.xml
        reporter: java-junit

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 0621ed6 and 5162d68 commits.
Files selected for processing (1)
  • .github/workflows/ci_windows.yml (1 hunks)
Additional comments (Suppressed): 3
.github/workflows/ci_windows.yml (3)
  • 47-55: The new action phoenix-actions/test-reporting@v12 is being used to publish test reports. Ensure that this action is compatible with the project's testing framework and that it can correctly interpret the XML files generated by the tests. Also, verify that the path tests/*/*/*/TEST-*.xml correctly points to the location of the test result XML files in your project structure.

  • 49-49: The condition if: ${{ always() }} means that this step will always run, even if previous steps fail. This is generally a good practice for test reporting steps, as you often want to see test results even if other parts of the workflow fail. However, ensure that this is the desired behavior in your specific context.

  • 51-55: The configuration options for the new action have been set appropriately. The name field has been set to 'Windows Test Reports', the path field points to the location of the test result XML files, and the reporter field has been set to 'java-junit', which is appropriate for a Java project using JUnit for testing.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 9d6c775 and 6c6f5f8 commits.
Files selected for processing (1)
  • .github/workflows/ci_windows.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/ci_windows.yml

Copy link
Collaborator

@kolipakakondal kolipakakondal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kolipakakondal kolipakakondal merged commit ef09be8 into master Sep 28, 2023
7 checks passed
@kolipakakondal kolipakakondal deleted the IEP-1008 branch September 28, 2023 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants