Skip to content

Commit 4f290d1

Browse files
howard-ehoward-e
authored
fix: Update instructions on running setup script (#1639)
* Clearly note instructions on running the setup script across review pages and TestRenderer * Revert aria-at branch to master
1 parent e358de4 commit 4f290d1

File tree

6 files changed

+98
-39
lines changed

6 files changed

+98
-39
lines changed

‎client/components/CandidateReview/CandidateTestPlanRun/InstructionsRenderer.jsx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ const InstructionsRenderer = ({
113113

114114
const defaultInstructions =
115115
renderableContent.target.at.raw.defaultConfigurationInstructionsHTML;
116-
const setupScriptDescription = `${supportJson.testPlanStrings.openExampleInstruction} ${renderableContent.target.setupScript.scriptDescription}`;
116+
const openExampleInstruction =
117+
supportJson.testPlanStrings.openExampleInstruction;
118+
const setupScriptDescription = `${supportJson.testPlanStrings.setupScriptDescriptionPreface} ${renderableContent.target.setupScript.scriptDescription}`;
117119
const testInstructions = renderableContent.instructions.instructions;
118120
const settingsInstructions = `${
119121
supportJson.testPlanStrings.commandListPreface
@@ -125,6 +127,7 @@ const InstructionsRenderer = ({
125127

126128
allInstructions = [
127129
defaultInstructions,
130+
openExampleInstruction,
128131
setupScriptDescription + '.',
129132
testInstructions + ' ' + settingsInstructions
130133
].map(e => unescape(e));

‎client/components/TestRenderer/index.jsx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,9 @@ const TestRenderer = ({
341341

342342
const defaultInstructions =
343343
renderableContent.target.at.raw.defaultConfigurationInstructionsHTML;
344-
const setupScriptDescription = `${supportJson.testPlanStrings.openExampleInstruction} ${renderableContent.target.setupScript.scriptDescription}`;
344+
const openExampleInstruction =
345+
supportJson.testPlanStrings.openExampleInstruction;
346+
const setupScriptDescription = `${supportJson.testPlanStrings.setupScriptDescriptionPreface} ${renderableContent.target.setupScript.scriptDescription}`;
345347
const testInstructions = renderableContent.instructions.instructions;
346348
const settingsInstructions = `${
347349
supportJson.testPlanStrings.commandListPreface
@@ -353,6 +355,7 @@ const TestRenderer = ({
353355

354356
allInstructions = [
355357
defaultInstructions,
358+
openExampleInstruction,
356359
setupScriptDescription + '.',
357360
testInstructions + ' ' + settingsInstructions
358361
].map(e => unescape(e));

‎client/tests/e2e/snapshots/saved/_candidate-test-plan_24_1.html‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -633,9 +633,13 @@ <h1 class="disclosure-heading">
633633
</li>
634634
<li>
635635
Activate the "Open test page" button, which
636-
opens the example to test in a new window
637-
and runs a script that sets focus on the
638-
'Add Delivery Address' button
636+
opens the example to test in a new window.
637+
</li>
638+
<li>
639+
In the window that displays the example to
640+
test, activate the "Run Setup" button, which
641+
sets focus on the 'Add Delivery Address'
642+
button
639643
</li>
640644
<li>
641645
With the reading cursor on the 'Add Delivery

‎client/tests/e2e/snapshots/saved/_test-plan-report_1.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -591,9 +591,12 @@ <h2>Test cannot be performed due to error(s)</h2>
591591
</li>
592592
<li>
593593
Activate the "Open test page" button, which
594-
opens the example to test in a new window and
595-
runs a script that sets focus on a link before
596-
the button
594+
opens the example to test in a new window.
595+
</li>
596+
<li>
597+
In the window that displays the example to test,
598+
activate the "Run Setup" button, which sets
599+
focus on a link before the button
597600
</li>
598601
<li>
599602
With the reading cursor on the 'Navigate

‎client/tests/e2e/snapshots/saved/_test-review_8.html‎

Lines changed: 75 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -406,8 +406,11 @@ <h5>Instructions</h5>
406406
</li>
407407
<li>
408408
Activate the "Open test page" button, which opens the example to
409-
test in a new window and runs a script that sets focus on a link
410-
before the button
409+
test in a new window.
410+
</li>
411+
<li>
412+
In the window that displays the example to test, activate the
413+
"Run Setup" button, which sets focus on a link before the button
411414
</li>
412415
<li>
413416
With the reading cursor on the 'Navigate forwards from here'
@@ -542,8 +545,11 @@ <h5>Instructions</h5>
542545
</li>
543546
<li>
544547
Activate the "Open test page" button, which opens the example to
545-
test in a new window and runs a script that sets focus on a link
546-
before the button
548+
test in a new window.
549+
</li>
550+
<li>
551+
In the window that displays the example to test, activate the
552+
"Run Setup" button, which sets focus on a link before the button
547553
</li>
548554
<li>
549555
With the reading cursor on the 'Navigate forwards from here'
@@ -691,8 +697,11 @@ <h5>Instructions</h5>
691697
</li>
692698
<li>
693699
Activate the "Open test page" button, which opens the example to
694-
test in a new window and runs a script that sets focus on a link
695-
after the button
700+
test in a new window.
701+
</li>
702+
<li>
703+
In the window that displays the example to test, activate the
704+
"Run Setup" button, which sets focus on a link after the button
696705
</li>
697706
<li>
698707
With the reading cursor on the 'Navigate backwards from here'
@@ -827,8 +836,11 @@ <h5>Instructions</h5>
827836
</li>
828837
<li>
829838
Activate the "Open test page" button, which opens the example to
830-
test in a new window and runs a script that sets focus on a link
831-
after the button
839+
test in a new window.
840+
</li>
841+
<li>
842+
In the window that displays the example to test, activate the
843+
"Run Setup" button, which sets focus on a link after the button
832844
</li>
833845
<li>
834846
With the reading cursor on the 'Navigate backwards from here'
@@ -976,8 +988,11 @@ <h5>Instructions</h5>
976988
</li>
977989
<li>
978990
Activate the "Open test page" button, which opens the example to
979-
test in a new window and runs a script that sets focus on a link
980-
before the button
991+
test in a new window.
992+
</li>
993+
<li>
994+
In the window that displays the example to test, activate the
995+
"Run Setup" button, which sets focus on a link before the button
981996
</li>
982997
<li>
983998
With focus on the 'navigate forwards from here' link, navigate
@@ -1034,8 +1049,11 @@ <h5>Instructions</h5>
10341049
</li>
10351050
<li>
10361051
Activate the "Open test page" button, which opens the example to
1037-
test in a new window and runs a script that sets focus on a link
1038-
before the button
1052+
test in a new window.
1053+
</li>
1054+
<li>
1055+
In the window that displays the example to test, activate the
1056+
"Run Setup" button, which sets focus on a link before the button
10391057
</li>
10401058
<li>
10411059
With focus on the 'navigate forwards from here' link, navigate
@@ -1105,8 +1123,11 @@ <h5>Instructions</h5>
11051123
</li>
11061124
<li>
11071125
Activate the "Open test page" button, which opens the example to
1108-
test in a new window and runs a script that sets focus on a link
1109-
after the button
1126+
test in a new window.
1127+
</li>
1128+
<li>
1129+
In the window that displays the example to test, activate the
1130+
"Run Setup" button, which sets focus on a link after the button
11101131
</li>
11111132
<li>
11121133
With focus on the 'Navigate backwards from here' link, navigate
@@ -1163,8 +1184,11 @@ <h5>Instructions</h5>
11631184
</li>
11641185
<li>
11651186
Activate the "Open test page" button, which opens the example to
1166-
test in a new window and runs a script that sets focus on a link
1167-
after the button
1187+
test in a new window.
1188+
</li>
1189+
<li>
1190+
In the window that displays the example to test, activate the
1191+
"Run Setup" button, which sets focus on a link after the button
11681192
</li>
11691193
<li>
11701194
With focus on the 'Navigate backwards from here' link, navigate
@@ -1235,8 +1259,11 @@ <h5>Instructions</h5>
12351259
</li>
12361260
<li>
12371261
Activate the "Open test page" button, which opens the example to
1238-
test in a new window and runs a script that sets focus on a link
1239-
before the button
1262+
test in a new window.
1263+
</li>
1264+
<li>
1265+
In the window that displays the example to test, activate the
1266+
"Run Setup" button, which sets focus on a link before the button
12401267
</li>
12411268
<li>
12421269
With focus on the 'Navigate forwards from here' link, navigate
@@ -1359,8 +1386,11 @@ <h5>Instructions</h5>
13591386
</li>
13601387
<li>
13611388
Activate the "Open test page" button, which opens the example to
1362-
test in a new window and runs a script that sets focus on a link
1363-
after the button
1389+
test in a new window.
1390+
</li>
1391+
<li>
1392+
In the window that displays the example to test, activate the
1393+
"Run Setup" button, which sets focus on a link after the button
13641394
</li>
13651395
<li>
13661396
With focus on the 'Navigate backwards from here' link, navigate
@@ -1482,8 +1512,11 @@ <h5>Instructions</h5>
14821512
</li>
14831513
<li>
14841514
Activate the "Open test page" button, which opens the example to
1485-
test in a new window and runs a script that sets focus on the
1486-
button
1515+
test in a new window.
1516+
</li>
1517+
<li>
1518+
In the window that displays the example to test, activate the
1519+
"Run Setup" button, which sets focus on the button
14871520
</li>
14881521
<li>
14891522
With the reading cursor on the 'Print Page' button, read
@@ -1566,8 +1599,11 @@ <h5>Instructions</h5>
15661599
</li>
15671600
<li>
15681601
Activate the "Open test page" button, which opens the example to
1569-
test in a new window and runs a script that sets focus on the
1570-
button
1602+
test in a new window.
1603+
</li>
1604+
<li>
1605+
In the window that displays the example to test, activate the
1606+
"Run Setup" button, which sets focus on the button
15711607
</li>
15721608
<li>
15731609
With the reading cursor on the 'Print Page' button, read
@@ -1663,8 +1699,11 @@ <h5>Instructions</h5>
16631699
</li>
16641700
<li>
16651701
Activate the "Open test page" button, which opens the example to
1666-
test in a new window and runs a script that sets focus on the
1667-
button
1702+
test in a new window.
1703+
</li>
1704+
<li>
1705+
In the window that displays the example to test, activate the
1706+
"Run Setup" button, which sets focus on the button
16681707
</li>
16691708
<li>
16701709
With focus on the 'Print Page' button, read information about
@@ -1747,8 +1786,11 @@ <h5>Instructions</h5>
17471786
</li>
17481787
<li>
17491788
Activate the "Open test page" button, which opens the example to
1750-
test in a new window and runs a script that sets focus on the
1751-
button
1789+
test in a new window.
1790+
</li>
1791+
<li>
1792+
In the window that displays the example to test, activate the
1793+
"Run Setup" button, which sets focus on the button
17521794
</li>
17531795
<li>
17541796
With focus on the 'Print Page' button, read information about
@@ -1845,8 +1887,11 @@ <h5>Instructions</h5>
18451887
</li>
18461888
<li>
18471889
Activate the "Open test page" button, which opens the example to
1848-
test in a new window and runs a script that sets focus on the
1849-
button
1890+
test in a new window.
1891+
</li>
1892+
<li>
1893+
In the window that displays the example to test, activate the
1894+
"Run Setup" button, which sets focus on the button
18501895
</li>
18511896
<li>
18521897
With focus on the 'Print Page' button, read information about

‎server/resources/support.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@
117117
},
118118
"testPlanStrings": {
119119
"ariaSpecsPreface": "Tested ARIA features:",
120-
"openExampleInstruction": "Activate the &quot;Open test page&quot; button, which opens the example to test in a new window and runs a script that",
120+
"openExampleInstruction": "Activate the &quot;Open test page&quot; button, which opens the example to test in a new window.",
121+
"setupScriptDescriptionPreface": "In the window that displays the example to test, activate the &quot;Run Setup&quot; button, which",
121122
"commandListPreface": "Do this with each of the following commands or command sequences.",
122123
"commandListSettingsPreface": "If any settings are specified in parentheses, ensure the settings are active before executing the command or command sequence.",
123124
"settingInstructionsPreface": "To perform a task with",

0 commit comments

Comments
 (0)