allure-framework / allure-framework/allure-python

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

Đang mở
#786 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
task:improvement theme:core
Ngôn ngữ chính
Python
Star
814
Fork
260
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

[//]: # (
. 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
)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách xác định entry point của pytest adapter cho decorator @allure.testcase và mọi test hoặc tài liệu mô tả nó. Kiểm tra xem tên @allure.tms được đề xuất nên hoạt động như thế nào bên cạnh API hiện có, sau đó xác minh rằng người dùng pytest có thể tạo cùng liên kết TMS-456 thông qua tên decorator nhất quán.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
testing
Loại issue
Tính năng
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
42/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.