Skip to content

Commit

Permalink
Add documentation for new name/string/text and comparison assertions,…
Browse files Browse the repository at this point in the history
… and for parameter soft object references.
  • Loading branch information
npruehs committed May 18, 2020
1 parent 68dc6bd commit 5853497
Show file tree
Hide file tree
Showing 12 changed files with 6 additions and 2 deletions.
Binary file added Documentation/AssertCompareByte.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/AssertCompareFloat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/AssertCompareInteger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/AssertCompareInteger64.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/AssertEqualName.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/AssertEqualString.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/AssertEqualText.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/AssertNotEqualName.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/AssertNotEqualString.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/AssertNotEqualText.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions Documentation/Assertions.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,13 @@ Daedalic Test Automation Plugin comes with the following assertion nodes for use
| Node | Description |
| --- | --- |
| ![Assert Not Equal (Byte)](AssertNotEqualByte.png) | Expects the specified bytes not to be equal. |
| ![Assert Compare (Byte)](AssertCompareByte.png) | Compares the specified bytes for order. |
| ![Assert Not Equal (Integer)](AssertNotEqualInteger.png) | Expects the specified 32-bit integers not to be equal. |
| ![Assert Compare (Integer)](AssertCompareInteger.png) | Compares the specified 32-bit integers for order. |
| ![Assert Not Equal (Integer64)](AssertNotEqualInteger64.png) | Expects the specified 64-bit integers not to be equal. |
| ![Assert Compare (Integer64)](AssertCompareInteger64.png) | Compares the specified 64-bit integers for order. |
| ![Assert Not Equal (Float)](AssertNotEqualFloat.png) | Expects the specified floats not to be equal. |
| ![Assert Compare (Float)](AssertCompareFloat.png) | Compares the specified floats for order. |
| ![Assert Not Equal (Name)](AssertNotEqualName.png) | Expects the specified names not to be equal. |
| ![Assert Not Equal (String)](AssertNotEqualString.png) | Expects the specified strings not to be equal. |
| ![Assert Not Equal (Text)](AssertNotEqualText.png) | Expects the specified texts not to be equal. |
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,11 @@ After creating your test suite blueprint, you can add instances of that blueprin

In case you want to run the same test multiple times with just slightly different configurations, Daedalic Test Automation Plugin offers _parameterized tests_. You can specify any number of parameters for your test instance (or blueprint).

In order to provide a consistent test API, these parameters have to be of type UObject, so if you have any other type you want to pass in as parameter, you'll need to wrap them with an UObject. Using UObject parameters also enables you to reference other actors in your test level.
In order to provide a consistent test API, these parameters have to be of type UObject, so if you have any other type you want to pass in as parameter, you'll need to wrap them with an UObject. Using UObject parameters also enables you to reference other actors in your test level. We're using soft references to the parameter objects, enabling you to reference actors from other streaming levels as well.

![Parameterized Test](Documentation/ParameterizedTest.png)

The parameter will be passed to all test events, where you can perform your test actions on them:
The parameter references will be resolved and passed to all test events, where you can perform your test actions on them:

![Test Parameter](Documentation/TestParameter.png)

Expand Down

0 comments on commit 5853497

Please sign in to comment.