Integración con Slack Allure 3

Allure Report 3 puede publicar un resumen de cada ejecución en un canal de Slack. El plugin slack que realiza esto está incluido en el paquete allure.

El mensaje contiene el número de pruebas con cada estado y la lista de pruebas fallidas y rotas, por sus nombres completos. Los estados sin pruebas no se incluyen en la lista.

Hay dos formas de publicar el mensaje:

• con un webhook entrante - la configuración más simple, el mensaje siempre va al canal seleccionado para el webhook;
• con un token de bot - el mensaje va al canal configurado en la configuración de Allure, y la aplicación de Slack debe ser miembro del canal.

Publicar con un webhook entrante

1. En Slack API: Applications, crea una nueva aplicación para tu espacio de trabajo.

2. En la configuración de la aplicación, abre Incoming Webhooks, activa Activate Incoming Webhooks y haz clic en Add New Webhook. Selecciona el canal para los mensajes y copia la URL del webhook.

3. Pasa la URL a Allure en la variable de entorno ALLURE_SLACK_WEBHOOK, por ejemplo, como un secreto de tu pipeline de CI.

   Cualquiera que conozca la URL puede publicar en el canal, así que no la mantengas en el archivo de configuración ni en ningún otro lugar bajo control de versiones.

4. Agrega el plugin slack a la sección plugins del archivo de configuración, junto al plugin de tu reporte:

   allurerc.mjs

   import { defineConfig } from "allure";
   
   export default defineConfig({
     plugins: {
       awesome: {},
       slack: {},
     },
   });

   allurerc.json

   {
     "plugins": {
       "awesome": {},
       "slack": {}
     }
   }

   allurerc.yaml

   plugins:
     awesome: {}
     slack: {}

Después de generar el reporte, Allure publica el mensaje en el canal.

Publicar con un token de bot

1. En Slack API: Applications, crea una nueva aplicación para tu espacio de trabajo.

2. En la configuración de la aplicación, abre OAuth & Permissions y agrega el scope chat:write a Bot Token Scopes. Luego instala la aplicación en tu espacio de trabajo y copia el Bot User OAuth Token.

3. En Slack, agrega la aplicación al canal para los mensajes, por ejemplo, escribiendo /invite @app-name en el canal.

4. Pasa el token y el canal a Allure en las variables de entorno ALLURE_SLACK_TOKEN y ALLURE_SLACK_CHANNEL. El canal puede configurarse por su ID, como C0123456789, o por su nombre, como test-results o #test-results.

5. Agrega el plugin slack al archivo de configuración, de la misma forma que para el webhook entrante.

Si se proporcionan tanto una URL de webhook como un token, Allure usa el webhook.

Opciones

Todas las opciones también pueden proporcionarse mediante variables de entorno. Si una opción está configurada en el archivo de configuración, la variable de entorno no se utiliza.

Opción	Variable de entorno	Descripción
webhook	ALLURE_SLACK_WEBHOOK	URL del webhook entrante. Si se configura, token y channel no se utilizan.
token	ALLURE_SLACK_TOKEN	Token de bot de la aplicación de Slack.
channel	ALLURE_SLACK_CHANNEL	ID o nombre del canal donde publicar con el token de bot.

Por ejemplo, para configurar el canal en el archivo de configuración y mantener solo el token en el entorno:

allurerc.mjs

import { defineConfig } from "allure";

export default defineConfig({
  plugins: {
    awesome: {},
    slack: {
      options: {
        channel: "test-results",
      },
    },
  },
});

allurerc.json

{
  "plugins": {
    "awesome": {},
    "slack": {
      "options": {
        "channel": "test-results"
      }
    }
  }
}

allurerc.yaml

plugins:
  awesome: {}
  slack:
    options:
      channel: test-results

Solución de problemas

Si Allure no puede publicar el mensaje, imprime el error en la consola y genera el reporte de todas formas. El error contiene el código de error que Slack devolvió, por ejemplo:

plugin slack error Error: slack error: not_in_channel

• not_in_channel - la aplicación no es miembro del canal. Agrega la aplicación al canal.
• channel_not_found - no existe un canal con ese ID o nombre, o la aplicación no puede verlo.
• invalid_auth - el token no es válido.
• invalid_arguments - el canal no está configurado.