search

Ginger-Automation / Ginger

Ginger Automation IDE
https://ginger.amdocs.com
Apache License 2.0
92 stars 61 forks source link

Added Auto Capture Screenshot on Failure option on action level. #3853

Closed Maheshkale447 closed 2 months ago

Maheshkale447 commented 2 months ago

It will be by default disabled for Non Driver and Webservices action

Thank you for your contribution. Before submitting this PR, please make sure:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes enhance the functionality of the Ginger framework by introducing a new feature for automatic screenshot capture on execution failure. This includes updates to the configuration, UI components, and associated classes, ensuring that users can easily manage screenshot behavior. Overall, the modifications improve usability and maintainability of the codebase while refining layout and design elements.

Changes

File Path Change Summary
Ginger/.editorconfig Changed C# brace indentation rule from true to false.
Ginger/Ginger/Actions/ActionEditPage.xaml Updated layout to vertical orientation; added checkbox for auto screenshot on failure.
Ginger/Ginger/Actions/ActionEditPage.xaml.cs Bound new checkbox to mAction for controlling screenshot behavior.
Ginger/GingerCoreCommon/Actions/Act.cs Added AutoScreenShotOnFailure property and refactored SupportSimulation getter.
Ginger/GingerCoreCommon/Actions/ActWithoutDriver.cs Added constructor initializing AutoScreenShotOnFailure to false.
Ginger/GingerCoreCommon/Actions/Webservices/ActSoapUI.cs Added constructor setting AutoScreenShotOnFailure to false.
Ginger/GingerCoreCommon/InterfacesLib/IAct.cs Introduced AutoScreenShotOnFailure property in the IAct interface.
Ginger/GingerCoreNET/ActionsLib/Webservices/ActWebAPIBase.cs Added constructor; updated ActionDescription for clarity.
Ginger/GingerCoreNET/ActionsLib/Webservices/ActWebAPIModel.cs Added constructor; modified input value list method for initialization.
Ginger/GingerCoreNET/ActionsLib/Webservices/ActWebAPIRest.cs Updated ActionDescription for better readability.
Ginger/GingerCoreNET/ActionsLib/Webservices/ActWebAPISoap.cs Changed ActionDescription for clarity.
Ginger/GingerCoreNET/ActionsLib/Webservices/Diameter/ActDiameter.cs Added constructor initializing AutoScreenShotOnFailure to false.
Ginger/GingerCoreNET/Run/GingerExecutionEngine.cs Formatting adjustments for better readability without logical changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant Act
    participant Screenshot

    User->>UI: Initiates Action
    UI->>Act: Start Execution
    Act->>Act: Check for Failure
    alt Failure Detected
        Act->>Screenshot: Capture Screenshot
    end

🐇✨
In code we leap, with changes bright,
Automatic captures, a splendid sight!
With each new checkbox, we frolic and play,
Improving our tools in a whimsical way!
Hops of joy for features added,
In the garden of code, our dreams are padded! 🌼

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.