Improve error message for failed steps

[swissspidy]

No description provided.

[github-actions]

Hello! 👋

Thanks for opening this pull request! Please check out our contributing guidelines. We appreciate you taking the initiative to contribute to this project.

Contributing isn't limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

Here are some useful Composer commands to get you started:

• composer install: Install dependencies.
• composer test: Run the full test suite.
• composer phpcs: Check for code style violations.
• composer phpcbf: Automatically fix code style violations.
• composer phpunit: Run unit tests.
• composer behat: Run behavior-driven tests.

To run a single Behat test, you can use the following command:

# Run all tests in a single file
composer behat features/some-feature.feature

# Run only a specific scenario (where 123 is the line number of the "Scenario:" title)
composer behat features/some-feature.feature:123

You can find a list of all available Behat steps in our handbook.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the diagnostic capabilities of the testing framework by providing more explicit and helpful error messages. It clarifies the reasons behind failed string comparisons and offers detailed insights into unexpected outcomes during command execution, guiding users to quickly identify and resolve issues in their tests or code.

Highlights

• Enhanced String Comparison Error Messages: Improved the error messages for string comparison failures (e.g., be, contain, not contain) in src/Context/Support.php to provide more specific context about the expected string and the nature of the mismatch.
• Detailed Process Execution Error Messages: Updated src/Context/WhenStepDefinitions.php to catch RuntimeException during process invocation and provide more informative error messages, distinguishing between unexpected STDERR output and non-zero exit statuses, and suggesting appropriate test syntax.

Changelog

• src/Context/Support.php
  • Added specific action messages (e.g., 'Output does not exactly match expected string:') to error messages for string comparison failures.
  • Included the expected string in the error message to provide better context for debugging.
• src/Context/WhenStepDefinitions.php
  • Implemented a try-catch block around process invocation to handle RuntimeException more gracefully.
  • Modified error messages for run mode to differentiate between unexpected STDERR output (with a zero exit status) and unexpected non-zero exit statuses.
  • Provided guidance within error messages, suggesting the use of When I try [...] when non-zero exit statuses or STDERR output are expected.

Activity

• The pull request was created by swissspidy with the goal of improving error messages for failed steps.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