LinuxSuRen / LinuxSuRen/api-testing

Support to take the user-defined test report template

Open
#106 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Go
Stars
369
Forks
67
PR merge metrics
No merged PRs in 30d

Description

Currently, all the test reports are embed in the code lines. But it's quite normal that uesrs want a new test report style. A simple solution is that allowing pass a user-defined template.

A suggestion is adding a flag to the following command:

atest run --report-template (my-template.md | my-template.html | https://foo/my-template.html)

References

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the atest run --report-template command described in the issue, then read pkg/runner/writer_markdown.go and pkg/runner/writer_html.go at the referenced locations. Trace how reports are selected and generated. Done means local Markdown or HTML templates, as well as the specified URL form, can be supplied and used for test reports.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.