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

support html report #21

Merged
merged 2 commits into from
Oct 22, 2024
Merged

support html report #21

merged 2 commits into from
Oct 22, 2024

Conversation

vearne
Copy link
Owner

@vearne vearne commented Oct 22, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a "Test Report" section in the README, including a visual report link.
    • Added HTML templates for better display of HTTP request and response details.
    • Enhanced reporting capabilities with HTML report generation for HTTP automation tests.
  • Bug Fixes

    • Corrected YAML serialization for the Report struct in the configuration.
  • Documentation

    • Updated TODO section in README to reflect completed tasks and improvements in documentation clarity.
  • Chores

    • Upgraded dependency version for improved functionality.

@vearne vearne merged commit c5a1dba into main Oct 22, 2024
1 of 2 checks passed
Copy link

coderabbitai bot commented Oct 22, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduced in this pull request encompass enhancements to documentation, configuration, and functionality across multiple files. Notably, the README.md and its Chinese counterpart have been updated to include a "Test Report" section and reflect completed tasks. Configuration adjustments in autotest.yml include changes to debugging settings and the commenting out of gRPC rules. The http_automate.go file has been significantly modified to improve reporting capabilities, while new HTML templates have been added for displaying HTTP request and response details. Additional utility functions and struct modifications enhance error handling and data representation.

Changes

File Change Summary
README.md, README_zh.md Added "Test Report" section with image link; updated "TODO" section to reflect completed tasks related to Lua scripting, report output, and gRPC automation.
config_files/autotest.yml Updated debug setting from true to false; commented out grpc_rule_files.
go.mod Updated github.com/spf13/cast dependency version from v1.6.0 to v1.7.0.
internal/command/http_automate.go Introduced embedded file system for templates; added CaseShow struct; modified GenReportFileHttp function to include summary info; added HTML report generation and RenderTpl function for template rendering.
internal/command/http_call.go Updated HttpTestCaseResult struct to include Error and Response fields; added ReqDetail and RespDetail methods for detailed logging.
internal/command/template/case.tpl Added new HTML template for displaying HTTP request and response details.
internal/command/template/index.tpl Added new HTML template for displaying structured data in a table format.
internal/config/config.go Corrected YAML tag alignment in AutoTestConfig struct for proper serialization.
internal/resource/resource.go Enhanced ParseConfigFile function to modify report path with a timestamp; added error handling for directory creation.
internal/util/util.go Added MD5 function for computing MD5 hashes of strings; included necessary imports.

Poem

🐇 In the garden of code, where changes bloom,
A "Test Report" shines, dispelling the gloom.
With Lua and gRPC, tasks now complete,
New templates arise, making reports neat.
So hop with delight, let the updates play,
For in every line, a bright future's way! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

1 participant