Skip to content

Commit

Permalink
fix(uat): add a new command to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
auarbekov authored and bgklika committed Jul 31, 2023
1 parent 116d4ce commit 3736486
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions uat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,33 +125,33 @@ Dtest.log.path - path where you would like the test results to be stored.
### Tags
-Dtags can be extended if you would like to test exact scenarios or exclude some scenarios:

@GGMQ - to start all GGMQ test scenarios run
@GGMQ - to start all GGMQ test scenarios run.\
Example:
```bash
sudo -E java -Dggc.archive=greengrass-nucleus-latest.zip -Dtest.log.path=logs -Dtags="@GGMQ" -jar testing-features/target/client-devices-auth-testing-features.jar
```

To choose running of specific tests using the following tags:

@sdk-java, @mosquitto-c, @paho-java, @paho-python - to choose client to run test scenarios
@sdk-java, @mosquitto-c, @paho-java, @paho-python - to choose client to run test scenarios.\
Example:
```bash
sudo -E java -Dggc.archive=greengrass-nucleus-latest.zip -Dtest.log.path=logs -Dtags="@GGMQ and @sdk-java" -jar testing-features/target/client-devices-auth-testing-features.jar
```

@mqtt3, @mqtt5 - to choose protocol version for test scenarios
@mqtt3, @mqtt5 - to choose protocol version for test scenarios.\
Example:
```bash
sudo -E java -Dggc.archive=greengrass-nucleus-latest.zip -Dtest.log.path=logs -Dtags="@GGMQ and @mqtt5" -jar testing-features/target/client-devices-auth-testing-features.jar
```

@GGMQ-1-T(scenario number) - to specify scenario number that should be run
@GGMQ-1-T(scenario number) - to specify scenario number that should be run.\
Example:
```bash
sudo -E java -Dggc.archive=greengrass-nucleus-latest.zip -Dtest.log.path=logs -Dtags="@GGMQ-1-T1" -jar testing-features/target/client-devices-auth-testing-features.jar
```

@SkipOnWindows - to skip clients or tests that are not supported by Windows
@SkipOnWindows - to skip clients or tests that are not supported by Windows.\
Example:
```
java -Dggc.archive=greengrass-nucleus-latest.zip -Dtest.log.path=logs -Dtags="@GGMQ and not @SkipOnWindows" -jar testing-features/target/client-devices-auth-testing-features.jar
Expand All @@ -169,14 +169,15 @@ sudo -E java -Dggc.archive=greengrass-nucleus-latest.zip -Dtest.log.path=logs -D
Due to scenario usually requires upload/download artifacts to S3, create and delete roles, policies, do Greengrass discovery and so one please ensure CodeBuild instance has enough AWS permissions to do that.
For more information please read [Create a CodeBuild service role](https://docs.aws.amazon.com/codebuild/latest/userguide/setting-up.html#setting-up-service-role)

## Limitations
MQTT clients based on IoT Device SDK for Java v2, mosquitto C, Paho Java, Paho Python do no provide API to get information from PUBREC/PUBREL/PUBCOMP packages used when messages published with QoS 2.

Not all features of MQTT v5.0 have been implemented in clients and are supported by gRPC proto and the control as was requested, these are not bugs but designed by requirement.

### Generate html-documentation from JavaDoc
## Generate html-documentation from JavaDoc
To generate html-documentation from JavaDoc, run the following command from the uat directory of the project:
```bash
mvn -ntp -U clean install
mvn javadoc:javadoc
```
The main html-file will be located in each module by path **~/target/site/apidocs/index.html**
The main html-file will be located in each module by path **target/site/apidocs/index.html**

## Limitations
MQTT clients based on IoT Device SDK for Java v2, mosquitto C, Paho Java, Paho Python do no provide API to get information from PUBREC/PUBREL/PUBCOMP packages used when messages published with QoS 2.

Not all features of MQTT v5.0 have been implemented in clients and are supported by gRPC proto and the control as was requested, these are not bugs but designed by requirement.

0 comments on commit 3736486

Please sign in to comment.