Ensure patterns written to the filesystem in unit tests don't persist #185

kienstra · 2023-05-23T23:38:15Z

Summary of changes

At the end of each unit test, removes patterns written to the filesystem.

A follow-up to #183 (comment)

How do you know this PR does anything? These unit tests passed before this PR.

Fastest way:

git checkout add/setup-teardown
npm run test:phpunit
Delete all save_pattern_to_file() calls in ModelTest.php
npm run test:phpunit
Expected and actual: there are 2 failures
Before this PR, the tests still passed, even if you deleted the save_pattern_to_file() calls (the written patterns persisted after the tests)

Slowest way:

git checkout 23e03b4fd3df77a5db029b6a98119b553c5c88a6
That gets these tests before this PR
npm run test:phpunit
Go to http://localhost:1001/wp-admin/post-new.php
In the inserter, see the patterns that unit tests created (they persisted after the tests):

Go to http://localhost:1001/wp-admin/themes.php
Delete Twenty Twentythree, reinstall it, and activate it (to delete those patterns)
git checkout add/setup-teardown
npm run test:phpunit
Wait for tests to pass
Go back to http://localhost:1001/wp-admin/post-new.php
Click the inserter
Expected and actual: There's no 'Uncategorized' pattern (patterns written in unit tests didn't persist after the tests):

Fixes #168 (again)

Co-authored-by: Ryan Kienstra <kienstraryan@gmail.com>

…-bug-tests Update/patternception saving bug tests

* Add a naive function to update a slug * Use preg_replace() to update the slug

kienstra · 2023-05-24T00:12:07Z

wp-modules/editor/tests/ModelTest.php

+		parent::setUp();
+		$this->stylesheet_dir = get_wp_filesystem_api()->wp_themes_dir() . '/pm-testing';
+		get_wp_filesystem_api()->mkdir( $this->stylesheet_dir );
+		add_filter( 'stylesheet_directory', [ $this, 'get_stylesheet_dir' ] );


Like this example, this makes get_patterns_directory() get the mock theme directory we created for these unit tests:$this->stylesheet_dir.

* Add a naive function to update a slug * Handle multiple attributes in pattern block * Only output the name and textdomain if they exist

kienstra · 2023-05-24T17:13:54Z

wp-modules/editor/tests/ModelTest.php

+				'post_name'    => 'new-pattern-originally-created-with-pattern-manager',
+				'post_type'    => get_pattern_post_type(),
+			]
+		);


I'll revert this if you'd like. It's a tangent.

If it still works it's fine with me to keep :)

OK, thanks!

kienstra · 2023-06-01T18:48:58Z

Thanks, @johnstonphilip!

kienstra added 30 commits May 17, 2023 12:20

Add a naive function to update a slug

74073bc

Use preg_replace() to update the slug

c35b2be

Fix the conversion, using addslashes

293e24a

Add a helper to get whether a pattern has a pattern block

7b4ab6a

Add a function to update all patterns

1f48cb8

Fix fatal error

e883ce6

Allow the slug to be different from the name

1437e52

Set the slug to the name for new patterns

68aeef4

For Patternception, don't rely on the name

5994762

If the name changes, change the slug

2b92ef4

Simplify the name to $name_changed

0b03748

Fix a failed PHPUnit test

bafb3bf

Add a comment about why the slug is set to the name

a1abea9

Replace ... with array_merge()

35e3e49

Pass all 3 arguments to update_slug()

6c45631

Rename converToSlug(), as it's actually converting to a name

11fb47a

Actually rename a file to toKebabCase.ts

237cb35

Remove an extra 'a'

cfb3814

Allow saving a new pattern with only meta

0e80e0c

Fixes #168 (again)

Fix how name changes work

a722e10

Merge in update/patternception-saving-bug, resolve conflict

082122f

Use the previous pattern slug

ccb273b

Make a test case cover 2 of the same pattern being renamed

