allure-framework / allure-framework/allure-python

Limit step parameter content size in allure report

Đang mở
#293 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
theme:core type:enhancement
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?
Given following example
```python
import allure

def test_example():
big_arg = 'abcdef ' * 1000
example_step(big_arg)

@allure.step("Example Step")
def example_step(big_arg):
pass
```
In allure report for above test for `example_step` step argument `big_arg` value is conveniently included in report. Even if value is quite large.

#### If the current behaviour is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem

#### What is the expected behaviour?

#### What is the motivation / use case for changing the behaviour?
There are valid cases where argument(s) passed to `allure.step` function is quite large and in my opinion it does not make sense to include all of it allure report. Perhaps instead it could be truncated to some reasonable length?

In case user wants to keep all contents of specific variables/arguments he or she can always use attachment feature.

In some cases where allure step functions are dealing with quite large text chunks this increases allure report size considerably. For now as a workaround I have to avoid using `@allure.step` decorator and instead use `with allure.step()` context manager inside step function.

#### Please tell us about your environment:

- Allure version: 2.7.0
- Test framework: pytest@3.6.3
- Allure adaptor: allure-pytest@2.5.0

#### 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 theo dõi cách decorator Python @allure.step ghi lại các đối số trong report được tạo ra, rồi so sánh với context manager with allure.step() hiện đang được dùng như một workaround. Xác định giới hạn cắt ngắn và hành vi mong đợi đối với các giá trị đối số lớn trước khi xác định các test liên quan. Công việc được xem là hoàn tất khi các tham số Step quá lớn được giới hạn, trong khi attachments vẫn có thể giữ lại toàn bộ nội dung.

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ần làm rõ
Mức phù hợp với người mới
35/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.