Skip to content

Improve versatility of System Test Framework, introduce ensure_speech_did_not_occur#13877

Merged
seanbudd merged 4 commits into
masterfrom
improveWaitForSpeech
Jul 15, 2022
Merged

Improve versatility of System Test Framework, introduce ensure_speech_did_not_occur#13877
seanbudd merged 4 commits into
masterfrom
improveWaitForSpeech

Conversation

@seanbudd

@seanbudd seanbudd commented Jul 8, 2022

Copy link
Copy Markdown
Member

Link to issue number:

None

Summary of the issue:

While working on a separate PR, system tests were needed which changed the interval of checking speech, and to expect a failure.
This led to the contributor writing duplicate code to handle these cases, instead of improving the system test API.

That PR no longer requires this change, but the situation is generic enough to keep the API changes to make contributions easier in future.

Description of user facing changes

wait_for_specific_speech now accepts a parameter to change the checking interval.

A new function ensure_speech_did_not_occur has been introduced.

Description of development approach

N/A

Testing strategy:

Tested when working on #13550

Known issues with pull request:

N/A

Change log entries:

N/A

Code Review Checklist:

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

@seanbudd seanbudd requested a review from a team as a code owner July 8, 2022 02:39
@seanbudd seanbudd requested a review from feerrenrut July 8, 2022 02:39

@feerrenrut feerrenrut left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Rather than add a parameter, it might be better to add the corollary, I.E. ensure_not_spoken or similar. Mostly to make the tests easier to read, rather than having to invert the expectation.

What do you think? I'd also be ok with renaming wait_for_specific_speech if that helps.

@seanbudd seanbudd changed the title Improve versatility of System Test Framework wait_for_specific_speech Improve versatility of System Test Framework, introduce ensure_speech_did_not_occur Jul 12, 2022
@seanbudd

Copy link
Copy Markdown
Member Author

I've split the function into 2 now

@seanbudd seanbudd requested a review from feerrenrut July 12, 2022 02:47
Comment thread tests/system/libraries/SystemTestSpy/speechSpyGlobalPlugin.py
@seanbudd seanbudd requested a review from feerrenrut July 14, 2022 04:53
Comment thread tests/system/libraries/SystemTestSpy/speechSpyGlobalPlugin.py Outdated
@seanbudd seanbudd requested a review from feerrenrut July 15, 2022 02:10
@seanbudd seanbudd merged commit 7c08cf5 into master Jul 15, 2022
@seanbudd seanbudd deleted the improveWaitForSpeech branch July 15, 2022 22:57
@nvaccessAuto nvaccessAuto added this to the 2022.3 milestone Jul 15, 2022
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.

3 participants