Skip to content

Commit 0385a99

Browse files
bjuricbjuric
committed
Examples Implicits
1 parent f09188e commit 0385a99

File tree

2 files changed

+242
-1
lines changed

2 files changed

+242
-1
lines changed

‎docs/05-annotations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Use annotations in [meta](/docs/meta) and avoid them in features where possible.
3535
| [`@Parallel`](/docs/parallel#parallel-scenario-outline-examples) | Examples | [v3.69.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.69.0) | Executes expanded examples in outlines in parallel |
3636
| [`@Timeout`](/docs/locator-level-timeouts#timeout-annotations) | Step | [v3.73.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.73.0) | Specifies a timeout period on a [wait](/docs/dsl#sleeps-and-waits), [until/while](/docs/dsl#untilwhile), [for each](/docs/dsl#foreach), [assertion](/docs/dsl#assertions) or [locator](/docs/dsl#element-locators) DSL step. Examples: `@Timeout('10s')`, `@Timeout('2m30s')`, `@Timeout('2m')` |
3737
| [`@Delay`](/docs/locator-level-timeouts#delay-annotation) | Step | [v3.73.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.73.0) | Specifies a delay interval on a [wait](/docs/dsl#sleeps-and-waits), [until/while](/docs/dsl#untilwhile) DSL step. Examples: `@Delay('2s')`, `@Delay('1s500ms')`, `@Delay('1m')` |
38-
| [`@Results`](/docs/reports/csv#results-annotation) | Feature<br/>Rule</b>Scenario<br/>StepDef<br/>Scenario Outline<br/>Examples | [v3.77.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0) | Generates CSV results for a gherkin node |
38+
| [`@Results`](/docs/reports/csv#results-annotation) | Feature<br/>Rule<br/>Scenario<br/>StepDef<br/>Scenario Outline<br/>Examples | [v3.77.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0) | Generates CSV results for a gherkin node |
3939
| `@Trim` | Step | [v3.62.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.62.0) | Trims strings when performing comparison operations |
4040
| `@IgnoreCase` | Step | [v3.62.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.62.0) | Ignores case when performing comparison operations |
4141
| `@Ignore` | Feature<br/>Scenario<br/>Rule<br/>Background<br/>Examples | [v1.0.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v1.0.0) | Ignores and skips over a Gherkin block/node to avoid evaluation |

‎docs/15-implicit-values.mdx

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -896,6 +896,247 @@ The following values are implicitly available to all feature and meta files at r
896896
</div>
897897
</details>
898898

899+
## Examples Level
900+
901+
<details id="gwen-examples-name">
902+
<summary class="setting">
903+
904+
```properties
905+
gwen.examples.name
906+
```
907+
<p>The current examples name (as specified in Examples clause).</p>
908+
909+
</summary>
910+
911+
<div class="grid-3">
912+
<div><Link to="#gwen-examples-name">Link</Link></div>
913+
<div align="center"></div>
914+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
915+
</div>
916+
</details>
917+
918+
<details id="gwen-examples-eval-status-keyword">
919+
<summary class="setting">
920+
921+
```properties
922+
gwen.examples.eval.status.keyword
923+
```
924+
<p>The current examples level evaluation status (<code>Pending</code>, <code>Passed</code> or <code>Failed</code>).</p>
925+
926+
</summary>
927+
928+
<div class="grid-3">
929+
<div><Link to="#gwen-examples-eval-status-keyword">Link</Link></div>
930+
<div align="center"></div>
931+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
932+
</div>
933+
</details>
934+
935+
<details id="gwen-examples-eval-status-keyword-upperCased">
936+
<summary class="setting">
937+
938+
```properties
939+
gwen.examples.eval.status.keyword.upperCased
940+
```
941+
<p>The current examples level evaluation status in upper case (<code>PENDING</code>, <code>PASSED</code> or <code>FAILED</code>).</p>
942+
943+
</summary>
944+
945+
<div class="grid-3">
946+
<div><Link to="#gwen-examples-eval-status-keyword-upperCased">Link</Link></div>
947+
<div align="center"></div>
948+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
949+
</div>
950+
</details>
951+
952+
<details id="gwen-examples-eval-status-keyword-lowerCased">
953+
<summary class="setting">
954+
955+
```properties
956+
gwen.examples.eval.status.keyword.lowerCased
957+
```
958+
<p>The current examples level evaluation status in lower case (<code>pending</code>, <code>passed</code> or <code>failed</code>).</p>
959+
960+
</summary>
961+
962+
<div class="grid-3">
963+
<div><Link to="#gwen-examples-eval-status-keyword-lowerCased">Link</Link></div>
964+
<div align="center"></div>
965+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
966+
</div>
967+
</details>
968+
969+
<details id="gwen-examples-eval-status-isPassed">
970+
<summary class="setting">
971+
972+
```properties
973+
gwen.examples.eval.status.isPassed
974+
```
975+
<p><code>true</code> if the current examples level evaluation status is not <code>Failed</code>, <code>false</code> otherwise.</p>
976+
977+
</summary>
978+
979+
<div class="grid-3">
980+
<div><Link to="#gwen-examples-eval-status-isPassed">Link</Link></div>
981+
<div align="center"></div>
982+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
983+
</div>
984+
</details>
985+
986+
<details id="gwen-examples-eval-status-isFailed">
987+
<summary class="setting">
988+
989+
```properties
990+
gwen.examples.eval.status.isFailed
991+
```
992+
<p><code>true</code> if examples level the current evaluation status is <code>Failed</code>, <code>false</code> otherwise.</p>
993+
994+
</summary>
995+
996+
<div class="grid-3">
997+
<div><Link to="#gwen-examples-eval-status-isFailed">Link</Link></div>
998+
<div align="center"></div>
999+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1000+
</div>
1001+
</details>
1002+
1003+
<details id="gwen-examples-eval-status-message">
1004+
<summary class="setting">
1005+
1006+
```properties
1007+
gwen.examples.eval.status.message
1008+
```
1009+
<p>The current examples level evaluation status message if the evaluation status is <code>Failed</code>, blank otherwise.</p>
1010+
1011+
</summary>
1012+
1013+
<div class="grid-3">
1014+
<div><Link to="#gwen-examples-eval-status-message">Link</Link></div>
1015+
<div align="center"></div>
1016+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1017+
</div>
1018+
</details>
1019+
1020+
<details id="gwen-examples-eval-status-message-escaped">
1021+
<summary class="setting">
1022+
1023+
```properties
1024+
gwen.examples.eval.status.message.escaped
1025+
```
1026+
<p>The current examples level evaluation status message with all new line and special characters escaped (using Java escaping rules). Non blank if the evaluation status is <code>Failed</code>, blank otherwise.</p>
1027+
1028+
</summary>
1029+
1030+
<div class="grid-3">
1031+
<div><Link to="#gwen-examples-eval-status-message-escaped">Link</Link></div>
1032+
<div align="center"></div>
1033+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1034+
</div>
1035+
</details>
1036+
1037+
<details id="gwen-examples-eval-status-message-csvescaped">
1038+
<summary class="setting">
1039+
1040+
```properties
1041+
gwen.examples.eval.status.message.csvEscaped
1042+
```
1043+
<p>The current examples level evaluation status message escaped for CSV. Non blank if the evaluation status is <code>Failed</code>, blank otherwise.</p>
1044+
1045+
</summary>
1046+
1047+
<div class="grid-3">
1048+
<div><Link to="#gwen-examples-eval-status-message-csvescaped">Link</Link></div>
1049+
<div align="center"></div>
1050+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1051+
</div>
1052+
</details>
1053+
1054+
1055+
<details id="gwen-examples-eval-started">
1056+
<summary class="setting">
1057+
1058+
```properties
1059+
gwen.examples.eval.started
1060+
```
1061+
<p>The date and time when the Examples started (in format of default locale)</p>
1062+
1063+
</summary>
1064+
1065+
<div class="grid-3">
1066+
<div><Link to="#gwen-examples-eval-started">Link</Link></div>
1067+
<div align="center"></div>
1068+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1069+
</div>
1070+
</details>
1071+
1072+
<details id="gwen-examples-eval-finished">
1073+
<summary class="setting">
1074+
1075+
```properties
1076+
gwen.examples.eval.finished
1077+
```
1078+
<p>The date and time when the Examples finished (in format of default locale)</p>
1079+
1080+
</summary>
1081+
1082+
<div class="grid-3">
1083+
<div><Link to="#gwen-examples-eval-finished">Link</Link></div>
1084+
<div align="center"></div>
1085+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1086+
</div>
1087+
</details>
1088+
1089+
<details id="gwen-examples-eval-duration">
1090+
<summary class="setting">
1091+
1092+
```
1093+
gwen.examples.eval.duration
1094+
```
1095+
<p>Provides access the elapsed duration since the beginning of an examples execution in human readable format. Example: 12s 345ms</p>
1096+
1097+
</summary>
1098+
1099+
<div class="grid-3">
1100+
<div><Link to="#gwen-examples-eval-duration">Link</Link></div>
1101+
<div align="center"></div>
1102+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1103+
</div>
1104+
</details>
1105+
1106+
<details id="gwen-examples-eval-duration-msecs">
1107+
<summary class="setting">
1108+
1109+
```
1110+
gwen.examples.eval.duration.msecs
1111+
```
1112+
<p>Provides access the elapsed duration since the beginning of an examples execution in milliseconds.</p>
1113+
1114+
</summary>
1115+
1116+
<div class="grid-3">
1117+
<div><Link to="#gwen-examples-eval-duration-msecs">Link</Link></div>
1118+
<div align="center"></div>
1119+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1120+
</div>
1121+
</details>
1122+
1123+
<details id="gwen-examples-eval-duration-secs">
1124+
<summary class="setting">
1125+
1126+
```
1127+
gwen.examples.eval.duration.secs
1128+
```
1129+
<p>Provides access the elapsed duration since the beginning of an examples execution in seconds.</p>
1130+
1131+
</summary>
1132+
1133+
<div class="grid-3">
1134+
<div><Link to="#gwen-examples-eval-duration-secs">Link</Link></div>
1135+
<div align="center"></div>
1136+
<div align="right">Since <Link to="https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0">v3.77.0</Link></div>
1137+
</div>
1138+
</details>
1139+
8991140
## StepDef Level
9001141

9011142
<details id="gwen-stepDef-name">

0 commit comments

Comments
 (0)