Command/39 checkPostExists from any CPT

[faisal-alvi]

Description of the Change

Added a new command checkPostExists which checks whether a given post title exists in a specified post type or not.

It accepts the following parameters.

• title: Post Title.
• postType: Post type. Default to post.

Note: The command searches for the exact title on the site. It fails the test if the title string does not match.

Closes #39

Verification Process

1. Build the project using npm run build.
2. Make sure the docker is running.
3. Run npm run env:start.
4. Run npm run cypress:open.
5. Run check-post-exists.test.js.
6. Try to change the post title(s) in the /tests/cypress/integration/check-post-exists.test.js file and see the test should fail.

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my change.
• All new and existing tests passed.

Changelog Entry

Added - New Command checkPostExists to check if post exists.

Credits

Props @faisal-alvi

[Sidsector9]

LGTM 🚀

[cadic]

Potentially chainable command. IMO, we should wrap the result and don't fail if the post doesn't exist.

[Sidsector9]

@faisal-alvi I have a suggestion to make this command run faster, effectively running tests faster.

The admin page exposes the wp-json/wp/v2/posts endpoint which we can use to search for a post(s).
Instead of typing the search term in the search box, submitting and waiting for thee page to reload, we can use REST to search faster:

fetch( `${Cypress.config().baseUrl}/wp-json/wp/v2/post?s="${searchString}"` )
    .then( response => {
        return response.json();
    } )
    .then( data => {
        // Run assertions here.
    } );

Let me know what you think of this. Thanks!

[faisal-alvi]

@Sidsector9 thanks for the suggestion, however, I can see only one drawback of using the REST API. It won't work with the CPTs in which the REST API support is disabled, i.e. show_in_rest is set to false.

[faisal-alvi]

@cadic thanks for the suggestion, the result is now wrapped and returned.

[Sidsector9]

Fair point @faisal-alvi

Although, we can still have the best of both worlds:

1. Check via REST.
2. If REST is disabled for a CPT, then use UI

[cadic]

@faisal-alvi thank you for the command. I've added few tests to cover the functionality in both situations (post exists or not)

[faisal-alvi]

@cadic any thoughts on @Sidsector9's ^recommendation?