Adding test cases for blurb front end

[JoanneHing]

What feature(s) would you like to see in RepoSense

Currently there is only some simple test cases for chart blurb frontend, may add in more to ensure that the chart frontend is working as intended

If possible, describe the solution

May refer to the frontend test for repo blurb and author blurb for example of test cases added for the front end.

[gekjunxu]

Hi, can I work on this issue?

[CYX22222003]

@gekjunxu Sure, we'll be happy to have your help.

If you need info about the setup, workflow, PRs etc, you can check out our developer guide. Please make sure closely follow the workflow when making contribution.

[gekjunxu]

Hi @CYX22222003 @JoanneHing and anyone else who may know, I think I might need a bit of help here.

I'm having some trouble figuring out how the contents of chart-blurb.md are rendered in the report, and I was hoping someone could point me in the right direction.

I created a report using GitHub Actions, with all 3 blurbs (author, repo chart) markdown files specified. I can see author and repo blurbs, but I can't seem to find the chart blurb.

I checked the UG, but the only mention I saw was “These blurbs will be displayed with the charts,” which didn’t clarify the exact location or appearance.

I did a report generation for the same repo as above (my cs2103t IP) locally on my computer, and I can see the chart blurb being parsed successfully in the summary.json file.

I see the "chartBlurbs":{"blurbMap":{"https://github.com/gekjunxu/ip/tree/master|gekjunxu":"Testing chart-blurbs.md"}} entry in the summary.json file. I have also tried using my team's tp repo to generate the report as well, but I don't see any chart blurbs.

Does anyone have a screenshot or example of what the chart blurb is supposed to look like on the report UI? Or is there a chance that it's currently not being rendered due to a bug?

Thanks in advance!

[CYX22222003]

@gekjunxu

Thanks for spotting this bug. This is due to inconsistency between frontend and backend. Frontend will refer chart blurbs with keyword chartsBlurbs but backend generates JSON with keyword chartBlurbs.

I have made a bug report at #2478 and will create a PR to fix this ASAP.

FYI, the correct display of chart blurbs can refer to #2319