'. '

Never update tests

From APIDesign

(Difference between revisions)
Jump to: navigation, search
m (Incompatible moved to Never update tests: Witness incompatible change by the need to update tests.)
Current revision (04:03, 24 January 2019) (edit) (undo)
 
Line 12: Line 12:
When you have to update your [[API]] tests, because they are failing, you have probably broken [[functional compatibility]] of your [[API]]. Don't do that, rather try following [[API Design Patterns]]:
When you have to update your [[API]] tests, because they are failing, you have probably broken [[functional compatibility]] of your [[API]]. Don't do that, rather try following [[API Design Patterns]]:
* Don't modify existing behavior, but provide [[AlternativeBehavior]] with compile time alternatives
* Don't modify existing behavior, but provide [[AlternativeBehavior]] with compile time alternatives
-
* Add new constructors, or add a [[builder]] to construct newer version of an [[API]] object
+
* Add new constructors, or add a [[builder]] to configure construction of a newer version of an [[API]] object
== Summary ==
== Summary ==

Current revision

Keeping BackwardCompatibility helps distributed development. How shall one recognize an incompatible change?

Never Update API Tests

An API without tests is like cake without ketchup. Thus let's assume there are some tests checking behavior of the API. The first sign of an incompatible change is the need to update tests.

If you are changing an API and you have to update tests because they no longer compile, then you have broken Source_Compatibility. Common mistakes include adding new methods into interfaces or abstract methods into subclassable classes. Consider following API Design Patterns:

When you have to update your API tests, because they are failing, you have probably broken functional compatibility of your API. Don't do that, rather try following API Design Patterns:

  • Don't modify existing behavior, but provide AlternativeBehavior with compile time alternatives
  • Add new constructors, or add a builder to configure construction of a newer version of an API object

Summary

If you want your API to be backward compatible, then: Never update tests for your API! Copy them and create new ones!

Personal tools
buy