Refactor test design to allow commands.json file in each pattern directory #73

spectranaut · 2020-02-22T01:51:45Z

From now on, we will simply add a commands.json file with the tasks/mode/assistive technology to command list data structure.

evmiguel · 2020-02-24T17:56:28Z

tests/menubar-editor/commands.json

@@ -0,0 +1 @@
+{"navigate to menuitemcheckbox in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["DOWN"]]}}, "close submenu of menubar using reading mode": {"reading": {"jaws": [["ESC"]]}}, "open submenu of menubar using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["UP_AND_DOWN"]]}}, "read menu item in menubar using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read disabled menuitem in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "tab to menubar in reading mode": {"reading": {"jaws": [["TAB_AND_SHIFT_TAB"]]}}, "change state of menuitemcheckbox in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"]]}}, "navigate to menubar in reading mode": {"reading": {"jaws": [["UP_AND_DOWN"], ["F_AND_SHIFT_F"]]}}, "read menuitemcheckbox in a submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitemcheckbox in submenu using reading mode": {"reading": {"jaws": [["UP_AND_DOWN"]]}}, "change state of menuitemradio in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"]]}}, "close submenu of menubar using interaction mode": {"interaction": {"jaws": [["ESC"]]}}, "read disabled menuitem in a submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitem in menubar using interaction mode": {"interaction": {"jaws": [["TAB_AND_SHIFT_TAB"]]}}, "read menuitemradio in a group in submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read menuitemradio in a group in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read menuitemcheckbox in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "change state of menuitemcheckbox in submenu using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}, "read menu item in menubar using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitemradio in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["DOWN"]]}}, "navigate to menuitem in menubar using reading mode": {"reading": {"jaws": [["LEFT_AND_RIGHT", " (with Smart Navigation on)"]]}}, "change state of menuitemradio in submenu using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}, "navigate to menuitemradio in submenu using reading mode": {"reading": {"jaws": [["UP_AND_DOWN"]]}}, "open submenu of menubar using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}}


Can this file be edited so that it spans more than one line?

It could, but I did have the suggestion/thought from Mike that if it is printed like this then people might realize it is generated and not for manual editing.

It wasn't clear to me. Is there a way for us to note this difference?

very soon all of these files will be generated, so there won't be a need for the distinction!

evmiguel · 2020-02-24T19:46:10Z

tests/resources/aria-at-harness.mjs

+// Get the commands for this test file ("commands.json" in the same directory)
+// and initialize the commands API.
+var xobj = new XMLHttpRequest();
+xobj.overrideMimeType("application/json");


Is XMLHttpRequest used to explicitly invoke xobj.overrideMimeType?

evmiguel · 2020-02-24T20:54:55Z

tests/resources/at-commands.mjs

-  nvda: 'NVDA',
-  voiceover: 'VoiceOver'
-}
+export class commandsAPI {


Is the commandsAPI the pattern we are going to use in the production system?

Right now, this file is part of the test suite, it's for rendering the test files. So only indirectly, because the production system consumes the tests

In this case, can we use a more descriptive class name or have a JSDoc about what this class does? commandsAPI wasn't clear enough for me to understand until I saw it in use.

good point. There should be documentation. I'll add it right now!

evmiguel · 2020-02-24T21:10:39Z

tests/menubar-editor/commands.json

@@ -0,0 +1 @@
+{"navigate to menuitemcheckbox in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["DOWN"]]}}, "close submenu of menubar using reading mode": {"reading": {"jaws": [["ESC"]]}}, "open submenu of menubar using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["UP_AND_DOWN"]]}}, "read menu item in menubar using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read disabled menuitem in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "tab to menubar in reading mode": {"reading": {"jaws": [["TAB_AND_SHIFT_TAB"]]}}, "change state of menuitemcheckbox in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"]]}}, "navigate to menubar in reading mode": {"reading": {"jaws": [["UP_AND_DOWN"], ["F_AND_SHIFT_F"]]}}, "read menuitemcheckbox in a submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitemcheckbox in submenu using reading mode": {"reading": {"jaws": [["UP_AND_DOWN"]]}}, "change state of menuitemradio in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"]]}}, "close submenu of menubar using interaction mode": {"interaction": {"jaws": [["ESC"]]}}, "read disabled menuitem in a submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitem in menubar using interaction mode": {"interaction": {"jaws": [["TAB_AND_SHIFT_TAB"]]}}, "read menuitemradio in a group in submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read menuitemradio in a group in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read menuitemcheckbox in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "change state of menuitemcheckbox in submenu using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}, "read menu item in menubar using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitemradio in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["DOWN"]]}}, "navigate to menuitem in menubar using reading mode": {"reading": {"jaws": [["LEFT_AND_RIGHT", " (with Smart Navigation on)"]]}}, "change state of menuitemradio in submenu using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}, "navigate to menuitemradio in submenu using reading mode": {"reading": {"jaws": [["UP_AND_DOWN"]]}}, "open submenu of menubar using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}}


