Skip to content

Remove unit tests for linking code between reportFontAttributes and fontAttributeReporting#17035

Merged
seanbudd merged 1 commit intomasterfrom
i16802
Aug 27, 2024
Merged

Remove unit tests for linking code between reportFontAttributes and fontAttributeReporting#17035
seanbudd merged 1 commit intomasterfrom
i16802

Conversation

@SaschaCowley
Copy link
Copy Markdown
Member

@SaschaCowley SaschaCowley commented Aug 21, 2024 •
edited by coderabbitai bot
Loading

Link to issue number:

Partial fix for #16802

Summary of the issue:

#16748 introduced new behaviour whereby NVDA can be configured to report font attributes in speech, braille, both or not at all. This required the implementation of a new configuration key, documentFormatting.fontAttributeReporting. To avoid a breaking change to the API, aliasing code was introduced to ensure that the new key and its deprecated counterpart were kept in sync. When the API version is updated, these tests will fail as this code will no-longer run. Therefore, these tests need to be removed.

Description of user facing changes

None.

Description of development approach

Deleted tests.unit.test_config.Config_getitem_alias.

Testing strategy:

Ran unit tests to ensure they all ran, and verified that the total number of tests only reduced by 6 (as a sanity check that I hadn't accidentally deleted too much).

Known issues with pull request:

#16802 calls for the complete removal of the linking code, however this has not been done in this PR.

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • Bug Fixes
    • Removed outdated test class that could lead to gaps in testing coverage for configuration management functionality.
  • Chores
    • Adjusted testing strategy related to font attributes to enhance overall test integrity.

@SaschaCowley SaschaCowley requested a review from a team as a code owner August 21, 2024 06:07
@SaschaCowley SaschaCowley requested a review from seanbudd August 21, 2024 06:07
@SaschaCowley SaschaCowley linked an issue Aug 21, 2024 that may be closed by this pull request
Remove linking code between config.conf['documentFormatting']['reportFontAttributes'] and config.conf['documentFormatting']['fontAttributeReporting'] #16802
Closed
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 21, 2024 •
edited
Loading

Walkthrough

The recent changes involve the removal of the Config_getitem_alias test class from the tests/unit/test_config.py file. This class was responsible for a series of unit tests that validated the behavior of font attribute properties in a configuration object. Its removal signifies a shift in testing strategy, potentially impacting the coverage of critical functionality related to configuration management.

Changes

Files Change Summary
tests/unit/test_config.py Removed the Config_getitem_alias test class, which included multiple unit tests for reportFontAttributes and fontAttributeReporting properties, affecting test coverage for these functionalities.

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>.
    • 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.

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.

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Aug 27, 2024
@seanbudd seanbudd added this to the 2024.4 milestone Aug 27, 2024
@seanbudd seanbudd changed the base branch from master to beta August 27, 2024 03:05
@seanbudd seanbudd modified the milestones: 2024.4, 2025.1 Aug 27, 2024
@seanbudd seanbudd changed the base branch from beta to master August 27, 2024 03:05
@seanbudd seanbudd merged commit 248e023 into master Aug 27, 2024
@seanbudd seanbudd deleted the i16802 branch August 27, 2024 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seanbudd seanbudd seanbudd approved these changes

Assignees

No one assigned

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Milestone

2025.1

Development

Successfully merging this pull request may close these issues.

Remove linking code between config.conf['documentFormatting']['reportFontAttributes'] and config.conf['documentFormatting']['fontAttributeReporting']

2 participants

@SaschaCowley @seanbudd