Skip to content

Create tool for comparing GUI and UI elements in copies of NVDA#12308

Merged
seanbudd merged 5 commits intomasterfrom
addSettingsDiff
Apr 28, 2021
Merged

Create tool for comparing GUI and UI elements in copies of NVDA#12308
seanbudd merged 5 commits intomasterfrom
addSettingsDiff

Conversation

@seanbudd
Copy link
Copy Markdown
Member

@seanbudd seanbudd commented Apr 19, 2021

Link to issue number:

None

Summary of the issue:

GUI and UI features for NVDA can become lost through code refactors such as #12181. Generating screenshots and comparing text across copies of NVDA is an annoying process for developers.

Description of how this pull request fixes the issue:

A tool is created using our system tests to generate screenshots and text of all the content in NVDA settings. This can be expanded upon to include other GUI and UI features of NVDA.

See the README for usage.

Testing strategy:

None, adds a testing tool

Known issues with pull request:

Can be expanded to include more GUI/UI features.

Change log entry:

None, developer tool

Code Review Checklist:

  • Pull Request description is up to date.
  • Unit tests.
  • System (end to end) tests.
  • Manual tests.
  • User Documentation.
  • Change log entry.
  • Context sensitive help for GUI changes.

@seanbudd seanbudd changed the title Create tool for comparing GUI elements in copies of NVDA Create tool for comparing GUI and UI elements in copies of NVDA Apr 19, 2021
@seanbudd seanbudd self-assigned this Apr 19, 2021
@seanbudd seanbudd requested a review from a team as a code owner April 22, 2021 05:37
Copy link
Copy Markdown
Contributor

@feerrenrut feerrenrut left a comment

Choose a reason for hiding this comment

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

Let's go ahead with this. I wonder if this would be simpler not to have a particular version's output checked in, rather just require that a developer run this tool against multiple versions independently and manually diff the output.

I'm also a little worried that this will stop working if it is not being run regularly (eg via automated tests).

I don't think we need to do anything about these concerns now, lets just pay attention to how this goes.

@seanbudd
Copy link
Copy Markdown
Member Author

Let's go ahead with this. I wonder if this would be simpler not to have a particular version's output checked in, rather just require that a developer run this tool against multiple versions independently and manually diff the output.

I thought about this, at least now both workflows work. I would think if we were to do this automated, some version would have to be checked in though to save build times.

My thoughts of adding automated tests is to rename the folder "master", check in what master reads instead and then run the system test against that. That way we can track the changes to dialogs with PRs.

If we want to run this less regularly, we can just run the system test when the target of the PR is beta/release.

@seanbudd seanbudd merged commit e8c32e3 into master Apr 28, 2021
@seanbudd seanbudd deleted the addSettingsDiff branch April 28, 2021 06:30
@nvaccessAuto nvaccessAuto added this to the 2021.1 milestone Apr 28, 2021
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