Skip to content
This repository was archived by the owner on Jun 10, 2025. It is now read-only.

Commit 62fee50

Browse files
authored
Minor updates (#876)
Tidy up a few things following 0.41.0 review comments
2 parents d1ca89b + 948215e commit 62fee50

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

src/markdown-pages/docs/manage-ecosystem/runs-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Use the tables provided to view the options for filtering test results, and for
2121
| `--result` | Use the [`--result` option](#result) to return test runs based on test run results. You can select more than one result by using a comma-separated list. The `--result` flag cannot be used in conjunction with the `--active` flag. The two flags are mutually exclusive. |
2222
| `--active` | Use the `--active` option to query tests that have not finished, so that you can quickly see which tests are currently running. The `--active` flag cannot be used in conjunction with the `--result` flag. The two flags are mutually exclusive.|
2323
| `--group` | Use the `--group` flag to get all the test runs associated with the given group name. A custom group name can be assigned to a set of test runs when submitting tests using the [galasactl runs submit](./ecosystem-cli-runs-submit) command, otherwise a random group name will be assigned. `--group` can be used with other flags, like `--age`, `--requestor`, and `--result`, to filter test runs as desired, but it cannot be used alongside the `--name` flag. |
24-
| `--tags` | Use the `--tags` flag to get all the test runs that have the given test tags assigned to them. A custom set of tags can be assigned to a set of test runs when submitting tests using the [galasactl runs submit](./ecosystem-cli-runs-submit) command. `--tags` can be used with other flags, like `--age`, `--requestor`, and `--result`, to filter test runs as desired. Multiple tags can be supplied by either providing `--tags` with a comma-separated list of tags (e.g. `--tags tag1,tag2,tag3`) or by providing multiple `--tags` flags separately (e.g. `--tags tag1 --tags tag2 --tags tag3`). |
24+
| `--tags` | Use the `--tags` flag to get all the test runs that have test tags assigned to them. A custom set of tags can be assigned to a set of test runs when submitting tests using the [galasactl runs submit](./ecosystem-cli-runs-submit) command. `--tags` can be used with other flags, like `--age`, `--requestor`, and `--result`, to filter test runs. Multiple tags can be supplied by either providing `--tags` with a comma-separated list of tags (e.g. `--tags tag1,tag2,tag3`) or by providing multiple `--tags` flags separately (e.g. `--tags tag1 --tags tag2 --tags tag3`). |
2525

2626
<b>Table 2:</b> The following table shows the options that you can set on the `galasactl runs get` command to display test run results in different formats:
2727

src/markdown-pages/docs/writing-own-tests/test-result-provider.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ title: "Controlling code execution after test failure"
55

66
As a tester, you may want the ability to access the result so far of a Galasa test at different points during the test lifecycle, to control the execution of code based on that result.
77

8-
The `ITestResultProvider` can be used to get the test result so far after the first method invokation in a test. It can give you access to if the test is in Passed or Failed state. You can then check the result so far in your test code and choose to call or not call non-test methods based on this.
8+
The `ITestResultProvider` can be used to get the test result so far after the first method invocation in a test.
9+
It can give you access to if the test is in Passed or Failed state.
10+
You can use the state of the test (Passed or Failed) to control how non-test code is run.
911

1012
The annotation `@TestResultProvider` injects a `ITestResultProvider` object into your test class. The Core Manager updates the provider with the test result so far after each `@BeforeClass`, `@Before`, `@Test`, `@After` and `@AfterClass` method.
1113

@@ -16,7 +18,9 @@ To use this capability, simply include the lines of code below in your test:
1618
public ITestResultProvider testResultProvider;
1719
```
1820

19-
In the example below, the `@AfterClass` method retrieves the result from the `ITestResultProvider` and checks if it is Failed. If the result is Failed, the method `myCustomCleanupMethod` is called which could contain some diagnostic collection or clean up of resources, which the tester only wants to be run if the test Failed.
21+
In the example below, the `@AfterClass` method retrieves the result from the `ITestResultProvider` and checks if it is Failed.
22+
If the result is Failed, the method `myCustomCleanupMethod` is called.
23+
Running the `myCustomCleanupMethod` generates additional information to help diagnose the cause of the failure and cleans up resources.
2024

2125
```java
2226
@AfterClass
@@ -28,7 +32,7 @@ public void afterClassMethod() throws FrameworkException {
2832

2933
private void myCustomCleanupMethod() {
3034
try {
31-
// Some custom cleanup logic that only happens on failures.
35+
// Custom diagnostic collection and cleanup logic that only happens on failures.
3236
} catch(Exception ex) {
3337
logger.error("Failing while cleaning up in myCustomCleanupMethod()");
3438
// Ignore the problem.

src/markdown-pages/highlights.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ Access the Galasa source code in [GitHub](https://github.com/galasa-dev) and ope
5353

5454
- Managers vetoing method execution changes:
5555

56-
- Managers implementing anyReasonTestMethodShouldBeIgnored will not be called to see whether the manager wants to veto the execution of @Before or @After methods separately to the test method they surround. Managers will only be asked whether the test method should be ignored or not, which will cause the "before" and "after" methods to also be ignored.
56+
- Managers implementing `anyReasonTestMethodShouldBeIgnored` are no longer asked whether the test method should be ignored before running the `@Before` and `@After` methods. If the test method is ignored, then the `@Before` and `@After` methods are also ignored.
5757

5858
- Tests can find out if the test has failed yet:
5959

6060
- Test code can ask for a TestStatus provider to be injected into their object. This can be used to find out if the test has failed yet or not, and can be useful when doing complex cleanup of resources allocated during the test.
6161

62-
- 3270 manager now copes with SSCP-LU-DATA:
62+
- 3270 Manager can now process SSCP-LU-DATA:
6363

64-
- Unformatted data screens are now processed and the contents is visible to test applications.
64+
- Unformatted data screens are processed and the contents made available to test applications.
6565

6666
- @ContinueOnTestFailure annotations:
6767

0 commit comments

Comments
 (0)