It wasn't clear to me. Is there a way for us to note this difference?

evmiguel · 2020-02-24T21:15:56Z

tests/resources/at-commands.mjs

-  nvda: 'NVDA',
-  voiceover: 'VoiceOver'
-}
+export class commandsAPI {


In this case, can we use a more descriptive class name or have a JSDoc about what this class does? commandsAPI wasn't clear enough for me to understand until I saw it in use.

evmiguel · 2020-02-24T21:39:59Z

After discussion with @spectranaut, in the future, the commands.json and test files will be generated. The official process of how these files get generated has yet to be solidified, but will be decided in the near future. For now, both generated and manually created commands.json will be committed to this repo.

spectranaut · 2020-02-24T22:06:17Z

tests/resources/at-commands.mjs

-}
+import * as keys from './keys.mjs';
+
+/** Class for getting AT-specific instructions for a test against a design pattern. */


I added comments @evmiguel thanks for that nudge

Valerie Young added 6 commits February 21, 2020 17:21

Remove unnecessary imports

eb0ab46

Refactor to expect commands.json file

c1d2a97

checkbox commands.json file

ea96c19

Update create-at-commands.py script to print JSON

ea6480c

Add commands.json for menubar-editor

a4a309e

Add commands.json for combobox

f1696bf

spectranaut mentioned this pull request Feb 22, 2020

Move AT task to commands mappings to design pattern folders #67

Closed

evmiguel requested changes Feb 24, 2020

View reviewed changes

evmiguel mentioned this pull request Feb 24, 2020

Reconsider format for commands.json and test files #75

Open

Add documentation

3e3c63e

spectranaut requested a review from evmiguel February 24, 2020 22:05

spectranaut commented Feb 24, 2020

View reviewed changes

spectranaut merged commit 515808d into master Feb 24, 2020

spectranaut deleted the at-commands-refactor branch March 9, 2020 22:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor test design to allow commands.json file in each pattern directory #73

Refactor test design to allow commands.json file in each pattern directory #73

spectranaut commented Feb 22, 2020

evmiguel Feb 24, 2020

spectranaut Feb 24, 2020

evmiguel Feb 24, 2020

spectranaut Feb 24, 2020

evmiguel Feb 24, 2020

evmiguel Feb 24, 2020

spectranaut Feb 24, 2020

evmiguel Feb 24, 2020

spectranaut Feb 24, 2020

evmiguel Feb 24, 2020

evmiguel Feb 24, 2020

evmiguel commented Feb 24, 2020

spectranaut Feb 24, 2020

		@@ -0,0 +1 @@
		{"navigate to menuitemcheckbox in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["DOWN"]]}}, "close submenu of menubar using reading mode": {"reading": {"jaws": [["ESC"]]}}, "open submenu of menubar using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["UP_AND_DOWN"]]}}, "read menu item in menubar using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read disabled menuitem in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "tab to menubar in reading mode": {"reading": {"jaws": [["TAB_AND_SHIFT_TAB"]]}}, "change state of menuitemcheckbox in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"]]}}, "navigate to menubar in reading mode": {"reading": {"jaws": [["UP_AND_DOWN"], ["F_AND_SHIFT_F"]]}}, "read menuitemcheckbox in a submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitemcheckbox in submenu using reading mode": {"reading": {"jaws": [["UP_AND_DOWN"]]}}, "change state of menuitemradio in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"]]}}, "close submenu of menubar using interaction mode": {"interaction": {"jaws": [["ESC"]]}}, "read disabled menuitem in a submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitem in menubar using interaction mode": {"interaction": {"jaws": [["TAB_AND_SHIFT_TAB"]]}}, "read menuitemradio in a group in submenu using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read menuitemradio in a group in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "read menuitemcheckbox in a submenu using interaction mode": {"interaction": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "change state of menuitemcheckbox in submenu using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}, "read menu item in menubar using reading mode": {"reading": {"jaws": [["INS_TAB"], ["INS_UP"]]}}, "navigate to menuitemradio in submenu using interaction mode": {"interaction": {"jaws": [["ENTER"], ["SPACE"], ["DOWN"]]}}, "navigate to menuitem in menubar using reading mode": {"reading": {"jaws": [["LEFT_AND_RIGHT", " (with Smart Navigation on)"]]}}, "change state of menuitemradio in submenu using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}, "navigate to menuitemradio in submenu using reading mode": {"reading": {"jaws": [["UP_AND_DOWN"]]}}, "open submenu of menubar using reading mode": {"reading": {"jaws": [["ENTER"], ["SPACE"]]}}}

Refactor test design to allow commands.json file in each pattern directory #73

Refactor test design to allow commands.json file in each pattern directory #73

Conversation

spectranaut commented Feb 22, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evmiguel commented Feb 24, 2020

Choose a reason for hiding this comment