Skip to content

Expect download method wrap#304

Merged
mshriver merged 1 commit into
RedHatQE:mainfrom
digitronik:download_info
May 13, 2026
Merged

Expect download method wrap#304
mshriver merged 1 commit into
RedHatQE:mainfrom
digitronik:download_info

Conversation

@digitronik
Copy link
Copy Markdown
Member

@digitronik digitronik commented May 11, 2026

It will help in download related testing.

Summary by Sourcery

Add a browser-level wrapper for Playwright's expect_download context manager and cover it with tests.

New Features:

  • Introduce a Browser.expect_download context manager to wait for file downloads initiated by page actions.

Tests:

  • Add tests verifying expect_download captures downloads and supports an optional predicate for matching specific files.

@digitronik digitronik self-assigned this May 11, 2026
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 11, 2026

Reviewer's Guide

Adds a Browser.expect_download context manager that wraps Playwright’s page.expect_download and introduces tests covering basic download capture and predicate-based filtering.

Sequence diagram for the new Browser.expect_download context manager

sequenceDiagram
    actor Test
    participant Browser
    participant Page
    participant Download

    Test->>Browser: expect_download(predicate, timeout)
    Browser->>Browser: log expect_download(timeout)
    Browser->>Page: expect_download(predicate, timeout)
    activate Page
    Note over Test,Page: with block body triggers download action
    Page-->>Download: create Download
    Page-->>Browser: download context manager
    deactivate Page
    Browser-->>Test: context manager

    Note over Test,Browser: after with block, download_info.value is Download

    Test->>Download: access suggested_filename/save_as()
Loading

Updated class diagram for Browser with expect_download

classDiagram
    class Browser {
        Page page
        Logger logger
        +expect_response(url_or_predicate, timeout int)
        +expect_download(predicate, timeout int)
    }

    class Page {
        +expect_response(url_or_predicate, timeout int)
        +expect_download(predicate, timeout int)
    }

    class Download {
        +suggested_filename str
        +save_as(path str)
    }

    Browser --> Page : uses
    Page --> Download : creates
    Browser ..> Download : returns_via_context_manager
Loading

File-Level Changes

Change Details Files
Introduce expect_download context manager on Browser that proxies to Playwright’s expect_download with logging and optional predicate support.
  • Add expect_download method accepting optional predicate and timeout parameters.
  • Log the timeout value before delegating to the underlying page.expect_download.
  • Build kwargs dynamically to include predicate only when provided and return the underlying context manager.
src/widgetastic/browser.py
Add automated tests validating expect_download behavior for generic and predicate-filtered downloads.
  • Create a test that triggers a JavaScript-initiated download and asserts suggested_filename is captured via expect_download.
  • Create a test that supplies a predicate filtering downloads by filename extension and verifies the matched download’s suggested_filename.
testing/test_browser.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.72%. Comparing base (9959ddf) to head (8594ec8).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #304      +/-   ##
==========================================
- Coverage   92.82%   92.72%   -0.10%     
==========================================
  Files          19       19              
  Lines        2744     2750       +6     
==========================================
+ Hits         2547     2550       +3     
- Misses        197      200       +3     
Flag Coverage Δ
unittests 92.72% <100.00%> (-0.10%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mshriver mshriver merged commit e652099 into RedHatQE:main May 13, 2026
29 of 35 checks passed
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