allure-framework / allure-framework/allure-python

[Feature] Pytest - Rename @allure.testcase decorator to @allure.tms

Aperta
#786 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
task:improvement theme:core
Lingua principale
Python
Stelle
814
Fork
260
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

[//]: # (
. Note: for support questions, please use Stackoverflow or Gitter**.
. This repository's issues are reserved for feature requests and bug reports.
.
. In case of any problems with Allure Jenkins plugin** please use the following repository
. to create an issue: https://github.com/jenkinsci/allure-plugin/issues
.
. Make sure you have a clear name for your issue. The name should start with a capital
. letter and no dot is required in the end of the sentence. An example of good issue names:
.
. - The report is broken in IE11
. - Add an ability to disable default plugins
. - Support emoji in test descriptions
)

#### I'm submitting a ...
- [ ] bug report
- [x] feature request
- [ ] support request => Please do not submit support request here, see note at the top of this template.

#### What is the current behavior?
The different Allure API implementations use different names for the testcase link:

- Python behave: `@allure.tms:TMS-456`
- Python pytest: `@allure.testcase("TMS-456")`
- Java JUnit: `@TmsLink("TMS-456")`
- .Net NUnit: `[AllureTms("TMS-456")]`
- Cucumber.js: `this.tms("https://example.com/tms/TMS-456", "TMS-456");`
- PHPUnit: `#[TmsLink('TMS-456')]`

#### What is the expected behavior?
For the sake of coherence, could we rename the `@allure.testcase` decorator to `@allure.tms` for pytest ?

#### What is the motivation / use case for changing the behavior?
To have a coherent API

#### Please tell us about your environment:

- Allure version: 2.25.0
- Test framework: pytest@7.4.2
- Allure adaptor: allure-pytest@2.13.2

#### Other information

[//]: # (
. e.g. detailed explanation, stacktraces, related issues, suggestions
. how to fix, links for us to have more context, eg. Stackoverflow, Gitter etc
)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia individuando il punto di ingresso dell’adattatore pytest per il decoratore @allure.testcase e tutti i test o la documentazione che lo riguardano. Verifica come dovrebbe comportarsi il nome proposto @allure.tms insieme all’API esistente, quindi verifica che gli utenti di pytest possano creare lo stesso link TMS-456 tramite il nome coerente del decoratore.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.