Skip to content

Migration.md

Latest commit

 

History

History
111 lines (85 loc) · 6.65 KB

Migration.md

File metadata and controls

111 lines (85 loc) · 6.65 KB
Raw

Upgrading CakePHP Data Validation Testing to 3.x

This major version bundles two breaking changes:

  1. Method renames — PR #45 (closes #44)
  2. Rule-dedicated methods now check only their own rule — PR #40 (closes #38)

You can use the Migration Script to rename the old method calls automatically and to find the places that need a manual review.

Migration Script

The Migration Script does not fully automate the upgrade, but it takes care of the method renames and lists everything else you need to review manually. It is shipped with the package, so first update the package to 3.x:

composer require --dev orca-services/cakephp-data-validation-testing:^3.0 -W

Then run the script from the root of your application:

php vendor/orca-services/cakephp-data-validation-testing/migrate.php

The script interactively asks for the directories to migrate (comma separated, default: tests,plugins).

What it does:

  1. Renames all calls of the old method names to the new ones (see Method renames). Only method calls and references preceded by -> or :: are replaced, so your own test methods with similar names are left untouched.
  2. Replaces calls of the removed testRules() with assertRules() and lists them for manual review (see testRules() removal).
  3. Lists all calls of rule-dedicated methods for manual review (see Rule-dedicated methods now check only their own rule).
  4. Lists old method names it did not replace, e.g. in strings, callables or own methods with the same name.

The script modifies your files in place, so make sure your working tree is clean (e.g. committed in Git) before running it. Afterward:

  • Review the diff (e.g. git diff) and the listed findings.
  • Run your test suite and fix any failing tests.

1. Method renames

All test/testData-prefixed methods on DataValidationTestTrait are now prefixed with assert instead. This avoids PHPUnit mistaking them for actual test methods. No logic changed only the method names.

Rename table

Old New
testDataValidationNotEmpty() assertValidationNotEmpty()
testDataValidationEmpty() assertValidationEmpty()
testDataValidationRequired() assertValidationRequired()
testDataValidationNotRequired() assertValidationNotRequired()
testDataValidationBoolean() assertValidationBoolean()
testDataValidationURLWithProtocol() assertValidationURLWithProtocol()
testDataValidationDateTime() assertValidationDateTime()
testDataValidationDate() assertValidationDate()
testDataValidationInList() assertValidationInList()
testDataValidation() assertValidation()
testDataValidationNoErrors() assertValidationNoErrors()
testFullDataValidation() assertValidationTableErrors()
testFullDataValidationNoErrors() assertValidationTableNoErrors()
testDataValidationContains() assertValidationContains()
testDataValidationNotContains() assertValidationNotContains()
assertDataValidationErrorsContain() assertValidationErrorsContain()
testDataValidationListContains() assertValidationListContains()
testDataValidationListNotContains() assertValidationListNotContains()
testDataRules() assertRules()
testRules() Removed. Use assertRules() instead
testDataRulesNoErrors() assertRulesNoErrors()
testDataValidationMaxLength() assertValidationMaxLength()
testDataValidationMinLength() assertValidationMinLength()
testDataValidationScalar() assertValidationScalar()
testDataValidationDecimal() assertValidationDecimal()
testDataValidationInteger() assertValidationInteger()
testDataValidationNonNegativeInteger() assertValidationNonNegativeInteger()
testDataValidationGreaterThanOrEqual() assertValidationGreaterThanOrEqual()
testDataValidationEmail() assertValidationEmail()
testDataValidationUuid() assertValidationUuid()
testDataValidationLengthBetween() assertValidationLengthBetween()
testDataValidationRange() assertValidationRange()
testDataValidationNaturalNumber() assertValidationNaturalNumber()
testDataValidationForeignKey() assertValidationForeignKey()
testDataValidationIsUnique() assertValidationIsUnique()

testRules() removal

testRules() was removed without a direct equivalent. Use assertRules() instead, but note the difference in behavior: assertRules() skips data validation (validate => false) and asserts that saving fails, while testRules() first asserted that there are no validation errors. Review each replaced call to make sure the test still covers what you intend.

2. Rule-dedicated methods now check only their own rule

Previously, methods like assertValidationBoolean(), assertValidationEmail(), assertValidationInteger(), etc. compared the entire error array for a field against an expected array (or [] for valid values). If a field had multiple validation errors, this could hide unrelated errors or cause false failures.

Now these methods assert only their own rule key (present or absent), ignoring any other errors on the same field.

Review your calls of these methods, especially where a custom $expected array containing several rules is passed, and make sure the tests still cover what you intend. The Migration Script lists all these calls for you.