Add neo properties chapter #278
Conversation
There was a problem hiding this comment.
I checked the quick start guide and added some comments, please take care @RobertAvemarg
|
|
||
| * as JUnit test via IDE | ||
| * `mvn clean test` for all tests | ||
| * `mvn clean test -Dtest=<NameOfTestClass>` for specific tests |
There was a problem hiding this comment.
please add how to run a single test method
|
|
||
| ### Generate Reports | ||
|
|
||
| * `mvn allure:serve` to generate and show the report |
There was a problem hiding this comment.
maybe a line to run tests AND generate a report (just for copy and past purposes)
|
|
||
| ## Useful Annotations | ||
|
|
||
| ### Test JUnit5 |
|
|
||
| `@NeodymiumTest` - on test methods | ||
|
|
||
| ### Test JUnit4 |
|
|
||
| Methods can have multiple `@DataSet()` annotations | ||
|
|
||
| * `@DataSet("<dataSetId>")` - limit method to data set with defined id |
There was a problem hiding this comment.
That won't work, you have to use @DataSet(id="<dataSetId>")
|
|
||
| {{< TODO >}}check if the info boxes are useful and move them to a good position{{< /TODO >}} | ||
|
|
||
| {{% note title="most common browser properties" %}} |
There was a problem hiding this comment.
nice look and feel, but still maybe a bit much for the sake of this quick start, also you have an additional chapter about configs below.
| tests are annotated, so the Neodymium default browser is used. To execute all tests with every configured browser, | ||
| we annotate the AbstractTest class with `@Browser("<browserId>")` for each browser. Individual test methods within a | ||
| class can also be run with different browsers by annotating them with `@Browser("<browserId>")` or all browsers can be | ||
| suppressed using `@SuppressBrowsers`. |
There was a problem hiding this comment.
remove the SuppressBrowsers part
| import com.xceptance.neodymium.util.Neodymium; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| @Browser |
There was a problem hiding this comment.
remove the default browser?
| configurations, `dev-*.properties` files can be used to override or add values. It is crucial to exclude these files | ||
| from version control to avoid unintended consequences for CI/CD and commiting secrets. Temporary property files can be | ||
| created during test execution using | ||
| `ConfigFactory.setProperty(Neodymium.TEMPORARY_CONFIG_FILE_PROPERTY_NAME, "file:" + fileLocation);` within a |
There was a problem hiding this comment.
the temp config file name is mostly for unit tests isn't it?
| recording is added to the Allure report. Otherwise, it's only added if appendAllRecordingsToAllureReport is set to | ||
| `true`. | ||
|
|
||
| ## Accessibility |
No description provided.