Release 4.18.0 changes description

Starting from the release 4.18.0, the following parameters must be always present in uaa service of Allure TestOps. Without these settings the registration of users in ATO Allure TestOps won't be possible using the designed way.

    SPRING_MAIL_HOST = smtp.gmail.com
    SPRING_MAIL_PORT = 465
    SPRING_MAIL_USERNAME = username
    SPRING_MAIL_PASSWORD = password
    [email protected]
    SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH = true
    SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE = true
    SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_REQUIRED = true
    SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_ENABLE = true
    SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_TRUST = smtp.gmail.com

How to update the configurations

Normally, all the required parameters are present in the configuration files if you are deploying Allure TestOps from scratch. If you are upgrading an existing version and you don't have smtp server configured as yet, then this article is for you.

SMTP server settings are required for the password restoration process as well.

Kubernetes deployment

The actual Helm chart already has all the required settings in smtp section of values.yaml file. All you need is...

1. To enable the functionality and set the values for the integration with your smtp server.
2. To update the version settings to 4.18.1.
3. Perform the helm upgrade.

Docker compose deployment

1. The following recommendation implies you haven't made any changes into docker-compose.yml file and you've done all the configuration in .env file as it's recommended in the docker compose installation guide.
2. The following recommendation implies you are using this configuration parameters set in your production environment.

1. Make sure, you are using actual configuration for docker compose deployment from this repo: https://github.com/qameta/allure-docker-compose
2. Download templatesof .env and docker-compose.yml files.
3. Create a copy of existing docker-compose.yml, e.g. cp docker-compose.yml docker-compose.backup
4. Replace docker-compose.yml with the same file downloaded on the step 2.
5. In the uaa section of env-example locate the example settings related to email configuration.
6. Copy email settings to your existing .env file.
7. Add correct configuration parameters to work with your SMTP server.
8. Update the VERSION parameter to 4.18.1
9. Stop (docker compose down) the installed system.
10. Start (docker compose up -d) the installed system.

Packages deployment

Allure TestOps must be deployed [as described here.]({{< relref "../install/packages" >}}) If the deployment is made using old packages deployment, you need to switch to the actual one as the settings are incompatible.

Existing installation

If you have installed Allure TestOps using either deb or rpm packages, you need to update the installed software

sudo apt-get install allure-testops-<package_name>=4.18.1

# or

yum install allure-testops-<package_name>-4.18.1-1

package name could be box or min.

then open the uaa configuration file for editing /opt/allure-testops/uaa/conf/allure-uaa.conf

and add the following strings to the end of the file

SPRING_MAIL_HOST=smtp.<domain>
SPRING_MAIL_PORT=465
SPRING_MAIL_USERNAME=username
SPRING_MAIL_PASSWORD=password
[email protected]
SPRING_MAIL_PROPERTIES_MAIL_SMTP_AUTH=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_REQUIRED=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_ENABLE=true
SPRING_MAIL_PROPERTIES_MAIL_SMTP_SSL_TRUST=smtp.<domain>

update the strings with the correct cfg parameters for your smtp server and save the file.

Then start the services as usual.