Configuración de Allure RSpec

Para personalizar el comportamiento del adaptador Allure RSpec:

1. Crea o edita un archivo de ayuda para ejecutar al principio de cada ejecución de RSpec, por ejemplo, spec/spec_helper.rb.

2. En el archivo de ayuda, requiere el módulo allure-rspec y ejecuta la función AllureRspec.configure(). La función recibe un bloque con el argumento único config, en el cual puedes modificar varios parámetros de configuración.

   require 'allure-rspec'
   
   AllureRspec.configure do |config|
     config.results_directory = 'allure-results'
     config.clean_results_directory = true
     config.ignored_tags = [:retry, :retry_wait]
   end

3. En el archivo .rspec del proyecto, agrega una directiva --require para ejecutar el archivo de ayuda, por ejemplo:

   --format AllureRspecFormatter --require spec_helper

results_directory

Ruta al directorio donde Allure RSpec guardará los resultados de las pruebas, consulta Cómo funciona. Si el directorio no existe, será creado. Por defecto es “reports/allure-results”.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.results_directory = 'allure-results'
end

clean_results_directory

Si se establece en true, el directorio de resultados se limpiará antes de generar nuevos resultados de prueba.

Por defecto, los datos existentes se mantienen intactos, lo que permite combinar los resultados de varias ejecuciones de pruebas en un solo informe de prueba.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.clean_results_directory = true
end

issue_tag, tms_tag

Los nombres de las claves de metadatos de RSpec que se usarán para agregar enlaces de problemas y enlaces de TMS al resultado de la prueba. Por defecto son “issue” y “tms”.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.issue_tag = 'bug'
  config.tms_tag = 'test'
end

Consulta también: link_issue_pattern y link_tms_pattern.

severity_tag

El nombre de la clave de metadatos de RSpec que se usará para especificar la gravedad de una prueba. Por defecto es “severity”.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.severity_tag = 'priority'
end

epic_tag, feature_tag, story_tag

Los nombres de las claves de metadatos de RSpec que se usarán para especificar la ubicación de una prueba en la jerarquía basada en comportamientos. Por defecto son “epic”, “feature” y “story”.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.epic_tag = 'theme'
  config.feature_tag = 'functionality'
  config.story_tag = 'task'
end

ignored_tags

Los nombres de las etiquetas que no deben ser procesadas al agregar etiquetas a través de metadatos de RSpec. Usa esto para excluir etiquetas que hayas configurado para fines no relacionados con Allure Report, por ejemplo, para otros complementos de RSpec.

Ten en cuenta que incluso cuando una etiqueta es ignorada, aún podrás agregarla al resultado de la prueba usando la función Allure.tag().

require 'allure-rspec'

AllureRspec.configure do |config|
  config.ignored_tags = [:retry, :retry_wait]
end

logger, logging_level

Configura el registrador al que Allure RSpec enviará los mensajes sobre el inicio y el fin de cada prueba o paso de prueba.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.logger = Logger.new($stdout, Logger::DEBUG)
  config.logging_level = Logger::INFO
end

link_issue_pattern, link_tms_pattern

Define plantillas que pueden ser usadas para construir URLs completas a partir de identificadores cortos, consulta la referencia. El patrón debe contener {} en la posición donde se debe colocar el identificador.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.link_issue_pattern = 'https://issues.example.org/{}'
  config.link_tms_pattern = 'https://tms.example.org/{}'
end

Consulta también: issue_tag y tms_tag.

environment_properties

Pares clave-valor que se mostrarán en la página principal del informe, consulta Información del entorno.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.environment_properties = {
    os_platform: RbConfig::CONFIG['host_os'],
    ruby_version: RUBY_VERSION,
  }
end

categories

Ruta al archivo de categorías. Allure RSpec copiará este archivo al directorio de resultados, para que pueda ser utilizado para analizar los resultados de las pruebas en el informe.

require 'allure-rspec'

AllureRspec.configure do |config|
  config.categories = File.new("my_custom_categories.json")
end