Dart pub
Testing infrastructure AngularDart,
used with the build_runner package.
Documentation and examples:
_tests/test/ (tests for the main dart-lang/angular package)NOTE: Some of the guides above are out of date the for the latest angular_test versions.
Additional resources:
angular_test is a library for writing tests for AngularDart components.
// Assume this is 'my_test.dart'.
import 'my_test.template.dart' as ng;
void main() {
ng.initReflector();
tearDown(disposeAnyRunningTest);
test('should render "Hello World"', () async {
final testBed = new NgTestBed<HelloWorldComponent>();
final testFixture = await testBed.create();
expect(testFixture.text, 'Hello World');
await testFixture.update((c) => c.name = 'Universe');
expect(testFixture.text, 'Hello Universe');
});
}
@Component(selector: 'test', template: 'Hello {{name}}')
class HelloWorldComponent {
String name = 'World';
}
To use angular_test, configure your package's pubspec.yaml as follows:
dev_dependencies:
build_runner: ^1.0.0
build_test: ^0.10.0
build_web_compilers: ^1.0.0
IMPORTANT: angular_test will not run without these dependencies set.
To run tests, use pub run build_runner test. It automatically compiles your
templates and annotations with AngularDart, and then compiles all of the Dart
code to JavaScript in order to run browser tests. Here's an example of using
Chrome with Dartdevc:
pub run build_runner test -- -p chrome
For more information using pub run build_runner test, see the documentation:
https://github.com/dart-lang/build/tree/master/build_runner#built-in-commands
Added an optional named parameter, maxIterations, to
FakeTimeNgZoneStabilizer's constructor. If not specified 10 maximum loops
are attempted to elapse pending timers. In advanced use cases, a test may
configure a higher threshold:
NgZoneStabilizer allow100InsteadOf10() {
return FakeTimeNgZoneStabilizer(timerZone, ngZone, maxIterations: 100);
}
NgTestFixture.update() now delegates to ComponentRef.update(), which
automatically calls markForCheck(). Previously, an OnPush component
under test might not have been properly updated.FakeTimeNgZoneStabilizer. Changed NgTestStabilizer initialization from originating from a
List<NgTestStabilizerFactory> to a single NgTestStabilizerFactory. The
new top-level function composeStabilizers may be used to create a
composite factory from multiple factories:
composeStabilizers([
(_) => stabilizer1,
(_) => stabilizer2,
])
This helps disambiguate the order of stabilizers running, which in turn will allow additional new stabilizers and features to be added in a non-breaking fashion. This change does not impact users that were not augmenting or creating their own stabilizers (i.e. most users/most tests).
Removed NgTestStabilizer.all. See composeStabilizers instead.
Removed NgZoneStabilizer. The new class is RealTimeNgZoneStabilizer,
though most users should not be impacted NgTestBed now uses the new
stabilizer by default.
NgTestStabilizer.alwaysStable, which does what it sounds like
and always reports stability. This handles making composition easier as the
root stabilizer can effectively be a no-op.RealTimeNgZoneStabilizer, do not try to stabilize timers that
run outside of Angular zone. Supported beforeComponentCreated(Injector) when creating fixture to allow
using injector to set up prerequisite data for testing from DI.
This is useful when an object (that is already injected to the app) is difficult to create otherwise. For example:
// ComplexDataLayer is difficult to instantiate in test, but it is needed
// to set up some fake data before the component is loaded and used.
final fixture = await testBed.create(
beforeComponentCreated: (i) {
var dataLayer = i.get(ComplexDataLayer) as ComplexDataLayer;
dataLayer.setUpMockDataForTesting();
},
);
Supported FutureOr<void> for beforeChangeDetection.
NgZoneStabilizer waits for the longest pending timer during update().
Added isStable API to NgTestStabilizer.
Made NgTestStabilizerFactory public.
Removed throwsInAngular. Use throwsA.
Removed NgTestFixture#query/queryAll, as debug-mode is being turned down.
Run DelegatingNgTestStabilizer stabilizers one by one instead of run all
at once. update() for each stabilizers will be run at least once. After
that, it will only be run if the current stabilizer is not stable.
pub run angular_test was entirely removed. Similar functionality is
supported out of the box by build_runner:
$ pub run build_runner test
Removed built-in support for package:pageloader. The current version of
pageloader relies on dart:mirrors, which is being removed from the web
compilers (dart2js, dartdevc). There is a new version of pageloader in
development that uses code generation. We'll consider re-adding support once
available or through another package (i.e. angular_pageloader or similar).
Adding stabilizers to NgTestBed now takes a factory function of type
NgTestStabilizer Function(Injector), which is aliased as
NgTestStabilizerFactory. This allows using NgTestBed without any dynamic
reflective factories (i.e. initReflector()) and doesn't have impact to
most users.
Deleted an unnecessary hostElement.append(componentRef.location).
Fixed a bug where a WillNeverStabilizeError was thrown whenever there was
a non-zero length Timer being executed. This was due to a bug in how the
NgStabilizer was executing - constantly calling the update function
instead of calling it once and waiting for stabilization.
Fixed a bug where stabilizers are considered stable even when some of them are not.
Fixed a bug where _createDynamic does not preserve rootInjector.
Added NgTestBed.forComponent, which takes a ComponentFactory<T>, and
optionally an InjectorFactory. This allows writing tests entirely free of
any invocations of initReflector().
angular_router. Throws in bootstrapping if the root component does not use default change
detection. AngularDart does not support OnPush or other change detection
strategies on the root component.
Pub serve now defaults to a random unused port (instead of 8080) and
--port is deprecated. Going forward the supported way to supply this
argument is via --serve-arg:
$ pub run angular_test --serve-arg=port=1234
--run-test-flag (-t) is now deprecated, and no longer has a
default value of aot. Tags are still highly encouraged in order to have
faster compilation times! Use --test-arg instead:$ pub run angular_test --test-arg=--tags=aot
--platform (-p) is now Deprecated, and no longer has a
default value of content-shell, which was not always installed on host
machines. Instead use --test-arg:$ pub run angular_test --test-arg=--platform=content-shell
Option --name (-n) and --simple-name (-N) are also deprecated. Use
--test-arg=--name= and --test-arg=--simple-name= instead.
Changes to compatibility.dart might not be considered in future semver
updates, and it highly suggested you don't use these APIs for any new
code.
Change NgTestFixture.update to have a single optional parameter
Add assertOnlyInstance to fixture to remove some boilerplate around testing the state of a instance. Only use to test state, not to update it.
Added --serve-arg and --test-arg, which both support multiple arguments
in order to have better long-term support for proxying to both pub serve
and pub run test without frequent changes to this package. For example to
use the [DartDevCompiler (dartdevc)]:
$ pub run angular_test --serve-arg=web-compiler=dartdevc
PageLoader factory:testBed = testBed.setPageLoader(
(element) => new CustomPageLoader(...),
);
query and queryAll to NgTestFixture. This works
similar to the update command, but is called back with either a single or
multiple child component instances to interact with or run expectations
against:// Assert we have 3 instances of <child>.
await fixture.queryAll(
(el) => el.componentInstance is ChildComponent,
(children) {
expect(children, hasLength(3));
},
);
package:pageloader:final fixture = await new NgTestBed<TestComponent>().create();
final pageObject = await fixture.getPageObject/*<ClickCounterPO>*/(
ClickCounterPO,
);
expect(await pageObject.button.visibleText, 'Click count: 0');
await pageObject.button.click();
expect(await pageObject.button.visibleText, 'Click count: 1');
Workaround for pub {serve|build} hanging on angular_test as a
dependency.
Fixes a bug where the root was not removed from the DOM after disposed.
Added a missing dependency on package:func.
Properly fix support for windows by using pub.bat.
Replace all uses of generic comment with proper syntax.
Fixed a bug where activeTest was never set (and therefore disposed).
Fixed a bug where pub, not pub.bat, is run in windows.
Update pubspec.yaml so it properly lists AngularDart 3.0.0-alpha
Fix the executable so pub run angular_test can be used
Fix a serious generic type error when NgTestBed is forked
Fix a generic type error
Added compatibility.dart, a temporary API to some users migrate
Add this to your package's pubspec.yaml file:
dependencies:
angular_test: ^2.4.0
You can install packages from the command line:
with pub:
$ pub get
Alternatively, your editor might support pub get.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:angular_test/angular_test.dart';
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
87
|
|
Health:
Code health derived from static analysis.
[more]
|
0
|
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
42
|
|
Overall:
Weighted score of the above.
[more]
|
52
|
We analyzed this package on Aug 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms:
Error(s) prevent platform classification:
Fix dependencies in
pubspec.yaml.
Fix dependencies in pubspec.yaml.
Running pub upgrade failed with the following output:
ERR: The current Dart SDK version is 2.4.0.
Because angular_test requires SDK version >=2.5.0-dev.1.0 <3.0.0, version solving failed.
Fix platform conflicts. (-20 points)
Error(s) prevent platform classification:
Fix dependencies in pubspec.yaml.
Make sure dartdoc successfully runs on your package's source files. (-10 points)
Dependencies were not resolved.
The package description is too short. (-18 points)
Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.
Maintain an example. (-10 points)
Create a short demo in the example/ directory to show how to use this package.
Common filename patterns include main.dart, example.dart, and angular_test.dart. Packages with multiple examples should provide example/README.md.
For more information see the pub package layout conventions.
| Package | Constraint | Resolved | Available |
|---|---|---|---|
| Direct dependencies | |||
| Dart SDK | >=2.5.0-dev.1.0 <3.0.0 | ||