Skip to content

Commit 928912e

Browse files
n7studiosn7studios
authored
Merge pull request #825 from Kit/tests-use-named-arguments
Tests: Use Named Arguments
2 parents 36c89e1 + 755dd98 commit 928912e

54 files changed

Lines changed: 2601 additions & 1219 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/coding-standards.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ jobs:
120120
# Run Coding Standards on Tests.
121121
- name: Run Coding Standards on Tests
122122
working-directory: ${{ env.PLUGIN_DIR }}
123+
if: ${{ matrix.php-versions == '8.1' || matrix.php-versions == '8.2' || matrix.php-versions == '8.3' || matrix.php-versions == '8.4' }}
123124
run: php vendor/bin/phpcs -q --standard=phpcs.tests.xml --report=checkstyle ./tests | cs2pr
124125

125126
# Run WordPress Coding Standards on Plugin.

‎tests/EndToEnd/broadcasts/blocks-shortcodes/PageBlockBroadcastsCest.php‎

Lines changed: 113 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,22 @@ public function _before(EndToEndTester $I)
3535
public function testBroadcastsBlockWhenNoCredentials(EndToEndTester $I)
3636
{
3737
// Add a Page using the Gutenberg editor.
38-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Block: No Credentials');
38+
$I->addGutenbergPage(
39+
$I,
40+
title: 'Kit: Page: Broadcasts: Block: No Credentials'
41+
);
3942

4043
// Add block to Page.
41-
$I->addGutenbergBlock($I, 'Kit Broadcasts', 'convertkit-broadcasts');
44+
$I->addGutenbergBlock(
45+
$I,
46+
blockName: 'Kit Broadcasts',
47+
blockProgrammaticName: 'convertkit-broadcasts'
48+
);
4249

4350
// Test that the popup window works.
4451
$I->testBlockNoCredentialsPopupWindow(
4552
$I,
46-
'convertkit-broadcasts'
53+
blockName: 'convertkit-broadcasts'
4754
);
4855

4956
// Publish and view the Page on the frontend site.
@@ -72,13 +79,23 @@ public function testBroadcastsBlockWithNoBroadcasts(EndToEndTester $I)
7279
$I->setupKitPluginResourcesNoData($I);
7380

7481
// Add a Page using the Gutenberg editor.
75-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: No Broadcasts');
82+
$I->addGutenbergPage(
83+
$I,
84+
title: 'Kit: Page: Broadcasts: No Broadcasts'
85+
);
7686

7787
// Add block to Page.
78-
$I->addGutenbergBlock($I, 'Kit Broadcasts', 'convertkit-broadcasts');
88+
$I->addGutenbergBlock(
89+
$I,
90+
blockName: 'Kit Broadcasts',
91+
blockProgrammaticName: 'convertkit-broadcasts'
92+
);
7993

8094
// Confirm that the Broadcasts block displays instructions to the user on how to add a Broadcast in Kit.
81-
$I->seeBlockHasNoContentMessage($I, 'No broadcasts exist in Kit.');
95+
$I->seeBlockHasNoContentMessage(
96+
$I,
97+
message: 'No broadcasts exist in Kit.'
98+
);
8299

83100
// Click the link to confirm it loads Kit.
84101
$I->clickLinkInBlockAndAssertKitLoginScreen($I, 'Click here to send your first broadcast.');
@@ -104,10 +121,17 @@ public function testBroadcastsBlockRefreshButton(EndToEndTester $I)
104121
$I->setupKitPluginResourcesNoData($I);
105122

106123
// Add a Page using the Gutenberg editor.
107-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Refresh Button');
124+
$I->addGutenbergPage(
125+
$I,
126+
title: 'Kit: Page: Broadcasts: Refresh Button'
127+
);
108128

109129
// Add block to Page.
110-
$I->addGutenbergBlock($I, 'Kit Broadcasts', 'convertkit-broadcasts');
130+
$I->addGutenbergBlock(
131+
$I,
132+
blockName: 'Kit Broadcasts',
133+
blockProgrammaticName: 'convertkit-broadcasts'
134+
);
111135

112136
// Setup Plugin with a valid API Key and resources, as if the user performed the necessary steps to authenticate
113137
// and created a broadcast.
@@ -143,10 +167,17 @@ public function testBroadcastsBlockWithDefaultParameters(EndToEndTester $I)
143167
$I->setupKitPluginResources($I);
144168

145169
// Add a Page using the Gutenberg editor.
146-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Default Params');
170+
$I->addGutenbergPage(
171+
$I,
172+
title: 'Kit: Page: Broadcasts: Default Params'
173+
);
147174

148175
// Add block to Page.
149-
$I->addGutenbergBlock($I, 'Kit Broadcasts', 'convertkit-broadcasts');
176+
$I->addGutenbergBlock(
177+
$I,
178+
blockName: 'Kit Broadcasts',
179+
blockProgrammaticName: 'convertkit-broadcasts'
180+
);
150181

151182
// Publish and view the Page on the frontend site.
152183
$I->publishAndViewGutenbergPage($I);
@@ -183,14 +214,17 @@ public function testBroadcastsBlockWithDisplayGridParameter(EndToEndTester $I)
183214
$I->setupKitPluginResources($I);
184215

185216
// Add a Page using the Gutenberg editor.
186-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Display as Grid');
217+
$I->addGutenbergPage(
218+
$I,
219+
title: 'Kit: Page: Broadcasts: Display as Grid'
220+
);
187221

188222
// Add block to Page, setting the date format.
189223
$I->addGutenbergBlock(
190224
$I,
191-
'Kit Broadcasts',
192-
'convertkit-broadcasts',
193-
[
225+
blockName: 'Kit Broadcasts',
226+
blockProgrammaticName: 'convertkit-broadcasts',
227+
blockConfiguration: [
194228
'#inspector-toggle-control-0' => [ 'toggle', true ],
195229
]
196230
);
@@ -222,14 +256,17 @@ public function testBroadcastsBlockWithDateFormatParameter(EndToEndTester $I)
222256
$I->setupKitPluginResources($I);
223257

224258
// Add a Page using the Gutenberg editor.
225-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Date Format Param');
259+
$I->addGutenbergPage(
260+
$I,
261+
title: 'Kit: Page: Broadcasts: Date Format Param'
262+
);
226263

227264
// Add block to Page, setting the date format.
228265
$I->addGutenbergBlock(
229266
$I,
230-
'Kit Broadcasts',
231-
'convertkit-broadcasts',
232-
[
267+
blockName: 'Kit Broadcasts',
268+
blockProgrammaticName: 'convertkit-broadcasts',
269+
blockConfiguration: [
233270
'date_format' => [ 'select', 'Y-m-d' ],
234271
]
235272
);
@@ -269,14 +306,17 @@ public function testBroadcastsBlockWithDisplayImageParameter(EndToEndTester $I)
269306
$I->setupKitPluginResources($I);
270307

271308
// Add a Page using the Gutenberg editor.
272-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Display image');
309+
$I->addGutenbergPage(
310+
$I,
311+
title: 'Kit: Page: Broadcasts: Display image'
312+
);
273313

274314
// Add block to Page, setting the date format.
275315
$I->addGutenbergBlock(
276316
$I,
277-
'Kit Broadcasts',
278-
'convertkit-broadcasts',
279-
[
317+
blockName: 'Kit Broadcasts',
318+
blockProgrammaticName: 'convertkit-broadcasts',
319+
blockConfiguration: [
280320
'#inspector-toggle-control-0' => [ 'toggle', true ],
281321
'#inspector-toggle-control-1' => [ 'toggle', true ],
282322
]
@@ -310,14 +350,17 @@ public function testBroadcastsBlockWithDisplayDescriptionParameter(EndToEndTeste
310350
$I->setupKitPluginResources($I);
311351

312352
// Add a Page using the Gutenberg editor.
313-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Display description');
353+
$I->addGutenbergPage(
354+
$I,
355+
title: 'Kit: Page: Broadcasts: Display description'
356+
);
314357

315358
// Add block to Page, setting the date format.
316359
$I->addGutenbergBlock(
317360
$I,
318-
'Kit Broadcasts',
319-
'convertkit-broadcasts',
320-
[
361+
blockName: 'Kit Broadcasts',
362+
blockProgrammaticName: 'convertkit-broadcasts',
363+
blockConfiguration: [
321364
'#inspector-toggle-control-2' => [ 'toggle', true ],
322365
]
323366
);
@@ -349,14 +392,17 @@ public function testBroadcastsBlockWithDisplayReadMoreLinkParameter(EndToEndTest
349392
$I->setupKitPluginResources($I);
350393

351394
// Add a Page using the Gutenberg editor.
352-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Display read more link');
395+
$I->addGutenbergPage(
396+
$I,
397+
title: 'Kit: Page: Broadcasts: Display read more link'
398+
);
353399

354400
// Add block to Page, setting the date format.
355401
$I->addGutenbergBlock(
356402
$I,
357-
'Kit Broadcasts',
358-
'convertkit-broadcasts',
359-
[
403+
blockName: 'Kit Broadcasts',
404+
blockProgrammaticName: 'convertkit-broadcasts',
405+
blockConfiguration: [
360406
'#inspector-toggle-control-3' => [ 'toggle', true ],
361407
'read_more_label' => [ 'input', 'Continue reading' ],
362408
]
@@ -389,14 +435,17 @@ public function testBroadcastsBlockWithLimitParameter(EndToEndTester $I)
389435
$I->setupKitPluginResources($I);
390436

391437
// Add a Page using the Gutenberg editor.
392-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Limit Param');
438+
$I->addGutenbergPage(
439+
$I,
440+
title: 'Kit: Page: Broadcasts: Limit Param'
441+
);
393442

394443
// Add block to Page, setting the limit.
395444
$I->addGutenbergBlock(
396445
$I,
397-
'Kit Broadcasts',
398-
'convertkit-broadcasts',
399-
[
446+
blockName: 'Kit Broadcasts',
447+
blockProgrammaticName: 'convertkit-broadcasts',
448+
blockConfiguration: [
400449
'limit' => [ 'input', '2', 'Pagination' ], // Click the Pagination tab first before starting to complete fields.
401450
]
402451
);
@@ -433,10 +482,17 @@ public function testBroadcastsBlockWithBlankLimitParameter(EndToEndTester $I)
433482
$I->setupKitPluginResources($I);
434483

435484
// Add a Page using the Gutenberg editor.
436-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Blank Limit Param');
485+
$I->addGutenbergPage(
486+
$I,
487+
title: 'Kit: Page: Broadcasts: Blank Limit Param'
488+
);
437489

438490
// Add block to Page.
439-
$I->addGutenbergBlock($I, 'Kit Broadcasts', 'convertkit-broadcasts');
491+
$I->addGutenbergBlock(
492+
$I,
493+
blockName: 'Kit Broadcasts',
494+
blockProgrammaticName: 'convertkit-broadcasts'
495+
);
440496

441497
// When the sidebar appears, blank the limit parameter as the user might, by pressing the backspace key twice.
442498
$I->waitForElementVisible('.interface-interface-skeleton__sidebar[aria-label="Editor settings"]');
@@ -479,14 +535,17 @@ public function testBroadcastsBlockWithPaginationEnabled(EndToEndTester $I)
479535
$I->setupKitPluginResources($I);
480536

481537
// Add a Page using the Gutenberg editor.
482-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Pagination');
538+
$I->addGutenbergPage(
539+
$I,
540+
title: 'Kit: Page: Broadcasts: Pagination'
541+
);
483542

484543
// Add block to Page, setting the limit.
485544
$I->addGutenbergBlock(
486545
$I,
487-
'Kit Broadcasts',
488-
'convertkit-broadcasts',
489-
[
546+
blockName: 'Kit Broadcasts',
547+
blockProgrammaticName: 'convertkit-broadcasts',
548+
blockConfiguration: [
490549
'limit' => [ 'input', '2', 'Pagination' ], // Click the Pagination tab first before starting to complete fields.
491550
'#inspector-toggle-control-4' => [ 'toggle', true ],
492551
]
@@ -513,14 +572,17 @@ public function testBroadcastsBlockWithPaginationLabelParameters(EndToEndTester
513572
$I->setupKitPluginResources($I);
514573

515574
// Add a Page using the Gutenberg editor.
516-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Pagination Labels');
575+
$I->addGutenbergPage(
576+
$I,
577+
title: 'Kit: Page: Broadcasts: Pagination Labels'
578+
);
517579

518580
// Add block to Page, setting the limit.
519581
$I->addGutenbergBlock(
520582
$I,
521-
'Kit Broadcasts',
522-
'convertkit-broadcasts',
523-
[
583+
blockName: 'Kit Broadcasts',
584+
blockProgrammaticName: 'convertkit-broadcasts',
585+
blockConfiguration: [
524586
'limit' => [ 'input', '2', 'Pagination' ], // Click the Pagination tab first before starting to complete fields.
525587
'#inspector-toggle-control-4' => [ 'toggle', true ],
526588
'paginate_label_prev' => [ 'input', 'Newer' ],
@@ -549,14 +611,17 @@ public function testBroadcastsBlockWithBlankPaginationLabelParameters(EndToEndTe
549611
$I->setupKitPluginResources($I);
550612

551613
// Add a Page using the Gutenberg editor.
552-
$I->addGutenbergPage($I, 'page', 'Kit: Page: Broadcasts: Blank Pagination Labels');
614+
$I->addGutenbergPage(
615+
$I,
616+
title: 'Kit: Page: Broadcasts: Blank Pagination Labels'
617+
);
553618

554619
// Add block to Page, setting the limit.
555620
$I->addGutenbergBlock(
556621
$I,
557-
'Kit Broadcasts',
558-
'convertkit-broadcasts',
559-
[
622+
blockName: 'Kit Broadcasts',
623+
blockProgrammaticName: 'convertkit-broadcasts',
624+
blockConfiguration: [
560625
'limit' => [ 'input', '2', 'Pagination' ], // Click the Pagination tab first before starting to complete fields.
561626
'#inspector-toggle-control-4' => [ 'toggle', true ],
562627
'paginate_label_prev' => [ 'input', '' ],

0 commit comments

Comments
 (0)