allure-framework / allure-framework/allure-python

allure-behave: extend scenario_history_id to use optional environment variable

Aperta
#880 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
814
Fork
260
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia in allure-behave/src/utils.py, in scenario_history_id(scenario), poi esamina come viene utilizzato l’ID della cronologia restituito quando vengono raccolti i risultati di Allure. Il lavoro è completato quando un valore opzionale di ALLURE_HISTORY_ID differenzia le esecuzioni, mentre gli input esistenti feature, scenario e scenario-row continuano a determinare l’ID quando la variabile è assente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
testing-qa
Tipo di issue
Funzionalità
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.