Skip to content

[Behat] Reuse common setup contexts in API and UI (in shipping order and related scenarios)#17816

Merged
GSadee merged 20 commits intoSylius:2.0from
Rafikooo:SYL-4572/shipping
Apr 9, 2025
Merged

[Behat] Reuse common setup contexts in API and UI (in shipping order and related scenarios)#17816
GSadee merged 20 commits intoSylius:2.0from
Rafikooo:SYL-4572/shipping

Conversation

@Rafikooo
Copy link
Copy Markdown
Contributor

Q A
Branch? 2.0
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
License MIT

Continuation of:

Until now, the checkout-related scenarios have been set up as follows:
• UI – via web actions (e.g. Given I have a product ... actually triggered browser actions to prepare the initial step),
• API – a mix of messenger commands and API calls.

During the development of Sylius 2.0, with the introduction of dynamic components, all scenarios involving product-related actions had to be marked as JS to work correctly. This significantly increased build time and reduced overall stability.

This PR focuses on decoupling the Behat architecture to unify the test setup for both UI and API. The goal is to eliminate most JS tags, which should lead to greater stability. Some performance improvements are already noticeable.

This PR doesn’t yet include all refactored scenarios, but at this stage we already observe the following performance gains:
• For non-JS scenarios, the timing is likely similar — some JS scenarios have been converted to non-JS, but at the same time, we benefit from faster setup thanks to the refactor (using messenger commands instead of API calls or UI interactions to prepare tests).
• For JS scenarios executed via Chromedriver, the same applies — some Panther scenarios have been switched to Chromedriver, and performance remains comparable.

JS with Panther: ~30 min → ~20 min

@Rafikooo Rafikooo requested review from a team as code owners March 31, 2025 14:58
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 31, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 31, 2025

❌ Preview Environment deleted from Bunnyshell

Available commands:

  • 🚀 /bns:deploy to redeploy the environment

@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch 9 times, most recently from b0d6920 to 5feabf1 Compare April 7, 2025 12:03
@Rafikooo Rafikooo changed the title [WIP][Behat] Decouple cart setup from interaction – Given I added vs When I add - Shipping [Behat] Decouple cart setup from interaction – Given I added vs When I add - Shipping Apr 7, 2025
@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch from 5feabf1 to de5f8f9 Compare April 7, 2025 12:19
@Rafikooo Rafikooo changed the title [Behat] Decouple cart setup from interaction – Given I added vs When I add - Shipping [Behat] Refactor shipping order and other scenarios to reuse common setup contexts for both API and UI Apr 7, 2025
@Rafikooo Rafikooo changed the title [Behat] Refactor shipping order and other scenarios to reuse common setup contexts for both API and UI [Behat] Reuse common setup contexts in API and UI (in shipping order and related scenarios) Apr 7, 2025
@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch from de5f8f9 to 47c2f40 Compare April 7, 2025 21:45
@GSadee GSadee added the Behat Issues and PRs aimed at improving Behat usage. label Apr 8, 2025
@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch from 47c2f40 to bd565a6 Compare April 8, 2025 05:20
Scenario: Seeing payment state as paid on orders list
When I browse orders
Then the order "#00000666" should have order payment state "Paid"
Then the last order should have order payment state "Paid"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why? It could have stayed as it was 🤔

Copy link
Copy Markdown
Contributor Author

@Rafikooo Rafikooo Apr 8, 2025

Choose a reason for hiding this comment

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

It’s because of this unusual setup where we first place the order and only afterward add the product and address it. That’s why I decided to simplify it. Also, as a customer, we can’t choose the order number ourselves, so in such a scenario it should be something like #00000001 (which matches the last order) rather than #00000666. wdyt?”

@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch from 4ca2fc5 to 22f50a1 Compare April 8, 2025 10:23
@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch 3 times, most recently from 1e78ba7 to 960ff97 Compare April 8, 2025 12:10
@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch 3 times, most recently from 2e456cf to 0548159 Compare April 8, 2025 13:27
@Rafikooo Rafikooo force-pushed the SYL-4572/shipping branch from 0548159 to e9bc43c Compare April 8, 2025 13:38
Given the customer logged in
Given the customer added product "Stark T-Shirt" to the cart
When the customer checks the details of their cart
When I check the details of my cart
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
When I check the details of my cart

When the visitor specify the email as "jon.snow@example.com"
And the visitor specify the billing address as "Ankh Morpork", "Frost Alley", "90210", "United States" for "Jon Snow"
Given the visitor added product "Stark T-Shirt" to the cart
When the visitor specify the billing address
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
When the visitor specify the billing address
When the visitor specifies the billing address

And the visitor specify the billing address as "Ankh Morpork", "Frost Alley", "90210", "United States" for "Jon Snow"
Given the visitor added product "Stark T-Shirt" to the cart
When the visitor specify the billing address
And the visitor specify the email as "guest@example.com"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
And the visitor specify the email as "guest@example.com"
And the visitor specifies the email as "guest@example.com"

Comment on lines +30 to +31
When the visitor specify the email as "guest@example.com"
And the visitor specify the billing address
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

As above

@GSadee GSadee merged commit 61de194 into Sylius:2.0 Apr 9, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Behat Issues and PRs aimed at improving Behat usage.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants