Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feat: Add JSON and HTML apis for reports/testruns #69

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Feat: Add JSON and HTML apis for reports/testruns #69

wants to merge 1 commit into from

Conversation

gowtham-ra
Copy link

  1. Render ReportTestRunAll data as json instead of HTML.
  2. Update README for accessing the Fern-UI dashboard for test results.

@gowtham-ra gowtham-ra marked this pull request as draft May 20, 2024 05:07
anoop2811
anoop2811 requested changes May 20, 2024
View reviewed changes
README.md Outdated
- View reports at `http://[your-api-url]/reports/testruns`.
- If using `make docker-run`, reports are available at `http://localhost:8080/reports/testruns`.
To view the test reports, you can use the Fern-UI frontend,
which provides a visual dashboard for the test results.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets leave both options ie. use fern-ui or use the embedded UI. The idea behind this is to foster innovation outside if needed using the apis we have

pkg/api/handlers/handlers.go Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets add new methods for fern-ui without removing the old code for static html. I would always leave the embedded here as a one stop shop so as not to depend on many external packages,.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback. I'll make the changes to support both views.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made the changes. Now by default reports/testruns return JSON. HTML is available at reports/testruns/html

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would instead use /api/reports/testruns to indicate the api which returns json and leave reports/testruns as the embedded html

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated this. Please let me know if everything looks okay. Thank you.

@gowtham-ra gowtham-ra changed the title Feat: Render testruns data as JSON instead of HTML for Fern-UI Feat: Add JSON and HTML apis for reports/testruns Jun 3, 2024
@gowtham-ra gowtham-ra requested a review from anoop2811 June 3, 2024 06:16
@gowtham-ra gowtham-ra marked this pull request as ready for review June 3, 2024 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anoop2811 anoop2811 Awaiting requested review from anoop2811

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@gowtham-ra @anoop2811