@@ -9,7 +9,8 @@ the persistence layer, and input from the watch stream. The spec tests fake all
9
9
of these. Since these external events are asynchronous in nature, in the real
10
10
world there is some non-determinism in the ordering of events. The spec tests
11
11
allow these orderings to be specified explicitly, enabling orderings that are
12
- difficult or impossible to force when connected to a real backend.
12
+ difficult or impossible to force when connected to a real backend. In addition,
13
+ when running under Node, the IndexedDb persistence layer is faked.
13
14
14
15
The Firestore Spec Tests are portable and must be kept in sync between the Web
15
16
SDK (this SDK), Android SDK, and iOS SDK. The Web SDK contains the authoritative
@@ -22,10 +23,19 @@ The spec tests are part of the unit test suite of each SDK. Therefore, to run
22
23
the spec tests simply run the entire unit test suite and the spec tests will be
23
24
executed as a part of it.
24
25
25
- For example, in the Web SDK (this SDK), the best way to run the spec tests is
26
- via the Intellij IDEA IDE. After following the instructions to set up IntelliJ
27
- in [ CONTRIBUTING.md] ( ../../../CONTRIBUTING.md ) , run the "Unit Tests" Run
28
- Configuration, which will include the spec tests.
26
+ ## Test Tags
27
+
28
+ Each spec test can specify zero or many "tags" that influence the test's
29
+ execution. Some of the commonly-used tags are documented here; see
30
+ [ describe_spec.ts] ( describe_spec.ts ) for the full set of supported tags.
31
+
32
+ - ` exclusive ` - Only run this spec test and skip all others. It can be useful
33
+ to apply this tag to a test while it is under active development or debugging.
34
+ Tests should never be checked into source control with this tag.
35
+
36
+ - ` no-android ` and ` no-ios ` - Do not run this spec test on Android and/or iOS,
37
+ respectively. It may be useful to specify these tags if the functionality has
38
+ not been or never will be ported to these platforms.
29
39
30
40
## Exporting the Tests
31
41
0 commit comments