8b4f516

Test there being no content

5221859

Update comments

2bfc017

Handle multiple attributes in pattern block

c25f236

Add another test case for changing both patterns

586eced

Rename to something without a slash

5734314

Allow a pattern slug to start with a number

44cac0e

Still handle multiple attributes

fb14449

johnstonphilip and others added 11 commits May 23, 2023 13:11

Update wp-modules/editor/tests/ModelTest.php

348bb7e

Co-authored-by: Ryan Kienstra <kienstraryan@gmail.com>

Update wp-modules/editor/tests/ModelTest.php

dbf43d6

Co-authored-by: Ryan Kienstra <kienstraryan@gmail.com>

Comment tweak

c9089fd

Merge pull request #183 from studiopress/update/patternception-saving…

5c07334

…-bug-tests Update/patternception saving bug tests

Update a Patternception slug in all patterns on changing a slug (#175)

621d151

* Add a naive function to update a slug * Use preg_replace() to update the slug

Merge in target branch, resolve merge conflicts

20a84e2

Add space to the bottom of package.json

13d64c2

Fix unit tests for prefixing

019e781

Only prepend a textdomain if there's a textdomain

e951357

Only output the name and textdomain if they exist

23e03b4

Ensure the patterns written to the fs don't persist across tests

6273ca2

kienstra changed the base branch from main to add/slug-prefixing May 23, 2023 23:38

Use WP_UnitTestCase factory to create posts

0ea824c

kienstra commented May 24, 2023

View reviewed changes

kienstra added 2 commits May 23, 2023 18:14

Remove a filter created for the unit tests

3229372

Add a comment back in

f863b6b

kienstra marked this pull request as ready for review May 24, 2023 00:28

kienstra requested review from johnstonphilip, dreamwhisper and mike-day May 24, 2023 00:31

Prepend the textdomain to the slug (#180)

ac955a1

* Add a naive function to update a slug * Handle multiple attributes in pattern block * Only output the name and textdomain if they exist

Base automatically changed from add/slug-prefixing to update/patternception-saving-bug May 24, 2023 16:57

Merge in target branch, resolve conflict

be86a4c

kienstra commented May 24, 2023

View reviewed changes

Base automatically changed from update/patternception-saving-bug to main May 24, 2023 19:50

Merge in main, resolve conflicts

832e017

johnstonphilip approved these changes Jun 1, 2023

View reviewed changes

kienstra merged commit ed56885 into main Jun 1, 2023

kienstra deleted the add/setup-teardown branch June 1, 2023 18:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure patterns written to the filesystem in unit tests don't persist #185

Ensure patterns written to the filesystem in unit tests don't persist #185

kienstra commented May 23, 2023 •

edited

Loading

kienstra May 24, 2023 •

edited

Loading

kienstra May 24, 2023 •

edited

Loading

johnstonphilip Jun 1, 2023 •

edited

Loading

kienstra Jun 1, 2023

kienstra commented Jun 1, 2023

Ensure patterns written to the filesystem in unit tests don't persist #185

Ensure patterns written to the filesystem in unit tests don't persist #185

Conversation

kienstra commented May 23, 2023 • edited Loading

Summary of changes

How do you know this PR does anything? These unit tests passed before this PR.

Fastest way:

Slowest way:

kienstra May 24, 2023 • edited Loading

Choose a reason for hiding this comment

kienstra May 24, 2023 • edited Loading

Choose a reason for hiding this comment

johnstonphilip Jun 1, 2023 • edited Loading

Choose a reason for hiding this comment

kienstra Jun 1, 2023

Choose a reason for hiding this comment

kienstra commented Jun 1, 2023

kienstra commented May 23, 2023 •

edited

Loading

kienstra May 24, 2023 •

edited

Loading

kienstra May 24, 2023 •

edited

Loading

johnstonphilip Jun 1, 2023 •

edited

Loading