Skip to content

Tests: Cover rest_find_matching_pattern_property_schema(). - #14819

Open
ekamran wants to merge 1 commit into
WordPress:trunkfrom
ekamran:shifteq/test-rest-find-matching-pattern-property-schema
Open

ekamran wants to merge 1 commit into
WordPress:trunkfrom
ekamran:shifteq/test-rest-find-matching-pattern-property-schema

Conversation

@ekamran

@ekamran ekamran commented Oct 24, 2026

Copy link
Copy Markdown

Adds unit tests for rest_find_matching_pattern_property_schema() in tests/phpunit/tests/rest-api/restFindMatchingPatternPropertySchema.php. The function returns the schema of the patternProperties entry that matches a property name. It is used by REST API validation, sanitization and filtering by context, and by wp_prepare_json_value_for_client(), to pick the schema for a property. It had no dedicated tests.

Trac ticket: https://core.trac.wordpress.org/ticket/65819

What the tests cover

  • A property that matches one pattern returns that pattern's schema, including when the match is on a later pattern.
  • An integer property name matches. The callers loop over arrays, so a numeric name such as "123" reaches the function as the integer 123.
  • Patterns are not anchored, as in JSON Schema: [0-9] matches prop0.
  • A pattern containing #, the regex delimiter, matches a#b and does not match ab.
  • The multibyte property name é matches ^.$, which only works with the Unicode modifier.
  • null is returned when the schema has no patternProperties, an empty one, or no pattern that matches.

When more than one pattern matches a property, the function returns the first one. JSON Schema applies every matching pattern, so these tests do not cover overlapping patterns.

Test-only change.

Testing

npm run test:php -- --filter Tests_REST_API_RestFindMatchingPatternPropertySchema

All 10 test cases pass. Breaking the function or the pattern helper it uses in eight ways, such as checking only the first pattern, anchoring the pattern, dropping the Unicode modifier, or not escaping #, makes 1 to 8 of them fail or error each time.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code and Codex
Used for: Choosing the function, writing the tests, checking them against the function's real output, and auditing the tests and this description. I reviewed the tests and the results, and I take responsibility for the contribution.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Add coverage for a single matching pattern, an integer property name,
a pattern that matches only part of the name, a match on a later
pattern, a pattern that contains the `#` delimiter, a multibyte
property name that only matches with the Unicode modifier, and the
cases that return null: no patternProperties keyword, an empty one, no
matching pattern, and a `#` that has to match literally.

See #65819.
@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs.

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

Props ekamran.

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


Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

  • @propsbot add <username> to give props to a GitHub user. Requires write access.
  • @propsbot remove <username> to leave a user out of the props. Requires write access.
  • @propsbot refresh to refresh this list. Adding the props-bot label works too.

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.

1 participant