In #37957, parts of the testing guide were broken out into separate guides. As part of that work, the `<live-example>` tags were also copied to the new guides. These `<live-example>` tags did not specify the targeted example project via the `name` attribute, thus they were implicitly targeting the example with the same name as the guide they were in. See the [Docs style guide][1] for more info. However, there is only one example project (`testing/`) and all `<live-example>` tags were supposed to target that. This worked fine on the `testing.md` guide, but it broke on other guides (which tried to target non-existing example projects based on their names). This commit fixes it by explicitly specifying which example is targeted by the `<live-example>` tags. It also removes the `embedded-style` attribute that has no effect. [1]: https://angular.io/guide/docs-style-guide#live-examples Fixes #38036 PR Close #38038
3.9 KiB
{@a attribute-directive}
Testing Attribute Directives
An attribute directive modifies the behavior of an element, component or another directive. Its name reflects the way the directive is applied: as an attribute on a host element.
For the sample app that the testing guides describe, see the sample app.
For the tests features in the testing guides, see tests.
Testing the HighlightDirective
The sample application's HighlightDirective
sets the background color of an element
based on either a data bound color or a default color (lightgray).
It also sets a custom property of the element (customProperty
) to true
for no reason other than to show that it can.
It's used throughout the application, perhaps most simply in the AboutComponent
:
Testing the specific use of the HighlightDirective
within the AboutComponent
requires only the techniques explored in the "Nested component tests" section of Component testing scenarios.
However, testing a single use case is unlikely to explore the full range of a directive's capabilities. Finding and testing all components that use the directive is tedious, brittle, and almost as unlikely to afford full coverage.
Class-only tests might be helpful, but attribute directives like this one tend to manipulate the DOM. Isolated unit tests don't touch the DOM and, therefore, do not inspire confidence in the directive's efficacy.
A better solution is to create an artificial test component that demonstrates all ways to apply the directive.
The <input>
case binds the HighlightDirective
to the name of a color value in the input box.
The initial value is the word "cyan" which should be the background color of the input box.
Here are some tests of this component:
A few techniques are noteworthy:
-
The
By.directive
predicate is a great way to get the elements that have this directive when their element types are unknown. -
The
:not
pseudo-class inBy.css('h2:not([highlight])')
helps find<h2>
elements that do not have the directive.By.css('*:not([highlight])')
finds any element that does not have the directive. -
DebugElement.styles
affords access to element styles even in the absence of a real browser, thanks to theDebugElement
abstraction. But feel free to exploit thenativeElement
when that seems easier or more clear than the abstraction. -
Angular adds a directive to the injector of the element to which it is applied. The test for the default color uses the injector of the second
<h2>
to get itsHighlightDirective
instance and itsdefaultColor
. -
DebugElement.properties
affords access to the artificial custom property that is set by the directive.