Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tests: Add Unit Tests for wp_fast_hash() Function #8556

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

Debarghya-Banerjee
Copy link

Trac Ticket: Core-63136

Copy link

github-actions bot commented Mar 20, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props debarghyabanerjee, mukesh27, johnbillion.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@johnbillion
Copy link
Member

Thanks for the PR @Debarghya-Banerjee . Honestly I am in two minds about this, on one hand increased test coverage is always good, but on the other hand I don't believe these tests provide value. This has also came up in Core-53651 (#7731) and some other tickets that propose adding tests to functions that perform little or no logic. If the tests simply copy the logic that exists in the function, or if the function itself performs no real logic, then the tests are of no value, and they can end up unnecessarily tying the tests to an implementation detail.

  • Asserting that the return value is not empty is useless because the function always returns a value. There is no conditional logic that affects this.
  • Asserting that the return value starts with $generic$ is possibly useful for future changes, but if any work were to be done to this prefix then it would likely become part of some conditional logic so the test would need to change anyway.
  • Asserting that the function returns a non-empty value when special characters are included in the message doesn't assure us of anything useful. We have to implicitly trust that the Sodium functions are performing as expected otherwise we'd need to write an exhaustive suite of tests that assure the cryptographic security of Sodium.

It might seem like a waste of time to push back on adding these sorts of tests, but they have a cost both in terms of the test run time, future maintainability, and time spent by contributors adding further similar tests when that time would be better spent elsewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants