Allure notifications 🌞

for telegram, slack, skype, email, mattermost

Languages: 🇬🇧 🇫🇷 🇷🇺 🇺🇦 🇧🇾 🇨🇳

Telegram	Slack

Mattermost	Email

Skype	Icq
Done	Wat? lol

How to:

CommandLine options

All keys should be used with `-D`:

key	description
configFile	Path to JSON-config file

java \
"-DconfigFile=${PATH_TO_FILE}" \
-jar allure-notifications-4.1.jar

If you want the project logo to appear in the upper left corner of the chart, add the file logo.png to root of project

Config file structure

Here you can find config file structure for lib configuration.

{
  "base": {
    "logo": "",
    "project": "",
    "environment": "",
    "comment": "",
    "reportLink": "",
    "language": "ru",
    "allureFolder": "",
    "enableChart": false
  },
  "telegram": {
    "token": "",
    "chat": "",
    "replyTo": ""
  },
  "slack": {
    "token": "",
    "chat": "",
    "replyTo": ""
  },
  "mattermost": {
    "url": "",
    "token": "",
    "chat": ""
  },
  "skype": {
    "appId": "",
    "appSecret": "",
    "serviceUrl": "",
    "conversationId": "",
    "botId": "",
    "botName": ""
  },
  "mail": {
    "host": "",
    "port": "",
    "username": "",
    "password": "",
    "securityProtocol": null,
    "from": "",
    "recipient": ""
  },
  "proxy": {
    "host": "",
    "port": 0,
    "username": "",
    "password": ""
  }
}

You only need:

to fill needed options in base block (please, be careful, language field is required!);
to configure desired destinations for notifications (telegram, slack, mattermost, skype, mail), keep in mind it's possible to set multiple destinations at once, if no destination is set, then no notification will be sent and no error will occur;
to specify optional proxy configuration in proxy block.

If you want the project logo to appear in the upper left corner of the chart, add file path to logo parameter in configuration

Example for Telegram messenger:

{
  "base": {
    "project": "some project",
    "environment": "some env",
    "comment": "some comment",
    "reportLink": "",
    "language": "en",
    "allureFolder": "build/allure-report/",
    "enableChart": true
  },
  "telegram": {
    "token": "asdhsdgfjsdfgFgjhg4831)@",
    "chat": "-1",
    "replyTo": ""
  }
}

Email client configuration

host - the SMTP server to connect to.
port - the SMTP server port to connect to.
username - user to authenticate to the SMTP server.
password - user's password for authentication.
securityProtocol (optional: can be omitted or set to null) - one of the following security protocols:
- SSL - use SSL to connect (make sure the SSL port is used).
- STARTTLS - use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. If the server does not support STARTTLS, the connection continues without the use of TLS.
from - email address to use for SMTP MAIL command, this sets the envelope return address.
recipient - comma-separated list of recipient email addresses.

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

qa-guru / allure-notifications

Programming Languages