Bug: Not able to open traceviewer directlly from within the BDD report

Question

Bug: Not able to open traceviewer directlly from within the BDD report

NikkTod opened this issue 2 months ago · 11 comments

Given
We have a fail test and traces are enabled and we have set correct attchmentsBaseURL

When
I open the BDD report and go to the test that failed

Then
I click on the link to open directlly the traceviewer and see the trace for that fail test

Bug:
Clicking on the link does not open the traces zip file. I compared vs the link in the playwright html report and I saw that the generated URL is missing a /reports before the /trace/index.html?trace=......

Playwright html:
server:port/reports/trace/index.html?trace=https://localhost:port/data/traceID.zip

Environment
Playwright-bdd v7.5.0

Answer 1 · 2024-10-08T14:25:36.000Z

Actually this /reports path is coming from me

My attachmentBaseURL is: https://host:port/reports/data
With this settings I am not able to open the traceviewer with the zip inside the BDD report, it produces for me URL like:

https://host:port/trace/index.html?trace=https://host:port/reports/data/traceID.zip

Playwright traceview URL, which is working is:

https://host:port/reports/trace/index.html?trace=https://host:port/reports/data/traceID.zip

Answer 2 · 2024-10-08T14:50:27.000Z

Ahhh I think the problem is that my bdd report is called cucumber.html and not index.html

Answer 3 · 2024-10-08T14:51:50.000Z

From the config I see that /reports is set for outputFolder in Playwright html reporter, not for Cucumber html reporter.
Could you for now disable Playwright html reporter and generate Cucumber html with attachmentBaseURL = https://host:port/data ?

Answer 4 · 2024-10-09T06:25:54.000Z

Hi @vitalets, I tried as you suggested, the problem is that my URL has a part that is changing for every build.

eg. https://host:port/repositry/download/id_of_build_that_is_changing

So when I set the attachmentBaseURL = https://host:port/data

Then I am produced with the following URL within the bdd report

https://host:port/repositry/download/id_of_build_that_is_changing/trace/index.html?trace=https://host:port/data/traceID.zip

After ?trace= I not able to set correct path to the zip, it seems I will have to catch that changable build id and set it in the attachmentBaseURL, so that I should get the following:

https://host:port/repositry/download/id_of_build_that_is_changing/trace/index.html?trace=https://host:port/repositry/download/id_of_build_that_is_changing/data/traceID.zip

Answer 5 · 2024-10-09T10:55:15.000Z

Closing the ticket, adding the build id as configuration parameter to the attachmentBaseURL did the trick.

Thanks for the help @vitalets

Answer 6 · 2024-10-10T06:18:47.000Z

You are welcome!

Answer 7 · 2024-10-10T11:33:25.000Z

@NikkTod could you share your final config (without private details)?
I'll add it as example to docs for other Teamcity users.

Answer 8 · 2024-10-10T11:50:18.000Z

Sure, here you go! Maybe it is important to mention that report should be called index.html

playwright-report for folder is not a good name, maybe write it as bdd-report :)

cucumberReporter('html', {
  outputFile: 'playwright-report/index.html',
  externalAttachments: true,
  attachmentsBaseURL: `https://host:port/repository/download/${process.env.TCBuildTypeID}/${process.env.TCBuildID}:id/data`
});

cc: @vitalets

Answer 9 · 2024-10-11T07:25:40.000Z

Thank you!
Just curios, should not playwright-report appear somewhere in attachmentsBaseURL? As attachments are stored inside that dir.

Answer 10 · 2024-10-11T07:40:12.000Z

Good point, usually yes, but in my case I have the posiblity to point where the atrifact path is, directlly in the settings of team city, so the playwright-report is there.

Answer 11 · 2024-10-11T08:52:47.000Z

Ok, will mention that as well!