allure-framework / allure-framework/allure-python
allure-behave: extend scenario_history_id to use optional environment variable
- Lenguaje dominante
- Python
- Estrellas
- 814
- Forks
- 260
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
### Context
# allure-behave: extend scenario_history_id to use optional environment variable
We have a problem where we want to run the same test-suite in different environments. For example:
1. **Execute Test-Suite for Different Browser:** Firefox, Chrome, ... (i.e. 'BROWSER=firefox behave' 'BROWSER=chromium behave' etc.)
2. **Execute Test-Suite for Different Systems:** Linux armx64, Linux amd64, Win amd64, ...
If we collect all JSON allure-results and generate an allure report we only see **one** result for each test-scenario. Other executions are shown only in the "retries" section. We need to change the history ID so that each execution appears as a separate test.
We want to solve this by adding additional information into the historyId. It would have been nice to use additional user-modifiable information from the Scenario object, but this is not possible since scenario_history_id() is called before the before_scenario() hook (environment.py). Therefore not action in the before_scenario hook function (like changing scenario name or adding other information, can impact the historyId.
Thus, we designed a solution that uses an environment variable to pass this information. Our proposal is to the set an environment variable in `environment.py` that is used to influence the `historyId`.
In `allure-python/allure-behave/src/utils.py`:
```python
def scenario_history_id(scenario) -> str:
"""
Create a historyId for a scenario.
- Always based on feature name and scenario name
- Optional: can append a value from an environment variable
"""
parts = [scenario.feature.name, scenario.name]
if hasattr(scenario, "_row") and scenario._row:
row = scenario._row
parts.extend([f"{name}={value}" for name, value in zip(row.headings, row.cells)])
# Optional: append environment variable to differentiate runs
history_id = os.getenv("ALLURE_HISTORY_ID")
if history_id:
parts.append(history_id)
return md5(*parts)
```
To use this feature, add the environment variable in `environment.py`:
```python
from enum import Enum
import os
class Option(str, Enum):
OPTION_A = "Option A"
OPTION_B = "Option B"
def before_all(context):
os.environ["ALLURE_HISTORY_ID"] = Option.OPTION_B.name
```
Pull Request: #879
Guía de contribución
Línea de trabajo
Comienza en allure-behave/src/utils.py, en scenario_history_id(scenario), y revisa después cómo se utiliza el ID de historial devuelto cuando se recopilan los resultados de Allure. Se considera terminado cuando un valor opcional de ALLURE_HISTORY_ID diferencia las ejecuciones, mientras que las entradas existentes feature, scenario y scenario-row siguen determinando el ID cuando la variable está ausente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- testing-qa
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 48/100