Skip to content

Commit 446147d

Browse files
mosuemmosuem
authored
Merge package:fake_async (#2291)
- [x] Move and fix workflow files and badges in the README.md - [x] Rev the version of the package, so that pub.dev points to the correct site - [x] Add a line to the changelog: ``` * Move to `dart-lang/test` monorepo. ``` - [x] Add the package to the top-level readme of the monorepo: ``` | [fake_async](pkgs/fake_async/) | Fake asynchronous events such as timers and microtasks for deterministic testing. | [![pub package](https://img.shields.io/pub/v/fake_async.svg)](https://pub.dev/packages/fake_async) | ``` - [ ] **Important!** Merge the PR with 'Create a merge commit' (enabling then disabling the `Allow merge commits` admin setting) - [ ] Update the auto-publishing settings on https://pub.dev/packages/fake_async/admin - [ ] Add the following text to https://github.com/dart-lang/fake_async/:' ``` > [!IMPORTANT] > This repo has moved to https://github.com/dart-lang/test/tree/main/pkgs/fake_async ``` - [ ] Publish using the autopublish workflow - [ ] Push tags to GitHub using `git tag --list 'fake_async*' | xargs git push origin` - [ ] Close open PRs in dart-lang/fake_async with the following message: `Closing as the [dart-lang/fake_async](https://github.com/dart-lang/fake_async) repository is merged into the [dart-lang/test](https://github.com/dart-lang/test) monorepo. Please re-open this PR there!` - [ ] Transfer issues by running `dart run pkgs/repo_manage/bin/report.dart transfer-issues --source-repo dart-lang/fake_async --target-repo dart-lang/test --add-label package:fake_async --apply-changes` - [ ] Archive https://github.com/dart-lang/fake_async/ --- - [x] I’ve reviewed the contributor guide and applied the relevant portions to this PR. <details> <summary>Contribution guidelines:</summary><br> - See our [contributor guide](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md) for general expectations for PRs. - Larger or significant changes should be discussed in an issue before creating a PR. - Contributions to our repos should follow the [Dart style guide](https://dart.dev/guides/language/effective-dart) and use `dart format`. - Most changes should add an entry to the changelog and may need to [rev the pubspec package version](https://github.com/dart-lang/sdk/blob/main/docs/External-Package-Maintenance.md#making-a-change). - Changes to packages require [corresponding tests](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md#Testing). Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback. </details>
2 parents 6e4a6af + 01e8e92 commit 446147d

File tree

13 files changed

+1665
-86
lines changed

13 files changed

+1665
-86
lines changed

‎.github/ISSUE_TEMPLATE/fake_async.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: "package:fake_async"
3+
about: "Create a bug or file a feature request against package:fake_async."
4+
labels: "package:fake_async"
5+
---

‎.github/workflows/dart.yml‎

Lines changed: 244 additions & 86 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ literate API.
1717
| Package | Description | Version |
1818
|---|---|---|
1919
| [checks](pkgs/checks/) | A framework for checking values against expectations and building custom expectations. | [![pub package](https://img.shields.io/pub/v/checks.svg)](https://pub.dev/packages/checks) |
20+
| [fake_async](pkgs/fake_async/) | Fake asynchronous events such as timers and microtasks for deterministic testing. | [![pub package](https://img.shields.io/pub/v/fake_async.svg)](https://pub.dev/packages/fake_async) |
2021
| [test](pkgs/test/) | A full featured library for writing and running Dart tests across platforms. | [![pub package](https://img.shields.io/pub/v/test.svg)](https://pub.dev/packages/test) |
2122
| [test_api](pkgs/test_api/) | | [![pub package](https://img.shields.io/pub/v/test_api.svg)](https://pub.dev/packages/test_api) |
2223
| [test_core](pkgs/test_core/) | | [![pub package](https://img.shields.io/pub/v/test_core.svg)](https://pub.dev/packages/test_core) |

‎pkgs/fake_async/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.packages
2+
.pub/
3+
.dart_tool/
4+
build/
5+
pubspec.lock

‎pkgs/fake_async/AUTHORS‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Below is a list of people and organizations that have contributed
2+
# to the project. Names should be added to the list like so:
3+
#
4+
# Name/Organization <email address>
5+
6+
Google Inc.

‎pkgs/fake_async/CHANGELOG.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
## 1.3.2
2+
3+
* Require Dart 3.3
4+
* Fix bug where a `flushTimers` or `elapse` call from within
5+
the callback of a periodic timer would immediately invoke
6+
the same timer.
7+
* Move to `dart-lang/test` monorepo.
8+
* Require Dart 3.5.
9+
10+
## 1.3.1
11+
12+
* Populate the pubspec `repository` field.
13+
14+
## 1.3.0
15+
16+
* `FakeTimer.tick` will return a value instead of throwing.
17+
* `FakeAsync.includeTimerStackTrace` allows controlling whether timers created
18+
with a FakeAsync will include a creation Stack Trace.
19+
20+
## 1.2.0
21+
22+
* Stable release for null safety.
23+
24+
## 1.2.0-nullsafety.3
25+
26+
* Update SDK constraints to `>=2.12.0-0 <3.0.0` based on beta release
27+
guidelines.
28+
29+
## 1.2.0-nullsafety.2
30+
31+
* Allow prerelease versions of the 2.12 sdk.
32+
33+
## 1.2.0-nullsafety.1
34+
35+
* Allow 2.10 stable and 2.11.0 dev SDK versions.
36+
37+
## 1.2.0-nullsafety
38+
39+
Pre-release for the null safety migration of this package.
40+
41+
Note that `1.2.0` may not be the final stable null safety release version,
42+
we reserve the right to release it as a `2.0.0` breaking change.
43+
44+
This release will be pinned to only allow pre-release sdk versions starting
45+
from `2.10.0-0`.
46+
47+
## 1.1.0
48+
49+
* Exposed the `FakeTimer` class as a public class.
50+
* Added `FakeAsync.pendingTimers` which gives access to all pending timers at
51+
the time of the call.
52+
53+
## 1.0.2
54+
55+
* Update min SDK to 2.2.0
56+
57+
## 1.0.1
58+
59+
* Update to lowercase Dart core library constants.
60+
* Fix use of deprecated `isInstanceOf` matcher.
61+
62+
## 1.0.0
63+
64+
This release contains the `FakeAsync` class that was defined in [`quiver`][].
65+
It's backwards-compatible with both the `quiver` version *and* the old version
66+
of the `fake_async` package.
67+
68+
[`quiver`]: https://pub.dev/packages/quiver
69+
70+
### New Features
71+
72+
* A top-level `fakeAsync()` function was added that encapsulates
73+
`new FakeAsync().run(...)`.
74+
75+
### New Features Relative to `quiver`
76+
77+
* `FakeAsync.elapsed` returns the total amount of fake time elapsed since the
78+
`FakeAsync` instance was created.
79+
80+
* `new FakeAsync()` now takes an `initialTime` argument that sets the default
81+
time for clocks created with `FakeAsync.getClock()`, and for the `clock`
82+
package's top-level `clock` variable.
83+
84+
### New Features Relative to `fake_async` 0.1
85+
86+
* `FakeAsync.periodicTimerCount`, `FakeAsync.nonPeriodicTimerCount`, and
87+
`FakeAsync.microtaskCount` provide visibility into the events scheduled within
88+
`FakeAsync.run()`.
89+
90+
* `FakeAsync.getClock()` provides access to fully-featured `Clock` objects based
91+
on `FakeAsync`'s elapsed time.
92+
93+
* `FakeAsync.flushMicrotasks()` empties the microtask queue without elapsing any
94+
time or running any timers.
95+
96+
* `FakeAsync.flushTimers()` runs all microtasks and timers until there are no
97+
more scheduled.
98+
99+
## 0.1.2
100+
101+
* Integrate with the clock package.
102+

‎pkgs/fake_async/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎pkgs/fake_async/README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
[![pub package](https://img.shields.io/pub/v/fake_async.svg)](https://pub.dev/packages/fake_async)
2+
[![package publisher](https://img.shields.io/pub/publisher/fake_async.svg)](https://pub.dev/packages/fake_async/publisher)
3+
4+
This package provides a [`FakeAsync`][] class, which makes it easy to
5+
deterministically test code that uses asynchronous features like `Future`s,
6+
`Stream`s, `Timer`s, and microtasks. It creates an environment in which the user
7+
can explicitly control Dart's notion of the "current time". When the time is
8+
advanced, `FakeAsync` fires all asynchronous events that are scheduled for that
9+
time period without actually needing the test to wait for real time to elapse.
10+
11+
[`FakeAsync`]: https://www.dartdocs.org/documentation/fake_async/latest/fake_async/FakeAsync-class.html
12+
13+
For example:
14+
15+
```dart
16+
import 'dart:async';
17+
18+
import 'package:fake_async/fake_async.dart';
19+
import 'package:test/test.dart';
20+
21+
void main() {
22+
test("Future.timeout() throws an error once the timeout is up", () {
23+
// Any code run within [fakeAsync] is run within the context of the
24+
// [FakeAsync] object passed to the callback.
25+
fakeAsync((async) {
26+
// All asynchronous features that rely on timing are automatically
27+
// controlled by [fakeAsync].
28+
expect(Completer().future.timeout(Duration(seconds: 5)),
29+
throwsA(isA<TimeoutException>()));
30+
31+
// This will cause the timeout above to fire immediately, without waiting
32+
// 5 seconds of real time.
33+
async.elapse(Duration(seconds: 5));
34+
});
35+
});
36+
}
37+
```
38+
39+
## Integration With `clock`
40+
41+
`FakeAsync` can't control the time reported by [`DateTime.now()`][] or by
42+
the [`Stopwatch`][] class, since they're not part of `dart:async`. However, if
43+
you create them using the [`clock`][] package's [`clock.now()`][] or
44+
[`clock.stopwatch()`][] functions, `FakeAsync` will automatically override
45+
them to use the same notion of time as `dart:async` classes.
46+
47+
[`DateTime.now()`]: https://api.dart.dev/stable/dart-core/DateTime/DateTime.now.html
48+
[`Stopwatch`]: https://api.dart.dev/stable/dart-core/Stopwatch-class.html
49+
[`clock`]: https://pub.dev/packages/clock
50+
[`clock.now()`]: https://pub.dev/documentation/clock/latest/clock/Clock/now.html
51+
[`clock.stopwatch()`]: https://pub.dev/documentation/clock/latest/clock/Clock/stopwatch.html

0 commit comments

Comments
 (0)