forked from jboss-eap-qe/eap-microprofile-test-suite
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fixes jboss-eap-qe#61 fixes jboss-eap-qe#105 fixes jboss-eap-qe#139 fixes jboss-eap-qe#140
- Loading branch information
1 parent
b57ea0b
commit bcd353d
Showing
7 changed files
with
133 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| ## Contributing | ||
| Standard PR workflow - [link](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) | ||
|
|
||
| ## Structure of the testsuite | ||
| Group all tests for given MP spec into single module | ||
| * for example to group all tests for MP Metric together | ||
| * in case that tests for integration of multiple MP specs are developed and it's not clear to which module they belong then new module can be created. Preferable a name of such module should reflect MP specs. | ||
|
|
||
| Tooling should be in separate module so it is isolated and easily used by other (test) modules. | ||
| Try to add tooling to existing module. | ||
| If there is no module that reflect tooling purpose you can create new module. | ||
| The name **must** include `tooling-` prefix. | ||
|
|
||
| Rather than add new dependency try to extend existing tooling or add new one yet still consider the trade-off. | ||
|
|
||
| Examples of available tooling: | ||
| * tooling-cpu-load | ||
| * tooling-docker | ||
| * tooling-server-configuration | ||
|
|
||
| **In order to configure and manage server you need to use tooling-server-configuration and Creaper core library, see [the module description](tooling-server-configuration/README.md)** | ||
|
|
||
| ## Test documentation | ||
| For documentation and test plan purposes use following annotations for each test to properly document its purpose, passing criteria and version of EAP since a test is valid from: | ||
| ``` | ||
| /** | ||
| * @tpTestDetails __PUT TEST DETAILS__ | ||
| * @tpPassCrit __PUT PASSING CRITERIA__ | ||
| * @tpSince __VERSION OF WILDFLY/EAP WITH A FEATURE__ | ||
| */ | ||
| ``` | ||
|
|
||
| ## Coding conventions | ||
| To enforce common codestyle the testsuite uses formatter plugin which automatically formats a code. To run it manually run `mvn -B formatter:validate impsort:check`. | ||
|
|
||
| ## Another best practices | ||
| To get arquillian properties such ach server address and so on, use: | ||
| ``` | ||
| ArquillianContainerProperties arqProps = new ArquillianContainerProperties( | ||
| ArquillianDescriptorWrapper.getArquillianDescriptor()); | ||
| arqProps.getDefaultManagementAddress(); | ||
| ``` | ||
|
|
||
| To validate server functionality via REST point use restassured library: | ||
| * if possible import statically `get()`, `given()`,... method | ||
| * use one `baseUri()` with fully-qualified URL instead of | ||
| ``` | ||
| .baseUri(...) | ||
| .port(...) | ||
| .basePath(...) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Module description | ||
| Module contains classes for configuring and managing server. | ||
|
|
||
| ## Creaper | ||
|
|
||
| Creaper core library [link](https://github.com/wildfly-extras/creaper) is meant to be used to configure and manage server. | ||
| To get `OnlineManagementClient` you can use `ManagementClientProvider` class. | ||
| The class reads Arquillian configuration autimatically. | ||
|
|
||
| ## Configure server | ||
|
|
||
| To achieve desired configuration of server you can implement `MicroProfileServerSetupTask` that extends `ServerSetupTask` interface and annotate testclass with `@ServerSetup` annotation. | ||
| The setup task in invoked after Arquillian observers and before a deployment is deployed. | ||
| The interface provides two methods: | ||
| * setup(): implement desired changes | ||
| * teardown(): restore and rollback changes | ||
|
|
||
| If you need to configure a server see [Creaper section](#Creaper) to get a instance of `OnlineManagementClient` | ||
|
|
||
| ## Logging | ||
|
|
||
| Module also contains tooling for checking server log files - `ModelNodeLogChecker`. |