Magento Definition of Done
The “Definition of Done” (DoD) is a collective term for a set of acceptance criteria that is applied to any changes in the product code base. The requirements that result from our DoD are applied by default to all Magento-owned repositories.
Internally, the Magento development teams follow the DoD to ensure that all work meets consistent release criteria. We encourage our community contributors to also follow the Magento DoD.
At a high level, the criteria defined in our “definition of done” revolve around the principle of writing clean code that is reviewed and includes unit tests and solid documentation along with the code.
The following sections provide additional details about each of these criteria:
Functional Backward Compatibility
Functional backward compatibility means the behaviour of the application is preserved.
Existing product features and functionality must be retained during any changes to the code. Any backward-incompatible functional changes must be approved by a product owner. The documentation should explain the justification and provide the “business value”.
Technical Backward Compatibility
Technical backward compatibility means the technical interfaces are preserved.
Technical interfaces include PHP interfaces or classes, CLI commands, URLs or any other interfaces that can be used by 3rd-party developer, system integrator, or user of Magento. Any change to an interface that can lead to a broken integration is a breaking technical change. Technical interfaces and the corresponding level of change is described in Code Changes and Module Version Dependencies documents in more details.
Technical backward compatibility must be retained between PATCH (marketing) versions of Magento products. It should also be retained between MINOR (marketing) releases if possible. Any breaking changes must be approved by an architect, product owner and release manager.
All changes, additions, and extensions to the product should be documented by the author. The documentation should provide an overview of the change, and information about standard use cases, audience, and procedural instructions for implementing the feature.
Documentation for the submitted code should be submitted as a pull request to the official Magento DevDocs repository.
When submitting either code or documentation, a brief summary of the work should be included in the commit message.
Additionally, the code itself should follow our DocBlock standard and contain high-quality comments and descriptions for all classes and methods.
For documenting backward-incompatible changes, please see Backwards Compatible Development.
Understanding Black, White, and Gray tests
- A black box test does not have any knowledge of how the subject of the test is built.
- A white box has knowledge of how the subject of the test is built. The test logic is usually coupled to the implementation and will typically be sensitive to changes.
- A gray box is similar to black box testing where the test is not directly coupled to the subject’s implementation but the test cases may be designed in a way to assert that sensitive portions of the implementation will work correctly.
Assume there is a method with the signature
function removeLetterFromString(string $letter, string $string): string
- A black box test would test the obvious cases both normal cases such as
removeLetterFromString('a', 'fooabar') === 'foobr'and edge cases such as when
$stringare empty or
$lettercontains multiple or multibyte characters. It would probably test several variations of string lengths. Notice there is no knowledge of how this function is written.
- A white box test would look into the implementation of the method and see that it calls a microservice API and make sure that each condition of the code has test coverage. For example, this test may force the microservice client to return an error and have a test for the expected handling of that scenario. This wouldn’t be a reusable test and it’s directly coupled to the implementation.
- A gray box test would look at the implementation of the method and see that it calls a microservice API and injects the
$stringinto the URL so it may add some extra test coverage for strings that contain unsafe URL characters such as
&?=%/. This is not coupled to the implementation as the implementation could be changed and the test should still pass.
Code changes must be covered by automated tests according to Classification of Magento Automated Tests. When choosing how to cover your changes, pick the most lightweight (execution time wise) test type that will provide sufficient coverage. If you encounter an existing test that insufficiently covers your changes, you can delete that test but you must write a proper test to replace it. For example, a method that interacts with database has a unit test. You can replace it with an integration test.
Be aware that while high-level tests may provide coverage to code, it is only indirect coverage. Tests with more direct usage of the changed code will likely still needs to be written to ensure that regardless of the which components are actually used in the black box, the individual components still have coverage.
High level testing policy:
- Any code that is added or changed must have explicit tests to validate the behavior. To clarify, this policy is intended to prove that the integrity of the code is verified regardless of which implementations are loaded in a black box environment. This may be done through unit or integration testing as appropriate.
- Code must be also shown to work with known collaborators. This must be done through integration tests and ideally should involve as few components as possible per test case. This level of tests ensures that the code will work with its known associates. Specific examples can be subject but such associates would include composites, chains, pools, etc. but also include cases like a Template filter working with a specific processor loaded.
- In addition, regardless of the interpretation of the testing strategy below: Any class marked with an
@apiannotation MUST be covered with explicit test coverage via integration or unit tests.
These tests must test the concrete implementation’s behavior in a way that can not be inadvertently changed outside of the test itself.
For example: testing a concrete class through DI preference is not safe because it could be overridden via configuration of another loaded module. The test should not ask for the interface but rather the concrete implementation.
An integration test should be used to cover any code that does not meet the requirements of a unit test or functional test and should be thought of as essentially the default test type.
Integration tests come in many forms and can drastically vary in definition depending on what the intention of the test is. Generally speaking an integration test verifies that two or more things work together correctly. i.e. We are testing the integration of one thing with another thing. For the purpose of Magento testing, there are essentially two broad categories of integration tests: narrow-form and broad-form.
- Narrow-form integration tests focus on testing something mostly in isolation an can be as simple as a unit test as described in this guide except without mocked dependencies.
- Broad-form integration tests focus on testing something with less isolation and will involve multiple components explicitly collaborating. (compared to narrow-form where the dependencies are implicit collaborating)
Integration test policy:
- Methods and classes must have black box or gray box test coverage, including all variations for normal use, as well as edge-cases.
- SPIs must have test coverage. Often times Magento has extension points that may only be utilized by extension developers. Use TestModules to implement those SPI extension points and verify they are used correctly.
- As mentioned above, classes marked with
@apimust contain coverage. Integration tests must be used cover these classes unless a unit test is more appropriate. This includes JS modules and components.
- Consumers of default SPI implementations should have at least basic coverage that ensures the default implementations of the SPI are correctly configured and loaded.
Magento\Framework\SomeClassFilter may contain a
FilterPool that comes with default
Magento\Framework. Each of these implementations would have their own coverage pursuant to this document. However, there should also be some basic assertions within the test coverage for
Magento\Framework\SomeClassFilter that ensure each of the default filters are loaded correctly.
This should not be explicit coverage such as
UI functional tests are inherently unstable regardless of platform or testing framework. For this reason, along with reasons of maintainability and quality assurance delivery time, these tests should be prioritized below all other tests types.
Functional test policy:
- Web API endpoints must have functional test coverage via api-functional tests. These tests should ensure that the endpoints behave in accordance to their service contracts regardless of the actual concrete implementation that may be loaded.
- For UI-related code, there are some circumstances where it is not possible to cover changes with unit or integration tests. In these cases the appropriate type of coverage would be a functional test but this is a last resort only. However, aside from those cases UI functional tests should only be used to cover P0/P1 testing scenarios. If there are no scenarios available to make this decision, a product owner must be consulted for approval of new tests.
If there is a scenario that is not classified as a P0/P1 but should be, have a discussion with the product owner to get it elevated.
See Functional Tests.
There are a small number of use cases for unit tests in Magento. The nature of our code and development practices make it increasingly hard to write and maintain high-quality unit tests. Many of them end up being replaced by integration tests or are practically useless from the beginning due to how much mocking is needed to make them pass. Generally, an integration test is the preferred test type.
A unit test may be preferred when you have classes or methods that:
- Have few or no dependencies.
- The test must not be directly coupled to the collaborators of the test subject. If the collaborators are solely responsible for the behavior of the tested subject, it will not be a good unit test.
- Do not interact with resources such as databases, the file system, 3rd party systems, etc.
- Can be covered by a black box test.
- The test must not be a mirror of the code. Instead, the test must validate that the contract of the method or class is upheld by the implementation. Specific implementations may be weak in certain areas so specific corner cases could cover that logic while still being a black box test.
- Would not be easily foreseen to have dependencies in the future.
- This can be hard to predict but a good example of when it would be unlikely is a simple utility class that performs some standalone operation. By contrast, a helper would be very likely to have dependencies by nature.
- Utility classes such as
- Simple classes that can also be used independently such as
- Algorithms that perform calculation or parsing.
And by explicit contrast here are some things NOT to cover:
- Classes/methods with numerous dependencies.
- Creation of unit tests for such classes will result in the creation of many mocks and writing complex test logic (that most likely follows code to large extend and as a result we will have fragile and hard to maintain tests)
- Classes/methods interacting with resources directly or indirectly.
- Mostly passing data between collaborators and has no or small amount of logic so it can be covered indirectly by integration/functional tests.
- They are the “glue” that connects different app layers. They should not contain any business logic and should only be responsible for directing request/response information to/from services. They can be tested via integration or functional tests. Also, controller-specific tests will likely be rendered useless and ultimately deleted at some point in the context of the service isolation initiative which makes this idea much more important.
- Model triad classes (Model/Resource Model/Collection)
- They have many dependencies and interact with resources.
Code to cover:
- Must cover any code which introduces convention in scope of a particular implementation, violation of which would lead to runtime error.
Expected code coverage:
- Must cover all files applicable to this convention.
- Scan for all XML-files of certain type and validate them using appropriate XML-schema.
- Scan for declarations of templates and invoke “fallback” mechanism to ensure they resolve.
Static Code Analysis
Code to cover:
- Must cover all new code files (or whatever qualifies as “new”).
Expected code coverage: must cover all applicable files in entire code base.
Code to cover:
- Must cover any formal backward-incompatible changes on code level. For more information, see Magento’s backward compatibility policy.
A failure in a legacy test must provide comprehensive explanation of an alternative, if there is any.
Expected code coverage:
- Must cover the majority of occurrences of the backward-incompatible change.
- Should cover 100% of occurrences.
Not all changes can be covered. For example, it is possible to scan a file for literals, but it is unfeasible to analyze string concatenation or any other dynamic way of building a variable.
Functional Manual Tests
Must cover new or changed application behavior (functional). Added/updated functionality should be covered by a functional Zephyr test(s) related to current sprint commitment.
A task, when complete by the author, should be reviewed by another Magento community member through a process of formal code review. The reviewer should check whether the task meets the original acceptance criteria and verify that there are no code defects and that all points of this definition of done are met.
The work cannot be considered as complete unless all the criteria are verified.