Skip to content

Document all three account provisioning methods #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 26, 2025
Merged

Document all three account provisioning methods #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions _documentation/bamboo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,14 @@ The Build JDK that is selected needs to be Java 11 or higher.

To interact with the server, fill out the IP address (or hostname) of the server that was started in the previous job. Also provide the name of the XMPP domain that is serviced by that server. When the server is running on local hardware, then there should not be a reason to increase the default timeout value.

The tests are executed using dedicated accounts. These accounts are created by the test framework in one of two ways:
The tests are executed using dedicated accounts. These accounts are created by the test framework in one of three ways:
- by using an administrative account (per [XEP-0133](https://xmpp.org/extensions/xep-0133.html))
- by explicitly providing three accounts
- using in-band registration (per [XEP-0077](https://xmpp.org/extensions/xep-0077.html))

If the former method is desired, then you should provide the credentials of an administrative user in the task configuration. When these credentials are not provided, then the latter method will be used to provision test accounts.
If the first method is desired, then you should provide the credentials of an administrative user in the task configuration. Alternatively, three sets of test accounts can be provided. When none of these credentials are provided, then the last method will be used to provision test accounts.

For more information on provisioning accounts, consult the ['Test Account Provisioning' guide](/documentation/provisioning-accounts).

Finally, you can control the tests that are to be attempted. You can provide a comma-separated list of tests that are to be skipped (For example: `EntityCapsTest,SoftwareInfoIntegrationTest`), or specifications (not case-sensitive) that are to be skipped (For example: `XEP-0045,XEP-0060`). Conversely, you can limit the run tests by providing a comma-separated list of tests or specifications to enabled (for example, for quick tests of refactored functionality, or to test functionality offered in a server with a plugin architecture). If both the enabled and disabled lists are provided, then tests will only run that match the enabled list, and are not in the disabled list. For more information on enabling and disabling tests, consult [this guide](/documentation/selecting-tests).

Expand Down
25 changes: 7 additions & 18 deletions _documentation/circleci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,24 +166,13 @@ usage:

## Configuration

Various options are available when calling _xmpp_interop_tests_action_, and whilst none of them are absolutely required, the defaults are unlikely to be perfect for everyone.

| Option | Description | Default value |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
| host | IP address or DNS name of the XMPP service to run the tests on. | 127.0.0.1 |
| domain | the XMPP domain name of server under test. | example.org |
| timeout | the amount of milliseconds after which an XMPP action (typically an IQ request) is considered timed out. | 5000 (five seconds) |
| adminAccountUsername | (optional) The account name of a pre-existing user that is allowed to create other users, per [XEP-0133](https://xmpp.org/extensions/xep-0133.html). If not provided, in-band registration ([XEP-0077](https://xmpp.org/extensions/xep-0077.html)) will be used to provision accounts | - |
| adminAccountPassword | (optional) The password of the admin account | - |
| disabledTests | (optional) A comma-separated list of tests that are to be skipped. For example: EntityCapsTest,SoftwareInfoIntegrationTest | - |
| disabledSpecifications | (optional) A comma-separated list of specifications (not case-sensitive) that are to be skipped. For example: XEP-0045,XEP-0060 | - |
| enabledTests | (optional) A comma-separated list of tests that are the only ones to be run. For example: EntityCapsTest,SoftwareInfoIntegrationTest | - |
| enabledSpecifications | (optional) A comma-separated list of specifications (not case-sensitive) that are the only ones to be run. For example: XEP-0045,XEP-0060 | - |
| logDir | (optional) The directory in which the test output and logs are to be stored. This directory will be created, if it does not already exist. | ./output |

For more information on enabling and disabling tests, consult [this guide](/documentation/selecting-tests).

For the latest updates to the documentation of the configuration updates, consult the [GitHub repository](https://github.com/XMPP-Interop-Testing/xmpp-interop-tests-circleci-orb).
Various options are available when calling _xmpp-interop-tests_, and whilst none of them are absolutely required, the defaults are unlikely to be perfect for everyone.

For the latest updates to the documentation of the configuration updates, consult the [GitHub repository of the CircleCI orb](https://github.com/XMPP-Interop-Testing/xmpp-interop-tests-circleci-orb).

{% include doc-conf-table.html %}

{% include doc-conf-provision.html %}

{% include doc-next-steps.html %}

Expand Down
20 changes: 5 additions & 15 deletions _documentation/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,11 @@ The above assumes that your server is running and reachable on the domain `shake

Various options are available when invoking the _xmpp_interop_tests_, and whilst none of them are absolutely required, the defaults are unlikely to be perfect for everyone.

| Option | Description | Default value |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
| host | IP address or DNS name of the XMPP service to run the tests on. | 127.0.0.1 |
| domain | the XMPP domain name of server under test. | example.org |
| timeout | the amount of milliseconds after which an XMPP action (typically an IQ request) is considered timed out. | 5000 (five seconds) |
| adminAccountUsername | (optional) The account name of a pre-existing user that is allowed to create other users, per [XEP-0133](https://xmpp.org/extensions/xep-0133.html). If not provided, in-band registration ([XEP-0077](https://xmpp.org/extensions/xep-0077.html)) will be used to provision accounts | - |
| adminAccountPassword | (optional) The password of the admin account | - |
| disabledTests | (optional) A comma-separated list of tests that are to be skipped. For example: EntityCapsTest,SoftwareInfoIntegrationTest | - |
| disabledSpecifications | (optional) A comma-separated list of specifications (not case-sensitive) that are to be skipped. For example: XEP-0045,XEP-0060 | - |
| enabledTests | (optional) A comma-separated list of tests that are the only ones to be run. For example: EntityCapsTest,SoftwareInfoIntegrationTest | - |
| enabledSpecifications | (optional) A comma-separated list of specifications (not case-sensitive) that are the only ones to be run. For example: XEP-0045,XEP-0060 | - |

For more information on enabling and disabling tests, consult [this guide](/documentation/selecting-tests).
For the latest updates to the documentation of the configuration updates, consult the [GitHub repository of the Docker image](https://github.com/XMPP-Interop-Testing/smack-sint-server-extensions?#from-a-container).

{% include doc-conf-table.html %}

{% include doc-conf-provision.html %}

### Exposing XMPP traffic logs

Expand Down Expand Up @@ -85,8 +77,6 @@ $ echo $?
2
{% endhighlight %}

For the latest updates to the documentation of the configuration updates, consult the [GitHub repository](https://github.com/XMPP-Interop-Testing/smack-sint-server-extensions?#from-a-container).

{% include doc-next-steps.html %}

_Splash image courtesy of [Bernd 📷 Dittrich, Unsplash](https://unsplash.com/photos/a-group-of-trucks-parked-next-to-each-other-in-a-parking-lot-bUnsDLFRNWc?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash")_
Expand Down
17 changes: 4 additions & 13 deletions _documentation/drone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,21 +91,12 @@ Drone does not make available the XMPP stanza logs that are generated by the XMP

Various options are available when calling _xmpp-interop-testing/drone-xmpp-test_, and whilst none of them are absolutely required, the defaults are unlikely to be perfect for everyone.

| Option | Description | Default value |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
| host | IP address or DNS name of the XMPP service to run the tests on. | 127.0.0.1 |
| domain | the XMPP domain name of server under test. | example.org |
| timeout | the amount of milliseconds after which an XMPP action (typically an IQ request) is considered timed out. | 5000 (five seconds) |
| adminAccountUsername | (optional) The account name of a pre-existing user that is allowed to create other users, per [XEP-0133](https://xmpp.org/extensions/xep-0133.html). If not provided, in-band registration ([XEP-0077](https://xmpp.org/extensions/xep-0077.html)) will be used to provision accounts | - |
| adminAccountPassword | (optional) The password of the admin account | - |
| disabledTests | (optional) A comma-separated list of tests that are to be skipped. For example: EntityCapsTest,SoftwareInfoIntegrationTest | - |
| disabledSpecifications | (optional) A comma-separated list of specifications (not case-sensitive) that are to be skipped. For example: XEP-0045,XEP-0060 | - |
| enabledTests | (optional) A comma-separated list of tests that are the only ones to be run. For example: EntityCapsTest,SoftwareInfoIntegrationTest | - |
| enabledSpecifications | (optional) A comma-separated list of specifications (not case-sensitive) that are the only ones to be run. For example: XEP-0045,XEP-0060 | - |
| logDir | (optional) The directory in which the test output and logs are to be stored. This directory will be created, if it does not already exist. | ./output |

For the latest updates to the documentation of the configuration updates, consult the [GitHub repository of the Drone plugin](https://github.com/XMPP-Interop-Testing/xmpp-interop-tests-drone-plugin).

{% include doc-conf-table.html %}

{% include doc-conf-provision.html %}

{% include doc-next-steps.html %}

_Splash image courtesy of [Shahadat Rahman, Unsplash](https://unsplash.com/photos/shallow-focus-photography-of-computer-codes-BfrQnKBulYQ?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash)_
Loading